fix: IgnoreComparer should check for CompareDcision.Difference

Author: linkdotnet

src/AngleSharp.Diffing.Tests/Strategies/ElementStrategies/IgnoreAttributesElementComparerTest.cs

@@ -47,4 +47,24 @@ public void Test003(string controlHtml, string testHtml)
         IgnoreAttributesElementComparer.Compare(comparison, CompareResult.SkipChildren).ShouldBe(CompareResult.SkipChildrenAndAttributes);
         IgnoreAttributesElementComparer.Compare(comparison, CompareResult.SkipAttributes).ShouldBe(CompareResult.SkipAttributes);
     }
+
+    [Theory(DisplayName = "When control has 'diff:ignoreAttributes' and current decision is Different, returns DifferentAndSkipAttributes")]
+    [InlineData(@"<p diff:ignoreAttributes></p>")]
+    [InlineData(@"<p diff:ignoreAttributes=""true""></p>")]
+    public void Test004(string controlHtml)
+    {
+        var comparison = ToComparison(controlHtml, "<p></p>");
+
+        IgnoreAttributesElementComparer.Compare(comparison, CompareResult.Different).ShouldBe(CompareResult.DifferentAndSkipAttributes);
+    }
+
+    [Theory(DisplayName = "When control has 'diff:ignoreAttributes' and current decision is DifferentAndSkipChildren, returns DifferentAndSkipChildrenAndSkipAttributes")]
+    [InlineData(@"<p diff:ignoreAttributes></p>")]
+    [InlineData(@"<p diff:ignoreAttributes=""true""></p>")]
+    public void Test005(string controlHtml)
+    {
+        var comparison = ToComparison(controlHtml, "<p></p>");
+
+        IgnoreAttributesElementComparer.Compare(comparison, CompareResult.DifferentAndSkipChildren).ShouldBe(CompareResult.DifferentAndSkipChildrenAndSkipAttributes);
+    }
 }

src/AngleSharp.Diffing.Tests/Strategies/ElementStrategies/IgnoreChildrenElementComparerTest.cs

@@ -47,4 +47,24 @@ public void Test003(string controlHtml, string testHtml)
         IgnoreChildrenElementComparer.Compare(comparison, CompareResult.SkipAttributes).ShouldBe(CompareResult.SkipChildrenAndAttributes);
         IgnoreChildrenElementComparer.Compare(comparison, CompareResult.SkipChildren).ShouldBe(CompareResult.SkipChildren);
     }
+
+    [Theory(DisplayName = "When control has 'diff:ignoreChildren' and current decision is Different, returns DifferentAndSkipChildren")]
+    [InlineData(@"<p diff:ignoreChildren></p>")]
+    [InlineData(@"<p diff:ignoreChildren=""true""></p>")]
+    public void Test004(string controlHtml)
+    {
+        var comparison = ToComparison(controlHtml, "<p></p>");
+
+        IgnoreChildrenElementComparer.Compare(comparison, CompareResult.Different).ShouldBe(CompareResult.DifferentAndSkipChildren);
+    }
+
+    [Theory(DisplayName = "When control has 'diff:ignoreChildren' and current decision is DifferentAndSkipAttributes, returns DifferentAndSkipChildrenAndSkipAttributes")]
+    [InlineData(@"<p diff:ignoreChildren></p>")]
+    [InlineData(@"<p diff:ignoreChildren=""true""></p>")]
+    public void Test005(string controlHtml)
+    {
+        var comparison = ToComparison(controlHtml, "<p></p>");
+
+        IgnoreChildrenElementComparer.Compare(comparison, CompareResult.DifferentAndSkipAttributes).ShouldBe(CompareResult.DifferentAndSkipChildrenAndSkipAttributes);
+    }
 }

src/AngleSharp.Diffing/Core/CompareDecision.cs

@@ -30,5 +30,17 @@ public enum CompareDecision
     /// Use when the comparison should skip any attributes.
     /// </summary>
     SkipAttributes = 16,
+    /// <summary>
+    /// Use when the comparison is different and should skip children.
+    /// </summary>
+    DifferentAndSkipChildren = Different | SkipChildren,
+    /// <summary>
+    /// Use when the comparison is different and should skip attributes.
+    /// </summary>
+    DifferentAndSkipAttributes = Different | SkipAttributes,
+    /// <summary>
+    /// Use when the comparison is different and should skip both children and attributes.
+    /// </summary>
+    DifferentAndSkipChildrenAndSkipAttributes = Different | SkipChildren | SkipAttributes,
 }
 

src/AngleSharp.Diffing/Core/CompareResult.cs

