Merge pull request #20 from badawe/feature/fixes_and_qol

brunomikoski · web-flow · commit de4e901f520f · 2020-08-03T09:35:47.000+01:00
fix: more tweaks and improvements
diff --git a/CHANGELOG.MD b/CHANGELOG.MD
@@ -5,6 +5,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [1.1.7]
+## Added
+ - Proper error when there's no static script folder defined
+ - Default namespace on settings
+ - Stored the last scripts folder as cache for the wizzard
+ - Validation of null items on the Registry
+ 
+## Changed
+ - Changed to the static file use the Colllectable Type again
+ - Values on the static files now its just values not `CollectableType+Values`
+
 ## [1.1.6]
 ## Changed
  - Crash while changing to debug mode while having the Collection inspector open
@@ -81,6 +92,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
  - Add a setup wizzard for first time settings creation
 
+[1.1.7]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.1.7
 [1.1.6]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.1.6
 [1.1.5]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.1.5
 [1.1.4]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.1.4
diff --git a/Scripts/Editor/CreateCollectionWizzard.cs b/Scripts/Editor/CreateCollectionWizzard.cs
@@ -9,9 +9,11 @@ namespace BrunoMikoski.ScriptableObjectCollections
 {
     public sealed class CreateCollectionWizzard : EditorWindow
     {
+        private const string WAITING_SCRIPTS_TO_RECOMPILE_TO_CONTINUE_KEY = "WaitingScriptsToRecompileToContinueKey";
         private const string LAST_COLLECTION_SCRIPTABLE_OBJECT_PATH_KEY = "CollectionScriptableObjectPathKey";
         private const string LAST_COLLECTION_FULL_NAME_KEY = "CollectionFullNameKey";
-        private const string LAST_COLLECTION_SCRIPT_PATH_KEY = "CollectionScriptPathKey";
+        private const string LAST_GENERATED_COLLECTION_SCRIPT_PATH_KEY = "CollectionScriptPathKey";
+        private const string LAST_TARGET_SCRIPTS_FOLDER_KEY = "LastTargetScriptsFolder";
 
         private DefaultAsset cachedScriptableObjectFolder;
         private DefaultAsset ScriptableObjectFolder
@@ -26,6 +28,12 @@ private DefaultAsset ScriptableObjectFolder
                     cachedScriptableObjectFolder = AssetDatabase.LoadAssetAtPath<DefaultAsset>(targetFolder);
                     return cachedScriptableObjectFolder;
                 }
+
+                if (!string.IsNullOrEmpty(LastCollectionScriptableObjectPath))
+                {
+                    cachedScriptableObjectFolder = AssetDatabase.LoadAssetAtPath<DefaultAsset>(LastCollectionScriptableObjectPath);
+                    return cachedScriptableObjectFolder;
+                }
                 
                 if (!string.IsNullOrEmpty(ScriptableObjectCollectionSettings.Instance.DefaultScriptableObjectsFolder))
                 {
@@ -45,6 +53,12 @@ private DefaultAsset ScriptsFolder
                 if (cachedScriptsFolder != null) 
                     return cachedScriptsFolder;
                 
+                if (!string.IsNullOrEmpty(LastScriptsTargetFolder))
+                {
+                    cachedScriptsFolder = AssetDatabase.LoadAssetAtPath<DefaultAsset>(Path.GetDirectoryName(LastScriptsTargetFolder));
+                    return cachedScriptsFolder;
+                }
+                
                 if (!string.IsNullOrEmpty(targetFolder))
                 {
                     cachedScriptsFolder = AssetDatabase.LoadAssetAtPath<DefaultAsset>(targetFolder);
@@ -64,11 +78,22 @@ private DefaultAsset ScriptsFolder
         private string cachedNameSpace;
         private string TargetNameSpace
         {
-            get => cachedNameSpace;
+            get
+            {
+                if (string.IsNullOrEmpty(cachedNameSpace))
+                    cachedNameSpace = ScriptableObjectCollectionSettings.Instance.DefaultNamespace;
+                return cachedNameSpace;
+            }
             set => cachedNameSpace = value;
         }
 
 
+        private static bool WaitingRecompileForContinue
+        {
+            get => EditorPrefs.GetBool(WAITING_SCRIPTS_TO_RECOMPILE_TO_CONTINUE_KEY, false);
+            set => EditorPrefs.SetBool(WAITING_SCRIPTS_TO_RECOMPILE_TO_CONTINUE_KEY, value);
+        }
+        
         private static string LastCollectionScriptableObjectPath
         {
             get => EditorPrefs.GetString(LAST_COLLECTION_SCRIPTABLE_OBJECT_PATH_KEY, String.Empty);
@@ -81,10 +106,16 @@ private static string LastCollectionFullName
             set => EditorPrefs.SetString(LAST_COLLECTION_FULL_NAME_KEY, value);
         }
 
-        private static string LastCollectionScriptPath
+        private static string LastScriptsTargetFolder
+        {
+            get => EditorPrefs.GetString(LAST_TARGET_SCRIPTS_FOLDER_KEY, String.Empty);
+            set => EditorPrefs.SetString(LAST_TARGET_SCRIPTS_FOLDER_KEY, value);
+        }
+        
+        private static string LastGeneratedCollectionScriptPath
         {
-            get => EditorPrefs.GetString(LAST_COLLECTION_SCRIPT_PATH_KEY, String.Empty);
-            set => EditorPrefs.SetString(LAST_COLLECTION_SCRIPT_PATH_KEY, value);
+            get => EditorPrefs.GetString(LAST_GENERATED_COLLECTION_SCRIPT_PATH_KEY, String.Empty);
+            set => EditorPrefs.SetString(LAST_GENERATED_COLLECTION_SCRIPT_PATH_KEY, value);
         }
 
         private bool createFoldForThisCollection = true;
@@ -175,7 +206,6 @@ private void CreateNewCollection()
             scriptsGenerated |= CreateCollectableScript();
             scriptsGenerated |= CreateCollectionScript();
 
-            LastCollectionScriptableObjectPath = CreateCollectionObject();
 
             AssetDatabase.SaveAssets();
             AssetDatabase.Refresh();
@@ -202,15 +232,16 @@ private string CreateCollectionObject()
 
         private bool CreateCollectableScript()
         {
-            string targetFolder = AssetDatabase.GetAssetPath(ScriptsFolder);
+            string folder = AssetDatabase.GetAssetPath(ScriptsFolder);
+            LastScriptsTargetFolder = folder;
             if (createFoldForThisCollectionScripts)
-                targetFolder = Path.Combine(targetFolder, $"{collectionName}");
+                folder = Path.Combine(folder, $"{collectionName}");
             
             return CodeGenerationUtility.CreateNewEmptyScript(collectableName, 
-                targetFolder,
+                folder,
                 TargetNameSpace, 
                 string.Empty,
-                $"public class {collectableName} : CollectableScriptableObject", 
+                $"public partial class {collectableName} : CollectableScriptableObject", 
                     typeof(CollectableScriptableObject).Namespace);
         }
         
@@ -224,14 +255,14 @@ private bool CreateCollectionScript()
                 targetFolder,
                 TargetNameSpace,
                 $"[CreateAssetMenu(menuName = \"ScriptableObject Collection/Collections/Create {collectionName}\", fileName = \"{collectionName}\", order = 0)]",
-                $"public partial class {collectionName} : ScriptableObjectCollection<{collectableName}>", typeof(ScriptableObjectCollection).Namespace, "UnityEngine");
+                $"public class {collectionName} : ScriptableObjectCollection<{collectableName}>", typeof(ScriptableObjectCollection).Namespace, "UnityEngine");
 
             if (string.IsNullOrEmpty(TargetNameSpace))
                 LastCollectionFullName = $"{collectionName}";
             else
                 LastCollectionFullName = $"{TargetNameSpace}.{collectionName}";
 
-            LastCollectionScriptPath = Path.Combine(targetFolder, $"{collectionName}.cs");
+            LastGeneratedCollectionScriptPath = Path.Combine(targetFolder, $"{collectionName}.cs");
             return result;
         }
 
