Merge pull request #1 from coryleach/dev

Merge 1.0.2

Author: coryleach

.codacy.yml

@@ -0,0 +1,3 @@
+exclude_paths:
+    - '*.md'
+    - 'Tests/Runtime/*.cs'

CHANGELOG.md

@@ -1,37 +1,39 @@
-<h1 align="center">Welcome to com.gameframe.saveload 👋</h1>
-<p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.1-blue.svg?cacheSeconds=2592000" />
-  <a href="https://twitter.com/coryleach">
-    <img alt="Twitter: coryleach" src="https://img.shields.io/twitter/follow/coryleach.svg?style=social" target="_blank" />
-  </a>
-</p>
-
-> This is a simple utility for quickly saving and loading objects to disk in unity.</br></br>
-> Supports Binary, UnityJson, and JsonDotNet.</br>
-> Optionally you can select an encrypted version of each of the above.</br>
-> Additionally custom serialization methods are supported using the ISerializationMethod interface.</br>
-> JsonDotNet support requires the Json.Net for Unity asset store package or Newtonsoft's Json.</br>
-> For info on enabling JsonDotNet support see the <b>Enable Json.Net Support</b> section of this readme.</br>
+<h1 align="center">Gameframe.SaveLoad 👋</h1>
+
+<!-- BADGE-START -->
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d2749fdbc70f422a9d1efccb56d48bff)](https://www.codacy.com/manual/coryleach/UnitySaveLoad?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=coryleach/UnitySaveLoad&amp;utm_campaign=Badge_Grade)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/coryleach/UnitySaveLoad?include_prereleases)
+[![license](https://img.shields.io/github/license/coryleach/UnitySaveLoad)](https://github.com/coryleach/UnitySaveLoad/blob/master/LICENSE)
+
+[![twitter](https://img.shields.io/twitter/follow/coryleach.svg?style=social)](https://twitter.com/coryleach)
+<!-- BADGE-END -->
+
+Serialization helper utility that supports save, load and encryption.
 
 ## Quick Package Install
 
 #### Using UnityPackageManager (for Unity 2019.3 or later)
 Open the package manager window (menu: Window > Package Manager)<br/>
 Select "Add package from git URL...", fill in the pop-up with the following link:<br/>
-https://github.com/coryleach/UnitySaveLoad.git#1.0.1<br/>
+https://github.com/coryleach/UnitySaveLoad.git#1.0.2<br/>
 
 #### Using UnityPackageManager (for Unity 2019.1 or later)
 
 Find the manifest.json file in the Packages folder of your project and edit it to look like this:
 ```js
 {
   "dependencies": {
-    "com.gameframe.saveload": "https://github.com/coryleach/UnitySaveLoad.git#1.0.1",
+    "com.gameframe.saveload": "https://github.com/coryleach/UnitySaveLoad.git#1.0.2",
     ...
   },
 }
 ```
 
+<!-- DOC-START -->
+<!-- 
+Changes between 'DOC START' and 'DOC END' will not be modified by readme update scripts
+-->
+
 ## Usage
 
 SaveLoadManager is not a singleton. Multiple instances may be used and created.<br />
@@ -73,16 +75,19 @@ manager.LoadUnityObjectOverwrite(myScriptableObject,"MyUnityObjectData.data");
 Ensure the Json.Net for Unity package has been imported.</br>
 In player settings add the string 'JSON_DOT_NET' to Scripting Define Symbols.
 
+<!-- DOC-END -->
+
 ## Author
 
 👤 **Cory Leach**
 
 * Twitter: [@coryleach](https://twitter.com/coryleach)
 * Github: [@coryleach](https://github.com/coryleach)
 
+
 ## Show your support
 
 Give a ⭐️ if this project helped you!
 
 ***
-_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
+_This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_

LICENSE renamed to LICENSE.md

@@ -26,7 +26,7 @@ public class SaveLoadManager : ScriptableObject
         [SerializeField] protected string salt = string.Empty;
         public string Salt => salt;
 
-        private Dictionary<SerializationMethodType, ISerializationMethod> _methods = null;
+        private Dictionary<SerializationMethodType, ISerializationMethod> _methods;
 
         private void OnEnable()
         {
@@ -167,7 +167,7 @@ public object LoadWithMethod(SerializationMethodType methodType, Type type, stri
         /// <param name="folder">Name of folder to save the file in. Uses defualt folder when null.</param>
         public void SaveUnityObject(UnityEngine.Object unityObj, string filename, string folder = null)
         {
-            var savedObj = new JsonSerializedUnityObject()
+            var savedObj = new JsonSerializedUnityObject
             {
                 jsonData = JsonUtility.ToJson(unityObj)
             };
@@ -206,7 +206,7 @@ public bool LoadUnityObjectOverwrite(UnityEngine.Object objectToOverwrite, strin
         [Serializable]
         private class JsonSerializedUnityObject
         {
-            public string jsonData = null;
+            public string jsonData;
         }
 
         public bool IsEncrypted => (saveMethod == SerializationMethodType.BinaryEncrypted || saveMethod == SerializationMethodType.UnityJsonEncrypted);
@@ -266,7 +266,7 @@ private ISerializationMethod GetSaveLoadMethod(SerializationMethodType methodTyp
 #endif
 
                 case SerializationMethodType.Custom:
-                    throw new Exception("SaveMethod is Custom but no custom serialization method has been set.");
+                    throw new MissingComponentException("SerializationMethodType is Custom but no custom ISerializationMethod was found.");
                 default:
                     throw new ArgumentOutOfRangeException(nameof(methodType), methodType, "SaveLoadMethodType not supported");
             }

LICENSE.meta renamed to LICENSE.md.meta

@@ -12,11 +12,6 @@ public static class SaveLoadUtility
         public static string GetSavePath(string folderName = null, string baseFolderPath = null)
         {
             return GetRuntimeSavePath(folderName, baseFolderPath);
-/*#if UNITY_EDITOR
-            return GetEditorSavePath(folderName, baseFolderPath);
-#else
-            return GetRuntimeSavePath(folderName, baseFolderPath);
-#endif*/
         }
 
         public static string GetRuntimeSavePath(string folderName = null, string baseFolderPath = null)
@@ -35,23 +30,6 @@ public static string GetRuntimeSavePath(string folderName = null, string baseFol
             savePath = savePath + folderName + "/";
             return savePath;
         }
-        
-        public static string GetEditorSavePath(string folderName = null, string baseFolderPath = null)
-        {
-            if (string.IsNullOrEmpty(folderName))
-            {
-                folderName = DefaultFolderName;
-            }
-
-            if (string.IsNullOrEmpty(baseFolderPath))
-            {
-                baseFolderPath = DefaultBaseFolderPath;
-            }
-
-            var savePath = $"{Application.dataPath}/{baseFolderPath}/";
-            savePath = savePath + folderName + "/";
-            return savePath;
-        }
 
         /// <summary>
         /// 

README.md

@@ -6,8 +6,8 @@ namespace Gameframe.SaveLoad
 {
     public class SerializationMethodBinaryEncrypted : ISerializationMethod
     {
-        private string _key = null;
-        private string _salt = null;
+        private string _key;
+        private string _salt;
 
         public SerializationMethodBinaryEncrypted(string key, string salt)
         {

Runtime/SaveLoadManager.cs

@@ -6,8 +6,8 @@ namespace Gameframe.SaveLoad
 {
     public class SerializationMethodUnityJsonEncrypted : ISerializationMethodEncrypted
     {
-        private string _key = null;
-        private string _salt = null;
+        private string _key;
+        private string _salt;
 
         public SerializationMethodUnityJsonEncrypted(string key, string salt)
         {

Runtime/SaveLoadUtility.cs

@@ -0,0 +1 @@
+-nowarn:CS0649

Runtime/SerializationMethodBinaryEncrypted.cs

@@ -1,12 +1,15 @@
 {
   "name": "com.gameframe.saveload",
   "displayName": "Gameframe.SaveLoad",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Serialization helper utility that supports save, load and encryption.",
   "keywords": [],
   "author": {
     "name": "Cory Leach",
     "email": "cory.leach@gmail.com",
-    "url": "https://github.com/coryleach"
-  }
+    "url": "https://github.com/coryleach",
+    "github": "coryleach",
+    "twitter": "coryleach"
+  },
+  "repositoryName": "UnitySaveLoad"
 }