[Differ] Remove ConsoleDiffer, use DefaultDiffer that utilize ColorConsoleDiffFormatter instead to avoid double diffing process (#7309)

* [Differ] Remove ConsoleDiffer, use DefaultDiffer that utilize ColorConsoleDiffFormatter instead to avoid double diffing process

fix cs

* Fix e2e

* final touch: register e2e test runner script to phpstan so it detected by phpstan if any issue

* Final touch: fix phpstan

* Final touch: clean up regex

* final touch: clean up logic

* final touch: fix variable

* final touch: keep fg=cyan color

* final touch: keep variable name for consistency

* Final touch: stop loop when --- Original and +++ New already removed

* reduce loop

Author: samsonasik

e2e/e2eTestRunner.php

@@ -7,6 +7,7 @@
 use Rector\Console\Formatter\ColorConsoleDiffFormatter;
 use Rector\Console\Formatter\ConsoleDiffer;
 use Rector\Console\Style\SymfonyStyleFactory;
+use Rector\Differ\DefaultDiffer;
 use Rector\Util\Reflection\PrivatesAccessor;
 use Symfony\Component\Console\Command\Command;
 
@@ -37,7 +38,7 @@
 
 $cliOptions = 'cli-options.txt';
 if (file_exists($cliOptions)) {
-    $e2eCommand .= ' ' . trim(file_get_contents($cliOptions));
+    $e2eCommand .= ' ' . trim((string) file_get_contents($cliOptions));
 }
 
 
@@ -55,15 +56,16 @@
 $symfonyStyle =  $symfonyStyleFactory->create();
 
 $matchedExpectedOutput = false;
-$expectedOutput = trim(file_get_contents($expectedDiff));
+$expectedOutput = trim((string) file_get_contents($expectedDiff));
 if ($output === $expectedOutput) {
     $symfonyStyle->success('End-to-end test successfully completed');
     exit(Command::SUCCESS);
 }
 
 // print color diff, to make easy find the differences
-$consoleDiffer = new ConsoleDiffer(new ColorConsoleDiffFormatter());
-$diff = $consoleDiffer->diff($output, $expectedOutput);
+$defaultDiffer = new DefaultDiffer();
+$colorConsoleDiffFormatter = new ColorConsoleDiffFormatter();
+$diff = $colorConsoleDiffFormatter->format($defaultDiffer->diff($output, $expectedOutput));
 $symfonyStyle->writeln($diff);
 
 exit(Command::FAILURE);

e2e/e2eTestRunnerWithCache.php

@@ -7,6 +7,7 @@
 use Rector\Console\Formatter\ColorConsoleDiffFormatter;
 use Rector\Console\Formatter\ConsoleDiffer;
 use Rector\Console\Style\SymfonyStyleFactory;
+use Rector\Differ\DefaultDiffer;
 use Rector\Util\Reflection\PrivatesAccessor;
 use Symfony\Component\Console\Command\Command;
 
@@ -33,15 +34,16 @@
 $symfonyStyle =  $symfonyStyleFactory->create();
 
 $matchedExpectedOutput = false;
-$expectedOutput = trim(file_get_contents($expectedDiff));
+$expectedOutput = trim((string) file_get_contents($expectedDiff));
 if ($output === $expectedOutput) {
     $symfonyStyle->success('End-to-end test successfully completed');
     exit(Command::SUCCESS);
 }
 
 // print color diff, to make easy find the differences
-$consoleDiffer = new ConsoleDiffer(new ColorConsoleDiffFormatter());
-$diff = $consoleDiffer->diff($output, $expectedOutput);
+$defaultDiffer = new DefaultDiffer();
+$colorConsoleDiffFormatter = new ColorConsoleDiffFormatter();
+$diff = $colorConsoleDiffFormatter->format($defaultDiffer->diff($output, $expectedOutput));
 $symfonyStyle->writeln($diff);
 
 exit(Command::FAILURE);

phpstan.neon

@@ -26,6 +26,8 @@ parameters:
         - tests
         - rules-tests
         - utils
+        - e2e/e2eTestRunnerWithCache.php
+        - e2e/e2eTestRunner.php
 
     scanDirectories:
         - stubs

src/ChangesReporting/ValueObjectFactory/FileDiffFactory.php

@@ -5,7 +5,7 @@
 namespace Rector\ChangesReporting\ValueObjectFactory;
 
 use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
-use Rector\Console\Formatter\ConsoleDiffer;
+use Rector\Console\Formatter\ColorConsoleDiffFormatter;
 use Rector\Differ\DefaultDiffer;
 use Rector\FileSystem\FilePathHelper;
 use Rector\ValueObject\Application\File;
@@ -15,8 +15,8 @@
 {
     public function __construct(
         private DefaultDiffer $defaultDiffer,
-        private ConsoleDiffer $consoleDiffer,
         private FilePathHelper $filePathHelper,
+        private ColorConsoleDiffFormatter $colorConsoleDiffFormatter
     ) {
     }
 
@@ -32,11 +32,14 @@ public function createFileDiffWithLineChanges(
     ): FileDiff {
         $relativeFilePath = $this->filePathHelper->relativePath($file->getFilePath());
 
+        $diff = $shouldShowDiffs ? $this->defaultDiffer->diff($oldContent, $newContent) : '';
+        $consoleDiff = $shouldShowDiffs ? $this->colorConsoleDiffFormatter->format($diff) : '';
+
         // always keep the most recent diff
         return new FileDiff(
             $relativeFilePath,
-            $shouldShowDiffs ? $this->defaultDiffer->diff($oldContent, $newContent) : '',
-            $shouldShowDiffs ? $this->consoleDiffer->diff($oldContent, $newContent) : '',
+            $diff,
+            $consoleDiff,
             $rectorsWithLineChanges
         );
     }

src/Console/Formatter/ColorConsoleDiffFormatter.php

@@ -34,6 +34,12 @@
      */
     private const AT_START_REGEX = '#^(@.*)#';
 
+    /**
+     * @var string
+     * @see https://regex101.com/r/8MXnfa/2
+     */
+    private const AT_DIFF_LINE_REGEX = '#^\<fg=cyan\>@@ \-\d+,\d+ \+\d+,\d+ @@\<\/fg=cyan\>$#';
+
     private string $template;
 
     public function __construct()
@@ -56,30 +62,42 @@ private function formatWithTemplate(string $diff, string $template): string
 
         $escapedDiffLines = NewLineSplitter::split($escapedDiff);
 
-        // remove description of added + remove; obvious on diffs
+        // remove description of added + remove, obvious on diffs
+        // decorize lines
         foreach ($escapedDiffLines as $key => $escapedDiffLine) {
             if ($escapedDiffLine === '--- Original') {
                 unset($escapedDiffLines[$key]);
+                continue;
             }
 
             if ($escapedDiffLine === '+++ New') {
                 unset($escapedDiffLines[$key]);
+                continue;
             }
-        }
-
-        $coloredLines = array_map(function (string $string): string {
-            $string = $this->makePlusLinesGreen($string);
-            $string = $this->makeMinusLinesRed($string);
-            $string = $this->makeAtNoteCyan($string);
 
-            if ($string === ' ') {
-                return '';
+            if ($escapedDiffLine === ' ') {
+                $escapedDiffLines[$key] = '';
+                continue;
             }
 
-            return $string;
-        }, $escapedDiffLines);
+            $escapedDiffLine = $this->makePlusLinesGreen($escapedDiffLine);
+            $escapedDiffLine = $this->makeMinusLinesRed($escapedDiffLine);
+            $escapedDiffLine = $this->makeAtNoteCyan($escapedDiffLine);
+            $escapedDiffLine = $this->normalizeLineAtDiff($escapedDiffLine);
 
-        return sprintf($template, implode(PHP_EOL, $coloredLines));
+            // final decorized line
+            $escapedDiffLines[$key] = $escapedDiffLine;
+        }
+
+        return sprintf($template, implode(PHP_EOL, $escapedDiffLines));
+    }
+
+    /**
+     * Remove number diff, eg; @@ -67,6 +67,8 @@ to become @@ @@
+     */
+    private function normalizeLineAtDiff(string $string): string
+    {
+        return Strings::replace($string, self::AT_DIFF_LINE_REGEX, '<fg=cyan>@@ @@</fg=cyan>');
     }
 
     private function makePlusLinesGreen(string $string): string