feat: add new option: ignoreLineEnding

Signed-off-by: Jack Cherng <jfcherng@gmail.com>

Author: jfcherng

src/SequenceMatcher.php

@@ -90,8 +90,9 @@ final class SequenceMatcher
     private array $options = [];
 
     private static array $defaultOptions = [
-        'ignoreWhitespace' => false,
         'ignoreCase' => false,
+        'ignoreLineEnding' => false,
+        'ignoreWhitespace' => false,
     ];
 
     private array $matchingBlocks = [];
@@ -125,7 +126,11 @@ public function __construct(array $a, array $b, ?\Closure $junkCallback = null,
      */
     public function setOptions(array $options): static
     {
-        $needRerunChainB = $this->isAnyOptionChanged($this->options, $options, ['ignoreCase', 'ignoreWhitespace']);
+        $needRerunChainB = $this->isAnyOptionChanged(
+            $this->options,
+            $options,
+            ['ignoreCase', 'ignoreLineEnding', 'ignoreWhitespace'],
+        );
 
         $this->options = $options + self::$defaultOptions;
 
@@ -641,6 +646,10 @@ private function processLineWithOptions(string $line): string
             $line = strtolower($line);
         }
 
+        if ($this->options['ignoreLineEnding']) {
+            $line = rtrim($line, "\r\n");
+        }
+
         return $line;
     }
 

tests/SequenceMatcherTest.php

@@ -234,11 +234,11 @@ public function testGetOpcodes(array $old, array $new, array $expected): void
     }
 
     /**
-     * Data provider for SequenceMatcher::getGroupedOpcodes with "ignoreWhitespaces".
+     * Data provider for SequenceMatcher::getGroupedOpcodes with "ignoreWhitespace".
      *
      * @return array the data provider
      */
-    public static function getGroupedOpcodesIgnoreWhitespacesDataProvider(): array
+    public static function getGroupedOpcodesIgnoreWhitespaceDataProvider(): array
     {
         return [
             [
@@ -318,8 +318,8 @@ function foo()
                 ],
             ],
             [
-                file_get_contents(__DIR__ . '/data/WorkerCommandA.php'),
-                file_get_contents(__DIR__ . '/data/WorkerCommandB.php'),
+                file_get_contents(__DIR__ . '/data/ignore_whitespace/old_1.php'),
+                file_get_contents(__DIR__ . '/data/ignore_whitespace/new_1.php'),
                 [
                     [
                         [SequenceMatcher::OP_DEL, 217, 222, 217, 217],
@@ -330,15 +330,42 @@ function foo()
     }
 
     /**
-     * Test the SequenceMatcher::getOpcodes with "ignoreWhitespaces".
+     * Data provider for SequenceMatcher::getGroupedOpcodes with "ignoreLineEnding".
+     *
+     * @return array the data provider
+     */
+    public static function getGroupedOpcodesIgnoreLineEndingDataProvider(): array
+    {
+        return [
+            [
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/old_1.txt'),
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/new_1.txt'),
+                [],
+                true,
+            ],
+            [
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/old_1.txt'),
+                file_get_contents(__DIR__ . '/data/ignore_line_ending/new_1.txt'),
+                [
+                    [
+                        [SequenceMatcher::OP_REP, 0, 2, 0, 2],
+                    ],
+                ],
+                false,
+            ],
+        ];
+    }
+
+    /**
+     * Test the SequenceMatcher::getOpcodes with "ignoreWhitespace".
      *
      * @covers       \Jfcherng\Diff\SequenceMatcher::getOpcodes
      *
      * @param string $old      the old
      * @param string $new      the new
      * @param array  $expected the expected
      */
-    #[DataProvider('getGroupedOpcodesIgnoreWhitespacesDataProvider')]
+    #[DataProvider('getGroupedOpcodesIgnoreWhitespaceDataProvider')]
     public function testGetOpcodesIgnoreWhitespaces(string $old, string $new, array $expected): void
     {
         $this->sm->setSequences(explode("\n", $old), explode("\n", $new));
@@ -347,6 +374,30 @@ public function testGetOpcodesIgnoreWhitespaces(string $old, string $new, array
         static::assertSame($expected, $this->sm->getGroupedOpcodes(0));
     }
 
+    /**
+     * Test the SequenceMatcher::getOpcodes with "ignoreLineEnding".
+     *
+     * @covers       \Jfcherng\Diff\SequenceMatcher::getOpcodes
+     *
+     * @dataProvider getGroupedOpcodesIgnoreLineEndingDataProvider
+     *
+     * @param string $old              the old
+     * @param string $new              the new
+     * @param array  $expected         the expected
+     * @param array  $ignoreLineEnding should ignore line ending
+     */
+    public function testGetOpcodesIgnoreLineEnding(
+        string $old,
+        string $new,
+        array $expected,
+        bool $ignoreLineEnding
+    ): void {
+        $this->sm->setSequences(explode("\n", $old), explode("\n", $new));
+        $this->sm->setOptions(['ignoreLineEnding' => $ignoreLineEnding]);
+
+        static::assertSame($expected, $this->sm->getGroupedOpcodes(0));
+    }
+
     /**
      * @see https://github.com/jfcherng/php-sequence-matcher/issues/2
      */

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

tests/data/WorkerCommandB.php renamed to tests/data/ignore_whitespace/new_1.php

@@ -157,7 +157,7 @@ private function runWorker(
 		/** @var Registry $registry */
 		$registry = $container->getByType(Registry::class);
 
-		// todo collectErrors (from Analyser)
+		// collectErrors (from Analyser)
 		$in->on('data', static function (array $json) use ($fileAnalyser, $registry, $out, $analysedFiles): void {
 			$action = $json['action'];
 			if ($action !== 'analyse') {

tests/data/WorkerCommandA.php renamed to tests/data/ignore_whitespace/old_1.php

@@ -157,7 +157,7 @@ private function runWorker(
 		/** @var Registry $registry */
 		$registry = $container->getByType(Registry::class);
 
-		// todo collectErrors (from Analyser)
+		// collectErrors (from Analyser)
 		$in->on('data', static function (array $json) use ($fileAnalyser, $registry, $out, $analysedFiles): void {
 			$action = $json['action'];
 			if ($action !== 'analyse') {