Whitespace filter done

Author: egil

.vscode/launch.json

@@ -30,7 +30,7 @@ Using the `UseDefaultOptions()` method is equivalent to setting the following op
 var diffs = DiffBuilder
     .Compare(controlHtml)
     .WithTest(testHtml)
-    .RemoveComments()
+    .IgnoreComments()
     .Whitespace(WhitespaceOption.Normalize)
     .IgnoreDiffAttributes()
     .Build();
@@ -45,18 +45,18 @@ The library comes with a bunch of options (internally referred to as strategies)
 
 The following section document the current built-in strategies that are available. A later second will describe how to built your own strategies, to get very tight control of the diffing process.
 
-### Remove comments
-Enabling this strategy will remove all comment nodes from the comparison. Activate by calling the `RemoveComments()` method on a `DiffBuilder` instance, e.g.:
+### Ignore comments
+Enabling this strategy will ignore all comment nodes during comparison. Activate by calling the `IgnoreComments()` method on a `DiffBuilder` instance, e.g.:
 
 ```csharp
 var diffs = DiffBuilder
     .Compare(controlHtml)
     .WithTest(testHtml)
-    .RemoveComments()
+    .IgnoreComments()
     .Build();
 ```
 
-_NOTE: Currently, the remove comment strategy does NOT remove comments from CSS or JavaScript embedded in `<style>` or `<script>` tags.__
+_**NOTE**: Currently, the ignore comment strategy does NOT remove comments from CSS or JavaScript embedded in `<style>` or `<script>` tags._
 
 ### Whitespace handling
 Whitespace can be a source of false-positives when comparing two HTML fragments. Thus, the whitespace handling strategy offer different ways to deal with it during a comparison.

.vscode/tasks.json

@@ -11,13 +11,13 @@ public interface IFilterStrategy
         /// </summary>
         /// <param name="comparisonSource">A comparison source for the node</param>
         /// <returns>true if the node should be part of the comparison, false if the node should be filtered out.</returns>
-        bool Filter(in ComparisonSource comparisonSource);
+        FilterDecision Filter(in ComparisonSource comparisonSource);
 
         /// <summary>
         /// Decides whether an attribute should be part of the comparison.
         /// </summary>
         /// <param name="comparisonSource">A comparison source for the attribute</param>
         /// <returns>true if the attribute should be part of the comparison, false if the attribute should be filtered out.</returns>
-        bool Filter(in AttributeComparisonSource attributeComparisonSource);
+        FilterDecision Filter(in AttributeComparisonSource attributeComparisonSource);
     }
 }

README.md

