#28: Synergy.Contracts: Added Fail.IfCollectionContainsNull(collectio…

…n) method
synergy-software · Feb 3, 2024 · 817e4ab · 817e4ab
1 parent fb11baf
commit 817e4ab
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 5 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
@@ -102,7 +102,7 @@
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfCollectionContainsNull<T>(
      collection: IEnumerable<T> [CanBeNull, AssertionCondition],
-     collectionName: string [NotNull, NotNull]
+     collectionName: string? [Nullable, CallerArgumentExpression, Optional]
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfCollectionEmpty(
      collection: IEnumerable [CanBeNull, AssertionCondition],

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
@@ -102,7 +102,7 @@
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfCollectionContainsNull<T>(
      collection: IEnumerable<T> [CanBeNull, AssertionCondition],
-     collectionName: string [NotNull, NotNull]
+     collectionName: string? [Nullable, CallerArgumentExpression, Optional]
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfCollectionEmpty(
      collection: IEnumerable [CanBeNull, AssertionCondition],

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
@@ -102,7 +102,7 @@
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfCollectionContainsNull<T>(
      collection: IEnumerable<T> [CanBeNull, AssertionCondition],
-     collectionName: string [NotNull, NotNull]
+     collectionName: string? [Nullable, CallerArgumentExpression, Optional]
    ) : void [AssertionMethod, ContractAnnotation]
  - Fail.IfCollectionEmpty(
      collection: IEnumerable [CanBeNull, AssertionCondition],

diff --git a/Contracts/Synergy.Contracts.Test/Failures/FailCollectionTest.cs b/Contracts/Synergy.Contracts.Test/Failures/FailCollectionTest.cs
@@ -118,12 +118,22 @@ public void IfCollectionContainsNull([CanBeNull] IEnumerable<object> collection)
                 () => Fail.IfCollectionContainsNull(collection, nameof(collection))
             );
         }
+
+        [Test]
+        [TestCaseSource(nameof(FailCollectionTest.GetCollectionsWithNull))]
+        public void IfCollectionContainsNullCallerArgumentExpression([CanBeNull] IEnumerable<object> collection)
+        {
+            Assert.Throws<DesignByContractViolationException>(
+                () => Fail.IfCollectionContainsNull(collection)
+            );
+        }
 
         [Test]
         [TestCaseSource(nameof(FailCollectionTest.GetCollectionsWithoutNull))]
         public void IfCollectionContainsNullSuccess([CanBeNull] IEnumerable<object> collection)
         {
             Fail.IfCollectionContainsNull(collection, nameof(collection));
+            Fail.IfCollectionContainsNull(collection);
         }
 
         #endregion

diff --git a/Contracts/Synergy.Contracts/Failures/FailCollection.cs b/Contracts/Synergy.Contracts/Failures/FailCollection.cs
@@ -138,7 +138,11 @@ private static bool IsEmpty([NotNull] [System.Diagnostics.CodeAnalysis.NotNull]
         public static void IfCollectionContainsNull<T>(
             [CanBeNull, AssertionCondition(AssertionConditionType.IS_NOT_NULL)]
             IEnumerable<T> collection,
-            [NotNull] [System.Diagnostics.CodeAnalysis.NotNull] string collectionName
+#if NET6_0_OR_GREATER
+            [System.Runtime.CompilerServices.CallerArgumentExpression("collection")] string? collectionName = null
+#else
+            string collectionName
+#endif
         )
             where T : class
         {
@@ -221,7 +225,7 @@ Violation message
         /// Checks if collection name was provided.
         /// </summary>
         [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
-        private static void RequiresCollectionName([NotNull] [System.Diagnostics.CodeAnalysis.NotNull] string collectionName)
+        private static void RequiresCollectionName(string collectionName)
         {
             if (string.IsNullOrWhiteSpace(collectionName))
                 throw new ArgumentNullException(nameof(collectionName));