feat: add differ option: ignoreLineEnding

Signed-off-by: Jack Cherng <[email protected]>

Author: jfcherng

README.md

@@ -78,6 +78,8 @@ $differOptions = [
     'context' => 3,
     // ignore case difference
     'ignoreCase' => false,
+    // ignore line ending difference
+    'ignoreLineEnding' => false,
     // ignore whitespace difference
     'ignoreWhitespace' => false,
 ];

example/demo_base.php

@@ -18,6 +18,8 @@
     'context' => 1,
     // ignore case difference
     'ignoreCase' => false,
+    // ignore line ending difference
+    'ignoreLineEnding' => false,
     // ignore whitespace difference
     'ignoreWhitespace' => false,
 ];

src/Differ.php

@@ -111,10 +111,12 @@ final class Differ
         // show how many neighbor lines
         // Differ::CONTEXT_ALL can be used to show the whole file
         'context' => 3,
-        // ignore case difference
-        'ignoreWhitespace' => false,
         // ignore whitespace difference
         'ignoreCase' => false,
+        // ignore line ending difference
+        'ignoreLineEnding' => false,
+        // ignore case difference
+        'ignoreWhitespace' => false,
     ];
 
     /**
@@ -312,8 +314,14 @@ public function getGroupedOpcodes(): array
             return $this->groupedOpcodes;
         }
 
-        $old = $this->old;
-        $new = $this->new;
+        if ($this->options['ignoreLineEnding']) {
+            $old = array_map([$this, 'removeLineEnding'], $this->old);
+            $new = array_map([$this, 'removeLineEnding'], $this->new);
+        } else {
+            $old = $this->old;
+            $new = $this->new;
+        }
+
         $this->getGroupedOpcodesPre($old, $new);
 
         $opcodes = $this->sequenceMatcher
@@ -338,8 +346,14 @@ public function getGroupedOpcodesGnu(): array
             return $this->groupedOpcodesGnu;
         }
 
-        $old = $this->old;
-        $new = $this->new;
+        if ($this->options['ignoreLineEnding']) {
+            $old = array_map([$this, 'removeLineEnding'], $this->old);
+            $new = array_map([$this, 'removeLineEnding'], $this->new);
+        } else {
+            $old = $this->old;
+            $new = $this->new;
+        }
+
         $this->getGroupedOpcodesGnuPre($old, $new);
 
         $opcodes = $this->sequenceMatcher
@@ -462,6 +476,16 @@ private function getGroupedOpcodesGnuPost(array &$opcodes): void
         $this->getGroupedOpcodesPost($opcodes);
     }
 
+    /**
+     * Remove line ending characters at the end of the string.
+     *
+     * @param string $str the string
+     */
+    private function removeLineEnding(string $str): string
+    {
+        return rtrim($str, "\r\n");
+    }
+
     /**
      * Claim this class has settled down and we could calculate cached
      * properties by current properties.

tests/IgnoreLineEndingTest.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Jfcherng\Diff\Test;
+
+use Jfcherng\Diff\DiffHelper;
+use Jfcherng\Diff\Renderer\RendererConstant;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+final class IgnoreLineEndingTest extends TestCase
+{
+    /**
+     * @return string[][]
+     */
+    public function provideIgnoreLineEndingTrue(): array
+    {
+        return [
+            [
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/old_1.txt'),
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/new_1.txt'),
+                <<<'DIFF'
+DIFF
+            ],
+        ];
+    }
+
+    /**
+     * @return string[][]
+     */
+    public function provideIgnoreLineEndingFalse(): array
+    {
+        return [
+            [
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/old_1.txt'),
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/new_1.txt'),
+                <<<"DIFF"
+@@ -1,2 +1,2 @@
+-line 1\r
+-line 2\r
++line 1
++line 2
+
+DIFF
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider provideIgnoreLineEndingTrue
+     */
+    public function testIgnoreLineEndingTrue(string $old, string $new, string $expectedDiff): void
+    {
+        $diff = DiffHelper::calculate($old, $new, 'Unified', [
+            'ignoreLineEnding' => true,
+        ], [
+            'cliColorization' => RendererConstant::CLI_COLOR_DISABLE,
+        ]);
+
+        static::assertSame($expectedDiff, $diff);
+    }
+
+    /**
+     * @dataProvider provideIgnoreLineEndingFalse
+     */
+    public function testIgnoreLineEndingFalse(string $old, string $new, string $expectedDiff): void
+    {
+        $diff = DiffHelper::calculate($old, $new, 'Unified', [
+            'ignoreLineEnding' => false,
+        ], [
+            'cliColorization' => RendererConstant::CLI_COLOR_DISABLE,
+        ]);
+
+        static::assertSame($expectedDiff, $diff);
+    }
+}

tests/data/ignore_line_ending/new_1.txt

@@ -0,0 +1,2 @@
+line 1
+line 2

tests/data/ignore_line_ending/old_1.txt

@@ -0,0 +1,2 @@
+line 1
+line 2