Merge pull request #49 from AndanteTribe/feature/shared-unity-only

Feature/shared unity only

Author: kochounoyume

README.md

@@ -23,7 +23,7 @@ Unity’s built-in `UnityEngine.PlayerPrefs` API is known for several critical i
 
 **LocalPrefs** addresses these problems and offers a high-performance implementation.
 
-1. When using `LocalPrefs.Shared`, the default save path is `Application.persistentDataPath` in Unity. In .NET environments, an equivalent persistent path is used.
+1. The save path of `LocalPrefs.Shared` (`LocalPrefs.Unity`) defaults to `Application.persistentDataPath`. On WebGL, the optimal save destination is automatically configured.
 2. It provides APIs that allow customization, such as defining save paths and encryption. It also offers an abstraction layer through the `ILocalPrefs` interface to enable unified save/load management.
 3. It supports high-performance serialization using either `System.Text.Json` or [MessagePack-CSharp](https://github.com/MessagePack-CSharp/MessagePack-CSharp).
 4. By integrating with native JavaScript, it supports APIs for saving/loading using Local Storage and IndexedDB, along with unified implementations based on these.
@@ -62,7 +62,7 @@ The simplest implementation uses `LocalPrefs.Shared`.
 The types that can be saved/loaded depend on the serializer used. As long as the serializer’s requirements are met, any type can be handled.
 
 ```csharp
-using AndanteTribe.IO;
+using AndanteTribe.IO.Unity;
 
 var hoge = new Hoge();
 

README_JA.md

@@ -23,7 +23,7 @@ Unityの `UnityEngine.PlayerPrefs` は非常に問題の多いAPIで、以下の
 
 LocalPrefsはこれらの問題を解消し、かつ高速な実装を提供します。
 
-1. `LocalPrefs.Shared` の保存先はUnityの場合は `Application.persistentDataPath`、.NETの場合もそれに準じたパスが指定されます。
+1. `LocalPrefs.Shared` （`LocalPrefs.Unity`）の保存先は基本的に `Application.persistentDataPath` 、WebGLだと自動的に最適な保存先が指定されます。
 2. 保存先や暗号化など、独自の拡張をすることを入れ込むことを可能にするAPIを提供します。また、セーブ・ロードの一括制御をする実装の抽象レイヤーとして `ILocalPrefs` インターフェイスを提供します。
 3. `System.Text.Json` または [MessagePack-CSharp](https://github.com/MessagePack-CSharp/MessagePack-CSharp) を利用した、高速な読み込み実装を提供します。
 4. JavaScriptネイティブな実装との連携により、Local storageとIndexedDBへの保存・展開を可能とするAPIの提供、およびそれらを利用した一括制御実装を提供します。
@@ -59,7 +59,7 @@ Install-Package LocalPrefs.MessagePack
 指定する型は依存するシリアライザーによります。シリアライザー側の要件を満たせればどの型でもセーブ・ロードが可能です。
 
 ```cs
-using AndanteTribe.IO;
+using AndanteTribe.IO.Unity;
 
 var hoge = new Hoge();
 

bin/LocalPrefs.Core/LocalPrefs.Core.dll

@@ -47,6 +47,11 @@ public void TearDown()
             }
         }
 
+#if UNITY_EDITOR || UNITY_WEBGL
+        [Test]
+        public void Shared_IsNotNull() => LocalPrefsTest.Shared_IsNotNul();
+#endif
+
         [TestCaseSource(nameof(s_factories))]
         public Task SaveAndLoad_Int(Func<ILocalPrefs> factory)=>
             LocalPrefsTest.SaveAndLoad_Int(factory).AsTask();

bin/LocalPrefs.Core/LocalPrefs.Core.xml

@@ -26,6 +26,10 @@ public static class LocalPrefsTest
             0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30
         };
 
+#if UNITY_EDITOR || UNITY_WEBGL
+        public static void Shared_IsNotNul() => Assert.That(Unity.LocalPrefs.Shared, Is.Not.Null);
+#endif
+
         public static async ValueTask SaveAndLoad_Int(Func<ILocalPrefs> factory)
         {
             var prefs = factory();

bin/LocalPrefs.Json/LocalPrefs.Json.dll

@@ -36,6 +36,9 @@ public void TearDown()
             LSUtils.Delete(LocalPrefsTest.TestFilePath);
         }
 
+        [Test]
+        public void Shared_IsNotNull() => LocalPrefsTest.Shared_IsNotNul();
+
         [UnityTest]
         public IEnumerator SaveAndLoad_Int([ValueSource(nameof(s_factories))] Func<ILocalPrefs> factory)
         {

bin/LocalPrefs.MessagePack/LocalPrefs.MessagePack.dll

@@ -0,0 +1,13 @@
+namespace AndanteTribe.IO.Unity
+{
+    /// <summary>
+    /// Provides access to local preferences.
+    /// </summary>
+    public static class LocalPrefs
+    {
+        /// <summary>
+        /// Shared instance of <see cref="ILocalPrefs"/>.
+        /// </summary>
+        public static ILocalPrefs Shared { get; internal set; }
+    }
+}