@@ -255,13 +286,15 @@ private bool AreSettingsValid()
         [DidReloadScripts]
         static void OnAfterScriptsReloading()
         {
-            if (string.IsNullOrEmpty(LastCollectionScriptableObjectPath))
+            if (!WaitingRecompileForContinue)
                 return;
 
+            WaitingRecompileForContinue = false;
+
             ScriptableObjectCollection collectionAsset =
                 AssetDatabase.LoadAssetAtPath<ScriptableObjectCollection>(LastCollectionScriptableObjectPath);
 
-            string assemblyName = CompilationPipeline.GetAssemblyNameFromScriptPath(LastCollectionScriptPath);
+            string assemblyName = CompilationPipeline.GetAssemblyNameFromScriptPath(LastGeneratedCollectionScriptPath);
 
             Type targetType = Type.GetType($"{LastCollectionFullName}, {assemblyName}");
             
@@ -273,9 +306,6 @@ static void OnAfterScriptsReloading()
             collectionScriptableObject.FindProperty("m_Script").objectReferenceInstanceIDValue = typeId;
             collectionScriptableObject.ApplyModifiedProperties();
 
-            LastCollectionScriptableObjectPath = string.Empty;
-            LastCollectionFullName = string.Empty;
-
             Selection.objects = new[] {collectionScriptableObject.targetObject};
             EditorGUIUtility.PingObject(collectionScriptableObject.targetObject);
             GetWindowInstance().Close();
diff --git a/Scripts/Editor/Utils/CodeGenerationUtility.cs b/Scripts/Editor/Utils/CodeGenerationUtility.cs
@@ -4,6 +4,8 @@
 using System.Linq;
 using System.Text;
 using UnityEditor;
+using UnityEngine;
+using Object = UnityEngine.Object;
 
 namespace BrunoMikoski.ScriptableObjectCollections
 {
@@ -133,9 +135,17 @@ public static void GenerateStaticCollectionScript(ScriptableObjectCollection col
         {
             string dehumanizeCollectionName = collection.name.Sanitize();
 
-            string fileName = $"{dehumanizeCollectionName.FirstToUpper()}Static";
+            string fileName = $"{collection.GetCollectionType().Name}Static";
             string nameSpace = collection.GetCollectionType().Namespace;
             string finalFolder = ScriptableObjectCollectionSettings.Instance.GetStaticFileFolderForCollection(collection);
+
+            if (string.IsNullOrEmpty(finalFolder))
+            {
+                Debug.LogError("Static Code Generation folder not assigned, please assign it on the ScriptableObjectCollectionSettings");
+                EditorGUIUtility.PingObject(ScriptableObjectCollectionSettings.Instance);
+                Selection.objects = new Object[] {ScriptableObjectCollectionSettings.Instance};
+                return;
+            }
             
             AssetDatabaseUtils.CreatePathIfDontExist(finalFolder);
             using (StreamWriter writer = new StreamWriter(Path.Combine(finalFolder, $"{fileName}.cs")))
@@ -148,7 +158,7 @@ public static void GenerateStaticCollectionScript(ScriptableObjectCollection col
                 directives.AddRange(GetCollectionDirectives(collection));
 
                 AppendHeader(writer, ref indentation, nameSpace,
-                    collection.GetType().Name, true, false, directives.Distinct().ToArray());
+                    collection.GetCollectionType().Name, true, false, directives.Distinct().ToArray());
 
                 GeneratedStaticFileType staticFileTypeForCollection = ScriptableObjectCollectionSettings.Instance.GetStaticFileTypeForCollection(collection);
                 if (staticFileTypeForCollection == GeneratedStaticFileType.DirectAccess)
@@ -176,8 +186,8 @@ private static string[] GetCollectionDirectives(ScriptableObjectCollection colle
         private static void WriteTryGetAccessCollectionStatic(ScriptableObjectCollection collection, StreamWriter writer,
             ref int indentation)
         {
-            string cachedValuesName = $"cached{collection.name.Sanitize().FirstToUpper()}Values";
-            string valuesName = $"{collection.name.Sanitize().FirstToUpper()}Values";
+            string cachedValuesName = $"values";
+            string valuesName = $"Values";
             string tryGetValuesName = $"TryGet{valuesName}";
 
             AppendLine(writer, indentation, $"private static {collection.GetType().Name} {cachedValuesName};");
@@ -271,7 +281,7 @@ private static void WriteTryGetAccessCollectionStatic(ScriptableObjectCollection
         private static void WriteDirectAccessCollectionStatic(ScriptableObjectCollection collection, StreamWriter writer,
             ref int indentation)
         {
-            string cachedValuesName = $"cached{collection.name.Sanitize().FirstToUpper()}Values";
+            string cachedValuesName = "values";
             AppendLine(writer, indentation, $"private static {collection.GetType().Name} {cachedValuesName};");
 
             for (int i = 0; i < collection.Items.Count; i++)
@@ -283,7 +293,7 @@ private static void WriteDirectAccessCollectionStatic(ScriptableObjectCollection
 
             AppendLine(writer, indentation);
 
-            string valuesName = $"{collection.name.Sanitize().FirstToUpper()}Values";
+            string valuesName = $"Values";
             AppendLine(writer, indentation,
                 $"public static {collection.GetType().Name} {valuesName}");
             AppendLine(writer, indentation, "{");
diff --git a/Scripts/Runtime/CollectionsRegistry.cs b/Scripts/Runtime/CollectionsRegistry.cs
@@ -37,8 +37,20 @@ public void UnregisterCollection(ScriptableObjectCollection targetCollection)
             collectionGUIDs.Remove(targetCollection.GUID);
         }
 
+        private void ValidateItems()
+        {
+            for (int i = collections.Count - 1; i >= 0; i--)
+            {
+                if (collections[i] == null)
+                {
+                    collections.RemoveAt(i);
+                    collectionGUIDs.RemoveAt(i);
+                }
+            }
+        }
         private void ValidateCurrentGUIDs()
         {
+            ValidateItems();
             if (collectionGUIDs.Count != collections.Count)
             {
                 ReloadCollections();
diff --git a/Scripts/Runtime/ScriptableObjectCollectionSettings.cs b/Scripts/Runtime/ScriptableObjectCollectionSettings.cs
@@ -40,7 +40,8 @@ private class CollectionToSettings
         
         [SerializeField]
         private UnityEditor.DefaultAsset defaultGeneratedCodeFolder;
-        public string DefaultGeneratedCodeFolder => UnityEditor.AssetDatabase.GetAssetPath(defaultGeneratedCodeFolder);
+
+        private string DefaultGeneratedCodeFolder => UnityEditor.AssetDatabase.GetAssetPath(defaultGeneratedCodeFolder);
 #pragma warning restore 0649
 #endif
 
@@ -50,6 +51,10 @@ private class CollectionToSettings
         [SerializeField, HideInInspector]
         private List<CollectionToSettings> collectionsSettings = new List<CollectionToSettings>();
 
+        [SerializeField] 
+        private string defaultNamespace;
+        public string DefaultNamespace => defaultNamespace;
+
         public GeneratedStaticFileType GetStaticFileTypeForCollection(ScriptableObjectCollection collection)
         {
             if (!TryGetSettingsForCollection(collection, out CollectionToSettings settings))
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "com.brunomikoski.scriptableobjectcollection",
   "displayName": "Scriptable Object Collection",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "unity": "2018.4",
   "description": "Scriptable Object Collection",
   "keywords": [

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "com.brunomikoski.scriptableobjectcollection",`
`3`	`3`	`"displayName": "Scriptable Object Collection",`
`4`		`- "version": "1.1.6",`
	`4`	`+ "version": "1.1.7",`
`5`	`5`	`"unity": "2018.4",`
`6`	`6`	`"description": "Scriptable Object Collection",`
`7`	`7`	`"keywords": [`