Add "--only" option to process only a single rule (#6441)

* Add "--only" option to process only a single rule

The option for the "process" and "list-rules" commands applies
the single given rule only, without needing to modify
the configuration file.

The option value must be a fully classified class name:

  --only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

A hint is given when the user forgot to escape the backslashes.

----

It is impossible to modify the injected "$rectors" after the
command line configuration is parsed, so I had to introduce the
ConfigurationRuleFilter singleton.

Since both ListRulesCommand and ProcessCommand make use of the
ConfigurationRuleFilter - but list-rules does not have a Configuration -
I had to make the filterOnlyRule() method public to prevent
code duplication.

Resolves rectorphp/rector#8899

* Allow --rule option to take short rule names

.. but throw an exception if the name is ambiguous

.github/workflows/e2e.yaml

@@ -35,6 +35,11 @@ jobs:
                     - 'e2e/invalid-paths'
                     - 'e2e/applied-polyfill-php80'
                     - 'e2e/print-new-node'
+                    - 'e2e/only-option'
+                    - 'e2e/only-option-quote-double-equalnone'
+                    - 'e2e/only-option-quote-single'
+                    - 'e2e/only-option-quote-single-bsdouble'
+                    - 'e2e/only-option-quote-single-equalnone'
 
         name: End to end test - ${{ matrix.directory }}
 

e2e/e2eTestRunner.php

@@ -31,6 +31,12 @@
     $e2eCommand .= ' -a ' . $argv[2];
 }
 
+$cliOptions = 'cli-options.txt';
+if (file_exists($cliOptions)) {
+    $e2eCommand .= ' ' . trim(file_get_contents($cliOptions));
+}
+
+
 exec($e2eCommand, $output, $exitCode);
 $output = trim(implode("\n", $output));
 $output = str_replace(__DIR__, '.', $output);

e2e/only-option-quote-double-equalnone/cli-options.txt

@@ -0,0 +1 @@
+--only "Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

e2e/only-option-quote-double-equalnone/composer.json

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

e2e/only-option-quote-double-equalnone/expected-output.diff

@@ -0,0 +1,22 @@
+1 file with changes
+===================
+
+1) ../only-option/src/MultiRules.php:9
+
+    ---------- begin diff ----------
+@@ @@
+             echo 'a statement';
+         }
+     }
+-
+-    private function notUsed()
+-    {
+-    }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveUnusedPrivateMethodRector
+
+
+ [OK] 1 file would have been changed (dry-run) by Rector

e2e/only-option-quote-double-equalnone/rector.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
+use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/../only-option/src',
+    ]);
+
+    $rectorConfig->rules([
+        RemoveAlwaysElseRector::class,
+        RemoveUnusedPrivateMethodRector::class,
+    ]);
+};

e2e/only-option-quote-single-bsdouble/cli-options.txt

@@ -0,0 +1 @@
+--only='Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector'

e2e/only-option-quote-single-bsdouble/composer.json

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

e2e/only-option-quote-single-bsdouble/expected-output.diff

@@ -0,0 +1,22 @@
+1 file with changes
+===================
+
+1) ../only-option/src/MultiRules.php:9
+
+    ---------- begin diff ----------
+@@ @@
+             echo 'a statement';
+         }
+     }
+-
+-    private function notUsed()
+-    {
+-    }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveUnusedPrivateMethodRector
+
+
+ [OK] 1 file would have been changed (dry-run) by Rector

e2e/only-option-quote-single-bsdouble/rector.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
+use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/../only-option/src',
+    ]);
+
+    $rectorConfig->rules([
+        RemoveAlwaysElseRector::class,
+        RemoveUnusedPrivateMethodRector::class,
+    ]);
+};

e2e/only-option-quote-single-equalnone/cli-options.txt

@@ -0,0 +1 @@
+--only 'Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector'

e2e/only-option-quote-single-equalnone/composer.json

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

e2e/only-option-quote-single-equalnone/expected-output.diff

@@ -0,0 +1,22 @@
+1 file with changes
+===================
+
+1) ../only-option/src/MultiRules.php:9
+
+    ---------- begin diff ----------
+@@ @@
+             echo 'a statement';
+         }
+     }
+-
+-    private function notUsed()
+-    {
+-    }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveUnusedPrivateMethodRector
+
+
+ [OK] 1 file would have been changed (dry-run) by Rector

