Squashed commit of the following:

commit efd9467
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 24 11:56:22 2019 +0000

    Updated changelog

commit 8694b8f
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 24 11:52:27 2019 +0000

    Added HtmlDifferenceEngine.Compare(INode controlNode, INode testNode) to make it easier to compare single nodes to each other.

commit 6346069
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 22 13:54:25 2019 +0000

    Added docs to AttributeComparisonSource

commit 585337d
Merge: 5085ed2 282f679
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 3 23:59:38 2019 +0000

    Merge from master

commit 5085ed2
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 3 23:37:13 2019 +0000

    Tweaks to cake config

commit 38b46ed
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 3 23:19:08 2019 +0000

    Enabled build during Unit Test cake step

commit 3ff9e47
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 3 23:17:01 2019 +0000

    Enabled build during Create Package cake step

commit fc2a527
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 3 23:13:21 2019 +0000

    Reverted back to older version of tunnelvisionlabs.referenceassemblyannotator

commit b5a823c
Author: Egil Hansen <[email protected]>
Date:   Sun Nov 3 23:05:30 2019 +0000

    Preview 1 release

commit e4502f6
Author: Egil Hansen <[email protected]>
Date:   Sat Nov 2 15:31:09 2019 +0000

    Small tweaks to api

commit 8449eab
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 23:16:13 2019 +0000

    Tweaked DiffBuilders options handling, updated documentation

commit 62ada9f
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 21:57:32 2019 +0000

    Added docs generation

commit 290d431
Merge: e2c88f2 8fe6a54
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 21:34:01 2019 +0000

    Merge pull request #2 from AngleSharp/feature/anglesharp-cicd

    AngleSharp CI/CD

commit 8fe6a54
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 21:27:40 2019 +0000

    Remove appveyor logger during testing

commit 5d6460d
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 21:17:49 2019 +0000

    Fixed WithDefaultOptions logic where text nodes was compared by a naive node comparer, not text comparer

commit 64bae82
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 20:53:01 2019 +0000

    more fixes after merge

commit baef331
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 20:43:47 2019 +0000

    fixes after namespace changes

commit d99c828
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 14:50:36 2019 +0000

    renamed builder for more flexibility and usecases

commit 5d4a245
Merge: 038c640 6057251
Author: Florian Rappl <[email protected]>
Date:   Fri Nov 1 11:50:55 2019 +0100

    Merge branch 'feature/anglesharp-cicd' of github.com:AngleSharp/AngleSharp.Diffing into feature/anglesharp-cicd

commit 6057251
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 10:49:03 2019 +0000

    additional cleanup of csproj

commit 038c640
Merge: 9a161f7 44c8c69
Author: Florian Rappl <[email protected]>
Date:   Fri Nov 1 11:46:20 2019 +0100

    Merge branch 'feature/anglesharp-cicd' of github.com:AngleSharp/AngleSharp.Diffing into feature/anglesharp-cicd

commit 9a161f7
Author: Florian Rappl <[email protected]>
Date:   Fri Nov 1 11:46:12 2019 +0100

    Namespace renamed

commit 44c8c69
Author: Egil Hansen <[email protected]>
Date:   Fri Nov 1 10:38:37 2019 +0000

    cleanup of csproj

commit 9a33131
Author: Egil Hansen <[email protected]>
Date:   Thu Oct 31 23:16:36 2019 +0000

    Removed CI github action

commit 06f0a68
Author: Florian Rappl <[email protected]>
Date:   Thu Oct 31 23:52:37 2019 +0100

    Try 2019 image

commit 68f2f26
Author: Egil Hansen <[email protected]>
Date:   Thu Oct 31 21:54:02 2019 +0000

    Fixed path issues and C# version/target

commit ed9f4b9
Author: Florian Rappl <[email protected]>
Date:   Thu Oct 31 22:26:11 2019 +0100

    Updated devel to dev

commit 4f62811
Author: Florian Rappl <[email protected]>
Date:   Thu Oct 31 22:23:26 2019 +0100

    Build process set up

commit 720e482
Author: Florian Rappl <[email protected]>
Date:   Thu Oct 31 22:23:18 2019 +0100

    Ignore tools

