From 9636d5b3aac99459e5933bc4fa6ddb8ca84917af Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 20 Jan 2018 21:26:21 -0500
Subject: encapsulate common JSON converter code, improve parse errors (#423)

---
 .../Serialisation/SimpleReadOnlyConverter.cs       | 77 ++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs

(limited to 'src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs')

diff --git a/src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs b/src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs
new file mode 100644
index 00000000..9308456b
--- /dev/null
+++ b/src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs
@@ -0,0 +1,77 @@
+using System;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using StardewModdingAPI.Framework.Exceptions;
+
+namespace StardewModdingAPI.Framework.Serialisation
+{
+    /// <summary>The base implementation for simplified converters which deserialise <typeparamref name="T"/> without overriding serialisation.</summary>
+    /// <typeparam name="T">The type to deserialise.</typeparam>
+    internal abstract class SimpleReadOnlyConverter<T> : JsonConverter
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Whether this converter can write JSON.</summary>
+        public override bool CanWrite => false;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get whether this instance can convert the specified object type.</summary>
+        /// <param name="objectType">The object type.</param>
+        public override bool CanConvert(Type objectType)
+        {
+            return objectType == typeof(T);
+        }
+
+        /// <summary>Writes the JSON representation of the object.</summary>
+        /// <param name="writer">The JSON writer.</param>
+        /// <param name="value">The value.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new InvalidOperationException("This converter does not write JSON.");
+        }
+
+        /// <summary>Reads the JSON representation of the object.</summary>
+        /// <param name="reader">The JSON reader.</param>
+        /// <param name="objectType">The object type.</param>
+        /// <param name="existingValue">The object being read.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            string path = reader.Path;
+            switch (reader.TokenType)
+            {
+                case JsonToken.StartObject:
+                    return this.ReadObject(JObject.Load(reader), path);
+                case JsonToken.String:
+                    return this.ReadString(JToken.Load(reader).Value<string>(), path);
+                default:
+                    throw new SParseException($"Can't parse {typeof(T).Name} from {reader.TokenType} (path: {reader.Path}).");
+            }
+        }
+
+
+        /*********
+        ** Protected methods
+        *********/
+        /// <summary>Read a JSON object.</summary>
+        /// <param name="obj">The JSON object to read.</param>
+        /// <param name="path">The path to the current JSON node.</param>
+        protected virtual T ReadObject(JObject obj, string path)
+        {
+            throw new SParseException($"Can't parse {typeof(T).Name} from object (path: {path}).");
+        }
+
+        /// <summary>Read a JSON string.</summary>
+        /// <param name="str">The JSON string value.</param>
+        /// <param name="path">The path to the current JSON node.</param>
+        protected virtual T ReadString(string str, string path)
+        {
+            throw new SParseException($"Can't parse {typeof(T).Name} from string (path: {path}).");
+        }
+    }
+}
-- 
cgit 


From b10a4b410bb2d50245928bdb88a9efc05aadbe72 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 20 Jan 2018 22:18:11 -0500
Subject: tweak JSON error messages

---
 src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs')

diff --git a/src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs b/src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs
index 9308456b..5765ad96 100644
--- a/src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs
+++ b/src/SMAPI/Framework/Serialisation/SimpleReadOnlyConverter.cs
@@ -50,7 +50,7 @@ namespace StardewModdingAPI.Framework.Serialisation
                 case JsonToken.String:
                     return this.ReadString(JToken.Load(reader).Value<string>(), path);
                 default:
-                    throw new SParseException($"Can't parse {typeof(T).Name} from {reader.TokenType} (path: {reader.Path}).");
+                    throw new SParseException($"Can't parse {typeof(T).Name} from {reader.TokenType} node (path: {reader.Path}).");
             }
         }
 
@@ -63,7 +63,7 @@ namespace StardewModdingAPI.Framework.Serialisation
         /// <param name="path">The path to the current JSON node.</param>
         protected virtual T ReadObject(JObject obj, string path)
         {
-            throw new SParseException($"Can't parse {typeof(T).Name} from object (path: {path}).");
+            throw new SParseException($"Can't parse {typeof(T).Name} from object node (path: {path}).");
         }
 
         /// <summary>Read a JSON string.</summary>
@@ -71,7 +71,7 @@ namespace StardewModdingAPI.Framework.Serialisation
         /// <param name="path">The path to the current JSON node.</param>
         protected virtual T ReadString(string str, string path)
         {
-            throw new SParseException($"Can't parse {typeof(T).Name} from string (path: {path}).");
+            throw new SParseException($"Can't parse {typeof(T).Name} from string node (path: {path}).");
         }
     }
 }
-- 
cgit