#28: Synergy.Contracts: Added Fail.IfArgumentEmpty(guid) method

synergy-software · Feb 3, 2024 · cba2fee · cba2fee
1 parent d61e2d1
commit cba2fee
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 8 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
@@ -80,8 +80,8 @@
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfArgumentEmpty(
      value: Guid,
-     argumentName: string [NotNull]
-   ) : void [AssertionMethod]
+     argumentName: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod]
  - Fail.IfArgumentEqual<TExpected, TActual>(
      unexpected: TExpected [Nullable, CanBeNull],
      argumentValue: TActual [Nullable, CanBeNull],

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
@@ -80,8 +80,8 @@
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfArgumentEmpty(
      value: Guid,
-     argumentName: string [NotNull]
-   ) : void [AssertionMethod]
+     argumentName: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod]
  - Fail.IfArgumentEqual<TExpected, TActual>(
      unexpected: TExpected [Nullable, CanBeNull],
      argumentValue: TActual [Nullable, CanBeNull],

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
@@ -80,8 +80,8 @@
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfArgumentEmpty(
      value: Guid,
-     argumentName: string [NotNull]
-   ) : void [AssertionMethod]
+     argumentName: string? [CallerArgumentExpression, Optional]
+   ) : void [NullableContext, AssertionMethod]
  - Fail.IfArgumentEqual<TExpected, TActual>(
      unexpected: TExpected [Nullable, CanBeNull],
      argumentValue: TActual [Nullable, CanBeNull],

diff --git a/Contracts/Synergy.Contracts.Test/Failures/Doubles/ContractorRepository.cs b/Contracts/Synergy.Contracts.Test/Failures/Doubles/ContractorRepository.cs
@@ -10,7 +10,7 @@ public class ContractorRepository : IContractorRepository
     {
         public Contractor FindContractorByGuid(Guid id)
         {
-            Fail.IfArgumentEmpty(id, nameof(id));
+            Fail.IfArgumentEmpty(id);
 
             // WARN: Below is sample code with no sense at all
             return new Contractor();

diff --git a/Contracts/Synergy.Contracts.Test/Failures/FailGuidTest.cs b/Contracts/Synergy.Contracts.Test/Failures/FailGuidTest.cs
@@ -22,12 +22,25 @@ public void IfArgumentEmpty(Guid someEmptyGuid)
             // ASSERT
             Assert.That(exception.Message, Is.EqualTo("Argument 'someEmptyGuid' is an empty Guid."));
         }
+
+        [TestCaseSource(nameof(FailGuidTest.GetEmptyGuid))]
+        public void IfArgumentEmptyCallerArgumentExpression(Guid someEmptyGuid)
+        {
+            // ACT
+            var exception = Assert.Throws<DesignByContractViolationException>(
+                () => Fail.IfArgumentEmpty(someEmptyGuid)
+            );
+
+            // ASSERT
+            Assert.That(exception.Message, Is.EqualTo("Argument 'someEmptyGuid' is an empty Guid."));
+        }
 
         [TestCaseSource(nameof(FailGuidTest.GetNewGuid))]
         public void IfArgumentEmptySuccess(Guid someGuid)
         {
             // ACT
             Fail.IfArgumentEmpty(someGuid, nameof(someGuid));
+            Fail.IfArgumentEmpty(someGuid);
         }
 
         [TestCaseSource(nameof(FailGuidTest.GetEmptyGuid))]

diff --git a/Contracts/Synergy.Contracts/Failures/FailGuid.cs b/Contracts/Synergy.Contracts/Failures/FailGuid.cs
@@ -38,7 +38,15 @@ public static void IfEmpty(Guid value, Violation message)
         /// </code>
         /// </example>
         [AssertionMethod]
-        public static void IfArgumentEmpty(Guid value, [NotNull] string argumentName)
+        public static void IfArgumentEmpty(
+            Guid value,
+#if NET6_0_OR_GREATER
+            [System.Runtime.CompilerServices.CallerArgumentExpression("value")]
+            string? argumentName = null
+#else
+            string argumentName
+#endif
+        )
         {
             Fail.RequiresArgumentName(argumentName);
             Fail.IfEmpty(value, Violation.WhenGuidArgumentIsEmpty(argumentName));