deprecate Is, add Matches (#72)

theramis · Jan 11, 2021 · f8b66ec · f8b66ec
1 parent cb8c24f
commit f8b66ec
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/project/Snapper.Nunit/SnapConstraint.cs b/project/Snapper.Nunit/SnapConstraint.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using NUnit.Framework.Constraints;
 using Snapper.Core;
 
@@ -14,6 +14,7 @@ public static EqualToSnapshotConstraint EqualToSnapshot(this ConstraintExpressio
         }
     }
 
+    [Obsolete("Snapper.Nunit.Is will be removed in a future release.  Please use Snapper.Nunit.Matches")]
     public class Is : NUnit.Framework.Is
     {
         public static EqualToSnapshotConstraint EqualToSnapshot()
@@ -32,6 +33,19 @@ public static EqualToSnapshotConstraint EqualToChildSnapshot(string childSnapsho
         }
     }
 
+    public class Matches
+    {
+        public static EqualToSnapshotConstraint Snapshot()
+        {
+            return new EqualToSnapshotConstraint();
+        }
+
+        public static EqualToSnapshotConstraint ChildSnapshot(string snapshotName)
+        {
+            return new EqualToSnapshotConstraint(snapshotName);
+        }
+    }
+
     public class EqualToSnapshotConstraint : Constraint
     {
         private readonly SnapshotId _snapshotId;

diff --git a/project/Tests/Snapper.Nunit.Tests/NUnitSnapperTests.cs b/project/Tests/Snapper.Nunit.Tests/NUnitSnapperTests.cs
@@ -1,4 +1,4 @@
-using System.Runtime.CompilerServices;
+using System.Runtime.CompilerServices;
 using Newtonsoft.Json.Linq;
 using NUnit.Framework;
 
@@ -14,7 +14,7 @@ public void TestIfStoredSnapshotIsMatching()
             {
                 {"TestProperty", "TestValue"}
             };
-            Assert.That(actual, Is.EqualToSnapshot());
+            Assert.That(actual, Matches.Snapshot());
         }
 
         [Test]
@@ -25,7 +25,7 @@ public void TestIfNamedStoredSnapshotIsMatching()
             {
                 {"TestProperty2", "TestValue2"}
             };
-            Assert.That(actual, Is.EqualToChildSnapshot("ChildSnapshot"));
+            Assert.That(actual, Matches.ChildSnapshot("ChildSnapshot"));
         }
     }
 }