rename prop IsStrictlyOrdered, tests + reorder test's methods

Author: maximiliysiss

Src/FluentAssertions.Json/Common/JTokenExtensions.cs

@@ -5,6 +5,11 @@ namespace FluentAssertions.Json.Common
 {
     internal static class JTokenExtensions
     {
+        /// <summary>
+        /// Recursively sorts the properties of JObject instances by name and
+        /// the elements of JArray instances by their string representation,
+        /// producing a normalized JToken for consistent comparison
+        /// </summary>
         public static JToken Normalize(this JToken token)
         {
             return token switch

Src/FluentAssertions.Json/JTokenDifferentiator.cs

@@ -41,7 +41,7 @@ public Difference FindFirstDifference(JToken actual, JToken expected)
                 return new Difference(DifferenceKind.ExpectedIsNull, path);
             }
 
-            if (options.IsStrictOrdering is false)
+            if (!options.IsStrictlyOrdered)
             {
                 actual = actual.Normalize();
                 expected = expected.Normalize();

Src/FluentAssertions.Json/JsonAssertionOptions.cs

@@ -14,7 +14,7 @@ public JsonAssertionOptions(EquivalencyOptions<T> equivalencyAssertionOptions) :
         {
         }
 
-        internal bool IsStrictOrdering { get; private set; } = true;
+        internal bool IsStrictlyOrdered { get; private set; } = true;
 
         public new IJsonAssertionRestriction<T, TProperty> Using<TProperty>(Action<IAssertionContext<TProperty>> action)
         {
@@ -23,7 +23,7 @@ public JsonAssertionOptions(EquivalencyOptions<T> equivalencyAssertionOptions) :
 
         public new IJsonAssertionOptions<T> WithoutStrictOrdering()
         {
-            IsStrictOrdering = false;
+            IsStrictlyOrdered = false;
             return this;
         }
     }

Tests/FluentAssertions.Json.Specs/WithoutStrictOrderingSpecs.cs

@@ -9,61 +9,61 @@ namespace FluentAssertions.Json.Specs
     public class WithoutStrictOrderingSpecs
     {
         [Theory]
-        [MemberData(nameof(Should_HandleJToken_WhenNeedToIgnoreOrdering_SampleData))]
-        public void Should_HandleJToken_WhenNeedToIgnoreOrdering(string json1, string json2)
+        [MemberData(nameof(When_ignoring_ordering_BeEquivalentTo_should_succeed_sample_data))]
+        public void When_ignoring_ordering_BeEquivalentTo_should_succeed(string subject, string expectation)
         {
             // Arrange
-            var j1 = JToken.Parse(json1);
-            var j2 = JToken.Parse(json2);
+            var subjectJToken = JToken.Parse(subject);
+            var expectationJToken = JToken.Parse(expectation);
 
             // Act
-            j1.Should().BeEquivalentTo(j2, opt => opt.WithoutStrictOrdering());
+            subjectJToken.Should().BeEquivalentTo(expectationJToken, opt => opt.WithoutStrictOrdering());
 
             // Assert
         }
 
-        [Theory]
-        [MemberData(nameof(Should_DoNotHandleJToken_WhenNoNeedToIgnoreOrdering_SampleData))]
-        public void Should_DoNotHandleJToken_WhenNoNeedToIgnoreOrdering(string json1, string json2)
-        {
-            // Arrange
-            var j1 = JToken.Parse(json1);
-            var j2 = JToken.Parse(json2);
-
-            // Act
-            var action = new Func<AndConstraint<JTokenAssertions>>(() => j1.Should().BeEquivalentTo(j2));
-
-            // Assert
-            action.Should().Throw<XunitException>();
-        }
-
-        public static IEnumerable<object[]> Should_DoNotHandleJToken_WhenNoNeedToIgnoreOrdering_SampleData()
+        public static IEnumerable<object[]> When_ignoring_ordering_BeEquivalentTo_should_succeed_sample_data()
         {
             yield return new object[] { @"{""ids"":[1,2,3]}", @"{""ids"":[3,2,1]}" };
+            yield return new object[] { @"{""ids"":[1,2,3]}", @"{""ids"":[1,2,3]}" };
+            yield return new object[] { @"{""type"":2,""name"":""b""}", @"{""name"":""b"",""type"":2}" };
             yield return new object[] { @"{""names"":[""a"",""b""]}", @"{""names"":[""b"",""a""]}" };
             yield return new object[]
             {
                 @"{""vals"":[{""type"":1,""name"":""a""},{""name"":""b"",""type"":2}]}",
                 @"{""vals"":[{""type"":2,""name"":""b""},{""name"":""a"",""type"":1}]}"
             };
+            yield return new object[]
+            {
+                @"{""vals"":[{""type"":1,""name"":""a""},{""name"":""b"",""type"":2}]}",
+                @"{""vals"":[{""name"":""a"",""type"":1},{""type"":2,""name"":""b""}]}"
+            };
         }
 
-        public static IEnumerable<object[]> Should_HandleJToken_WhenNeedToIgnoreOrdering_SampleData()
+        [Theory]
+        [MemberData(nameof(When_not_ignoring_ordering_BeEquivalentTo_should_throw_sample_data))]
+        public void When_not_ignoring_ordering_BeEquivalentTo_should_throw(string subject, string expectation)
+        {
+            // Arrange
+            var subjectJToken = JToken.Parse(subject);
+            var expectationJToken = JToken.Parse(expectation);
+
+            // Act
+            var action = new Func<AndConstraint<JTokenAssertions>>(() => subjectJToken.Should().BeEquivalentTo(expectationJToken));
+
+            // Assert
+            action.Should().Throw<XunitException>();
+        }
+
+        public static IEnumerable<object[]> When_not_ignoring_ordering_BeEquivalentTo_should_throw_sample_data()
         {
             yield return new object[] { @"{""ids"":[1,2,3]}", @"{""ids"":[3,2,1]}" };
-            yield return new object[] { @"{""ids"":[1,2,3]}", @"{""ids"":[1,2,3]}" };
-            yield return new object[] { @"{""type"":2,""name"":""b""}", @"{""name"":""b"",""type"":2}" };
             yield return new object[] { @"{""names"":[""a"",""b""]}", @"{""names"":[""b"",""a""]}" };
             yield return new object[]
             {
                 @"{""vals"":[{""type"":1,""name"":""a""},{""name"":""b"",""type"":2}]}",
                 @"{""vals"":[{""type"":2,""name"":""b""},{""name"":""a"",""type"":1}]}"
             };
-            yield return new object[]
-            {
-                @"{""vals"":[{""type"":1,""name"":""a""},{""name"":""b"",""type"":2}]}",
-                @"{""vals"":[{""name"":""a"",""type"":1},{""type"":2,""name"":""b""}]}"
-            };
         }
     }
 }