Refactor tests and updated docs

Author: egil

README.md

@@ -130,8 +130,8 @@ By using the inline attribute `diff:regex` on the element containing the text no
 
 The above  control text would use case-insensitive regular expression to match against a test text string (e.g. "HELLO WORLD 2020").
 
-### Ignore attribute
-If the `diff:ignore="true"` attribute is used on a control element  (`="true"` implicit/optional), all their attributes and child nodes are skipped/ignored during comparison, including those of the test element, the control element is matched with.
+### Inline Ignore attribute
+If the inline `diff:ignore="true"` attribute is used on a control element  (`="true"` implicit/optional), all their attributes and child nodes are skipped/ignored during comparison, including those of the test element, the control element is matched with.
 
 In this example, the `<h1>` tag, it's attribute and children are considered the same as the element it is matched with:
 
@@ -155,7 +155,7 @@ Activate this strategy by calling the `EnableIgnoreAttribute()` method on a `Dif
 var diffs = DiffBuilder
     .Compare(controlHtml)
     .WithTest(testHtml)
-    .EnableIgnoreAttribute()
+    .EnableInlineIgnore()
     .Build();
 ```
 
@@ -167,13 +167,15 @@ var diffs = DiffBuilder
 
 #### CSS selector-cross tree matcher (node, attr)
 
-### Compare options
-#### Name/Type comparer (node, attr)
-#### Content comparer (text, attr)
-#### Content regex comparer (text, attr)
-#### IgnoreCase content comparer (text, attr)
+### Attr Compare options
+#### Name comparer (attr)
+#### Content comparer (attr)
+#### Content regex comparer (attr)
+#### IgnoreCase attr comparer (attr)
+#### Regex attr comparer (attr)
 #### Class attribute comparer (attr)
 #### Boolean-attribute comparer (attr)
+
 See rules at https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#boolean-attributes
 https://www.w3.org/TR/html52/infrastructure.html#sec-boolean-attributes
 https://gist.github.com/ArjanSchouten/0b8574a6ad7f5065a5e7

tests/Core/ComparisonSourceTest.cs

