V0.13.2 (#8)

* Refactored diffing strategy pipeline categories

* fixed bug in textnodefilter

* Code clean up

* 0.13.2 done

CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.13.2
+
+Released on Thursday, December 27, 2019.
+
+- Added code documentation to all public methods.
+- Refactored IDiffingStrategyCollection's methods to take a `StrategyType strategyType = StrategyType.Specialized` as input instead of `bool isSpecialized* = true` argument.
+- Fixed bug where `TextNodeFilter` would not give `<style>` and `<script>` the `WhitespaceOption.Preserve` by default.
+- Fixed bug where `IgnoreElementComparer` would not change a current decision to SKip if it was Same.
+
 # 0.13.1
 
 Released on Thursday, December 26, 2019.

src/.editorconfig

@@ -0,0 +1,227 @@
+# Remove the line below if you want to inherit .editorconfig settings from higher directories
+root = true
+
+# C# files
+[*.cs]
+
+#### Core EditorConfig Options ####
+
+# Indentation and spacing
+indent_size = 4
+indent_style = space
+tab_width = 4
+trim_trailing_whitespace = true
+
+# New line preferences
+end_of_line = crlf
+insert_final_newline = false
+
+#### .NET Coding Conventions ####
+
+# Organize usings
+dotnet_separate_import_directive_groups = true
+dotnet_sort_system_directives_first = true
+
+# this. and Me. preferences
+dotnet_style_qualification_for_event = false:silent
+dotnet_style_qualification_for_field = false:silent
+dotnet_style_qualification_for_method = false:silent
+dotnet_style_qualification_for_property = false:silent
+
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true:silent
+dotnet_style_predefined_type_for_member_access = true:silent
+
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = never_if_unnecessary:silent
+dotnet_style_parentheses_in_other_binary_operators = never_if_unnecessary:silent
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
+dotnet_style_parentheses_in_relational_binary_operators = never_if_unnecessary:silent
+
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
+
+# Expression-level preferences
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_prefer_compound_assignment = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+
+# Field preferences
+dotnet_style_readonly_field = true:suggestion
+
+# Parameter preferences
+dotnet_code_quality_unused_parameters = all:suggestion
+
+#### C# Coding Conventions ####
+
+# var preferences
+csharp_style_var_elsewhere = true:silent
+csharp_style_var_for_built_in_types = true:silent
+csharp_style_var_when_type_is_apparent = true:silent
+
+# Expression-bodied members
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_constructors = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = true:silent
+csharp_style_expression_bodied_methods = true:silent
+csharp_style_expression_bodied_operators = true:silent
+csharp_style_expression_bodied_properties = true:silent
+
+# Pattern matching preferences
+csharp_style_pattern_matching_over_as_with_null_check = true:warning
+csharp_style_pattern_matching_over_is_with_cast_check = true:warning
+csharp_style_prefer_switch_expression = true:suggestion
+
+# Null-checking preferences
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Modifier preferences
+csharp_prefer_static_local_function = true:suggestion
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:silent
+
+# Code-block preferences
+csharp_prefer_braces = when_multiline:silent
+csharp_prefer_simple_using_statement = true:suggestion
+
+# Expression-level preferences
+csharp_prefer_simple_default_expression = true:suggestion
+csharp_style_deconstructed_variable_declaration = true:suggestion
+csharp_style_inlined_variable_declaration = true:warning
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_prefer_index_operator = true:suggestion
+csharp_style_prefer_range_operator = true:suggestion
+csharp_style_throw_expression = true:suggestion
+csharp_style_unused_value_assignment_preference = discard_variable:suggestion
+csharp_style_unused_value_expression_statement_preference = discard_variable:silent
+
+# 'using' directive preferences
+csharp_using_directive_placement = outside_namespace:suggestion
+
+#### C# Formatting Rules ####
+
+# New line preferences
+csharp_new_line_before_catch = true
+csharp_new_line_before_else = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_open_brace = all
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = false
+csharp_indent_labels = no_change
+csharp_indent_switch_labels = true
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = false
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# Wrapping preferences
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = false
+
+#### Naming styles ####
+
+# Naming rules
+
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
+dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
+
+dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.types_should_be_pascal_case.symbols = types
+dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
+dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.static_field_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.static_field_should_be_pascal_case.symbols = static_field
+dotnet_naming_rule.static_field_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.const_field_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.const_field_should_be_pascal_case.symbols = const_field
+dotnet_naming_rule.const_field_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.private_or_internal_field_should_be_fields_begin_with__.severity = suggestion
+dotnet_naming_rule.private_or_internal_field_should_be_fields_begin_with__.symbols = private_or_internal_field
+dotnet_naming_rule.private_or_internal_field_should_be_fields_begin_with__.style = fields_begin_with__
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal
+dotnet_naming_symbols.interface.required_modifiers = 
+
+dotnet_naming_symbols.static_field.applicable_kinds = field
+dotnet_naming_symbols.static_field.applicable_accessibilities = public, internal, private, protected, protected_internal
+dotnet_naming_symbols.static_field.required_modifiers = static
+
+dotnet_naming_symbols.private_or_internal_field.applicable_kinds = field
+dotnet_naming_symbols.private_or_internal_field.applicable_accessibilities = internal, private
+dotnet_naming_symbols.private_or_internal_field.required_modifiers = 
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal
+dotnet_naming_symbols.types.required_modifiers = 
+
+dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal
+dotnet_naming_symbols.non_field_members.required_modifiers = 
+
+dotnet_naming_symbols.const_field.applicable_kinds = field
+dotnet_naming_symbols.const_field.applicable_accessibilities = *
+dotnet_naming_symbols.const_field.required_modifiers = const
+
+# Naming styles
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.begins_with_i.required_prefix = I
+dotnet_naming_style.begins_with_i.required_suffix = 
+dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.capitalization = pascal_case
+
+dotnet_naming_style.fields_begin_with__.required_prefix = _
+dotnet_naming_style.fields_begin_with__.required_suffix = 
+dotnet_naming_style.fields_begin_with__.word_separator = 
+dotnet_naming_style.fields_begin_with__.capitalization = camel_case

src/AngleSharp.Diffing.Tests/Core/AttributeComparisonSourceTest.cs

@@ -1,5 +1,7 @@
-using Shouldly;
-using System;
+using System;
+
+using Shouldly;
+
 using Xunit;
 
 namespace AngleSharp.Diffing.Core

src/AngleSharp.Diffing.Tests/Core/AttributeComparisonTest.cs

@@ -1,4 +1,5 @@
 using Shouldly;
+
 using Xunit;
 
 namespace AngleSharp.Diffing.Core

src/AngleSharp.Diffing.Tests/Core/ComparisonSourceTest.cs

@@ -1,5 +1,5 @@
-using System;
 using Shouldly;
+
 using Xunit;
 
 namespace AngleSharp.Diffing.Core

src/AngleSharp.Diffing.Tests/Core/DiffingEngineTestBase.cs

@@ -27,7 +27,7 @@ protected static HtmlDiffer CreateHtmlDiffer(
             );
         }
 