@@ -33,7 +33,22 @@ public readonly record struct CompareResult(CompareDecision Decision, IDiff? Dif
     public static readonly CompareResult SkipAttributes = new(CompareDecision.SkipAttributes);
 
     /// <summary>
-    /// Use when the comparison should skip any attributes.
+    /// Use when the comparison should skip any attributes but has element differences.
+    /// </summary>
+    public static readonly CompareResult DifferentAndSkipAttributes = new(CompareDecision.Different | CompareDecision.SkipAttributes);
+
+    /// <summary>
+    /// Use when the comparison should skip any attributes and children but has element differences.
+    /// </summary>
+    public static readonly CompareResult DifferentAndSkipChildrenAndSkipAttributes = new(CompareDecision.Different | CompareDecision.SkipChildren | CompareDecision.SkipAttributes);
+
+    /// <summary>
+    /// Use when the comparison should skip children but has element differences.
+    /// </summary>
+    public static readonly CompareResult DifferentAndSkipChildren = new(CompareDecision.Different | CompareDecision.SkipChildren);
+
+    /// <summary>
+    /// Use when the comparison should skip any children and any attributes.
     /// </summary>
     public static readonly CompareResult SkipChildrenAndAttributes = new(CompareDecision.SkipChildren | CompareDecision.SkipAttributes);
 
@@ -50,7 +65,7 @@ public readonly record struct CompareResult(CompareDecision Decision, IDiff? Dif
     public static CompareResult FromDiff(IDiff diff) => new(CompareDecision.Different, diff);
 
     /// <summary>
-    /// Checks if a <see cref="CompareResult"/> is either a <see cref="CompareResult.Same"/> or <see cref="CompareResult.Skip"/>.
+    /// Checks if a <see cref="CompareResult"/> is either a <see cref="CompareDecision.Same"/> or <see cref="CompareDecision.Skip"/>.
     /// </summary>
-    public bool IsSameOrSkip => this == Same || this == Skip;
+    public bool IsSameOrSkip => Decision.HasFlag(CompareDecision.Same) || Decision.HasFlag(CompareDecision.Skip);
 }

src/AngleSharp.Diffing/Core/HtmlDifferenceEngine.cs

@@ -187,7 +187,7 @@ private IEnumerable<IDiff> CompareAttributes(IEnumerable<AttributeComparison> co
         foreach (var comparison in comparisons)
         {
             var compareRes = _diffingStrategy.Compare(comparison);
-            if (compareRes.Decision == CompareDecision.Different)
+            if (compareRes.Decision.HasFlag(CompareDecision.Different))
             {
                 yield return compareRes.Diff ?? new AttrDiff(comparison, AttrDiffKind.Unspecified);
             }

src/AngleSharp.Diffing/Strategies/ElementStrategies/IgnoreAttributesElementComparer.cs

@@ -22,8 +22,9 @@ public static CompareResult Compare(in Comparison comparison, CompareResult curr
         {
             CompareDecision.None => CompareResult.SkipAttributes,
             CompareDecision.Same => CompareResult.SkipAttributes,
-            CompareDecision.Different => CompareResult.SkipAttributes,
+            CompareDecision.Different => CompareResult.DifferentAndSkipAttributes,
             CompareDecision.SkipChildren => CompareResult.SkipChildrenAndAttributes,
+            CompareDecision.DifferentAndSkipChildren => CompareResult.DifferentAndSkipChildrenAndSkipAttributes,
             _ => currentDecision,
         };
     }

src/AngleSharp.Diffing/Strategies/ElementStrategies/IgnoreChildrenElementComparer.cs

@@ -12,7 +12,7 @@ public static class IgnoreChildrenElementComparer
     /// </summary>
     public static CompareResult Compare(in Comparison comparison, CompareResult currentDecision)
     {
-        if (currentDecision == CompareResult.Skip || currentDecision == CompareResult.SkipChildren || currentDecision == CompareResult.SkipChildrenAndAttributes)
+        if (currentDecision.Decision.HasFlag(CompareDecision.SkipChildren) || currentDecision.Decision.HasFlag(CompareDecision.Skip))
             return currentDecision;
 
         if (!ControlHasTruthyIgnoreChildrenAttribute(comparison))
@@ -22,7 +22,8 @@ public static CompareResult Compare(in Comparison comparison, CompareResult curr
         {
             CompareDecision.None => CompareResult.SkipChildren,
             CompareDecision.Same => CompareResult.SkipChildren,
-            CompareDecision.Different => CompareResult.SkipChildren,
+            CompareDecision.Different => CompareResult.DifferentAndSkipChildren,
+            CompareDecision.Different | CompareDecision.SkipAttributes => CompareResult.DifferentAndSkipChildrenAndSkipAttributes,
             CompareDecision.SkipAttributes => CompareResult.SkipChildrenAndAttributes,
             _ => currentDecision,
         };