Merge pull request #70 from brunomikoski/feature/setttings-revamp

Feature/setttings revamp

Author: brunomikoski

CHANGELOG.MD

@@ -4,13 +4,24 @@ All notable changes to this project will be documented in this file.
 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.5.5]
+### Changed
+- In order to support multiple collections of the same type the check of the `Values` I had to tweak how the instance of every instance its assigned, changed for the `OnEnable` of the collection item
+- Changed the Refresh of the collections to only find items under the same folder.
+- Fixed a lot of scripts to work properly with multiple collections of the same type
+- Added some logs when `CollectionItems` are added/removed from collections to help the visibility
+- `CollectionType.Values` now will return all the `CollectionItem` available on the registry, so if you have 2 Collections of the one Type this will return the content of both collections while the `CollectionItem.Values` when the access file is generated will only return that specific collection items
+
 ## [1.5.4]
 ### Changed
 - Removed the automatically reload of CollectionRegistry using the `DidReloadScripts` callback, this caused multiple issues on batch mode and on clear libraries
 - Converted the `Collection` reference on the `CollectionItem` to be a Lazy reference, since this was causing some dependency when using `CollectionItem` as addressables
 - Refactored the `ScriptableObjectSettings` this used to be a Resources object that was auto loaded, but this could also create unwanted dependencies between items. The settings for code generated are not stored inside the Collection itself. Make sure you delete the `ScriptableObjectsSettings` ScriptableObject inside your resources folder.
 - Added a bunch of validation and verification for the Generation of the static access, making sure it only allows partial classes when is possible and other small checks.
 - The settings are now on the Project Preferences where you can define the default folder for the Scriptable Objects and default namespace.
+- Removed the `ReadOnlyList` on the `Collection`, the casting was expensive and was an unnecessary safety measure
+
 
 ## [1.5.3]
 ### Changed
@@ -229,7 +240,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Unreleased
 
 
-
+[1.5.5]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.5.5
 [1.5.4]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.5.4
 [1.5.3]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.5.3
 [1.5.2]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v1.5.2

Scripts/Editor/Core/CollectionCustomEditor.cs

@@ -35,7 +35,7 @@ public void OnEnable()
         {
             collection = (ScriptableObjectCollection)target;
 
-            if (!CollectionsRegistry.Instance.IsKnowCollectionGUID(collection.GUID))
+            if (!CollectionsRegistry.Instance.IsKnowCollection(collection))
                 CollectionsRegistry.Instance.ReloadCollections();
 
             FixCollectionItems();
@@ -74,6 +74,11 @@ private void FixCollectionItems()
                     return;
                 }
             }
+
+            for (int i = 0; i < collection.Count; i++)
+            {
+                collection[i].SetCollection(collection);
+            }
         }
 
         public override void OnInspectorGUI()

Scripts/Editor/Core/CollectionsAssetsPostProcessor.cs

@@ -2,39 +2,14 @@
 using System.Collections.Generic;
 using UnityEditor;
 using UnityEditor.Callbacks;
