From f9eb16489fcf3f4c486df5f96a94edf16cf19a09 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 18 Aug 2018 14:44:18 -0400
Subject: refactor some methods for reuse (#468)

---
 src/SMAPI/Framework/ModLoading/ModResolver.cs            |  3 +--
 .../Serialisation/JsonHelper.cs                          | 16 ++++++++++------
 src/StardewModdingAPI.Toolkit/Utilities/PathUtilities.cs |  8 ++++++++
 3 files changed, 19 insertions(+), 8 deletions(-)

(limited to 'src')

diff --git a/src/SMAPI/Framework/ModLoading/ModResolver.cs b/src/SMAPI/Framework/ModLoading/ModResolver.cs
index 9ac95fd4..09880d03 100644
--- a/src/SMAPI/Framework/ModLoading/ModResolver.cs
+++ b/src/SMAPI/Framework/ModLoading/ModResolver.cs
@@ -2,7 +2,6 @@ using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using System.Text.RegularExpressions;
 using StardewModdingAPI.Toolkit;
 using StardewModdingAPI.Toolkit.Framework.ModData;
 using StardewModdingAPI.Toolkit.Framework.ModScanning;
@@ -181,7 +180,7 @@ namespace StardewModdingAPI.Framework.ModLoading
                 }
 
                 // validate ID format
-                if (Regex.IsMatch(mod.Manifest.UniqueID, "[^a-z0-9_.-]", RegexOptions.IgnoreCase))
+                if (!PathUtilities.IsSlug(mod.Manifest.UniqueID))
                     mod.SetStatus(ModMetadataStatus.Failed, "its manifest specifies an invalid ID (IDs must only contain letters, numbers, underscores, periods, or hyphens).");
             }
 
diff --git a/src/StardewModdingAPI.Toolkit/Serialisation/JsonHelper.cs b/src/StardewModdingAPI.Toolkit/Serialisation/JsonHelper.cs
index cc8eeb73..dcc0dac4 100644
--- a/src/StardewModdingAPI.Toolkit/Serialisation/JsonHelper.cs
+++ b/src/StardewModdingAPI.Toolkit/Serialisation/JsonHelper.cs
@@ -95,18 +95,14 @@ namespace StardewModdingAPI.Toolkit.Serialisation
                 Directory.CreateDirectory(dir);
 
             // write file
-            string json = JsonConvert.SerializeObject(model, this.JsonSettings);
+            string json = this.Serialise(model);
             File.WriteAllText(fullPath, json);
         }
 
-
-        /*********
-        ** Private methods
-        *********/
         /// <summary>Deserialize JSON text if possible.</summary>
         /// <typeparam name="TModel">The model type.</typeparam>
         /// <param name="json">The raw JSON text.</param>
-        private TModel Deserialise<TModel>(string json)
+        public TModel Deserialise<TModel>(string json)
         {
             try
             {
@@ -127,5 +123,13 @@ namespace StardewModdingAPI.Toolkit.Serialisation
                 throw;
             }
         }
+
+        /// <summary>Serialize a model to JSON text.</summary>
+        /// <typeparam name="TModel">The model type.</typeparam>
+        /// <param name="model">The model to serialise.</param>
+        public string Serialise<TModel>(TModel model)
+        {
+            return JsonConvert.SerializeObject(model, this.JsonSettings);
+        }
     }
 }
diff --git a/src/StardewModdingAPI.Toolkit/Utilities/PathUtilities.cs b/src/StardewModdingAPI.Toolkit/Utilities/PathUtilities.cs
index 2e74e7d9..b959f9b5 100644
--- a/src/StardewModdingAPI.Toolkit/Utilities/PathUtilities.cs
+++ b/src/StardewModdingAPI.Toolkit/Utilities/PathUtilities.cs
@@ -2,6 +2,7 @@ using System;
 using System.Diagnostics.Contracts;
 using System.IO;
 using System.Linq;
+using System.Text.RegularExpressions;
 
 namespace StardewModdingAPI.Toolkit.Utilities
 {
@@ -61,5 +62,12 @@ namespace StardewModdingAPI.Toolkit.Utilities
                 relative = "./";
             return relative;
         }
+
+        /// <summary>Get whether a string is a valid 'slug', containing only basic characters that are safe in all contexts (e.g. filenames, URLs, etc).</summary>
+        /// <param name="str">The string to check.</param>
+        public static bool IsSlug(string str)
+        {
+            return !Regex.IsMatch(str, "[^a-z0-9_.-]", RegexOptions.IgnoreCase);
+        }
     }
 }
-- 
cgit