@@ -13,7 +13,7 @@ public class ComparisonSourceTest : DiffingTestBase
         [Fact(DisplayName = "Two sources are equal if all their properties are equal")]
         public void Test1()
         {
-            var node = ToNode("<br>");
+            var node =  ToNode("<br>");
             var source = new ComparisonSource(node, 1, "path", ComparisonSourceType.Control);
             var otherSource = new ComparisonSource(node, 1, "path", ComparisonSourceType.Control);
 

tests/Core/DiffingEngineTestBase.cs

@@ -0,0 +1,84 @@
+using System;
+using System.Collections.Generic;
+
+namespace Egil.AngleSharp.Diffing.Core
+{
+    public abstract class DiffingEngineTestBase : DiffingTestBase
+    {
+        protected static HtmlDifferenceEngine CreateHtmlDiffEngine(
+                Func<DiffContext, SourceCollection, SourceCollection, IEnumerable<Comparison>>? nodeMatcher = null,
+                Func<DiffContext, SourceMap, SourceMap, IEnumerable<AttributeComparison>>? attrMatcher = null,
+                Func<ComparisonSource, FilterDecision>? nodeFilter = null,
+                Func<AttributeComparisonSource, FilterDecision>? attrFilter = null,
+                Func<Comparison, CompareResult>? nodeComparer = null,
+                Func<AttributeComparison, CompareResult>? attrComparer = null
+            )
+        {
+            return new HtmlDifferenceEngine(
+                new MockFilterStrategy(nodeFilter, attrFilter),
+                new MockMatcherStrategy(nodeMatcher, attrMatcher),
+                new MockCompareStrategy(nodeComparer, attrComparer)
+            );
+        }
+
+        class MockMatcherStrategy : IMatcherStrategy
+        {
+            private readonly Func<DiffContext, SourceCollection, SourceCollection, IEnumerable<Comparison>>? _nodeMatcher;
+            private readonly Func<DiffContext, SourceMap, SourceMap, IEnumerable<AttributeComparison>>? _attrMatcher;
+
+            public MockMatcherStrategy(
+                Func<DiffContext, SourceCollection, SourceCollection, IEnumerable<Comparison>>? nodeMatcher = null,
+                Func<DiffContext, SourceMap, SourceMap, IEnumerable<AttributeComparison>>? attrMatcher = null)
+            {
+                _nodeMatcher = nodeMatcher;
+                _attrMatcher = attrMatcher;
+            }
+
+            public IEnumerable<Comparison> Match(
+                DiffContext context,
+                SourceCollection controlNodes,
+                SourceCollection testNodes) => _nodeMatcher!(context, controlNodes, testNodes);
+
+            public IEnumerable<AttributeComparison> Match(
+                DiffContext context,
+                SourceMap controlAttributes,
+                SourceMap testAttributes) => _attrMatcher!(context, controlAttributes, testAttributes);
+        }
+
+        class MockFilterStrategy : IFilterStrategy
+        {
+            private readonly Func<ComparisonSource, FilterDecision>? _nodeFilter;
+            private readonly Func<AttributeComparisonSource, FilterDecision>? _attrFilter;
+
+            public MockFilterStrategy(Func<ComparisonSource, FilterDecision>? nodeFilter = null, Func<AttributeComparisonSource, FilterDecision>? attrFilter = null)
+            {
+                _nodeFilter = nodeFilter;
+                _attrFilter = attrFilter;
+            }
+
+            public FilterDecision Filter(in AttributeComparisonSource attributeComparisonSource)
+                => _attrFilter!(attributeComparisonSource);
+
+            public FilterDecision Filter(in ComparisonSource comparisonSource)
+                => _nodeFilter!(comparisonSource);
+        }
+
+        class MockCompareStrategy : ICompareStrategy
+        {
+            private readonly Func<Comparison, CompareResult>? _nodeCompare;
+            private readonly Func<AttributeComparison, CompareResult>? _attrCompare;
+
+            public MockCompareStrategy(Func<Comparison, CompareResult>? nodeCompare = null, Func<AttributeComparison, CompareResult>? attrCompare = null)
+            {
+                _nodeCompare = nodeCompare;
+                _attrCompare = attrCompare;
+            }
+
+            public CompareResult Compare(in Comparison comparison)
+                => _nodeCompare!(comparison);
+
+            public CompareResult Compare(in AttributeComparison comparison)
+                => _attrCompare!(comparison);
+        }
+    }
+}

tests/Core/DiffingTestBase.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Generic;
 using AngleSharp;
 using AngleSharp.Dom;
@@ -64,81 +63,5 @@ protected AttributeComparison ToAttributeComparison(string controlHtml, string c
                 ToAttributeComparisonSource(testHtml, testAttrName, ComparisonSourceType.Test)
                 );
         }