+using UnityEngine;
 
 namespace BrunoMikoski.ScriptableObjectCollections
 {
     public sealed class CollectionsAssetsPostProcessor : AssetPostprocessor
     {
         private const string REFRESH_REGISTRY_AFTER_RECOMPILATION_KEY = "RefreshRegistryAfterRecompilationKey";
 
-        private static Dictionary<Type, ScriptableObjectCollection> cachedTypeToCollections;
-        private static Dictionary<Type, ScriptableObjectCollection> typeToCollections
-        {
-            get
-            {
-                if (cachedTypeToCollections == null)
-                {
-                    cachedTypeToCollections = new Dictionary<Type, ScriptableObjectCollection>();
-                    string[] collectionGUIDS = AssetDatabase.FindAssets($"t:{(nameof(ScriptableObjectCollection))}");
-
-                    foreach (string guid in collectionGUIDS)
-                    {
-                        ScriptableObjectCollection collection =
-                            AssetDatabase.LoadAssetAtPath<ScriptableObjectCollection>(
-                                AssetDatabase.GUIDToAssetPath(guid));
-                        if(collection == null)
-                            continue;
-
-                        cachedTypeToCollections.Add(collection.GetItemType(), collection);
-                    }
-                }
-
-                return cachedTypeToCollections;
-            }
-        }
-        
         private static bool RefreshRegistryAfterRecompilation
         {
             get => EditorPrefs.GetBool(REFRESH_REGISTRY_AFTER_RECOMPILATION_KEY, false);
@@ -59,15 +34,19 @@ static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAsse
                     {
                         if (scriptableObjectCollectionItem.Collection == null)
                         {
-                            if (typeToCollections.TryGetValue(type, out ScriptableObjectCollection collection))
-                            {
-                                if (!collection.Add(scriptableObjectCollectionItem))
-                                    scriptableObjectCollectionItem.SetCollection(collection);
-                            }
+                            Debug.LogError(
+                                $"CollectionItem ({scriptableObjectCollectionItem.name}) has null Collection, please assign it some Collection",
+                                scriptableObjectCollectionItem
+                            );
                         }
                         else
                         {
-                            scriptableObjectCollectionItem.Collection.Add(scriptableObjectCollectionItem);
+                            if (!scriptableObjectCollectionItem.Collection.Contains(scriptableObjectCollectionItem))
+                            {
+                                scriptableObjectCollectionItem.Collection.Add(scriptableObjectCollectionItem);
+                                Debug.Log($"{scriptableObjectCollectionItem.name} has collection assigned "
+                                          + $"{scriptableObjectCollectionItem.Collection} but its missing from collection list, adding it");
+                            }
                         }
                     }
                 }
@@ -80,9 +59,10 @@ static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAsse
                     if (collection == null)
                         continue;
 
-                    if (!CollectionsRegistry.Instance.IsKnowCollectionGUID(collection.GUID))
+                    if (!CollectionsRegistry.Instance.IsKnowCollection(collection))
                     {
                         RefreshRegistry();
+                        Debug.Log($"New collection found on the Project {collection.name}, refreshing the Registry");
                         return;
                     }
                 }
@@ -98,7 +78,6 @@ private static void RefreshRegistry()
             }
 
             EditorApplication.delayCall += () => { CollectionsRegistry.Instance.ReloadCollections(); };
-            
         }
 
 

Scripts/Runtime/Core/CollectionsRegistry.cs

@@ -1,8 +1,10 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using BrunoMikoski.ScriptableObjectCollections.Core;
 using UnityEngine;
 #if UNITY_EDITOR
+using System.IO;
 using UnityEditor;
 #endif
 
@@ -15,20 +17,16 @@ public class CollectionsRegistry : ResourceScriptableObjectSingleton<Collections
         private List<ScriptableObjectCollection> collections = new List<ScriptableObjectCollection>();
         public IReadOnlyList<ScriptableObjectCollection> Collections => collections;
 
-        [SerializeField, HideInInspector]
-        private List<string> collectionGUIDs = new List<string>();
-        
         public void UsedOnlyForAOTCodeGeneration()
         {
             LoadOrCreateInstance();
             // Include an exception so we can be sure to know if this method is ever called.
             throw new InvalidOperationException("This method is used for AOT code generation only. Do not call it at runtime.");
         }
 
-        public bool IsKnowCollectionGUID(string guid)
+        public bool IsKnowCollection(ScriptableObjectCollection targetCollection)
         {
-            ValidateCurrentGUIDs();
-            return collectionGUIDs.Contains(guid);
+            return collections.Any(collection => collection.GUID.Equals(targetCollection.GUID, StringComparison.Ordinal));
         }
 
         public void RegisterCollection(ScriptableObjectCollection targetCollection)
@@ -37,7 +35,6 @@ public void RegisterCollection(ScriptableObjectCollection targetCollection)
                 return;
 
             collections.Add(targetCollection);
