[Console] Move color differ here (#2887)

composer.json

@@ -37,9 +37,8 @@
         "symfony/dependency-injection": "^6.1",
         "symfony/finder": "^6.0",
         "symfony/string": "^6.0",
-        "symplify/autowire-array-parameter": "^11.1",
+        "symplify/autowire-array-parameter": "^11.1.8",
         "symplify/easy-parallel": "^11.1",
-        "symplify/symplify-kernel": "^11.1.7",
         "symplify/rule-doc-generator-contracts": "^11.1",
         "webmozart/assert": "^1.11"
     },

config/config.php

@@ -44,6 +44,7 @@
 use Rector\PSR4\Composer\PSR4NamespaceMatcher;
 use Rector\PSR4\Contract\PSR4AutoloadNamespaceMatcherInterface;
 use Rector\Utils\Command\MissingInSetCommand;
+use SebastianBergmann\Diff\Differ;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
@@ -224,4 +225,7 @@
     $services->set(\PHPStan\PhpDocParser\Lexer\Lexer::class);
     $services->set(TypeParser::class);
     $services->set(ConstExprParser::class);
+
+    // console color diff
+    $services->set(Differ::class);
 };

e2e/e2eTestRunner.php

@@ -4,11 +4,12 @@
 // runs a rector e2e test.
 // checks whether we expect a certain output, or alternatively that rector just processed everything without errors
 
+use Rector\Core\Console\Formatter\ColorConsoleDiffFormatter;
+use Rector\Core\Console\Formatter\ConsoleDiffer;
 use Rector\Core\Console\Style\SymfonyStyleFactory;
+use Rector\Core\Util\Reflection\PrivatesAccessor;
 use SebastianBergmann\Diff\Differ;
 use Symfony\Component\Console\Command\Command;
-use Symplify\PackageBuilder\Console\Formatter\ColorConsoleDiffFormatter;
-use Symplify\PackageBuilder\Console\Output\ConsoleDiffer;
 
 $projectRoot = __DIR__ .'/..';
 $rectorBin = $projectRoot . '/bin/rector';
@@ -40,7 +41,7 @@
     exit($exitCode);
 }
 
-$symfonyStyleFactory = new SymfonyStyleFactory(new \Rector\Core\Util\Reflection\PrivatesAccessor());
+$symfonyStyleFactory = new SymfonyStyleFactory(new PrivatesAccessor());
 $symfonyStyle =  $symfonyStyleFactory->create();
 
 $matchedExpectedOutput = false;

packages/ChangesReporting/ValueObjectFactory/FileDiffFactory.php

@@ -4,11 +4,11 @@
 
 namespace Rector\ChangesReporting\ValueObjectFactory;
 
+use Rector\Core\Console\Formatter\ConsoleDiffer;
 use Rector\Core\Differ\DefaultDiffer;
 use Rector\Core\FileSystem\FilePathHelper;
 use Rector\Core\ValueObject\Application\File;
 use Rector\Core\ValueObject\Reporting\FileDiff;