-
-        protected static HtmlDifferenceEngine CreateHtmlDiffEngine(
-                Func<DiffContext, SourceCollection, SourceCollection, IEnumerable<Comparison>>? nodeMatcher = null,
-                Func<DiffContext, SourceMap, SourceMap, IEnumerable<AttributeComparison>>? attrMatcher = null,
-                Func<ComparisonSource, FilterDecision>? nodeFilter = null,
-                Func<AttributeComparisonSource, FilterDecision>? attrFilter = null,
-                Func<Comparison, CompareResult>? nodeComparer = null,
-                Func<AttributeComparison, CompareResult>? attrComparer = null
-            )
-        {
-            return new HtmlDifferenceEngine(
-                new MockFilterStrategy(nodeFilter, attrFilter),
-                new MockMatcherStrategy(nodeMatcher, attrMatcher),
-                new MockCompareStrategy(nodeComparer, attrComparer)
-            );
-        }
-
-        class MockMatcherStrategy : IMatcherStrategy
-        {
-            private readonly Func<DiffContext, SourceCollection, SourceCollection, IEnumerable<Comparison>>? _nodeMatcher;
-            private readonly Func<DiffContext, SourceMap, SourceMap, IEnumerable<AttributeComparison>>? _attrMatcher;
-
-            public MockMatcherStrategy(
-                Func<DiffContext, SourceCollection, SourceCollection, IEnumerable<Comparison>>? nodeMatcher = null,
-                Func<DiffContext, SourceMap, SourceMap, IEnumerable<AttributeComparison>>? attrMatcher = null)
-            {
-                _nodeMatcher = nodeMatcher;
-                _attrMatcher = attrMatcher;
-            }
-
-            public IEnumerable<Comparison> Match(
-                DiffContext context,
-                SourceCollection controlNodes,
-                SourceCollection testNodes) => _nodeMatcher!(context, controlNodes, testNodes);
-
-            public IEnumerable<AttributeComparison> Match(
-                DiffContext context,
-                SourceMap controlAttributes,
-                SourceMap testAttributes) => _attrMatcher!(context, controlAttributes, testAttributes);
-        }
-
-        class MockFilterStrategy : IFilterStrategy
-        {
-            private readonly Func<ComparisonSource, FilterDecision>? _nodeFilter;
-            private readonly Func<AttributeComparisonSource, FilterDecision>? _attrFilter;
-
-            public MockFilterStrategy(Func<ComparisonSource, FilterDecision>? nodeFilter = null, Func<AttributeComparisonSource, FilterDecision>? attrFilter = null)
-            {
-                _nodeFilter = nodeFilter;
-                _attrFilter = attrFilter;
-            }
-
-            public FilterDecision Filter(in AttributeComparisonSource attributeComparisonSource)
-                => _attrFilter!(attributeComparisonSource);
-
-            public FilterDecision Filter(in ComparisonSource comparisonSource)
-                => _nodeFilter!(comparisonSource);
-        }
-
-        class MockCompareStrategy : ICompareStrategy
-        {
-            private readonly Func<Comparison, CompareResult>? _nodeCompare;
-            private readonly Func<AttributeComparison, CompareResult>? _attrCompare;
-
-            public MockCompareStrategy(Func<Comparison, CompareResult>? nodeCompare = null, Func<AttributeComparison, CompareResult>? attrCompare = null)
-            {
-                _nodeCompare = nodeCompare;
-                _attrCompare = attrCompare;
-            }
-
-            public CompareResult Compare(in Comparison comparison)
-                => _nodeCompare!(comparison);
-
-            public CompareResult Compare(in AttributeComparison comparison)
-                => _attrCompare!(comparison);
-        }
     }
 }

tests/Core/HtmlDifferenceEngineTest.cs