-            collectionGUIDs.Add(targetCollection.GUID);
         }
 
         public void UnregisterCollection(ScriptableObjectCollection targetCollection)
@@ -46,7 +43,6 @@ public void UnregisterCollection(ScriptableObjectCollection targetCollection)
                 return;
 
             collections.Remove(targetCollection);
-            collectionGUIDs.Remove(targetCollection.GUID);
         }
 
         private void ValidateItems()
@@ -56,39 +52,13 @@ private void ValidateItems()
                 if (collections[i] == null)
                 {
                     collections.RemoveAt(i);
-                    collectionGUIDs.RemoveAt(i);
                 }
             }
         }
-        private void ValidateCurrentGUIDs()
-        {
-            ValidateItems();
-            if (collectionGUIDs.Count != collections.Count)
-            {
-                ReloadCollections();
-                return;
-            }
 
-            for (int i = 0; i < collectionGUIDs.Count; i++)
-            {
-                string guid = collectionGUIDs[i];
-                bool guidFound = false;
-                for (int j = 0; j < collections.Count; j++)
-                {
-                    ScriptableObjectCollection collection = collections[j];
-                    if (string.Equals(collection.GUID, guid, StringComparison.Ordinal))
-                    {
-                        guidFound = true;
-                        break;
-                    }
-                }
-
-                if (!guidFound)
-                {
-                    ReloadCollections();
-                    break;
-                }
-            }
+        public List<T> GetAllCollectionItemsOfType<T>() where T : ScriptableObjectCollectionItem
+        {
+            return GetAllCollectionItemsOfType(typeof(T)).Cast<T>().ToList();
         }
 
         public List<ScriptableObjectCollectionItem> GetAllCollectionItemsOfType(Type itemType)
@@ -162,17 +132,22 @@ public bool TryGetCollectionFromCollectableType(Type targetType, out ScriptableO
 
         public bool TryGetCollectionFromItemType(Type targetType, out ScriptableObjectCollection scriptableObjectCollection)
         {
+            List<ScriptableObjectCollection> possibleCollections = new List<ScriptableObjectCollection>();
             for (int i = 0; i < collections.Count; i++)
             {
                 ScriptableObjectCollection collection = collections[i];
-                if(collection.GetItemType() == targetType
-                   || targetType.BaseType == collection.GetItemType())
+                if (collection.GetItemType() == targetType || collection.GetItemType().IsAssignableFrom(targetType))
                 {
-                    scriptableObjectCollection = collection;
-                    return true;
+                    possibleCollections.Add(collection);
                 }
             }
-            
+
+            if (possibleCollections.Count == 1)
+            {
+                scriptableObjectCollection = possibleCollections.First();
+                return true;
+            }
+
             scriptableObjectCollection = null;
             return false;
         }
@@ -231,7 +206,6 @@ public void DeleteCollection(ScriptableObjectCollection collection)
 
             if (!collections.Remove(collection))
                 return;
-            collectionGUIDs.Remove(collection.GUID);
 
 #if UNITY_EDITOR
             for (int i = collection.Items.Count - 1; i >= 0; i--)
@@ -247,7 +221,6 @@ public void ReloadCollections()
                 return;
 
             collections.Clear();
-            collectionGUIDs.Clear();
 
             bool changed = false;
             List<Type> types = TypeUtility.GetAllSubclasses(typeof(ScriptableObjectCollection));
@@ -267,7 +240,6 @@ public void ReloadCollections()
 
                     collection.RefreshCollection();
                     collections.Add(collection);
-                    collectionGUIDs.Add(collection.GUID);
                     changed = true;
                 }
             }
@@ -299,7 +271,6 @@ public void RemoveNonAutomaticallyInitializedCollections()
                     continue;
 
                 collections.Remove(collection);
-                collectionGUIDs.Remove(collection.GUID);
             }
             ObjectUtility.SetDirty(this);
 #endif