Refactor AnnotationExtractor fomr FileDiff value object to standalone…

… RectorsChangelogResolver service (#6088)
rectorphp · Apr 10, 2021 · f82a8dc · f82a8dc
1 parent 4587a7a
commit f82a8dc
Show file tree

Hide file tree

Showing 12 changed files with 166 additions and 196 deletions.
diff --git a/packages-tests/ChangesReporting/Annotation/AnnotationExtractorTest.php b/packages-tests/ChangesReporting/Annotation/AnnotationExtractorTest.php
@@ -6,8 +6,8 @@
 use Iterator;
 use PHPUnit\Framework\TestCase;
 use Rector\ChangesReporting\Annotation\AnnotationExtractor;
-use Rector\Tests\ChangesReporting\ValueObject\Source\RectorWithChangelog;
-use Rector\Tests\ChangesReporting\ValueObject\Source\RectorWithOutChangelog;
+use Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver\Source\RectorWithChangelog;
+use Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver\Source\RectorWithOutChangelog;
 
 final class AnnotationExtractorTest extends TestCase
 {

diff --git a/...ngesReporting/Annotation/AppliedRectorsChangelogResolver/RectorsChangelogResolverTest.php b/...ngesReporting/Annotation/AppliedRectorsChangelogResolver/RectorsChangelogResolverTest.php
@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver;
+
+use Rector\ChangesReporting\Annotation\RectorsChangelogResolver;
+use Rector\ChangesReporting\ValueObject\RectorWithFileAndLineChange;
+use Rector\Core\HttpKernel\RectorKernel;
+use Rector\Core\ValueObject\Reporting\FileDiff;
+use Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver\Source\RectorWithChangelog;
+use Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver\Source\RectorWithOutChangelog;
+use Symplify\PackageBuilder\Testing\AbstractKernelTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class RectorsChangelogResolverTest extends AbstractKernelTestCase
+{
+    /**
+     * @var RectorsChangelogResolver
+     */
+    private $rectorsChangelogResolver;
+
+    /**
+     * @var FileDiff
+     */
+    private $fileDiff;
+
+    protected function setUp(): void
+    {
+        $this->bootKernel(RectorKernel::class);
+        $this->rectorsChangelogResolver = $this->getService(RectorsChangelogResolver::class);
+
+        $this->fileDiff = $this->createFileDiff();
+    }
+
+    public function test(): void
+    {
+        $rectorsChangelogs = $this->rectorsChangelogResolver->resolve($this->fileDiff->getRectorClasses());
+
+        $expectedRectorsChangelogs = [
+            RectorWithChangelog::class => 'https://github.com/rectorphp/rector/blob/master/docs/rector_rules_overview.md',
+        ];
+        $this->assertSame($expectedRectorsChangelogs, $rectorsChangelogs);
+    }
+
+    private function createFileDiff(): FileDiff
+    {
+        // This is by intention to test the array_unique functionality
+        $rectorWithFileAndLineChange1 = new RectorWithFileAndLineChange(
+            new RectorWithChangelog(),
+            __DIR__ . '/Source/RectorWithChangelog.php',
+            1
+        );
+
+        $rectorWithFileAndLineChange2 = new RectorWithFileAndLineChange(
+            new RectorWithChangelog(),
+            __DIR__ . '/Source/RectorWithChangelog.php',
+            1
+        );
+
+        $rectorWithFileAndLineChange3 = new RectorWithFileAndLineChange(
+            new RectorWithOutChangelog(),
+            __DIR__ . '/Source/RectorWithOutChangelog.php',
+            1
+        );
+
+        $rectorWithFileAndLineChanges = [
+            $rectorWithFileAndLineChange1,
+            $rectorWithFileAndLineChange2,
+            $rectorWithFileAndLineChange3,
+        ];
+
+        return new FileDiff(new SmartFileInfo(__FILE__), 'foo', 'foo', $rectorWithFileAndLineChanges);
+    }
+}
diff --git a/...alueObject/Source/RectorWithChangelog.php → ...ogResolver/Source/RectorWithChangelog.php b/...alueObject/Source/RectorWithChangelog.php → ...ogResolver/Source/RectorWithChangelog.php
@@ -1,8 +1,8 @@
 <?php
-declare(strict_types=1);
 
+declare(strict_types=1);
 
-namespace Rector\Tests\ChangesReporting\ValueObject\Source;
+namespace Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver\Source;
 
 use Rector\Core\Contract\Rector\RectorInterface;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

diff --git a/...eObject/Source/RectorWithOutChangelog.php → ...esolver/Source/RectorWithOutChangelog.php b/...eObject/Source/RectorWithOutChangelog.php → ...esolver/Source/RectorWithOutChangelog.php
@@ -1,8 +1,8 @@
 <?php
-declare(strict_types=1);
 
+declare(strict_types=1);
 
-namespace Rector\Tests\ChangesReporting\ValueObject\Source;
+namespace Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver\Source;
 
 use Rector\Core\Contract\Rector\RectorInterface;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

diff --git a/packages-tests/ChangesReporting/ValueObject/FileDiffTest.php b/packages-tests/ChangesReporting/ValueObject/FileDiffTest.php
diff --git a/packages-tests/ChangesReporting/ValueObject/RectorWithFileAndLineChangeTest.php b/packages-tests/ChangesReporting/ValueObject/RectorWithFileAndLineChangeTest.php
diff --git a/packages/ChangesReporting/Annotation/AnnotationExtractor.php b/packages/ChangesReporting/Annotation/AnnotationExtractor.php
@@ -1,9 +1,11 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Rector\ChangesReporting\Annotation;
 
 use Nette\Utils\Strings;
+use Rector\Core\Contract\Rector\RectorInterface;
 use ReflectionClass;
 
 /**
@@ -12,7 +14,7 @@
 final class AnnotationExtractor
 {
     /**
-     * @param class-string<object> $className
+     * @param class-string<RectorInterface> $className
      */
     public function extractAnnotationFromClass(string $className, string $annotation): ?string
     {
@@ -26,7 +28,6 @@ public function extractAnnotationFromClass(string $className, string $annotation
         // @see https://regex101.com/r/oYGaWU/1
         $pattern = '#' . preg_quote($annotation, '#') . '\s+(?<content>.*?)$#m';
         $matches = Strings::match($docComment, $pattern);
-
         return $matches['content'] ?? null;
     }
 }
diff --git a/packages/ChangesReporting/Annotation/RectorsChangelogResolver.php b/packages/ChangesReporting/Annotation/RectorsChangelogResolver.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\ChangesReporting\Annotation;
+
+use Rector\Core\Contract\Rector\RectorInterface;
+
+final class RectorsChangelogResolver
+{
+    /**
+     * @var AnnotationExtractor
+     */
+    private $annotationExtractor;
+
+    public function __construct(AnnotationExtractor $annotationExtractor)
+    {
+        $this->annotationExtractor = $annotationExtractor;
+    }
+
+    /**
+     * @param array<class-string<RectorInterface>> $rectorClasses
+     * @return array<class-string, string>
+     */
+    public function resolve(array $rectorClasses): array
+    {
+        $rectorClassesToChangelogUrls = $this->resolveIncludingMissing($rectorClasses);
+        return array_filter($rectorClassesToChangelogUrls);
+    }
+
+    /**
+     * @param array<class-string<RectorInterface>> $rectorClasses
+     * @return array<class-string, string|null>
+     */
+    public function resolveIncludingMissing(array $rectorClasses): array
+    {
+        $rectorClassesToChangelogUrls = [];
+        foreach ($rectorClasses as $rectorClass) {
+            $changelogUrl = $this->annotationExtractor->extractAnnotationFromClass($rectorClass, '@changelog');
+            $rectorClassesToChangelogUrls[$rectorClass] = $changelogUrl;
+        }
+
+        return $rectorClassesToChangelogUrls;
+    }
+}
diff --git a/packages/ChangesReporting/Output/ConsoleOutputFormatter.php b/packages/ChangesReporting/Output/ConsoleOutputFormatter.php
@@ -5,7 +5,7 @@
 namespace Rector\ChangesReporting\Output;
 
 use Nette\Utils\Strings;
-use Rector\ChangesReporting\Annotation\AnnotationExtractor;
+use Rector\ChangesReporting\Annotation\RectorsChangelogResolver;
 use Rector\ChangesReporting\Application\ErrorAndDiffCollector;
 use Rector\ChangesReporting\Contract\Output\OutputFormatterInterface;
 use Rector\Core\Configuration\Configuration;
@@ -46,20 +46,20 @@ final class ConsoleOutputFormatter implements OutputFormatterInterface
     private $betterStandardPrinter;
 
     /**
-     * @var AnnotationExtractor
+     * @var RectorsChangelogResolver
      */
-    private $annotationExtractor;
+    private $rectorsChangelogResolver;
 
     public function __construct(
         BetterStandardPrinter $betterStandardPrinter,
         Configuration $configuration,
         SymfonyStyle $symfonyStyle,
-        AnnotationExtractor $annotationExtractor
+        RectorsChangelogResolver $rectorsChangelogResolver
     ) {
         $this->symfonyStyle = $symfonyStyle;
         $this->betterStandardPrinter = $betterStandardPrinter;
         $this->configuration = $configuration;
-        $this->annotationExtractor = $annotationExtractor;
+        $this->rectorsChangelogResolver = $rectorsChangelogResolver;
     }
 
     public function report(ErrorAndDiffCollector $errorAndDiffCollector): void
@@ -119,10 +119,12 @@ private function reportFileDiffs(array $fileDiffs): void
             $this->symfonyStyle->writeln($fileDiff->getDiffConsoleFormatted());
             $this->symfonyStyle->newLine();
 
+            $rectorsChangelogsLines = $this->createRectorChangelogLines($fileDiff);
+
             if ($fileDiff->getRectorChanges() !== []) {
                 $this->symfonyStyle->writeln('<options=underscore>Applied rules:</>');
                 $this->symfonyStyle->newLine();
-                $this->symfonyStyle->listing($fileDiff->getRectorClassesWithChangelogUrl($this->annotationExtractor));
+                $this->symfonyStyle->listing($rectorsChangelogsLines);
                 $this->symfonyStyle->newLine();
             }
         }
@@ -232,4 +234,19 @@ private function createSuccessMessage(ErrorAndDiffCollector $errorAndDiffCollect
             $this->configuration->isDryRun() ? 'would have changed (dry-run)' : ($changeCount === 1 ? 'has' : 'have') . ' been changed'
         );
     }
+
+    /**
+     * @return string[]
+     */
+    private function createRectorChangelogLines(FileDiff $fileDiff): array
+    {
+        $rectorsChangelogs = $this->rectorsChangelogResolver->resolveIncludingMissing($fileDiff->getRectorClasses());
+
+        $rectorsChangelogsLines = [];
+        foreach ($rectorsChangelogs as $rectorClass => $changelog) {
+            $rectorsChangelogsLines[] = $changelog === null ? $rectorClass : $rectorClass . ' ' . $changelog;
+        }
+
+        return $rectorsChangelogsLines;
+    }
 }