Rename BinaryPrefs to BinaryStorage (#34)

Appegy · Jun 22, 2024 · 2bb2a90 · 2bb2a90
1 parent fcacbf5
commit 2bb2a90
Show file tree

Hide file tree

Showing 68 changed files with 133 additions and 136 deletions.
diff --git a/.BinaryPrefs/Assets/Scripts/GameManager.cs b/.BinaryPrefs/Assets/Scripts/GameManager.cs
@@ -1,58 +1,58 @@
 using System.IO;
 using UnityEngine;
 
-namespace Appegy.BinaryStorage.Example
+namespace Appegy.Storage.Example
 {
     public class GameManager : MonoBehaviour
     {
-        private BinaryPrefs _prefs;
+        private BinaryStorage _storage;
 
         private void Awake()
         {
             Debug.Log("Game started");
-            _prefs = BinaryPrefs
+            _storage = BinaryStorage
                 .Construct(Path.Combine(Application.persistentDataPath, "PlayerPrefs.bin"))
                 .AddPrimitiveTypes()
                 .SupportListsOf<int>()
                 .SupportListsOf<string>()
                 .EnableAutoSaveOnChange()
                 .Build();
 
-            _prefs.GetListOf<int>("ints");
-            _prefs.Remove("ints");
+            _storage.GetListOf<int>("ints");
+            _storage.Remove("ints");
 
-            using (_prefs.MultipleChangeScope())
+            using (_storage.MultipleChangeScope())
             {
-                var value = _prefs.Get<int>("int_val", 0);
-                _prefs.Set("int_val", value + 1);
+                var value = _storage.Get<int>("int_val", 0);
+                _storage.Set("int_val", value + 1);
 
-                using (_prefs.MultipleChangeScope())
+                using (_storage.MultipleChangeScope())
                 {
-                    value = _prefs.Get<int>("int_val", 0);
-                    _prefs.Set("int_val", value + 1);
+                    value = _storage.Get<int>("int_val", 0);
+                    _storage.Set("int_val", value + 1);
 
-                    using (_prefs.MultipleChangeScope())
+                    using (_storage.MultipleChangeScope())
                     {
-                        value = _prefs.Get<int>("int_val", 0);
-                        _prefs.Set("int_val", value + 1);
+                        value = _storage.Get<int>("int_val", 0);
+                        _storage.Set("int_val", value + 1);
                     }
                 }
             }
         }
 
         private void OnGUI()
         {
-            var value = _prefs.Get<int>("int_val", 0);
+            var value = _storage.Get<int>("int_val", 0);
             if (GUILayout.Button($"INT={value}"))
             {
-                _prefs.Set("int_val", value + 1);
+                _storage.Set("int_val", value + 1);
             }
         }
 
         private void OnDestroy()
         {
-            _prefs?.Dispose();
-            _prefs = null;
+            _storage?.Dispose();
+            _storage = null;
         }
     }
 }
diff --git a/Editor/Appegy.BinaryStorage.Editor.asmdef b/Editor/Appegy.BinaryStorage.Editor.asmdef
@@ -1,6 +1,6 @@
 {
     "name": "Appegy.BinaryStorage.Editor",
-    "rootNamespace": "Appegy.BinaryStorage",
+    "rootNamespace": "Appegy.Storage",
     "references": [
         "Appegy.BinaryStorage"
     ],

diff --git a/Editor/BinaryPrefsExplorer.cs b/Editor/BinaryPrefsExplorer.cs
@@ -1,6 +1,6 @@
 using UnityEditor;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class BinaryPrefsExplorer : EditorWindow
     {

diff --git a/Runtime/Appegy.BinaryStorage.asmdef b/Runtime/Appegy.BinaryStorage.asmdef
@@ -1,6 +1,6 @@
 {
     "name": "Appegy.BinaryStorage",
-    "rootNamespace": "Appegy.BinaryStorage",
+    "rootNamespace": "Appegy.Storage",
     "references": [],
     "includePlatforms": [],
     "excludePlatforms": [],

diff --git a/Runtime/BinarySection.cs b/Runtime/BinarySection.cs
@@ -1,6 +1,6 @@
 using System.IO;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     internal abstract class BinarySection
     {

diff --git a/Runtime/BinaryPrefs.Builder.cs → Runtime/BinaryStorage.Builder.cs b/Runtime/BinaryPrefs.Builder.cs → Runtime/BinaryStorage.Builder.cs
@@ -3,20 +3,20 @@
 using System.IO;
 using System.Linq;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
-    public partial class BinaryPrefs
+    public partial class BinaryStorage
     {
         static partial void LockFilePathInEditor(string filePath);
         static partial void ThrowIfFilePathLocked(string filePath);
         static partial void UnlockFilePathInEditor(string filePath);
 
         /// <summary>
-        /// Creates and configures a new instance of <see cref="BinaryPrefs"/> with default settings.
+        /// Creates and configures a new instance of <see cref="BinaryStorage"/> with default settings.
         /// </summary>
         /// <param name="filePath">The file path for the storage.</param>
-        /// <returns>A configured <see cref="BinaryPrefs"/> instance.</returns>
-        public static BinaryPrefs Get(string filePath)
+        /// <returns>A configured <see cref="BinaryStorage"/> instance.</returns>
+        public static BinaryStorage Get(string filePath)
         {
             return Construct(filePath)
                 .AddPrimitiveTypes()
@@ -25,10 +25,10 @@ public static BinaryPrefs Get(string filePath)
         }
 
         /// <summary>
-        /// Begins the construction of a new <see cref="BinaryPrefs"/> instance.
+        /// Begins the construction of a new <see cref="BinaryStorage"/> instance.
         /// </summary>
         /// <param name="filePath">The file path for the storage.</param>
-        /// <returns>A <see cref="Builder"/> for configuring the <see cref="BinaryPrefs"/> instance.</returns>
+        /// <returns>A <see cref="Builder"/> for configuring the <see cref="BinaryStorage"/> instance.</returns>
         public static Builder Construct(string filePath)
         {
             ThrowIfFilePathLocked(filePath);
@@ -49,7 +49,7 @@ internal static void Delete(string storagePath)
         }
 
         /// <summary>
-        /// Provides a fluent interface for configuring and building a <see cref="BinaryPrefs"/> instance.
+        /// Provides a fluent interface for configuring and building a <see cref="BinaryStorage"/> instance.
         /// </summary>
         public class Builder
         {
@@ -215,15 +215,15 @@ public Builder SupportDictionariesOf<TKey, TValue>()
             }
 
             /// <summary>
-            /// Builds and returns the configured <see cref="BinaryPrefs"/> instance.
+            /// Builds and returns the configured <see cref="BinaryStorage"/> instance.
             /// </summary>
-            /// <returns>The configured <see cref="BinaryPrefs"/> instance.</returns>
+            /// <returns>The configured <see cref="BinaryStorage"/> instance.</returns>
             /// <exception cref="Exception">Thrown if the storage fails to load data from disk.</exception>
-            public BinaryPrefs Build()
+            public BinaryStorage Build()
             {
                 try
                 {
-                    var storage = new BinaryPrefs(_filePath, _serializers);
+                    var storage = new BinaryStorage(_filePath, _serializers);
                     storage.AutoSave = _autoSave;
                     storage.LoadDataFromDisk();
                     return storage;

diff --git a/Runtime/BinaryPrefs.Builder.cs.meta → Runtime/BinaryStorage.Builder.cs.meta b/Runtime/BinaryPrefs.Builder.cs.meta → Runtime/BinaryStorage.Builder.cs.meta
diff --git a/Runtime/BinaryPrefs.Debug.cs → Runtime/BinaryStorage.Debug.cs b/Runtime/BinaryPrefs.Debug.cs → Runtime/BinaryStorage.Debug.cs
@@ -4,9 +4,9 @@
 using System.IO;
 using System.Linq;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
-    public partial class BinaryPrefs
+    public partial class BinaryStorage
     {
         private static readonly HashSet<string> _lockedFiles = new();
 

diff --git a/Runtime/BinaryPrefs.Debug.cs.meta → Runtime/BinaryStorage.Debug.cs.meta b/Runtime/BinaryPrefs.Debug.cs.meta → Runtime/BinaryStorage.Debug.cs.meta
diff --git a/Runtime/BinaryPrefs.cs → Runtime/BinaryStorage.cs b/Runtime/BinaryPrefs.cs → Runtime/BinaryStorage.cs
@@ -5,15 +5,14 @@
 using UnityEngine;
 using UnityEngine.Pool;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     /// <summary>
     /// Manages a binary storage system for saving, retrieving, and managing records of various types.
     /// </summary>
-    public partial class BinaryPrefs : IDisposable
+    public partial class BinaryStorage : IDisposable
     {
         private readonly string _storageFilePath;
-        private readonly bool _autoSave;
         private readonly IReadOnlyList<BinarySection> _supportedTypes;
         private readonly Dictionary<string, Record> _data = new();
         private int _changeScopeCounter;
@@ -34,11 +33,11 @@ public partial class BinaryPrefs : IDisposable
         public bool IsDisposed { get; private set; }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="BinaryPrefs"/> class.
+        /// Initializes a new instance of the <see cref="BinaryStorage"/> class.
         /// </summary>
         /// <param name="storageFilePath">The file path for storing data.</param>
         /// <param name="supportedTypes">The list of supported types for storage.</param>
-        internal BinaryPrefs(string storageFilePath, IReadOnlyList<BinarySection> supportedTypes)
+        internal BinaryStorage(string storageFilePath, IReadOnlyList<BinarySection> supportedTypes)
         {
             _storageFilePath = storageFilePath;
             _supportedTypes = supportedTypes;
@@ -400,7 +399,7 @@ private void DecreaseCounter()
         {
             if (_changeScopeCounter == 0)
             {
-                Debug.LogError($"{nameof(BinaryPrefs)}: Unexpected behaviour - MultipleChangeScope counter is already zero");
+                Debug.LogError($"{nameof(BinaryStorage)}: Unexpected behaviour - MultipleChangeScope counter is already zero");
                 return;
             }
             _changeScopeCounter--;
@@ -460,7 +459,7 @@ private void ThrowIfCollection<T>()
         /// <summary>
         /// Finalizer
         /// </summary>
-        ~BinaryPrefs()
+        ~BinaryStorage()
         {
             Dispose(false);
         }
@@ -512,7 +511,7 @@ private void Dispose(bool disposing)
         private void LoadDataFromDisk()
         {
             ThrowIfDisposed();
-            BinaryPrefsIO.LoadDataFromDisk(_storageFilePath, _supportedTypes, _data);
+            BinaryStorageIO.LoadDataFromDisk(_storageFilePath, _supportedTypes, _data);
             foreach (var rc in _data.Values.Select(c => c.Object).OfType<IReactiveCollection>())
             {
                 rc.OnChanged += MarkChanged;
@@ -525,7 +524,7 @@ private void LoadDataFromDisk()
         private void SaveDataFromDisk()
         {
             ThrowIfDisposed();
-            BinaryPrefsIO.SaveDataOnDisk(_storageFilePath, _supportedTypes, _data);
+            BinaryStorageIO.SaveDataOnDisk(_storageFilePath, _supportedTypes, _data);
             IsDirty = false;
         }
 

diff --git a/Runtime/BinaryPrefs.cs.meta → Runtime/BinaryStorage.cs.meta b/Runtime/BinaryPrefs.cs.meta → Runtime/BinaryStorage.cs.meta
diff --git a/Runtime/BinaryPrefsIO.cs → Runtime/BinaryStorageIO.cs b/Runtime/BinaryPrefsIO.cs → Runtime/BinaryStorageIO.cs
@@ -4,9 +4,9 @@
 using System.Text;
 using UnityEngine;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
-    internal static class BinaryPrefsIO
+    internal static class BinaryStorageIO
     {
         internal static void SaveDataOnDisk(string storageFilePath, IReadOnlyList<BinarySection> sections, IReadOnlyDictionary<string, Record> data)
         {

diff --git a/Runtime/BinaryPrefsIO.cs.meta → Runtime/BinaryStorageIO.cs.meta b/Runtime/BinaryPrefsIO.cs.meta → Runtime/BinaryStorageIO.cs.meta
diff --git a/Runtime/Collections/IReactiveCollection.cs b/Runtime/Collections/IReactiveCollection.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     internal interface IReactiveCollection : IDisposable
     {

diff --git a/Runtime/Collections/ReactiveDictionary.cs b/Runtime/Collections/ReactiveDictionary.cs
@@ -2,7 +2,7 @@
 using System.Collections;
 using System.Collections.Generic;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class ReactiveDictionary<TKey, TValue> : IReactiveCollection, IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>
     {

diff --git a/Runtime/Collections/ReactiveList.cs b/Runtime/Collections/ReactiveList.cs
@@ -2,7 +2,7 @@
 using System.Collections;
 using System.Collections.Generic;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class ReactiveList<T> : IReactiveCollection, IList<T>, IReadOnlyList<T>
     {

diff --git a/Runtime/Collections/ReactiveSet.cs b/Runtime/Collections/ReactiveSet.cs
@@ -3,7 +3,7 @@
 using System.Collections.Generic;
 using JetBrains.Annotations;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class ReactiveSet<T> : IReactiveCollection, ISet<T>, IReadOnlyCollection<T>
     {

diff --git a/Runtime/Exceptions/CantSupportCollectionOfException.cs b/Runtime/Exceptions/CantSupportCollectionOfException.cs
@@ -1,13 +1,13 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class CantSupportCollectionOfException : Exception
     {
         public Type ItemType { get; }
 
         public CantSupportCollectionOfException(Type itemType)
-            : base($"Add serializer for {itemType.FullName} using {nameof(BinaryPrefs.Builder.AddTypeSerializer)} before adding support for List<{itemType.Name}>.")
+            : base($"Add serializer for {itemType.FullName} using {nameof(BinaryStorage.Builder.AddTypeSerializer)} before adding support for List<{itemType.Name}>.")
         {
             ItemType = itemType;
         }

diff --git a/Runtime/Exceptions/CollectionDisposedException.cs b/Runtime/Exceptions/CollectionDisposedException.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class CollectionDisposedException : Exception
     {

diff --git a/Runtime/Exceptions/DuplicateTypeSerializerException.cs b/Runtime/Exceptions/DuplicateTypeSerializerException.cs
@@ -1,7 +1,7 @@
 using System;
 using System.IO;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class DuplicateTypeSerializerException : Exception
     {

diff --git a/Runtime/Exceptions/IncorrectUsageOfCollectionException.cs b/Runtime/Exceptions/IncorrectUsageOfCollectionException.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class IncorrectUsageOfCollectionException : Exception
     {

diff --git a/Runtime/Exceptions/StorageDisposedException.cs b/Runtime/Exceptions/StorageDisposedException.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class StorageDisposedException : Exception
     {

diff --git a/Runtime/Exceptions/UnexpectedTypeException.cs b/Runtime/Exceptions/UnexpectedTypeException.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class UnexpectedTypeException : Exception
     {

diff --git a/Runtime/Exceptions/UnexpectedUnderlyingEnumTypeException.cs b/Runtime/Exceptions/UnexpectedUnderlyingEnumTypeException.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class UnexpectedUnderlyingEnumTypeException : Exception
     {

diff --git a/Runtime/Exceptions/UnregisteredTypeException.cs b/Runtime/Exceptions/UnregisteredTypeException.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public class UnregisteredTypeException : Exception
     {

diff --git a/Runtime/PackageInfo.cs b/Runtime/PackageInfo.cs
@@ -4,7 +4,7 @@
 
 [assembly: InternalsVisibleTo("Appegy.BinaryStorage.Tests")]
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     public static class PackageInfo
     {

diff --git a/Runtime/Record.cs b/Runtime/Record.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Appegy.BinaryStorage
+namespace Appegy.Storage
 {
     internal abstract class Record
     {