@@ -6,7 +6,7 @@
 
 namespace Egil.AngleSharp.Diffing.Core
 {
-    public class HtmlDifferenceEngineTest : DiffingTestBase
+    public class HtmlDifferenceEngineTest : DiffingEngineTestBase
     {
         [Fact(DisplayName = "Unmatched nodes in control/test are returned as missing/unexpected diffs")]
         public void UnmatchedNodesBecomesMissingUnexpectedDiffs()

tests/Core/SourceMapTest.cs

@@ -7,23 +7,18 @@ namespace Egil.AngleSharp.Diffing.Core
 {
     public class SourceMapTest : DiffingTestBase
     {
-        private ComparisonSource CreateSource(string html, ComparisonSourceType sourceType = ComparisonSourceType.Control)
-        {
-            return ToNode(html).ToComparisonSource(0, sourceType);
-        }
-
         [Fact(DisplayName = "When initialized with a non-element an exception is thrown")]
         public void Test0()
         {
-            var source = CreateSource(@"textnode", ComparisonSourceType.Test);
+            var source = ToComparisonSource(@"textnode", ComparisonSourceType.Test);
 
             Should.Throw<ArgumentException>(() => new SourceMap(source));
         }
 
         [Fact(DisplayName = "When initializing with an element source, its source type is used and its attributes are added at sources to the map")]
         public void Test1()
         {
-            var elementSource = CreateSource(@"<p foo=""bar"" baz=""foo""></p>", ComparisonSourceType.Test);
+            var elementSource = ToComparisonSource(@"<p foo=""bar"" baz=""foo""></p>", ComparisonSourceType.Test);
             var sut = new SourceMap(elementSource);
 
             sut.SourceType.ShouldBe(ComparisonSourceType.Test);
@@ -41,7 +36,7 @@ public void Test1()
         [Fact(DisplayName = "Accessing the indexer with a attr name that is not in the set throws")]
         public void Test2()
         {
-            var elementSource = CreateSource(@"<p></p>");
+            var elementSource = ToComparisonSource(@"<p></p>");
             var sut = new SourceMap(elementSource);
 
             Should.Throw<ArgumentException>(() => sut["foo"])
@@ -53,7 +48,7 @@ public void Test2()
         [InlineData(@"<p>", false)]
         public void Tests3(string html, bool expectedResult)
         {
-            var elementSource = CreateSource(html);
+            var elementSource = ToComparisonSource(html);
             var sut = new SourceMap(elementSource);
 
             sut.Contains("foo").ShouldBe(expectedResult);
@@ -62,7 +57,7 @@ public void Tests3(string html, bool expectedResult)
         [Fact(DisplayName = "Sources can be removed from map by passing a predicate to the Remove method")]
         public void Test4()
         {
-            var elementSource = CreateSource(@"<p foo=""bar"" baz=""foo""></p>");
+            var elementSource = ToComparisonSource(@"<p foo=""bar"" baz=""foo""></p>");
             var sut = new SourceMap(elementSource);
 
             sut.Remove((in AttributeComparisonSource cs) => cs.Attribute.Name == "foo" ? FilterDecision.Exclude : FilterDecision.Keep);
@@ -74,7 +69,7 @@ public void Test4()
         [Fact(DisplayName = "When a source is marked as matched, it is not returned in GetUnmatched")]
         public void Test5()
         {
-            var elementSource = CreateSource(@"<p foo=""bar"" baz=""foo""></p>");
+            var elementSource = ToComparisonSource(@"<p foo=""bar"" baz=""foo""></p>");
             var sut = new SourceMap(elementSource);
             var foo = sut["foo"];
 

tests/Strategies/IgnoreStrategies/IgnoreDiffAttributesFilterTest.cs

@@ -17,9 +17,7 @@ public class IgnoreDiffAttributesFilterTest : DiffingTestBase
         [InlineData(@"<p diff:ignore=""true"">", "diff:ignore")]
         public void Test1(string elementHtml, string diffAttrName)
         {
-            var elmSource = ToComparisonSource(elementHtml);
-            var attr = ((IElement)elmSource.Node).Attributes[diffAttrName];
-            var source = new AttributeComparisonSource(attr, elmSource);
+            var source = ToAttributeComparisonSource(elementHtml, diffAttrName);
 
             IgnoreDiffAttributesFilter.Filter(source, FilterDecision.Keep).ShouldBe(FilterDecision.Exclude);
         }
@@ -30,9 +28,7 @@ public void Test1(string elementHtml, string diffAttrName)
         [InlineData(@"<p diffx=""foo"">", "diffx")]
         public void Test2(string elementHtml, string diffAttrName)
         {
-            var elmSource = ToComparisonSource(elementHtml);
-            var attr = ((IElement)elmSource.Node).Attributes[diffAttrName];
-            var source = new AttributeComparisonSource(attr, elmSource);
+            var source = ToAttributeComparisonSource(elementHtml, diffAttrName);
 
             IgnoreDiffAttributesFilter.Filter(source, FilterDecision.Keep).ShouldBe(FilterDecision.Keep);
         }

tests/Strategies/IgnoreStrategies/InlineIgnoreAttributeMatcherTest.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Egil.AngleSharp.Diffing.Strategies.IgnoreStrategies
+{
+    public class InlineIgnoreAttributeMatcherTest 
+    {
+        // When a control attribute has the ':ignore' postfix, the postfix should not be used when matching with test attributes
+    }
+}