Merge pull request #6 from coryleach/dev

Updated Tests & Creation Menu

Author: coryleach

Editor/SaveLoadManagerEditor.cs

@@ -1,11 +1,12 @@
-using System.Collections;
-using System.Collections.Generic;
-using System.IO;
+using System.IO;
 using UnityEditor;
 using UnityEngine;
 
 namespace Gameframe.SaveLoad.Editor
 {
+    /// <summary>
+    /// Editor for SaveLoadManager
+    /// </summary>
     [CustomEditor(typeof(SaveLoadManager))]
     public class SaveLoadManagerEditor : UnityEditor.Editor
     {

README.md

@@ -1,16 +1,10 @@
-<p align="center">
-<img align="center" src="https://raw.githubusercontent.com/coryleach/UnityPackages/master/Documentation/GameframeFace.gif" />
-</p>
 <h1 align="center">Gameframe.SaveLoad 👋</h1>
-
-<!-- BADGE-START -->
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2ba0a4bb579d4a96ac91ab77458f7f76)](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)
-[![openupm](https://img.shields.io/npm/v/com.gameframe.saveload?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.gameframe.saveload/)
-![GitHub](https://img.shields.io/github/license/coryleach/UnitySaveLoad)
-
-[![twitter](https://img.shields.io/twitter/follow/coryleach.svg?style=social)](https://twitter.com/coryleach)
-<!-- BADGE-END -->
+<p>
+  <img alt="Version" src="https://img.shields.io/badge/version-1.0.3-blue.svg?cacheSeconds=2592000" />
+  <a href="https://twitter.com/Cory Leach">
+    <img alt="Twitter: coryleach" src="https://img.shields.io/twitter/follow/coryleach.svg?style=social" target="_blank" />
+  </a>
+</p>
 
 Serialization helper utility that supports save, load and encryption.
 
@@ -19,22 +13,22 @@ Serialization helper utility that supports save, load and encryption.
 #### 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.2<br/>
+https://github.com/coryleach/UnitySaveLoad.git#1.0.3<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.2",
+    "com.gameframe.saveload": "https://github.com/coryleach/UnitySaveLoad.git#1.0.3",
     ...
   },
 }
 ```
 
 <!-- DOC-START -->
-<!-- 
+<!--
 Changes between 'DOC START' and 'DOC END' will not be modified by readme update scripts
 -->
 
@@ -76,7 +70,7 @@ manager.LoadUnityObjectOverwrite(myScriptableObject,"MyUnityObjectData.data");
 
 ## Enable Json.Net Support
 
-Ensure the Json.Net for Unity package has been imported.</br>
+Ensure the [Json.Net for Unity](https://assetstore.unity.com/packages/tools/input-management/json-net-for-unity-11347) package has been imported.</br>
 In player settings add the string 'JSON_DOT_NET' to Scripting Define Symbols.
 
 <!-- DOC-END -->

Runtime/SaveLoadManager.cs

@@ -9,7 +9,7 @@ namespace Gameframe.SaveLoad
     /// SaveLoadManager
     /// Manager for saving and loading objects to/from disk.
     /// </summary>
-    [CreateAssetMenu(menuName = "GameFrame/SaveLoad/SaveLoadManager")]
+    [CreateAssetMenu(menuName = "Gameframe/SaveLoad/SaveLoadManager")]
     public class SaveLoadManager : ScriptableObject
     {
         [Header("Settings"),SerializeField] private string defaultFolder = "SaveData";

Tests/Runtime/SaveLoadManagerTests.cs

@@ -24,6 +24,13 @@ public class SaveLoadTestUnityObject : ScriptableObject
             public Quaternion rot;
         }
 
+        [Serializable]
+        public class SaveLoadDictionaryTestObject
+        {
+            public Dictionary<string, int> dict = new Dictionary<string, int>();
+            public string name = "";
+        }
+        
         private static readonly string BaseDirectory = "GameData";
         private static readonly string SaveDirectory = "SaveData";
         private static readonly string TestEncryptionKey = "SaveLoadTestEncryptionKey";
@@ -169,6 +176,49 @@ public void CanSaveLoadUnityObject([Values] SerializationMethodType method)
             Object.Destroy(manager);
         }
 
+        [Test]
+        public void CanSaveAndLoadDictionary([Values(
+            SerializationMethodType.Binary,
+            SerializationMethodType.BinaryEncrypted
+#if JSON_DOT_NET
+            ,SerializationMethodType.JsonDotNet,
+            SerializationMethodType.JsonDotNetEncrypted
+#endif
+            )] SerializationMethodType method)
+        {
+            var manager = CreateManager(method);
+
+            var testObject = new SaveLoadDictionaryTestObject()
+            {
+                dict = new Dictionary<string,int>
+                {
+                    {"one", 1}, 
+                    {"two", 2}
+                },
+                name = "Test",
+            };
+
+            const string filename = "Testfile";
+            
+            manager.Save(testObject,filename);
+
+            var filepath = $"{SaveLoadUtility.GetSavePath(SaveDirectory, BaseDirectory)}/{filename}";
+            Assert.IsTrue(File.Exists(filepath));
+
+            var loadedObject = manager.Load<SaveLoadDictionaryTestObject>(filename);
+            
+            Assert.IsTrue(loadedObject.name == testObject.name);
+            Assert.IsTrue(loadedObject.dict.Count == testObject.dict.Count);
+            Assert.IsTrue(loadedObject.dict.ContainsKey("one"));
+            Assert.IsTrue(loadedObject.dict.ContainsKey("two"));
+            Assert.IsTrue(loadedObject.dict["one"] == 1);
+            Assert.IsTrue(loadedObject.dict["two"] == 2);
+
+            manager.DeleteSave(filename);
+            Assert.IsFalse(File.Exists(filepath));
+            
+            Object.Destroy(manager);
+        }
 
     }
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.gameframe.saveload",
   "displayName": "Gameframe.SaveLoad",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Serialization helper utility that supports save, load and encryption.",
   "keywords": [],
   "author": {
@@ -11,5 +11,7 @@
     "github": "coryleach",
     "twitter": "coryleach"
   },
-  "repositoryName": "UnitySaveLoad"
+  "repositoryName": "UnitySaveLoad",
+  "type": "library",
+  "hideInEditor": false
 }