#28: Synergy.Contracts: Added Fail.IfArgumentNull(argumentValue) method

synergy-software · Feb 3, 2024 · 37d47d5 · 37d47d5
1 parent ddbcbd7
commit 37d47d5
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 12 deletions.
diff --git a/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet6_0.verified.md b/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet6_0.verified.md
@@ -88,9 +88,9 @@
      argumentName: string [NotNull, NotNull]
    ) : void [AssertionMethod]
  - Fail.IfArgumentNull<T>(
-     argumentValue: T? [CanBeNull, AssertionCondition, NoEnumeration],
-     argumentName: string [NotNull, NotNull]
-   ) : void [AssertionMethod, ContractAnnotation]
+     argumentValue: T [Nullable, CanBeNull, AssertionCondition, NoEnumeration],
+     argumentName: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod, ContractAnnotation]
  - Fail.IfArgumentWhiteSpace(
      argumentValue: string [CanBeNull, AssertionCondition],
      argumentName: string [NotNull, NotNull]

diff --git a/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet7_0.verified.md b/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet7_0.verified.md
@@ -88,9 +88,9 @@
      argumentName: string [NotNull, NotNull]
    ) : void [AssertionMethod]
  - Fail.IfArgumentNull<T>(
-     argumentValue: T? [CanBeNull, AssertionCondition, NoEnumeration],
-     argumentName: string [NotNull, NotNull]
-   ) : void [AssertionMethod, ContractAnnotation]
+     argumentValue: T [Nullable, CanBeNull, AssertionCondition, NoEnumeration],
+     argumentName: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod, ContractAnnotation]
  - Fail.IfArgumentWhiteSpace(
      argumentValue: string [CanBeNull, AssertionCondition],
      argumentName: string [NotNull, NotNull]

diff --git a/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet8_0.verified.md b/...ntracts.Test/Architecture/Public/Api.of.Synergy.Contracts.DotNet8_0.verified.md
@@ -88,9 +88,9 @@
      argumentName: string [NotNull, NotNull]
    ) : void [AssertionMethod]
  - Fail.IfArgumentNull<T>(
-     argumentValue: T? [CanBeNull, AssertionCondition, NoEnumeration],
-     argumentName: string [NotNull, NotNull]
-   ) : void [AssertionMethod, ContractAnnotation]
+     argumentValue: T [Nullable, CanBeNull, AssertionCondition, NoEnumeration],
+     argumentName: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod, ContractAnnotation]
  - Fail.IfArgumentWhiteSpace(
      argumentValue: string [CanBeNull, AssertionCondition],
      argumentName: string [NotNull, NotNull]

diff --git a/Contracts/Synergy.Contracts.Test/Failures/FailNullabilityTest.cs b/Contracts/Synergy.Contracts.Test/Failures/FailNullabilityTest.cs
@@ -244,12 +244,26 @@ public void IfArgumentNull([CanBeNull] object argumentValue)
             Assert.That(exception.Message, Is.EqualTo("Argument 'argumentValue' is null."));
         }
 
+        [Test]
+        [TestCaseSource(nameof(FailNullabilityTest.GetNulls))]
+        public void IfArgumentNullCallerArgumentExpression([CanBeNull] object argumentValue)
+        {
+            // ACT
+            var exception = Assert.Throws<DesignByContractViolationException>(
+                () => Fail.IfArgumentNull(argumentValue)
+            );
+
+            // ASSERT
+            Assert.That(exception.Message, Is.EqualTo("Argument 'argumentValue' is null."));
+        }
+
         [Test]
         [TestCaseSource(nameof(FailNullabilityTest.GetNotNulls))]
         public void IfArgumentNullSuccess(object argumentValue)
         {
             // ACT
             Fail.IfArgumentNull(argumentValue, nameof(argumentValue));
+            Fail.IfArgumentNull(argumentValue);
         }
 
         #endregion

diff --git a/Contracts/Synergy.Contracts/Failures/FailNullability.cs b/Contracts/Synergy.Contracts/Failures/FailNullability.cs
@@ -166,7 +166,12 @@ public static T CanBeNull<T>([CanBeNull] [NoEnumeration] this T value)
         public static void IfArgumentNull<T>(
             [CanBeNull] [AssertionCondition(AssertionConditionType.IS_NOT_NULL)] [NoEnumeration]
             T argumentValue,
-            [NotNull] [System.Diagnostics.CodeAnalysis.NotNull] string argumentName)
+#if NET6_0_OR_GREATER
+            [System.Runtime.CompilerServices.CallerArgumentExpression("argumentValue")] string? argumentName = null
+#else
+            string argumentName
+#endif
+        )
         {
             Fail.RequiresArgumentName(argumentName);
 

diff --git a/Web/Sample/Synergy.Sample.Web.API.Services/Infrastructure/Commands/CommandDispatcher.cs b/Web/Sample/Synergy.Sample.Web.API.Services/Infrastructure/Commands/CommandDispatcher.cs
@@ -21,7 +21,7 @@ public TCommandResult Dispatch<TCommand, TCommandHandler, TCommandResult>(TComma
             where TCommandResult : class
             where TCommandHandler : ICommandHandler<TCommand, TCommandResult>
         {
-            Fail.IfArgumentNull(command, nameof(command));
+            Fail.IfArgumentNull(command);
             var commandHandler = this.commandHandlerFactory.Create<TCommand, TCommandResult>(command);
             this._logger.LogTrace("Command {Command} dispatch started by {CommandHandler}", command.GetType().Name, commandHandler.GetType().Name);
 

diff --git a/Web/Sample/Synergy.Sample.Web.API.Services/Infrastructure/Queries/QueryDispatcher.cs b/Web/Sample/Synergy.Sample.Web.API.Services/Infrastructure/Queries/QueryDispatcher.cs
@@ -21,7 +21,7 @@ public TQueryResult Dispatch<TQuery, TQueryHandler, TQueryResult>(TQuery query)
             where TQueryResult : class
             where TQueryHandler : IQueryHandler<TQuery, TQueryResult>
         {
-            Fail.IfArgumentNull(query, nameof(query));
+            Fail.IfArgumentNull(query);
             var queryHandler = this.queryHandlerFactory.Create<TQuery, TQueryResult>(query);
             this._logger.LogTrace("Query {Query} dispatch started by {QueryHandler}", query.GetType().Name, queryHandler.GetType().Name);