commit 1863844
Author: Florian Rappl <[email protected]>
Date:   Thu Oct 31 22:23:08 2019 +0100

    Add changelog

commit 6589ed1
Merge: 217bb3f 3fdf871
Author: Florian Rappl <[email protected]>
Date:   Thu Oct 31 22:23:01 2019 +0100

    Moved files / folder structure

commit 3fdf871
Author: Florian Rappl <[email protected]>
Date:   Sat May 18 14:06:25 2019 +0200

    Added tools

commit 246f382
Author: Florian Rappl <[email protected]>
Date:   Sat May 18 13:48:06 2019 +0200

    Updated info on common files

commit 2d54c6e
Author: Florian Rappl <[email protected]>
Date:   Sat May 18 13:38:10 2019 +0200

    Initial commit

Author: egil

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.13.0-preview-3
+
+Released on Sunday, November 24, 2019.
+
+- Added `Compare(INode controlNode, INode testNode)` to HtmlDifferenceEngine
+- Changed existing `Compare` method in HtmlDifferenceEngine to take `IEnumerable<INode>` instead of `INodeList`.
+
 # 0.13.0-preview-2
 
 Released on Sunday, November 3, 2019.

src/AngleSharp.Diffing/Core/AttributeComparisonSource.cs

@@ -7,12 +7,24 @@ namespace AngleSharp.Diffing.Core
 {
     public readonly struct AttributeComparisonSource : IEquatable<AttributeComparisonSource>, IComparisonSource
     {
+        /// <summary>
+        /// Gets the attribute attached to this source.
+        /// </summary>
         public IAttr Attribute { get; }
 
+        /// <summary>
+        /// Gets the element source this attribute source is related to.
+        /// </summary>
         public ComparisonSource ElementSource { get; }
 
+        /// <summary>
+        /// Gets the path to the attribute in the source node tree.
+        /// </summary>
         public string Path { get; }
 
+        /// <summary>
+        /// Gets the source type, e.g. if it is a test or control source.
+        /// </summary>
         public ComparisonSourceType SourceType { get; }
 
         [SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase", Justification = "Path should be in lower case")]
@@ -29,13 +41,13 @@ public AttributeComparisonSource(string attributeName, in ComparisonSource eleme
         }
 
         #region Equals and HashCode
-        #pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
         public bool Equals(AttributeComparisonSource other) => Object.ReferenceEquals(Attribute, other.Attribute) && Path.Equals(other.Path, StringComparison.Ordinal) && ElementSource.Equals(other.ElementSource);
         public override int GetHashCode() => (Attribute, ElementSource).GetHashCode();
         public override bool Equals(object? obj) => obj is AttributeComparisonSource other && Equals(other);
         public static bool operator ==(AttributeComparisonSource left, AttributeComparisonSource right) => left.Equals(right);
         public static bool operator !=(AttributeComparisonSource left, AttributeComparisonSource right) => !left.Equals(right);
-        #pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
         #endregion
     }
 }

src/AngleSharp.Diffing/Core/HtmlDifferenceEngine.cs

@@ -16,29 +16,37 @@ public HtmlDifferenceEngine(IDiffingStrategy diffingStrategy)
             _diffingStrategy = diffingStrategy ?? throw new ArgumentNullException(nameof(diffingStrategy));
         }
 
-        public IEnumerable<IDiff> Compare(INodeList controlNodes, INodeList testNodes)
+        public IEnumerable<IDiff> Compare(INode controlNode, INode testNode)
+        {
+            if (controlNode is null) throw new ArgumentNullException(nameof(controlNode));
+            if (testNode is null) throw new ArgumentNullException(nameof(testNode));
+
+            return Compare(new[] { controlNode }, new[] { testNode });
+        }
+
+        public IEnumerable<IDiff> Compare(IEnumerable<INode> controlNodes, IEnumerable<INode> testNodes)
         {
             if (controlNodes is null) throw new ArgumentNullException(nameof(controlNodes));
             if (testNodes is null) throw new ArgumentNullException(nameof(testNodes));
 
             var controlSources = controlNodes.ToSourceCollection(ComparisonSourceType.Control);
             var testSources = testNodes.ToSourceCollection(ComparisonSourceType.Test);
 
-            var context = CreateDiffContext(controlNodes, testNodes);
+            var context = CreateDiffContext(controlSources, testSources);
 
             var diffs = CompareNodeLists(context, controlSources, testSources);
             var unmatchedDiffs = context.GetDiffsFromUnmatched();
 
             return diffs.Concat(unmatchedDiffs);
         }
 
