Add PostRectorInterface instance class names to list of applied rectors (#7304)

* [WIP] Add PostRectorInterface instances to list of applied rectors

* make RectorWithLineChange allow PostRectorInterface class-string type

* Rename getRectorClasses() to getMainRectorClasses() to differentiate use of PostRectorIntercace instance

* Fix phpstan

* [ci-review] Rector Rectify

* grammar fix

* grammar fix

* part 1: apply line with change on ClassRenamingPostRector

* part 2: apply line with change on DocblockNameImportingPostRector

* [ci-review] Rector Rectify

* Fix phpstan

* part 3: apply line with change on UnusedImportRemovingPostRector

* part 4: ensure partial remove use detected

* part 4: ensure partial remove use detected

* part 5: add rector clas with line on NameImportingPostRector

* Add OriginalNameImportSkipVoter for auto import

* Fix no change handling

* Fix cs

* Add e2e test

* Final touch: add UseAddingPostRector that NameImportingPostRector is rely when NameImportingPostRector exists

* Final touch: add UseAddingPostRector that NameImportingPostRector is rely when NameImportingPostRector exists

* final touch: fix grammar

* Really final touch: ensure UseAddingPostRector correctly added when exactly applied

* Really final touch: clean up

* Really Really final touch: use call addRectorClassWithLine() itself on UseAddingPostRector when there is add to use

* Really final touch: clean up logic

---------

Co-authored-by: GitHub Action <actions@github.com>

Author: samsonasik

.github/workflows/e2e.yaml

@@ -24,6 +24,7 @@ jobs:
             matrix:
                 php_version: ['8.2']
                 directory:
+                    - 'e2e/applied-auto-import'
                     - 'e2e/applied-polyfill-php80'
                     - 'e2e/applied-rule-change-docblock'
                     - 'e2e/applied-rule-removed-node'

e2e/applied-auto-import/.gitignore

@@ -0,0 +1 @@
+/vendor

e2e/applied-auto-import/composer.json

@@ -0,0 +1,7 @@
+{
+    "require": {
+        "php": "^8.1"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

e2e/applied-auto-import/expected-output.diff

@@ -0,0 +1,32 @@
+1 file with changes
+===================
+
+1) src/RenameDocblock.php:2
+
+    ---------- begin diff ----------
+@@ @@
+
+ namespace App;
+
+-use SomeUnusedClass;
++use DateTimeInterface;
+
+ /**
+- * @param \DateTime $someOldClass
++ * @param DateTimeInterface $someOldClass
+  */
+-function someFunction(\DateTime $someOldClass)
++function someFunction(DateTimeInterface $someOldClass)
+ {
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RenameClassRector
+ * DocblockNameImportingPostRector
+ * NameImportingPostRector
+ * UnusedImportRemovingPostRector
+ * UseAddingPostRector
+
+
+ [OK] 1 file would have been changed (dry-run) by Rector

e2e/applied-auto-import/rector.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Renaming\Rector\Name\RenameClassRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+    ]);
+
+    $rectorConfig->ruleWithConfiguration(RenameClassRector::class, [
+        'DateTime' => 'DateTimeInterface'
+    ]);
+
+    $rectorConfig->importNames();
+    $rectorConfig->removeUnusedImports();
+};

e2e/applied-auto-import/src/RenameDocblock.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App;
+
+use SomeUnusedClass;
+
+/**
+ * @param \DateTime $someOldClass
+ */
+function someFunction(\DateTime $someOldClass)
+{
+}

phpstan.neon

@@ -238,6 +238,7 @@ parameters:
             paths:
                 # caching and message of specific child Rector rules
                 - src/Rector/AbstractRector.php
+                - src/PostRector/Rector/AbstractPostRector.php
                 # for cache
                 - src/Testing/PHPUnit/AbstractRectorTestCase.php
 

rules/CodingStyle/Application/UseImportsAdder.php

