add CurrentRectorProvider

Author: TomasVotruba

.github/workflows/annotated_checkstyle.yaml

@@ -19,4 +19,4 @@ jobs:
                     tools: cs2pr
             -   run: composer install --no-progress
             -   run: |
-                    bin/rector p abz/DeadCode.php --set dead-code -n --autoload-file abz/DeadCode.php --output-format=checkstyle | cs2pr
+                    bin/rector process --config rector-ci.yaml --no-progress-bar --ansi --dry-run --output-format=checkstyle | cs2pr

docs/AllRectorsOverview.md

@@ -7015,9 +7015,9 @@ Changes heredoc/nowdoc that contains closing word to safe wrapper name
 
 <br>
 
-### `SetcookieRector`
+### `SetCookieRector`
 
-- class: [`Rector\Php73\Rector\FuncCall\SetcookieRector`](/../master/rules/php-73/src/Rector/FuncCall/SetcookieRector.php)
+- class: [`Rector\Php73\Rector\FuncCall\SetCookieRector`](/../master/rules/php-73/src/Rector/FuncCall/SetCookieRector.php)
 - [test fixtures](/../master/rules/php-73/tests/Rector/FuncCall/SetcookieRector/Fixture)
 
 Convert setcookie argument to PHP7.3 option array

packages/changes-reporting/src/Collector/RectorChangeCollector.php

@@ -7,7 +7,8 @@
 use PhpParser\Node;
 use Rector\ChangesReporting\ValueObject\RectorWithFileAndLineChange;
 use Rector\Core\Contract\Rector\RectorInterface;
-use Rector\Core\Exception\NotRectorException;
+use Rector\Core\Exception\ShouldNotHappenException;
+use Rector\Core\Logging\CurrentRectorProvider;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
@@ -18,14 +19,20 @@ final class RectorChangeCollector
      */
     private $rectorWithFileAndLineChanges = [];
 
-    public function addRectorClassWithLine(string $rectorClass, SmartFileInfo $smartFileInfo, int $line): void
+    /**
+     * @var CurrentRectorProvider
+     */
+    private $currentRectorProvider;
+
+    public function __construct(CurrentRectorProvider $currentRectorProvider)
     {
-        if (! is_a($rectorClass, RectorInterface::class, true)) {
-            throw new NotRectorException($rectorClass);
-        }
+        $this->currentRectorProvider = $currentRectorProvider;
+    }
 
+    public function addRectorClassWithLine(RectorInterface $rector, SmartFileInfo $smartFileInfo, int $line): void
+    {
         $this->rectorWithFileAndLineChanges[] = new RectorWithFileAndLineChange(
-            $rectorClass,
+            $rector,
             $smartFileInfo->getRealPath(),
             $line
         );
@@ -53,6 +60,11 @@ public function notifyNodeFileInfo(Node $node): void
             return;
         }
 
-        $this->addRectorClassWithLine(static::class, $fileInfo, $node->getLine());
+        $currentRector = $this->currentRectorProvider->getCurrentRector();
+        if ($currentRector === null) {
+            throw new ShouldNotHappenException();
+        }
+
+        $this->addRectorClassWithLine($currentRector, $fileInfo, $node->getLine());
     }
 }

packages/changes-reporting/src/Output/CheckstyleOutputFormatter.php

@@ -62,10 +62,13 @@ private function writeFileErrors(FileDiff $fileDiff): void
         $this->symfonyStyle->writeln(sprintf('<file name="%s">', $this->escape($fileDiff->getRelativeFilePath())));
 
         foreach ($fileDiff->getRectorChanges() as $rectorChange) {
+            $message = $rectorChange->getRectorDefinitionsDescription() . ' (Reported by: ' . $rectorChange->getRectorClass() . ')';
+            $message = $this->escape($message);
+
             $error = sprintf(
                 '  <error line="%d" column="1" severity="error" message="%s" />',
                 $this->escape((string) $rectorChange->getLine()),
-                $this->escape((string) $rectorChange->getRectorClass())
+                $message
             );
             $this->symfonyStyle->writeln($error);
         }

packages/changes-reporting/src/ValueObject/RectorWithFileAndLineChange.php

@@ -5,14 +5,13 @@
 namespace Rector\ChangesReporting\ValueObject;
 
 use Rector\Core\Contract\Rector\RectorInterface;