e2e/only-option-quote-single-equalnone/rector.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
+use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/../only-option/src',
+    ]);
+
+    $rectorConfig->rules([
+        RemoveAlwaysElseRector::class,
+        RemoveUnusedPrivateMethodRector::class,
+    ]);
+};

e2e/only-option-quote-single/cli-options.txt

@@ -0,0 +1 @@
+--only='Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector'

e2e/only-option-quote-single/composer.json

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

e2e/only-option-quote-single/expected-output.diff

@@ -0,0 +1,22 @@
+1 file with changes
+===================
+
+1) ../only-option/src/MultiRules.php:9
+
+    ---------- begin diff ----------
+@@ @@
+             echo 'a statement';
+         }
+     }
+-
+-    private function notUsed()
+-    {
+-    }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveUnusedPrivateMethodRector
+
+
+ [OK] 1 file would have been changed (dry-run) by Rector

e2e/only-option-quote-single/rector.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
+use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/../only-option/src',
+    ]);
+
+    $rectorConfig->rules([
+        RemoveAlwaysElseRector::class,
+        RemoveUnusedPrivateMethodRector::class,
+    ]);
+};

e2e/only-option/cli-options.txt

@@ -0,0 +1 @@
+--only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

e2e/only-option/composer.json

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

e2e/only-option/expected-output.diff

@@ -0,0 +1,22 @@
+1 file with changes
+===================
+
+1) src/MultiRules.php:9
+
+    ---------- begin diff ----------
+@@ @@
+             echo 'a statement';
+         }
+     }
+-
+-    private function notUsed()
+-    {
+-    }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveUnusedPrivateMethodRector
+
+
+ [OK] 1 file would have been changed (dry-run) by Rector

e2e/only-option/rector.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
+use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+    ]);
+
+    $rectorConfig->rules([
+        RemoveAlwaysElseRector::class,
+        RemoveUnusedPrivateMethodRector::class,
+    ]);
+};
+

e2e/only-option/src/MultiRules.php

@@ -0,0 +1,17 @@
+<?php
+
+final class MultiRules
+{
+    public function doSomething()
+    {
+        if (true === false) {
+            return -1;
+        } else {
+            echo 'a statement';
+        }
+    }
+
+    private function notUsed()
+    {
+    }
+}

e2e/only-option/src/RemoveAlwaysElse.php

@@ -0,0 +1,13 @@
+<?php
+
+class RemoveAlwaysElse
+{
+    public function run($value)
+    {
+        if ($value) {
+            throw new \InvalidStateException;
+        } else {
+            return 10;
+        }
+    }
+}

src/Configuration/ConfigurationFactory.php

@@ -16,7 +16,8 @@
 final readonly class ConfigurationFactory
 {
     public function __construct(
-        private SymfonyStyle $symfonyStyle
+        private SymfonyStyle $symfonyStyle,
+        private readonly OnlyRuleResolver $onlyRuleResolver,
     ) {
     }
 
@@ -41,7 +42,8 @@ public function createForTests(array $paths): Configuration
             false,
             null,
             false,
-            false
+            false,
+            null
         );
     }
 
@@ -62,6 +64,11 @@ public function createFromInput(InputInterface $input): Configuration
 
         $fileExtensions = SimpleParameterProvider::provideArrayParameter(Option::FILE_EXTENSIONS);
 
+        $onlyRule = $input->getOption(Option::ONLY);
+        if ($onlyRule !== null) {
+            $onlyRule = $this->onlyRuleResolver->resolve($onlyRule);
+        }
+
         $isParallel = SimpleParameterProvider::provideBoolParameter(Option::PARALLEL);
         $parallelPort = (string) $input->getOption(Option::PARALLEL_PORT);
         $parallelIdentifier = (string) $input->getOption(Option::PARALLEL_IDENTIFIER);
@@ -90,6 +97,7 @@ public function createFromInput(InputInterface $input): Configuration
             $memoryLimit,
             $isDebug,
             $isReportingWithRealPath,
+            $onlyRule,
         );
     }