@@ -31,15 +31,14 @@ public function __construct(
      * @param array<FullyQualifiedObjectType|AliasedObjectType> $useImportTypes
      * @param array<FullyQualifiedObjectType|AliasedObjectType> $constantUseImportTypes
      * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
-     * @return Stmt[]
      */
     public function addImportsToStmts(
         FileWithoutNamespace $fileWithoutNamespace,
         array $stmts,
         array $useImportTypes,
         array $constantUseImportTypes,
         array $functionUseImportTypes
-    ): array {
+    ): bool {
         $usedImports = $this->usedImportsResolver->resolveForStmts($stmts);
         $existingUseImportTypes = $usedImports->getUseImports();
         $existingConstantUseImports = $usedImports->getConstantImports();
@@ -57,7 +56,7 @@ public function addImportsToStmts(
 
         $newUses = $this->createUses($useImportTypes, $constantUseImportTypes, $functionUseImportTypes, null);
         if ($newUses === []) {
-            return [$fileWithoutNamespace];
+            return false;
         }
 
         $stmts = array_values(array_filter($stmts, static function (Stmt $stmt): bool {
@@ -94,7 +93,7 @@ public function addImportsToStmts(
             $fileWithoutNamespace->stmts = $stmts;
             $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 
-            return [$fileWithoutNamespace];
+            return true;
         }
 
         $this->mirrorUseComments($stmts, $newUses);
@@ -103,7 +102,7 @@ public function addImportsToStmts(
         $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
         $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 
-        return [$fileWithoutNamespace];
+        return true;
     }
 
     /**
@@ -116,7 +115,7 @@ public function addImportsToNamespace(
         array $useImportTypes,
         array $constantUseImportTypes,
         array $functionUseImportTypes
-    ): void {
+    ): bool {
         $namespaceName = $this->getNamespaceName($namespace);
 
         $existingUsedImports = $this->usedImportsResolver->resolveForStmts($namespace->stmts);
@@ -141,13 +140,15 @@ public function addImportsToNamespace(
         $newUses = $this->createUses($useImportTypes, $constantUseImportTypes, $functionUseImportTypes, $namespaceName);
 
         if ($newUses === []) {
-            return;
+            return false;
         }
 
         $this->mirrorUseComments($namespace->stmts, $newUses);
 
         $namespace->stmts = array_merge($newUses, $this->resolveInsertNop($namespace), $namespace->stmts);
         $namespace->stmts = array_values($namespace->stmts);
+
+        return true;
     }
 
     /**

rules/CodingStyle/Application/UseImportsRemover.php

@@ -4,8 +4,9 @@
 
 namespace Rector\CodingStyle\Application;
 
-use PhpParser\Node\Stmt;
+use PhpParser\Node\Stmt\Namespace_;
 use PhpParser\Node\Stmt\Use_;
+use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
 use Rector\Renaming\Collector\RenamedNameCollector;
 
 final readonly class UseImportsRemover
@@ -16,35 +17,40 @@ public function __construct(
     }
 
     /**
-     * @param Stmt[] $stmts
      * @param string[] $removedUses
-     * @return Stmt[]
      */
-    public function removeImportsFromStmts(array $stmts, array $removedUses): array
+    public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
     {
         $hasRemoved = false;
-        foreach ($stmts as $key => $stmt) {
+        foreach ($node->stmts as $key => $stmt) {
             if (! $stmt instanceof Use_) {
                 continue;
             }
 
-            $stmt = $this->removeUseFromUse($removedUses, $stmt);
+            if ($this->removeUseFromUse($removedUses, $stmt)) {
+                $node->stmts[$key] = $stmt;
+                $hasRemoved = true;
+            }
 
             // remove empty uses
             if ($stmt->uses === []) {
-                unset($stmts[$key]);
-                $hasRemoved = true;
+                unset($node->stmts[$key]);
             }
         }
 
-        return $hasRemoved ? array_values($stmts) : $stmts;
+        if ($hasRemoved) {
+            $node->stmts = array_values($node->stmts);
+        }
+
+        return $hasRemoved;
     }
 
     /**
      * @param string[] $removedUses
      */
-    private function removeUseFromUse(array $removedUses, Use_ $use): Use_
+    private function removeUseFromUse(array $removedUses, Use_ $use): bool
     {
+        $hasChanged = false;
         foreach ($use->uses as $usesKey => $useUse) {
             $useName = $useUse->name->toString();
             if (! in_array($useName, $removedUses, true)) {
@@ -56,8 +62,13 @@ private function removeUseFromUse(array $removedUses, Use_ $use): Use_
             }
 
             unset($use->uses[$usesKey]);
+            $hasChanged = true;
+        }
+
+        if ($hasChanged) {
+            $use->uses = array_values($use->uses);
         }
 
-        return $use;
+        return $hasChanged;
     }
 }

src/Bridge/SetRectorsResolver.php

@@ -46,7 +46,7 @@ public function resolveFromFilePathIncludingConfiguration(string $configFilePath
     {
         $rectorConfig = $this->loadRectorConfigFromFilePath($configFilePath);
 
-        $rectorClassesWithOptionalConfiguration = $rectorConfig->getRectorClasses();
+        $rectorClassesWithOptionalConfiguration = $rectorConfig->getMainRectorClasses();
 
         foreach ($rectorConfig->getRuleConfigurations() as $rectorClass => $configuration) {
             // remove from non-configurable, if added again with better config