Merge pull request #100 from /issues/97

Issues/97 Delete IStateClone

Assets/Plugins/Unidux/Scripts/StateBase.cs

@@ -4,11 +4,12 @@
 namespace Unidux
 {
     [Serializable]
-    public class StateBase : IState, IStateClone, IStateChanged
+    public class StateBase : IState, IStateChanged, ICloneable
     {
-        public virtual TValue Clone<TValue>() where TValue : IStateClone
+        public virtual object Clone()
         {
-            return (TValue) StateUtil.MemoryClone(this);
+            // It's slow. in case of requiring performance override this deep clone method by your code.
+            return StateUtil.MemoryClone(this);
         }
 
         public bool IsStateChanged { get; private set; }

Assets/Plugins/Unidux/Scripts/Store.cs

@@ -101,7 +101,7 @@ public void ForceUpdate()
             lock (this._state)
             {
                 // Prevent writing state object
-                fixedState = this._state.Clone<TState>();
+                fixedState = (TState) this._state.Clone();
 
                 // The function may slow
                 StateUtil.ResetStateChanged(this._state);

Assets/Plugins/Unidux/Test/Editor/Performance/ClonePerformanceTest.cs

@@ -3,7 +3,7 @@
 using System.Diagnostics;
 using NUnit.Framework;
 
-namespace Unidux.Test
+namespace Unidux.Performance
 {
     public class ClonePerformanceTest
     {
@@ -23,7 +23,7 @@ public void CloneTest()
             {
                 watch.Reset();
                 watch.Start();
-                var clone1 = state.Clone<SampleState>();
+                var clone1 = (SampleState)state.Clone();
                 watch.Stop();
                 UnityEngine.Debug.Log("Clone1: " + watch.Elapsed.Milliseconds + "[ms]");
             }
@@ -48,10 +48,10 @@ public static SampleState Create(int loop)
                 return state;
             }
 
-//            public override TValue Clone<TValue>()
+            // custom implementation of Clone is faster than default BinaryFormatter implementation.
+//            public override object Clone()
 //            {
-//                object clonee = CustomClone();
-//                return (TValue)clonee;
+//                return CustomClone();
 //            }
 
             public SampleState CustomClone()

Assets/Plugins/Unidux/Test/Editor/StateBaseTest.cs

@@ -12,7 +12,7 @@ public void CloneTest()
             var sample1 = new SampleState();
             sample1.List = new List<string>() {"a", "b", "c"};
 
-            var sample2 = sample1.Clone<SampleState>();
+            var sample2 = (SampleState)sample1.Clone();
             sample2.List[1] = "bb";
             Assert.AreEqual(new List<string>() {"a", "b", "c"}, sample1.List);
             Assert.AreEqual(new List<string>() {"a", "bb", "c"}, sample2.List);

Assets/Plugins/Unidux/Test/Editor/StateCloneTest.cs

@@ -1,9 +1,10 @@
-using NUnit.Framework;
+using System;
+using NUnit.Framework;
 namespace Unidux
 {
     public class StateCloneTest
     {
-        class Hoge : IStateClone
+        class Hoge : ICloneable
         {
             private bool Flag = false;
 
@@ -17,9 +18,9 @@ public bool GetFlag()
                 return this.Flag;
             }
 
-            public T Clone<T>() where T : IStateClone
+            public object Clone()
             {
-                return (T) MemberwiseClone();
+                return MemberwiseClone();
             }
         }
 
@@ -47,7 +48,7 @@ public void CloneTest()
             Assert.AreEqual(true, hoge1.GetFlag());
             Assert.AreEqual(100, hoge1.GetCount());
 
-            var hoge2 = hoge1.Clone<HogeHoge>();
+            var hoge2 = (HogeHoge)hoge1.Clone();
             Assert.AreEqual(true, hoge2.GetFlag());
             Assert.AreEqual(100, hoge2.GetCount());
         }

README.md

@@ -265,6 +265,27 @@ Foo.Instance
 
 The instance of the base class.
 
+# TIPS
+
+## Performance of object cloning
+
+Default implemention of `StateBase.Clone()` is not fast, because it uses `BinaryFormatter` & `MemoryStream`.
+And Unidux creates new State on every State chaning (it affects a few milliseconds).
+So in case of requiring performance, override clone method with your own logic.
+
+e.g.
+
+```
+[Serializable]
+class State : StateBase
+{
+    public override object Clone()
+    {
+        // implement your custom deep clone code
+    }
+}
+```
+
 # Thanks
 
 - [@austinmao](https://github.com/austinmao) for suggestion of Ducks and UniRx.