-use Rector\Core\Exception\NotRectorException;
 
 final class RectorWithFileAndLineChange
 {
     /**
-     * @var string
+     * @var RectorInterface
      */
-    private $rectorClass;
+    private $rector;
 
     /**
      * @var int
@@ -24,20 +23,26 @@ final class RectorWithFileAndLineChange
      */
     private $realPath;
 
-    public function __construct(string $rectorClass, string $realPath, int $line)
+    public function __construct(RectorInterface $rector, string $realPath, int $line)
     {
-        if (! is_a($rectorClass, RectorInterface::class, true)) {
-            throw new NotRectorException($rectorClass);
-        }
-
-        $this->rectorClass = $rectorClass;
+        $this->rector = $rector;
         $this->line = $line;
         $this->realPath = $realPath;
     }
 
+    public function getRector(): RectorInterface
+    {
+        return $this->rector;
+    }
+
+    public function getRectorDefinitionsDescription(): string
+    {
+        return $this->rector->getDefinition()->getDescription();
+    }
+
     public function getRectorClass(): string
     {
-        return $this->rectorClass;
+        return get_class($this->rector);
     }
 
     public function getLine(): int

src/Logging/CurrentRectorProvider.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Core\Logging;
+
+use Rector\Core\Contract\Rector\RectorInterface;
+
+final class CurrentRectorProvider
+{
+    /**
+     * @var RectorInterface|null
+     */
+    private $currentRector;
+
+    public function changeCurrentRector(RectorInterface $rector): void
+    {
+        $this->currentRector = $rector;
+    }
+
+    public function getCurrentRector(): ?RectorInterface
+    {
+        return $this->currentRector;
+    }
+}

src/Rector/AbstractRector.php

@@ -20,6 +20,7 @@
 use Rector\Core\Configuration\Option;
 use Rector\Core\Contract\Rector\PhpRectorInterface;
 use Rector\Core\Exclusion\ExclusionManager;
+use Rector\Core\Logging\CurrentRectorProvider;
 use Rector\NodeTypeResolver\FileSystem\CurrentFileInfoProvider;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\NodeTypeResolver\PhpDoc\NodeAnalyzer\DocBlockManipulator;
@@ -85,6 +86,11 @@ abstract class AbstractRector extends NodeVisitorAbstract implements PhpRectorIn
      */
     protected $staticTypeMapper;
 
+    /**
+     * @var CurrentRectorProvider
+     */
+    private $currentRectorProvider;
+
     /**
      * @var string[]
      */
@@ -122,7 +128,8 @@ public function autowireAbstractRectorDependencies(
         PhpDocInfoPrinter $phpDocInfoPrinter,
         DocBlockManipulator $docBlockManipulator,
         StaticTypeMapper $staticTypeMapper,
-        ParameterProvider $parameterProvider
+        ParameterProvider $parameterProvider,
+        CurrentRectorProvider $currentRectorProvider
     ): void {
         $this->symfonyStyle = $symfonyStyle;
         $this->phpVersionProvider = $phpVersionProvider;
@@ -134,6 +141,7 @@ public function autowireAbstractRectorDependencies(
         $this->docBlockManipulator = $docBlockManipulator;
         $this->staticTypeMapper = $staticTypeMapper;
         $this->parameterProvider = $parameterProvider;
+        $this->currentRectorProvider = $currentRectorProvider;
     }
 
     /**
@@ -145,6 +153,8 @@ final public function enterNode(Node $node)
             return null;
         }
 
+        $this->currentRectorProvider->changeCurrentRector($this);
+
         // show current Rector class on --debug
         if ($this->symfonyStyle->isDebug()) {
             // indented on purpose to improve log nesting under [refactoring]

tests/Standalone/RectorStandaloneRunnerTest.php

@@ -5,24 +5,15 @@
 namespace Rector\Core\Tests\Standalone;
 
 use PHPUnit\Framework\TestCase;
-use Rector\Core\Standalone\RectorStandaloneRunner;
 use Rector\Core\Standalone\RectorStandaloneRunnerStaticFactory;
 
 final class RectorStandaloneRunnerTest extends TestCase
 {
-    /**
-     * @var RectorStandaloneRunner
-     */
-    private $rectorStandaloneRunner;
-
-    protected function setUp(): void
-    {
-        $this->rectorStandaloneRunner = RectorStandaloneRunnerStaticFactory::create();
-    }
-
     public function test(): void
     {
-        $errorAndDiffCollector = $this->rectorStandaloneRunner->processSourceWithSet(
+        $rectorStandaloneRunner = RectorStandaloneRunnerStaticFactory::create();
+
+        $errorAndDiffCollector = $rectorStandaloneRunner->processSourceWithSet(
             [__DIR__ . '/Source/LowQualityFile.php'],
             'code-quality',
             true,