-use Symplify\PackageBuilder\Console\Output\ConsoleDiffer;
 
 final class FileDiffFactory
 {

src/Console/Formatter/ColorConsoleDiffFormatter.php

@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Core\Console\Formatter;
+
+use Nette\Utils\Strings;
+use Symfony\Component\Console\Formatter\OutputFormatter;
+
+/**
+ * Inspired by @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/src/Differ/DiffConsoleFormatter.php to be
+ * used as standalone class, without need to require whole package by Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * @see \Rector\Core\Tests\Console\Formatter\ColorConsoleDiffFormatterTest
+ */
+final class ColorConsoleDiffFormatter
+{
+    /**
+     * @var string
+     * @see https://regex101.com/r/ovLMDF/1
+     */
+    private const PLUS_START_REGEX = '#^(\+.*)#';
+
+    /**
+     * @var string
+     * @see https://regex101.com/r/xwywpa/1
+     */
+    private const MINUT_START_REGEX = '#^(\-.*)#';
+
+    /**
+     * @var string
+     * @see https://regex101.com/r/CMlwa8/1
+     */
+    private const AT_START_REGEX = '#^(@.*)#';
+
+    /**
+     * @var string
+     * @see https://regex101.com/r/qduj2O/1
+     */
+    private const NEWLINES_REGEX = "#\n\r|\n#";
+
+    private readonly string $template;
+
+    public function __construct()
+    {
+        $this->template = sprintf(
+            '<comment>    ---------- begin diff ----------</comment>%s%%s%s<comment>    ----------- end diff -----------</comment>' . PHP_EOL,
+            PHP_EOL,
+            PHP_EOL
+        );
+    }
+
+    public function format(string $diff): string
+    {
+        return $this->formatWithTemplate($diff, $this->template);
+    }
+
+    private function formatWithTemplate(string $diff, string $template): string
+    {
+        $escapedDiff = OutputFormatter::escape(rtrim($diff));
+
+        $escapedDiffLines = Strings::split($escapedDiff, self::NEWLINES_REGEX);
+
+        // remove description of added + remove; obvious on diffs
+        foreach ($escapedDiffLines as $key => $escapedDiffLine) {
+            if ($escapedDiffLine === '--- Original') {
+                unset($escapedDiffLines[$key]);
+            }
+
+            if ($escapedDiffLine === '+++ New') {
+                unset($escapedDiffLines[$key]);
+            }
+        }
+
+        $coloredLines = array_map(function (string $string): string {
+            $string = $this->makePlusLinesGreen($string);
+            $string = $this->makeMinusLinesRed($string);
+            $string = $this->makeAtNoteCyan($string);
+
+            if ($string === ' ') {
+                return '';
+            }
+
+            return $string;
+        }, $escapedDiffLines);
+
+        return sprintf($template, implode(PHP_EOL, $coloredLines));
+    }
+
+    private function makePlusLinesGreen(string $string): string
+    {
+        return Strings::replace($string, self::PLUS_START_REGEX, '<fg=green>$1</fg=green>');
+    }
+
+    private function makeMinusLinesRed(string $string): string
+    {
+        return Strings::replace($string, self::MINUT_START_REGEX, '<fg=red>$1</fg=red>');
+    }
+
+    private function makeAtNoteCyan(string $string): string
+    {
+        return Strings::replace($string, self::AT_START_REGEX, '<fg=cyan>$1</fg=cyan>');
+    }
+}

src/Console/Formatter/CompleteUnifiedDiffOutputBuilderFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Core\Console\Formatter;
+
+use Rector\Core\Util\Reflection\PrivatesAccessor;
+use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder;
+
+/**
+ * @api
+ * Creates @see UnifiedDiffOutputBuilder with "$contextLines = 1000;"
+ */
+final class CompleteUnifiedDiffOutputBuilderFactory
+{
+    public function __construct(
+        private readonly PrivatesAccessor $privatesAccessor
+    ) {
+    }
+
+    /**
+     * @api
+     */
+    public function create(): UnifiedDiffOutputBuilder
+    {
+        $unifiedDiffOutputBuilder = new UnifiedDiffOutputBuilder('');
+        $this->privatesAccessor->setPrivateProperty($unifiedDiffOutputBuilder, 'contextLines', 10000);
+        return $unifiedDiffOutputBuilder;
+    }
+}

src/Console/Formatter/ConsoleDiffer.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Core\Console\Formatter;
+
+use SebastianBergmann\Diff\Differ;
+
+final class ConsoleDiffer
+{
+    public function __construct(
+        private readonly Differ $differ,
+        private readonly ColorConsoleDiffFormatter $colorConsoleDiffFormatter
+    ) {
+    }
+
+    public function diff(string $old, string $new): string
+    {
+        $diff = $this->differ->diff($old, $new);
+        return $this->colorConsoleDiffFormatter->format($diff);
+    }
+}

src/Kernel/RectorKernel.php

@@ -15,7 +15,6 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symplify\AutowireArrayParameter\DependencyInjection\CompilerPass\AutowireArrayParameterCompilerPass;
-use Symplify\PackageBuilder\ValueObject\ConsoleColorDiffConfig;
 
 final class RectorKernel
 {
@@ -94,6 +93,6 @@ private function createCompilerPasses(): array
      */
     private function createDefaultConfigFiles(): array
     {
-        return [__DIR__ . '/../../config/config.php', ConsoleColorDiffConfig::FILE_PATH];
+        return [__DIR__ . '/../../config/config.php'];
     }
 }

tests/Console/Formatter/ColorConsoleDiffFormatterTest.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Core\Tests\Console\Formatter;
+
+use Iterator;
+use Nette\Utils\FileSystem;
+use PHPUnit\Framework\TestCase;
+use Rector\Core\Console\Formatter\ColorConsoleDiffFormatter;
+
+final class ColorConsoleDiffFormatterTest extends TestCase
+{
+    private ColorConsoleDiffFormatter $colorConsoleDiffFormatter;
+
+    protected function setUp(): void
+    {
+        $this->colorConsoleDiffFormatter = new ColorConsoleDiffFormatter();
+    }
+
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $content, string $expectedFormatedFileContent): void
+    {
+        $formattedContent = $this->colorConsoleDiffFormatter->format($content);
+
+        $this->assertStringEqualsFile($expectedFormatedFileContent, $formattedContent);
+    }
+
+    public function provideData(): Iterator
+    {
+        yield ['...', __DIR__ . '/Source/expected/expected.txt'];
+        yield ["-old\n+new", __DIR__ . '/Source/expected/expected_old_new.txt'];
+
+        yield [
+            FileSystem::read(__DIR__ . '/Fixture/with_full_diff_by_phpunit.diff'),
+            __DIR__ . '/Fixture/expected_with_full_diff_by_phpunit.diff',
+        ];
+    }
+}

tests/Console/Formatter/Fixture/expected_with_full_diff_by_phpunit.diff

@@ -0,0 +1,3 @@
+<comment>    ---------- begin diff ----------</comment>
+...
+<comment>    ----------- end diff -----------</comment>

tests/Console/Formatter/Fixture/with_full_diff_by_phpunit.diff

@@ -0,0 +1,3 @@
+--- Original
++++ New
+...

tests/Console/Formatter/Source/expected/expected.txt

@@ -0,0 +1,3 @@
+<comment>    ---------- begin diff ----------</comment>
+...
+<comment>    ----------- end diff -----------</comment>

tests/Console/Formatter/Source/expected/expected_old_new.txt

@@ -0,0 +1,4 @@
+<comment>    ---------- begin diff ----------</comment>
+<fg=red>-old</fg=red>
+<fg=green>+new</fg=green>
+<comment>    ----------- end diff -----------</comment>

tests/Util/Reflection/PrivatesAccessorTest.php

@@ -13,7 +13,7 @@
 
 final class PrivatesAccessorTest extends TestCase
 {
-    private PrivatesAccessor $privatesAccessor;
+    private readonly PrivatesAccessor $privatesAccessor;
 
     protected function setUp(): void
     {