#28: Synergy.Contracts: Added date.FailIfEmpty() method

synergy-software · Feb 3, 2024 · d731659 · d731659
1 parent a56ab08
commit d731659
Show file tree

Hide file tree

Showing 5 changed files with 33 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
@@ -52,8 +52,8 @@
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.FailIfEmpty(
      value: DateTime,
-     name: string [NotNull, NotNull]
-   ) : DateTime [Extension, AssertionMethod]
+     name: string? [CallerArgumentExpression, Optional]
+   ) : DateTime [NullableContext, Extension, AssertionMethod]
  - Fail.FailIfEnumOutOfRange<T>(
      value: Enum [NotNull, NotNull],
      name: 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
@@ -52,8 +52,8 @@
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.FailIfEmpty(
      value: DateTime,
-     name: string [NotNull, NotNull]
-   ) : DateTime [Extension, AssertionMethod]
+     name: string? [CallerArgumentExpression, Optional]
+   ) : DateTime [NullableContext, Extension, AssertionMethod]
  - Fail.FailIfEnumOutOfRange<T>(
      value: Enum [NotNull, NotNull],
      name: 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
@@ -52,8 +52,8 @@
    ) : T? [Extension, NotNull, AssertionMethod, ContractAnnotation]
  - Fail.FailIfEmpty(
      value: DateTime,
-     name: string [NotNull, NotNull]
-   ) : DateTime [Extension, AssertionMethod]
+     name: string? [CallerArgumentExpression, Optional]
+   ) : DateTime [NullableContext, Extension, AssertionMethod]
  - Fail.FailIfEnumOutOfRange<T>(
      value: Enum [NotNull, NotNull],
      name: string [NotNull, NotNull]

diff --git a/Contracts/Synergy.Contracts.Test/Failures/FailDateTimeTest.cs b/Contracts/Synergy.Contracts.Test/Failures/FailDateTimeTest.cs
@@ -251,13 +251,30 @@ public void FailIfDateEmpty()
             // ASSERT
             Assert.That(exception.Message, Is.EqualTo("'minDate' is empty = 01/01/0001 00:00:00"));
         }
+
+        [Test]
+        public void FailIfDateEmptyCallerArgumentExpression()
+        {
+            // ARRANGE
+            DateTime minDate = DateTime.MinValue;
+
+            // ACT
+            var exception = Assert.Throws<DesignByContractViolationException>(
+                () => minDate.FailIfEmpty()
+            );
+
+            // ASSERT
+            Assert.That(exception.Message, Is.EqualTo("'minDate' is empty = 01/01/0001 00:00:00"));
+        }
 
         [Test]
         public void FailIfDateEmptySuccess()
         {
             // ACT
             // ReSharper disable once UnusedVariable
-            var date = DateTime.Today.FailIfEmpty(nameof(DateTime.Today));
+            var date1 = DateTime.Today.FailIfEmpty(nameof(DateTime.Today));
+            // ReSharper disable once UnusedVariable
+            var date2 = DateTime.Today.FailIfEmpty();
         }
 
         #endregion

diff --git a/Contracts/Synergy.Contracts/Failures/FailDateTime.cs b/Contracts/Synergy.Contracts/Failures/FailDateTime.cs
@@ -161,7 +161,15 @@ string name
         /// <param name="value">DateTime to check</param>
         /// <param name="name">Name of the checked argument / parameter.</param>
         [AssertionMethod]
-        public static DateTime FailIfEmpty(this DateTime value, [NotNull] [System.Diagnostics.CodeAnalysis.NotNull] string name)
+        public static DateTime FailIfEmpty(
+            this DateTime value, 
+#if NET6_0_OR_GREATER
+            [System.Runtime.CompilerServices.CallerArgumentExpression("value")]
+            string? name = null
+#else
+            string name
+#endif
+            )
         {
             Fail.IfEmpty(value, name);
             return value;