@@ -5,7 +5,7 @@
 
 namespace Egil.AngleSharp.Diffing.Core
 {
-    public delegate bool SourceCollectionRemovePredicate(in ComparisonSource source);
+    public delegate FilterDecision SourceCollectionRemovePredicate(in ComparisonSource source);
 
     public class SourceCollection : IEnumerable<ComparisonSource>
     {
@@ -69,7 +69,7 @@ internal void Remove(SourceCollectionRemovePredicate predicate)
             for (int i = 0; i < _sources.Length; i++)
             {
                 var source = _sources[i];
-                if (!predicate(source))
+                if (predicate(source) == FilterDecision.Exclude)
                 {
                     _status[source.Index] = SOURCE_REMOVED;
                     Count--;

src/Core/IFilterStrategy.cs

@@ -6,7 +6,7 @@
 
 namespace Egil.AngleSharp.Diffing.Core
 {
-    public delegate bool SourceMapRemovePredicate(in AttributeComparisonSource source);
+    public delegate FilterDecision SourceMapRemovePredicate(in AttributeComparisonSource source);
 
     [SuppressMessage("Naming", "CA1710:Identifiers should have correct suffix")]
     public class SourceMap : IEnumerable<AttributeComparisonSource>
@@ -63,7 +63,7 @@ internal void Remove(SourceMapRemovePredicate predicate)
             var removeQueue = new Queue<string>(Count);
             foreach (var source in _sources.Values)
             {
-                if (!predicate(source)) removeQueue.Enqueue(source.Attribute.Name);
+                if (predicate(source) == FilterDecision.Exclude) removeQueue.Enqueue(source.Attribute.Name);
             }
             foreach (var name in removeQueue)
             {

src/Core/SourceCollection.cs

@@ -7,7 +7,8 @@
 
 namespace Egil.AngleSharp.Diffing
 {
-    public delegate bool FilterStrategy<TSource>(in TSource source, bool currentDecision);
+
+    public delegate FilterDecision FilterStrategy<TSource>(in TSource source, FilterDecision currentDecision);
     public delegate IEnumerable<TComparison> MatchStrategy<in TSources, out TComparison>(DiffContext context, TSources controlSources, TSources testSources);
     public delegate CompareResult CompareStrategy<TComparison>(in TComparison comparison, CompareResult currentDecision);
 
@@ -20,8 +21,8 @@ public class DiffingStrategyPipeline : IFilterStrategy, IMatcherStrategy, ICompa
         private readonly List<CompareStrategy<Comparison>> _nodeComparers = new List<CompareStrategy<Comparison>>();
         private readonly List<CompareStrategy<AttributeComparison>> _attrComparers = new List<CompareStrategy<AttributeComparison>>();
 
-        public bool Filter(in ComparisonSource comparisonSource) => Filter(comparisonSource, _nodeFilters);
-        public bool Filter(in AttributeComparisonSource attributeComparisonSource) => Filter(attributeComparisonSource, _attrsFilters);
+        public FilterDecision Filter(in ComparisonSource comparisonSource) => Filter(comparisonSource, _nodeFilters);
+        public FilterDecision Filter(in AttributeComparisonSource attributeComparisonSource) => Filter(attributeComparisonSource, _attrsFilters);
 
         public IEnumerable<Comparison> Match(DiffContext context, SourceCollection controlSources, SourceCollection testSources)
             => Match(context, controlSources, testSources, _nodeMatchers);
@@ -42,9 +43,9 @@ public CompareResult Compare(in AttributeComparison comparison)
         public void AddComparer(CompareStrategy<Comparison> compareStrategy) => _nodeComparers.Add(compareStrategy);
         public void AddComparer(CompareStrategy<AttributeComparison> compareStrategy) => _attrComparers.Add(compareStrategy);
 
-        private bool Filter<T>(in T source, List<FilterStrategy<T>> filterStrategies)
+        private FilterDecision Filter<T>(in T source, List<FilterStrategy<T>> filterStrategies)
         {
-            var result = true;
+            var result = FilterDecision.Keep;
             for (int i = 0; i < filterStrategies.Count; i++)
             {
                 result = filterStrategies[i](source, result);

src/Core/SourceMap.cs

@@ -4,6 +4,12 @@
     <TargetFramework>netstandard2.0</TargetFramework>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Compile Remove="Matchers\**" />
+    <EmbeddedResource Remove="Matchers\**" />
+    <None Remove="Matchers\**" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="AngleSharp" Version="$(AngleSharpVersion)" />
     <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.5">
@@ -12,8 +18,4 @@
     </PackageReference>
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="Matchers\" />
-  </ItemGroup>
-
 </Project>

src/DiffingStrategyPipeline.cs

@@ -0,0 +1,14 @@
+namespace Egil.AngleSharp.Diffing
+{
+    public enum FilterDecision
+    {
+        Keep = 0,
+        Exclude
+    }
+
+    public static class FilterDecisionExtensions
+    {
+        public static bool IsExclude(this FilterDecision decision) => decision == FilterDecision.Exclude;
+        public static bool IsKeep(this FilterDecision decision) => decision == FilterDecision.Keep;
+    }
+}