feat!: Rename DecoratorCommandStrategy to DelegatingCommandStrategy.

Author: jeanplevesque

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 * Support for Android 11 (March, 2021)
 
 ### Changed
+* Replaced `DecoratorCommandStrategy` with `DelegatingCommandStrategy`.
 * Replaced `IViewModelView` with `IDispatcher`.
   * Replaced `IViewModel.View` with `IViewModel.Dispatcher`
 * Update UWP target to 19041 and net framework to 4.7.2
@@ -20,6 +21,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 * [#39] Change target Uno.UI version to 4.0.7.
 
 ### Deprecated
+* `DecoratorCommandStrategy` not longer exists. Use `DelegatingCommandStrategy` instead.
 * `IViewModelView` not longer exists. Use `IDispatcher` instead.
 ### Removed
 * Support for Android 10 (March, 2022)

build/gitversion.yml

@@ -1,6 +1,6 @@
 assembly-versioning-scheme: MajorMinorPatch
 mode: ContinuousDeployment
-next-version: 0.10.0
+next-version: 0.11.0
 continuous-delivery-fallback-tag: ""
 increment: none # Disabled as it is not used. Saves time on the GitVersion step
 branches:

src/DynamicMvvm.Abstractions/Command/DecoratorCommandStrategy.cs

@@ -7,14 +7,16 @@
 namespace Chinook.DynamicMvvm
 {
 	/// <summary>
-	/// This is a base implementation for <see cref="IDynamicCommandStrategy"/> decorators.
+	/// This delegates the functionalities of <see cref="IDynamicCommandStrategy"/> to an inner strategy.
+	/// You may override any member add customization.
+	/// This class is an homologue to <see cref="System.Net.Http.DelegatingHandler"/>.
 	/// </summary>
-	public abstract class DecoratorCommandStrategy : IDynamicCommandStrategy
+	public abstract class DelegatingCommandStrategy : IDynamicCommandStrategy
 	{
 		/// <summary>
-		/// Initializes a new instance of the <see cref="DecoratorCommandStrategy"/> class.
+		/// Initializes a new instance of the <see cref="DelegatingCommandStrategy"/> class.
 		/// </summary>
-		public DecoratorCommandStrategy()
+		public DelegatingCommandStrategy()
 		{
 		}
 

src/DynamicMvvm.Abstractions/Command/IDynamicCommand.md

@@ -89,11 +89,11 @@ var myCommand = new DynamicCommand("MyCommandFromTaskWithParameter", myCommandSt
 Task ExecuteCommand(CancellationToken ct, int parameter) => Task.CompletedTask;
 ```
 
-### Strategy Decorators
+### Delegating Strategies
 
 `IDynamicCommandStrategy` can be decorated in order to add new logic to it.
 
-Here is a list of some decorators provided.
+Here is a list of some delegating strategies provided.
 
 - [BackgroundCommandStrategy](Implementations/Strategies/BackgroundCommandStrategy.cs) : Executes the command on a background thread.
 - [CanExecuteCommandStrategy](Implementations/Strategies/CanExecuteCommandStrategy.cs) : Attaches the `CanExecute` to the value of a `IDynamicProperty`.
@@ -116,35 +116,35 @@ var myCommand = new DynamicCommand("MyCommand", myStrategyWithLogs);
 void ExecuteCommand() { }
 ```
 
-You can create your own decorators by inheriting from `DecoratorCommandStrategy`.
+You can create your own strategies by inheriting from `DelegatingCommandStrategy`.
 
 ```csharp
-public class MyCustomCommandDecorator : DecoratorCommandStrategy
+public class MyCustomCommandStrategy : DelegatingCommandStrategy
 {
-  public MyCustomCommandDecorator(IDynamicCommandStrategy innerStrategy) : base(innerStrategy)
+  public MyCustomCommandStrategy(IDynamicCommandStrategy innerStrategy) : base(innerStrategy)
   { }
 
   public override bool CanExecute(object parameter, IDynamicCommand command)
   {
-    // Implement your custom decorator logic here.
+    // Implement your custom logic here.
     return base.CanExecute(parameter, command);
   }
 
   public override async Task Execute(CancellationToken ct, object parameter, IDynamicCommand command)
   {
-    // Implement your custom decorator logic here.
+    // Implement your custom logic here.
     base.Execute(ct, parameter, command);
   }
 }
 
-public static class MyCustomCommandDecoratorExtensions
+public static class MyCustomCommandStrategyExtensions
 {
-  public static IDynamicCommandStrategy WithMyCustomDecorator(this IDynamicCommandStrategy strategy)
-    => new MyCustomCommandDecorator(strategy);
+  public static IDynamicCommandStrategy WithMyCustomStrategy(this IDynamicCommandStrategy strategy)
+    => new MyCustomCommandStrategy(strategy);
 }
 
-// This will decorate the strategy with your custom decorator
-var myCommandWithMyCustomDecorator = myCommandStrategy.WithMyCustomDecorator();
+// This will decorate the strategy with your custom one.
+var myCommandWithMyCustomStrategy = myCommandStrategy.WithMyCustomStrategy();
 ```
 
 ### Command builder and factory

src/DynamicMvvm.Abstractions/Command/IDynamicCommandBuilder.Extensions.cs

@@ -17,7 +17,7 @@ public static class DynamicCommandBuilderExtensions
 		/// <param name="strategy">The strategy to add.</param>
 		/// <param name="wrapExisting">When true, the <paramref name="strategy"/> is added at the start of the list, so that it wraps all existing strategies already present in the list.</param>
 		/// <returns><see cref="IDynamicCommandBuilder"/></returns>
-		public static IDynamicCommandBuilder WithStrategy(this IDynamicCommandBuilder builder, DecoratorCommandStrategy strategy, bool wrapExisting = false)
+		public static IDynamicCommandBuilder WithStrategy(this IDynamicCommandBuilder builder, DelegatingCommandStrategy strategy, bool wrapExisting = false)
 		{
 			if (wrapExisting)
 			{

src/DynamicMvvm.Abstractions/Command/IDynamicCommandBuilder.cs

@@ -33,7 +33,7 @@ public interface IDynamicCommandBuilder
 		/// The list of strategies that will decorate the <see cref="BaseStrategy"/>.
 		/// The order is important: the first strategy wraps the second, which wraps the third and so on.
 		/// </summary>
-		IList<DecoratorCommandStrategy> Strategies { get; set; }
+		IList<DelegatingCommandStrategy> Strategies { get; set; }
 
 		/// <summary>
 		/// Creates a new instance of <see cref="IDynamicCommand"/>

src/DynamicMvvm.Abstractions/ViewModel/IViewModel.md

@@ -167,7 +167,7 @@ public class MyViewModel : ViewModelBase
 
 You can decorate a `IDynamicCommand` from its definition.
 
-[Refer to this documention for more information on IDynamicCommand decorators](../Command/IDynamicCommand.md#decorators).
+[Refer to this documention for more information on IDynamicCommand strategies](../Command/IDynamicCommand.md#Delegating-Strategies).
 
 ```csharp
 public class MyViewModel : ViewModelBase

src/DynamicMvvm.Tests/Command/DynamicCommandBuilderFactoryTests.cs

@@ -71,19 +71,19 @@ public async Task It_Creates_From_Task_T()
 		[Fact]
 		public async Task It_Decorates_Using_Global()
 		{
-			var decoratorCalled = false;
+			var configurationCalled = false;
 
 			var factory = new DynamicCommandBuilderFactory(Configure);
 
 			var command = factory.CreateFromAction(DefaultCommandName, () => { }).Build();
 
 			await command.Execute();
 
-			decoratorCalled.Should().BeTrue();
+			configurationCalled.Should().BeTrue();
 
 			IDynamicCommandBuilder Configure(IDynamicCommandBuilder builder)
 			{
-				decoratorCalled = true;
+				configurationCalled = true;
 				return builder;
 			}
 		}
@@ -178,7 +178,7 @@ public void It_passes_ViewModel_owner_correctly_when_null()
 
 		private class TestParameter { }
 
-		private class TestStrategy : DecoratorCommandStrategy
+		private class TestStrategy : DelegatingCommandStrategy
 		{
 			private readonly Action _testAction;
 

src/DynamicMvvm/Command/DynamicCommandBuilder.cs

@@ -40,7 +40,7 @@ public DynamicCommandBuilder(string name, IDynamicCommandStrategy baseStrategy,
 		public IDynamicCommandStrategy BaseStrategy { get; }
 
 		/// <inheritdoc/>
-		public IList<DecoratorCommandStrategy> Strategies { get; set; } = new List<DecoratorCommandStrategy>();
+		public IList<DelegatingCommandStrategy> Strategies { get; set; } = new List<DelegatingCommandStrategy>();
 
 		/// <inheritdoc/>
 		public IDynamicCommand Build()
@@ -56,7 +56,7 @@ public IDynamicCommand Build()
 			return _command;
 		}
 
-		private static IDynamicCommandStrategy GetStrategy(IDynamicCommandStrategy baseStrategy, IList<DecoratorCommandStrategy> delegatingStrategies)
+		private static IDynamicCommandStrategy GetStrategy(IDynamicCommandStrategy baseStrategy, IList<DelegatingCommandStrategy> delegatingStrategies)
 		{
 			var strategy = baseStrategy;
 

src/DynamicMvvm/Command/Strategies/BackgroundCommandStrategy.cs

@@ -18,9 +18,9 @@ public static IDynamicCommandBuilder OnBackgroundThread(this IDynamicCommandBuil
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will execute the command on a background thread.
+	/// This <see cref="DelegatingCommandStrategy"/> will execute the command on a background thread.
 	/// </summary>
-	public class BackgroundCommandStrategy : DecoratorCommandStrategy
+	public class BackgroundCommandStrategy : DelegatingCommandStrategy
 	{
 		/// <summary>
 		/// Initializes a new instance of the <see cref="BackgroundCommandStrategy"/> class.

src/DynamicMvvm/Command/Strategies/CanExecuteCommandStrategy.cs

@@ -19,10 +19,10 @@ public static IDynamicCommandBuilder WithCanExecute(this IDynamicCommandBuilder
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will attach
+	/// This <see cref="DelegatingCommandStrategy"/> will attach
 	/// its <see cref="ICommand.CanExecute(object)"/> to the value of a <see cref="IDynamicProperty"/>.
 	/// </summary>
-	public class CanExecuteCommandStrategy : DecoratorCommandStrategy
+	public class CanExecuteCommandStrategy : DelegatingCommandStrategy
 	{
 		private readonly IDynamicProperty<bool> _canExecute;
 

src/DynamicMvvm/Command/Strategies/CancelPreviousCommandStrategy.cs

@@ -18,9 +18,9 @@ public static IDynamicCommandBuilder CancelPrevious(this IDynamicCommandBuilder
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will cancel the previous command execution when executing the command.
+	/// This <see cref="DelegatingCommandStrategy"/> will cancel the previous command execution when executing the command.
 	/// </summary>
-	public class CancelPreviousCommandStrategy : DecoratorCommandStrategy
+	public class CancelPreviousCommandStrategy : DelegatingCommandStrategy
 	{
 		private CancellationTokenSource _cancellationTokenSource;
 

src/DynamicMvvm/Command/Strategies/DisableWhileExecutingCommandStrategy.cs

@@ -18,9 +18,9 @@ public static IDynamicCommandBuilder DisableWhileExecuting(this IDynamicCommandB
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will disable the command while it's executing.
+	/// This <see cref="DelegatingCommandStrategy"/> will disable the command while it's executing.
 	/// </summary>
-	public class DisableWhileExecutingCommandStrategy : DecoratorCommandStrategy
+	public class DisableWhileExecutingCommandStrategy : DelegatingCommandStrategy
 	{
 		public int _isExecuting;
 

src/DynamicMvvm/Command/Strategies/ErrorHandlerCommandStrategy.cs

@@ -28,10 +28,10 @@ public static IDynamicCommandBuilder CatchErrors(this IDynamicCommandBuilder bui
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will catch any exception
+	/// This <see cref="DelegatingCommandStrategy"/> will catch any exception
 	/// that may be thrown during its execution and delegate the exception to an error handler.
 	/// </summary>
-	public class ErrorHandlerCommandStrategy : DecoratorCommandStrategy
+	public class ErrorHandlerCommandStrategy : DelegatingCommandStrategy
 	{
 		private readonly IDynamicCommandErrorHandler _errorHandler;
 

src/DynamicMvvm/Command/Strategies/LockCommandStrategy.cs

@@ -18,9 +18,9 @@ public static IDynamicCommandBuilder Locked(this IDynamicCommandBuilder builder)
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will lock the command execution.
+	/// This <see cref="DelegatingCommandStrategy"/> will lock the command execution.
 	/// </summary>
-	public class LockCommandStrategy : DecoratorCommandStrategy
+	public class LockCommandStrategy : DelegatingCommandStrategy
 	{
 		private readonly SemaphoreSlim _semaphore = new SemaphoreSlim(1, 1);
 

src/DynamicMvvm/Command/Strategies/LoggerCommandStrategy.cs

@@ -20,9 +20,9 @@ public static IDynamicCommandBuilder WithLogs(this IDynamicCommandBuilder builde
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will log the execution of the command.
+	/// This <see cref="DelegatingCommandStrategy"/> will log the execution of the command.
 	/// </summary>
-	public class LoggerCommandStrategy : DecoratorCommandStrategy
+	public class LoggerCommandStrategy : DelegatingCommandStrategy
 	{
 		private readonly ILogger _logger;
 

src/DynamicMvvm/Command/Strategies/RaiseCanExecuteOnDispatcherCommandStrategy.cs

@@ -9,7 +9,7 @@ namespace Chinook.DynamicMvvm
 	/// <summary>
 	/// This <see cref="IDynamicCommandStrategy"/> ensures that the <see cref="CanExecuteChanged"/> event is raised using <see cref="IDispatcher.ExecuteOnDispatcher(CancellationToken, Action)"/>.
 	/// </summary>
-	public class RaiseCanExecuteOnDispatcherCommandStrategy : DecoratorCommandStrategy
+	public class RaiseCanExecuteOnDispatcherCommandStrategy : DelegatingCommandStrategy
 	{
 		private readonly WeakReference<IViewModel> _viewModel;
 		private readonly CancellationTokenSource _cts = new CancellationTokenSource();

src/DynamicMvvm/Command/Strategies/SkipWhileExecutingCommandStrategy.cs

@@ -19,9 +19,9 @@ public static IDynamicCommandBuilder SkipWhileExecuting(this IDynamicCommandBuil
 	}
 
 	/// <summary>
-	/// This <see cref="DecoratorCommandStrategy"/> will skip executions if the command is already executing.
+	/// This <see cref="DelegatingCommandStrategy"/> will skip executions if the command is already executing.
 	/// </summary>
-	public class SkipWhileExecutingCommandStrategy : DecoratorCommandStrategy
+	public class SkipWhileExecutingCommandStrategy : DelegatingCommandStrategy
 	{
 		public int _isExecuting;