From 3ba567eaddeaa0bb2bdd749b56e0601d1cf65a25 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sun, 4 Aug 2019 03:28:34 -0400
Subject: add JSON validator with initial support for manifest format (#654)

---
 .../JsonValidator/JsonValidatorErrorModel.cs       | 36 +++++++++
 .../ViewModels/JsonValidator/JsonValidatorModel.cs | 92 ++++++++++++++++++++++
 .../JsonValidator/JsonValidatorRequestModel.cs     | 15 ++++
 3 files changed, 143 insertions(+)
 create mode 100644 src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorErrorModel.cs
 create mode 100644 src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorModel.cs
 create mode 100644 src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorRequestModel.cs

(limited to 'src/SMAPI.Web/ViewModels')

diff --git a/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorErrorModel.cs b/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorErrorModel.cs
new file mode 100644
index 00000000..f9497a38
--- /dev/null
+++ b/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorErrorModel.cs
@@ -0,0 +1,36 @@
+namespace StardewModdingAPI.Web.ViewModels.JsonValidator
+{
+    /// <summary>The view model for a JSON validator error.</summary>
+    public class JsonValidatorErrorModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The line number on which the error occurred.</summary>
+        public int Line { get; set; }
+
+        /// <summary>The field path in the JSON file where the error occurred.</summary>
+        public string Path { get; set; }
+
+        /// <summary>A human-readable description of the error.</summary>
+        public string Message { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public JsonValidatorErrorModel() { }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="line">The line number on which the error occurred.</param>
+        /// <param name="path">The field path in the JSON file where the error occurred.</param>
+        /// <param name="message">A human-readable description of the error.</param>
+        public JsonValidatorErrorModel(int line, string path, string message)
+        {
+            this.Line = line;
+            this.Path = path;
+            this.Message = message;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorModel.cs b/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorModel.cs
new file mode 100644
index 00000000..4c122d4f
--- /dev/null
+++ b/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorModel.cs
@@ -0,0 +1,92 @@
+using System.Collections.Generic;
+using System.Linq;
+
+namespace StardewModdingAPI.Web.ViewModels.JsonValidator
+{
+    /// <summary>The view model for the JSON validator page.</summary>
+    public class JsonValidatorModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The root URL for the log parser controller.</summary>
+        public string SectionUrl { get; set; }
+
+        /// <summary>The paste ID.</summary>
+        public string PasteID { get; set; }
+
+        /// <summary>The schema name with which the JSON was validated.</summary>
+        public string SchemaName { get; set; }
+
+        /// <summary>The supported JSON schemas (names indexed by ID).</summary>
+        public readonly IDictionary<string, string> SchemaFormats;
+
+        /// <summary>The validated content.</summary>
+        public string Content { get; set; }
+
+        /// <summary>The schema validation errors, if any.</summary>
+        public JsonValidatorErrorModel[] Errors { get; set; } = new JsonValidatorErrorModel[0];
+
+        /// <summary>An error which occurred while uploading the JSON to Pastebin.</summary>
+        public string UploadError { get; set; }
+
+        /// <summary>An error which occurred while parsing the JSON.</summary>
+        public string ParseError { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public JsonValidatorModel() { }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="sectionUrl">The root URL for the log parser controller.</param>
+        /// <param name="pasteID">The paste ID.</param>
+        /// <param name="schemaName">The schema name with which the JSON was validated.</param>
+        /// <param name="schemaFormats">The supported JSON schemas (names indexed by ID).</param>
+        public JsonValidatorModel(string sectionUrl, string pasteID, string schemaName, IDictionary<string, string> schemaFormats)
+        {
+            this.SectionUrl = sectionUrl;
+            this.PasteID = pasteID;
+            this.SchemaName = schemaName;
+            this.SchemaFormats = schemaFormats;
+        }
+
+        /// <summary>Set the validated content.</summary>
+        /// <param name="content">The validated content.</param>
+        public JsonValidatorModel SetContent(string content)
+        {
+            this.Content = content;
+
+            return this;
+        }
+
+        /// <summary>Set the error which occurred while uploading the log to Pastebin.</summary>
+        /// <param name="error">The error message.</param>
+        public JsonValidatorModel SetUploadError(string error)
+        {
+            this.UploadError = error;
+
+            return this;
+        }
+
+        /// <summary>Set the error which occurred while parsing the JSON.</summary>
+        /// <param name="error">The error message.</param>
+        public JsonValidatorModel SetParseError(string error)
+        {
+            this.ParseError = error;
+
+            return this;
+        }
+
+        /// <summary>Add validation errors to the response.</summary>
+        /// <param name="errors">The schema validation errors.</param>
+        public JsonValidatorModel AddErrors(params JsonValidatorErrorModel[] errors)
+        {
+            this.Errors = this.Errors.Concat(errors).ToArray();
+
+            return this;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorRequestModel.cs b/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorRequestModel.cs
new file mode 100644
index 00000000..c8e851bf
--- /dev/null
+++ b/src/SMAPI.Web/ViewModels/JsonValidator/JsonValidatorRequestModel.cs
@@ -0,0 +1,15 @@
+namespace StardewModdingAPI.Web.ViewModels.JsonValidator
+{
+    /// <summary>The view model for a JSON validation request.</summary>
+    public class JsonValidatorRequestModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The schema name with which to validate the JSON.</summary>
+        public string SchemaName { get; set; }
+
+        /// <summary>The raw content to validate.</summary>
+        public string Content { get; set; }
+    }
+}
-- 
cgit