added GroupUnDo.MergeDescriptionAction property

Doraku · Oct 3, 2021 · cfd1d1c · cfd1d1c
1 parent 14bcbc1
commit cfd1d1c
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 4 deletions.
diff --git a/documentation/NEXT_RELEASENOTES.txt b/documentation/NEXT_RELEASENOTES.txt
@@ -1,5 +1,6 @@
 added ValueUnDo.MergeInterval property
 added ValueUnDo.MergeDescriptionAction property
+added GroupUnDo.MergeDescriptionAction property
 
 ---
 

diff --git a/source/DefaultUnDo.Test/GroupUnDoTest.cs b/source/DefaultUnDo.Test/GroupUnDoTest.cs
@@ -155,6 +155,42 @@ public void TryMerge_Should_return_true_When_merged()
             Check.That(newUndo).IsEqualTo(undo);
         }
 
+        [Fact]
+        public void TryMerge_Should_use_group_description()
+        {
+            IMergeableUnDo mergeable = Substitute.For<IMergeableUnDo>();
+            IUnDo undo = Substitute.For<IUnDo>();
+            IMergeableUnDo group = new GroupUnDo("test", mergeable);
+            undo.Description.Returns("test1");
+            mergeable.TryMerge(undo, out Arg.Any<IUnDo>()).Returns(x =>
+            {
+                x[1] = undo;
+                return true;
+            });
+            Check.That(group.TryMerge(undo, out IUnDo merged)).IsTrue();
+            Check.That(merged.Description).IsEqualTo(group.Description);
+        }
+
+        [Fact]
+        public void TryMerge_Should_use_MergeDescriptionAction_When_set()
+        {
+            IMergeableUnDo mergeable = Substitute.For<IMergeableUnDo>();
+            IUnDo undo = Substitute.For<IUnDo>();
+            IMergeableUnDo group = new GroupUnDo("test", mergeable);
+            undo.Description.Returns("test");
+            mergeable.TryMerge(undo, out Arg.Any<IUnDo>()).Returns(x =>
+            {
+                x[1] = undo;
+                return true;
+            });
+            GroupUnDo.MergeDescriptionAction = (_, _, _) => "kikoo";
+
+            Check.That(group.TryMerge(undo, out IUnDo merged)).IsTrue();
+            Check.That(merged.Description).IsEqualTo("kikoo");
+
+            GroupUnDo.MergeDescriptionAction = null;
+        }
+
         #endregion
     }
 }
diff --git a/source/DefaultUnDo.Test/ValueUnDoTest.cs b/source/DefaultUnDo.Test/ValueUnDoTest.cs
@@ -146,7 +146,7 @@ public void TryMerge_Should_use_non_generic_MergeDescriptionAction_When_Set()
         }
 
         [Fact]
-        public void TryMerge_Should_use_new_description_When_Set()
+        public void TryMerge_Should_use_new_description()
         {
             int item = 0;
             void setter(int v) => item = v;

diff --git a/source/DefaultUnDo/GroupUnDo.cs b/source/DefaultUnDo/GroupUnDo.cs
@@ -8,13 +8,31 @@ namespace DefaultUnDo
     /// </summary>
     public sealed class GroupUnDo : IMergeableUnDo
     {
+        /// <summary>
+        /// Represents a method that will be called when merging a <see cref="GroupUnDo"/> and a <see cref="IMergeableUnDo"/> instances to get the resulting description.
+        /// </summary>
+        /// <param name="oldDescription">The description of the previous <see cref="GroupUnDo"/> merged.</param>
+        /// <param name="newDescription">The description of the new <see cref="IMergeableUnDo"/> merged.</param>
+        /// <param name="mergedDescription">The description of the new resulting <see cref="IMergeableUnDo"/> merged.</param>
+        /// <returns></returns>
+        public delegate object MergeDescriptionHandler(object oldDescription, object newDescription, object mergedDescription);
+
         #region Fields
 
         private readonly object _description;
         private readonly IUnDo[] _commands;
 
         #endregion
 
+        #region Properties
+
+        /// <summary>
+        /// The <see cref="MergeDescriptionHandler"/> used to merge description between a <see cref="GroupUnDo"/> and a <see cref="IMergeableUnDo"/> instances.
+        /// </summary>
+        public static MergeDescriptionHandler MergeDescriptionAction { get; set; }
+
+        #endregion
+
         #region Initialisation
 
         /// <summary>
@@ -79,7 +97,9 @@ bool IMergeableUnDo.TryMerge(IUnDo other, out IUnDo mergedCommand)
         {
             mergedCommand =
                 TryGetSingle(out IMergeableUnDo mergeable) && mergeable.TryMerge(other, out mergedCommand)
-                ? new GroupUnDo(_description, mergedCommand)
+                ? new GroupUnDo(
+                    MergeDescriptionAction?.Invoke(_description, mergeable.Description, mergedCommand.Description) ?? _description,
+                    mergedCommand)
                 : null;
 
             return mergedCommand != null;

diff --git a/source/DefaultUnDo/ValueUnDo.cs b/source/DefaultUnDo/ValueUnDo.cs
@@ -9,7 +9,7 @@ namespace DefaultUnDo
     public static class ValueUnDo
     {
         /// <summary>
-        /// Represents a method that will be called when merging two <see cref="ValueUnDo{T}"/> instance to get the resulting description.
+        /// Represents a method that will be called when merging two <see cref="ValueUnDo{T}"/> instances to get the resulting description.
         /// </summary>
         /// <param name="oldDescription">The description of the previous <see cref="ValueUnDo{T}"/> merged.</param>
         /// <param name="newDescription">The description of the new <see cref="ValueUnDo{T}"/> merged.</param>
@@ -35,7 +35,7 @@ public static class ValueUnDo
     public sealed class ValueUnDo<T> : IMergeableUnDo
     {
         /// <summary>
-        /// Represents a method that will be called when merging two <see cref="ValueUnDo{T}"/> instance to get the resulting description.
+        /// Represents a method that will be called when merging two <see cref="ValueUnDo{T}"/> instances to get the resulting description.
         /// </summary>
         /// <param name="oldDescription">The description of the previous <see cref="ValueUnDo{T}"/> merged.</param>
         /// <param name="oldValue">The old value used when undoing the resulting merged <see cref="ValueUnDo{T}"/>.</param>