-        private static DiffContext CreateDiffContext(INodeList controlNodes, INodeList testNodes)
+        private static DiffContext CreateDiffContext(SourceCollection controlNodes, SourceCollection testNodes)
         {
             IElement? controlRoot = null;
             IElement? testRoot = null;
 
-            if (controlNodes.Length > 0 && controlNodes[0].GetRoot() is IElement r1) { controlRoot = r1; }
-            if (testNodes.Length > 0 && testNodes[0].GetRoot() is IElement r2) { testRoot = r2; }
+            if (controlNodes.Count > 0 && controlNodes.First().Node.GetRoot() is IElement r1) { controlRoot = r1; }
+            if (testNodes.Count > 0 && testNodes.First().Node.GetRoot() is IElement r2) { testRoot = r2; }
 
             return new DiffContext(controlRoot, testRoot);
         }

src/AngleSharp.Diffing/Extensions/NodeListExtensions.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using AngleSharp.Dom;
 using AngleSharp.Diffing.Core;
@@ -7,18 +7,20 @@ namespace AngleSharp.Diffing
 {
     public static class AngleSharpDomExtensions
     {
-        public static SourceCollection ToSourceCollection(this INodeList nodelist, ComparisonSourceType sourceType, string path = "")
+        public static SourceCollection ToSourceCollection(this IEnumerable<INode> nodelist, ComparisonSourceType sourceType, string path = "")
         {
             return new SourceCollection(sourceType, nodelist.ToComparisonSourceList(sourceType, path));
         }
 
-        public static IEnumerable<ComparisonSource> ToComparisonSourceList(this INodeList nodes, ComparisonSourceType sourceType, string path = "")
+        public static IEnumerable<ComparisonSource> ToComparisonSourceList(this IEnumerable<INode> nodes, ComparisonSourceType sourceType, string path = "")
         {
             if (nodes is null) throw new ArgumentNullException(nameof(nodes));
 
-            for (int index = 0; index < nodes.Length; index++)
+            var index = 0;
+            foreach (var node in nodes)
             {
-                yield return nodes[index].ToComparisonSource(index, sourceType, path);
+                yield return node.ToComparisonSource(index, sourceType, path);
+                index += 1;
             }
             yield break;
         }

tools/anglesharp.cake

@@ -58,14 +58,14 @@ Task("Build")
     .IsDependentOn("Restore-Packages")
     .Does(() =>
     {
-        var settings = new DotNetCoreMSBuildSettings();
-        settings.WarningCodesAsMessage.Add("CS1591"); // During CI builds we don't want the output polluted by "warning CS1591: Missing XML comment" warnings
+        var buildSettings = new DotNetCoreMSBuildSettings();
+        buildSettings.WarningCodesAsMessage.Add("CS1591"); // During CI builds we don't want the output polluted by "warning CS1591: Missing XML comment" warnings
 
         ReplaceRegexInFiles("./src/Directory.Build.props", "(?<=<Version>)(.+?)(?=</Version>)", version);
         DotNetCoreBuild($"./src/{solutionName}.sln", new DotNetCoreBuildSettings
         {
            Configuration = configuration,
-           MSBuildSettings = settings
+           MSBuildSettings = buildSettings
         });
     });
 
@@ -76,7 +76,7 @@ Task("Run-Unit-Tests")
         var settings = new DotNetCoreTestSettings
         {
             Configuration = configuration,
-            NoBuild = false
+            NoBuild = false,
         };
 
         if (isRunningOnAppVeyor)
@@ -185,7 +185,7 @@ Task("Publish-Release")
         {
             Name = version,
             Body = String.Join(Environment.NewLine, releaseNotes.Notes),
-            Prerelease = releaseNotes.Version.ToString() == version,
+            Prerelease = releaseNotes.Version.ToString() != version,
             TargetCommitish = "master",
         }).Wait();
     });