Added diffing for characters

Thomas Hambach · Thomas Hambach · commit f2f64f1f13bf · 2022-08-22T10:24:59.000+07:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,8 @@
+{
+    "omnisharp.organizeImportsOnFormat": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll": false,
+        "source.organizeImports": true,
+        "source.sortMembers": true
+    }
+}
diff --git a/CSharpDiff.Tests/DiffCharacterTests.cs b/CSharpDiff.Tests/DiffCharacterTests.cs
@@ -0,0 +1,39 @@
+using CSharpDiff.Converters;
+using CSharpDiff.Diffs;
+using CSharpDiff.Diffs.Models;
+
+namespace CSharpDiff.Tests
+{
+    public class DiffCharacterTests
+    {
+        [Fact]
+        public void ShouldDiffChars()
+        {
+            var diff = new Diff();
+            var result = diff.diff("New Value.", "New ValueMoreData.");
+            Assert.Equal("New Value<ins>MoreData</ins>.", DiffConvertXml.Convert(result));
+        }
+
+        [Fact]
+        public void ShouldConsiderCase()
+        {
+            var diff = new Diff(new DiffOptions
+            {
+                IgnoreCase = true
+            });
+            var result = diff.diff("New Value.", "New value.");
+            Assert.Equal("New value.", DiffConvertXml.Convert(result));
+        }
+
+        [Fact]
+        public void ShouldConsiderCaseWithDifference()
+        {
+            var diff = new Diff(new DiffOptions
+            {
+                IgnoreCase = true
+            });
+            var result = diff.diff("New Values.", "New value.");
+            Assert.Equal("New value<del>s</del>.", DiffConvertXml.Convert(result));
+        }
+    }
+}
diff --git a/CSharpDiff.Tests/DiffConvertXmlTests.cs b/CSharpDiff.Tests/DiffConvertXmlTests.cs
@@ -1,5 +1,5 @@
-using CSharpDiff.Convert;
-using CSharpDiff.Diff.Models;
+using CSharpDiff.Converters;
+using CSharpDiff.Diffs.Models;
 
 namespace CSharpDiff.Tests
 {
diff --git a/CSharpDiff.Tests/DiffSentenceTests.cs b/CSharpDiff.Tests/DiffSentenceTests.cs
@@ -1,5 +1,5 @@
-using CSharpDiff.Convert;
-using CSharpDiff.Diff;
+using CSharpDiff.Converters;
+using CSharpDiff.Diffs;
 
 namespace CSharpDiff.Tests
 {
diff --git a/CSharpDiff.Tests/DiffTests.cs b/CSharpDiff.Tests/DiffTests.cs
@@ -1,5 +1,5 @@
-using CSharpDiff.Convert;
-using CSharpDiff.Diff;
+using CSharpDiff.Converters;
+using CSharpDiff.Diffs;
 
 namespace CSharpDiff.Tests
 {
diff --git a/CSharpDiff/CSharpDiff.csproj b/CSharpDiff/CSharpDiff.csproj
@@ -4,15 +4,15 @@
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <PackageId>CSharpDiff</PackageId>
-    <Version>0.0.4</Version>
+    <Version>0.0.5</Version>
     <Authors>ThomasHambach</Authors>
     <Description>
       Unified Diff support for .NET. Based on the popular library JSDIFF.
     </Description>
     <PackageTags>Diff;UniDiff;Line Diff;Unified Diff</PackageTags>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageReadmeFile>README.md</PackageReadmeFile>
-    
+    <PackageProjectUrl>https://github.com/thomashambach/csharpdiff</PackageProjectUrl>
   </PropertyGroup>
   <ItemGroup>
     <None Include="..\README.md" Pack="true" PackagePath="\"/>
diff --git a/CSharpDiff/Converters/DiffConvertXml.cs b/CSharpDiff/Converters/DiffConvertXml.cs
@@ -1,7 +1,7 @@
 using System.Web;
-using CSharpDiff.Diff.Models;
+using CSharpDiff.Diffs.Models;
 
-namespace CSharpDiff.Convert
+namespace CSharpDiff.Converters
 {
     public static class DiffConvertXml
     {
diff --git a/CSharpDiff/Diffs/Diff.cs b/CSharpDiff/Diffs/Diff.cs
@@ -1,12 +1,21 @@
 ﻿using System.Text.RegularExpressions;
-using CSharpDiff.Diff.Models;
+using CSharpDiff.Diffs.Models;
 
-namespace CSharpDiff.Diff
+namespace CSharpDiff.Diffs
 {
     public class Diff : IDiff
     {
-        public bool UseLongestToken { get; set; } = true;
-        public bool IgnoreWhiteSpace { get; set; } = false;
+        public Diff()
+        {
+            Options = new DiffOptions();
+        }
+
+        public Diff(DiffOptions options)
+        {
+            Options = options;
+        }
+
+        public DiffOptions Options { get; set; }
 
         public IList<DiffResult> diff(string oldString, string newString)
         {
@@ -152,7 +161,7 @@ public List<DiffResult> buildValues(List<DiffResult> components, string[] newStr
                     }
                     else
                     {
-                        component.value = join(newString[newPos..whereToTakeOld]);
+                        component.value = join(newString[newPos..whereToTake]);
                     }
 
                     newPos += (int)component.count;
@@ -279,14 +288,9 @@ public int extractCommon(BestPath basePath, string[] newString, string[] oldStri
             return oldPos;
         }
 
-        public bool equals(char left, char right)
-        {
-            return left == right;
-        }
-
         public bool equals(string left, string right)
         {
-            return left == right;
+            return String.Compare(left, right, Options.IgnoreCase) == 0;
         }
     }
 
diff --git a/CSharpDiff/Diffs/DiffArray.cs b/CSharpDiff/Diffs/DiffArray.cs
@@ -1,6 +1,6 @@
-using CSharpDiff.Diff.Models;
+using CSharpDiff.Diffs.Models;
 
-namespace CSharpDiff.Diff
+namespace CSharpDiff.Diffs
 {
     public class DiffArray : Diff
     {
diff --git a/CSharpDiff/Diffs/DiffLines.cs b/CSharpDiff/Diffs/DiffLines.cs
@@ -1,6 +1,6 @@
 using System.Text.RegularExpressions;
-using CSharpDiff.Diff.Models;
-namespace CSharpDiff.Diff
+using CSharpDiff.Diffs.Models;
+namespace CSharpDiff.Diffs
 {
     public class DiffLines : Diff
     {
@@ -35,7 +35,7 @@ public class DiffLines : Diff
                 }
                 else
                 {
-                    if (IgnoreWhiteSpace)
+                    if (Options.IgnoreWhiteSpace)
                     {
                         line = line.Trim();
                     }
diff --git a/CSharpDiff/Diffs/DiffSentence.cs b/CSharpDiff/Diffs/DiffSentence.cs
@@ -1,7 +1,7 @@
 using System.Text.RegularExpressions;
-using CSharpDiff.Diff.Models;
+using CSharpDiff.Diffs.Models;
 
-namespace CSharpDiff.Diff
+namespace CSharpDiff.Diffs
 {
     public class DiffSentence : Diff
     {
diff --git a/CSharpDiff/Diffs/IDiff.cs b/CSharpDiff/Diffs/IDiff.cs
@@ -1,16 +1,9 @@
-using CSharpDiff.Diff.Models;
+using CSharpDiff.Diffs.Models;
 
-namespace CSharpDiff.Diff
+namespace CSharpDiff.Diffs
 {
     public interface IDiff
     {
-        bool UseLongestToken { get; set; }
-
-        /// <summary>
-        /// Defines whether we ignore white space.
-        /// </summary>
-        bool IgnoreWhiteSpace { get; set; }
-
         List<DiffResult> buildValues(List<DiffResult> components, string[] newString, string[] oldString, bool useLongestToken);
 
         BestPath clonePath(BestPath path);
@@ -19,14 +12,6 @@ public interface IDiff
 
         IList<DiffResult> diff(string oldString, string newString);
 
-        /// <summary>
-        /// Check whether left matches right.
-        /// </summary>
-        /// <param name="left"></param>
-        /// <param name="right"></param>
-        /// <returns></returns>
-        bool equals(char left, char right);
-
         /// <summary>
         /// Check whether left matches right.
         /// </summary>
diff --git a/CSharpDiff/Diffs/Models/BestPath.cs b/CSharpDiff/Diffs/Models/BestPath.cs
@@ -1,4 +1,4 @@
-namespace CSharpDiff.Diff.Models
+namespace CSharpDiff.Diffs.Models
 {
     public class BestPath
     {
diff --git a/CSharpDiff/Diffs/Models/DiffOptions.cs b/CSharpDiff/Diffs/Models/DiffOptions.cs
@@ -0,0 +1,9 @@
+namespace CSharpDiff.Diffs.Models
+{
+    public class DiffOptions
+    {
+        public bool UseLongestToken { get; set; } = true;
+        public bool IgnoreWhiteSpace { get; set; } = false;
+        public bool IgnoreCase { get; set; } = false;
+    }
+}
diff --git a/CSharpDiff/Diffs/Models/DiffResults.cs b/CSharpDiff/Diffs/Models/DiffResults.cs
@@ -1,4 +1,4 @@
-namespace CSharpDiff.Diff.Models
+namespace CSharpDiff.Diffs.Models
 {
     public class DiffResult
     {
diff --git a/CSharpDiff/Diffs/Models/Hunk.cs b/CSharpDiff/Diffs/Models/Hunk.cs
@@ -1,4 +1,4 @@
-namespace CSharpDiff.Diff.Models
+namespace CSharpDiff.Diffs.Models
 {
     public class Hunk
     {
diff --git a/CSharpDiff/Patches/IPatch.cs b/CSharpDiff/Patches/IPatch.cs
@@ -1,6 +1,6 @@
-using CSharpDiff.Patch.Models;
+using CSharpDiff.Patches.Models;
 
-namespace CSharpDiff.Patch
+namespace CSharpDiff.Patches
 {
     public interface IPatch
     {
diff --git a/CSharpDiff/Patches/Models/PatchOptions.cs b/CSharpDiff/Patches/Models/PatchOptions.cs
@@ -1,4 +1,4 @@
-namespace CSharpDiff.Patch.Models
+namespace CSharpDiff.Patches.Models
 {
     public class PatchOptions
     {
diff --git a/CSharpDiff/Patches/Models/PatchResult.cs b/CSharpDiff/Patches/Models/PatchResult.cs
@@ -1,6 +1,6 @@
-using CSharpDiff.Diff.Models;
+using CSharpDiff.Diffs.Models;
 
-namespace CSharpDiff.Patch.Models
+namespace CSharpDiff.Patches.Models
 {
     public class PatchResult
     {
diff --git a/CSharpDiff/Patches/Patch.cs b/CSharpDiff/Patches/Patch.cs
@@ -1,9 +1,9 @@
 using System.Text.RegularExpressions;
-using CSharpDiff.Diff;
-using CSharpDiff.Diff.Models;
-using CSharpDiff.Patch.Models;
+using CSharpDiff.Diffs;
+using CSharpDiff.Diffs.Models;
+using CSharpDiff.Patches.Models;
 
-namespace CSharpDiff.Patch
+namespace CSharpDiff.Patches
 {
     public class Patch : IPatch
     {
diff --git a/README.md b/README.md
@@ -12,6 +12,28 @@ C# Diff with Unified Diff Support, this codebase is a port from the popular JS l
 
 ### Diff
 
+#### Character
+
+```c#
+var diff = new Diff(new DiffOptions
+{
+    IgnoreCase = true
+});
+var result = diff.diff("New Value.", "New value.");
+```
+
+#### Line
+
+```c#
+using CSharpDiff.Diff;
+
+var text1 = "Here im.\nRock you like old man.\nYeah";
+var text2 = "Here im.\nRock you like hurricane.\nYeah";
+
+var diff = new DiffLines();
+var difference = diff.diff(text1, text2);
+```
+
 #### Sentence
 
 ```c#
@@ -53,7 +75,7 @@ string patch = ps.create("filename1", "filename2", text1, text2, "header1", "hea
 - [ ] Diff
   - [ ] Array (difficult, JS allows type mixing)
   - [x] Base
-  - [ ] Character
+  - [x] Character
   - [ ] CSS
   - [ ] JSON
   - [x] Line

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`		`-using CSharpDiff.Convert;`
`2`		`-using CSharpDiff.Diff.Models;`
	`1`	`+using CSharpDiff.Converters;`
	`2`	`+using CSharpDiff.Diffs.Models;`
`3`	`3`
`4`	`4`	`namespace CSharpDiff.Tests`
`5`	`5`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`		`-using CSharpDiff.Convert;`
`2`		`-using CSharpDiff.Diff;`
	`1`	`+using CSharpDiff.Converters;`
	`2`	`+using CSharpDiff.Diffs;`
`3`	`3`
`4`	`4`	`namespace CSharpDiff.Tests`
`5`	`5`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`using System.Web;`
`2`		`-using CSharpDiff.Diff.Models;`
	`2`	`+using CSharpDiff.Diffs.Models;`
`3`	`3`
`4`		`-namespace CSharpDiff.Convert`
	`4`	`+namespace CSharpDiff.Converters`
`5`	`5`	`{`
`6`	`6`	`public static class DiffConvertXml`
`7`	`7`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,21 @@`
`1`	`1`	`using System.Text.RegularExpressions;`
`2`		`-using CSharpDiff.Diff.Models;`
	`2`	`+using CSharpDiff.Diffs.Models;`
`3`	`3`
`4`		`-namespace CSharpDiff.Diff`
	`4`	`+namespace CSharpDiff.Diffs`
`5`	`5`	`{`
`6`	`6`	`public class Diff : IDiff`
`7`	`7`	`{`
`8`		`- public bool UseLongestToken { get; set; } = true;`
`9`		`- public bool IgnoreWhiteSpace { get; set; } = false;`
	`8`	`+ public Diff()`
	`9`	`+ {`
	`10`	`+ Options = new DiffOptions();`
	`11`	`+ }`
	`12`	`+`
	`13`	`+ public Diff(DiffOptions options)`
	`14`	`+ {`
	`15`	`+ Options = options;`
	`16`	`+ }`
	`17`	`+`
	`18`	`+ public DiffOptions Options { get; set; }`
`10`	`19`
`11`	`20`	`public IList<DiffResult> diff(string oldString, string newString)`
`12`	`21`	`{`
`@@ -152,7 +161,7 @@ public List<DiffResult> buildValues(List<DiffResult> components, string[] newStr`
`152`	`161`	`}`
`153`	`162`	`else`
`154`	`163`	`{`
`155`		`- component.value = join(newString[newPos..whereToTakeOld]);`
	`164`	`+ component.value = join(newString[newPos..whereToTake]);`
`156`	`165`	`}`
`157`	`166`
`158`	`167`	`newPos += (int)component.count;`
`@@ -279,14 +288,9 @@ public int extractCommon(BestPath basePath, string[] newString, string[] oldStri`
`279`	`288`	`return oldPos;`
`280`	`289`	`}`
`281`	`290`
`282`		`- public bool equals(char left, char right)`
`283`		`- {`
`284`		`- return left == right;`
`285`		`- }`
`286`		`-`
`287`	`291`	`public bool equals(string left, string right)`
`288`	`292`	`{`
`289`		`- return left == right;`
	`293`	`+ return String.Compare(left, right, Options.IgnoreCase) == 0;`
`290`	`294`	`}`
`291`	`295`	`}`
`292`	`296`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-using CSharpDiff.Diff.Models;`
	`1`	`+using CSharpDiff.Diffs.Models;`
`2`	`2`
`3`		`-namespace CSharpDiff.Diff`
	`3`	`+namespace CSharpDiff.Diffs`
`4`	`4`	`{`
`5`	`5`	`public class DiffArray : Diff`
`6`	`6`	`{`