-        class MockDiffingStrategy : IDiffingStrategy
+        private class MockDiffingStrategy : IDiffingStrategy
         {
             private readonly Func<ComparisonSource, FilterDecision>? _nodeFilter;
             private readonly Func<AttributeComparisonSource, FilterDecision>? _attrFilter;

src/AngleSharp.Diffing.Tests/Core/HtmlDifferenceEngineTest.cs

@@ -1,10 +1,13 @@
 using System;
 using System.Collections.Generic;
-using AngleSharp.Dom;
+using System.Linq;
+
 using AngleSharp.Diffing.Strategies.NodeStrategies;
+using AngleSharp.Dom;
+
 using Shouldly;
+
 using Xunit;
-using System.Linq;
 
 namespace AngleSharp.Diffing.Core
 {
@@ -296,7 +299,7 @@ public void OnlyOnePartHasChildNodes(string control, string test, Type expectedD
             results.Count.ShouldBe(2);
             results[0].ShouldBeOfType<NodeDiff>();
             results[1].ShouldBeOfType(expectedDiffType);
-        }      
+        }
 
         [Fact(DisplayName = "Comparison sources have their type set correctly")]
         public void ComparisonSourcesHaveCorrectType()
@@ -400,7 +403,9 @@ private static IEnumerable<AttributeComparison> AttributeNameMatcher(IDiffContex
             foreach (var ctrlAttrSrc in controlAttrs)
             {
                 if (testAttrs.Contains(ctrlAttrSrc.Attribute.Name))
+                {
                     yield return new AttributeComparison(ctrlAttrSrc, testAttrs[ctrlAttrSrc.Attribute.Name]);
+                }
             }
         }
 

src/AngleSharp.Diffing.Tests/Core/SourceCollectionTest.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Linq;
+
 using Shouldly;
+
 using Xunit;
 
 namespace AngleSharp.Diffing.Core

src/AngleSharp.Diffing.Tests/Core/SourceMapTest.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Linq;
+
 using Shouldly;
+
 using Xunit;
 
 namespace AngleSharp.Diffing.Core

src/AngleSharp.Diffing.Tests/DiffBuilderTest.cs

@@ -1,8 +1,10 @@
 using System;
 using System.Linq;
+
 using AngleSharp.Diffing.Core;
-using AngleSharp.Diffing.Strategies;
+
 using Shouldly;
+
 using Xunit;
 
 namespace AngleSharp.Diffing

src/AngleSharp.Diffing.Tests/DiffingTestBase.cs

@@ -1,8 +1,8 @@
 using System.Collections.Generic;
-using AngleSharp;
-using AngleSharp.Dom;
-using AngleSharp.Html.Parser;
+
 using AngleSharp.Diffing.Core;
+using AngleSharp.Dom;
+
 using Xunit;
 
 namespace AngleSharp.Diffing

src/AngleSharp.Diffing.Tests/DiffingTestFixture.cs

@@ -1,5 +1,4 @@
-using AngleSharp;
-using AngleSharp.Dom;
+using AngleSharp.Dom;
 using AngleSharp.Html.Parser;
 
 namespace AngleSharp.Diffing

src/AngleSharp.Diffing.Tests/ShouldlyTestExtensions.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+
 using Shouldly;
 
 namespace AngleSharp.Diffing

src/AngleSharp.Diffing.Tests/Strategies/AttributeStrategies/AttributeComparerTest.cs

@@ -1,5 +1,7 @@
 using AngleSharp.Diffing.Core;
+
 using Shouldly;
+
 using Xunit;
 
 namespace AngleSharp.Diffing.Strategies.AttributeStrategies