[Console] Add --max-changes option to stop after N changed files

Author: TomasVotruba

src/Application/ApplicationFileProcessor.php

@@ -162,6 +162,12 @@ public function processFiles(
                 if ($fileProcessResult->hasChanged()) {
                     ++$totalChanged;
                 }
+
+                // stop once the requested number of files is changed, leaving the rest untouched
+                $maxChanges = $configuration->getMaxChanges();
+                if ($maxChanges !== null && $totalChanged >= $maxChanges) {
+                    break;
+                }
             } catch (Throwable $throwable) {
                 $this->changedFilesDetector->invalidateFile($filePath);
 

src/Configuration/ConfigurationFactory.php

@@ -10,6 +10,7 @@
 use Rector\ValueObject\Configuration;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use Webmozart\Assert\Assert;
 
 /**
  * @see \Rector\Tests\Configuration\ConfigurationFactoryTest
@@ -97,6 +98,13 @@ public function createFromInput(InputInterface $input): Configuration
             $isParallel = false;
         }
 
+        $maxChanges = $this->resolveMaxChanges($input);
+
+        // a global change counter cannot be shared across parallel workers, so enforce the limit in a single process
+        if ($maxChanges !== null) {
+            $isParallel = false;
+        }
+
         $memoryLimit = $this->resolveMemoryLimit($input);
 
         $isReportingWithRealPath = SimpleParameterProvider::provideBoolParameter(Option::ABSOLUTE_FILE_PATH);
@@ -140,9 +148,23 @@ public function createFromInput(InputInterface $input): Configuration
             $isComposerBased,
             $isPhpOnly,
             $filters,
+            $maxChanges,
         );
     }
 
+    private function resolveMaxChanges(InputInterface $input): ?int
+    {
+        $maxChanges = $input->getOption(Option::MAX_CHANGES);
+        if ($maxChanges === null) {
+            return null;
+        }
+
+        $maxChanges = (int) $maxChanges;
+        Assert::positiveInteger($maxChanges);
+
+        return $maxChanges;
+    }
+
     private function shouldShowProgressBar(InputInterface $input, string $outputFormat): bool
     {
         $noProgressBar = (bool) $input->getOption(Option::NO_PROGRESS_BAR);

src/Configuration/Option.php

@@ -148,6 +148,8 @@ final class Option
 
     public const string RULES_SUMMARY = 'rules-summary';
 
+    public const string MAX_CHANGES = 'max-changes';
+
     public const string CONFIG = 'config';
 
     /**

src/Console/ProcessConfigureDecorator.php

@@ -102,5 +102,12 @@ public static function decorate(Command $command): void
             InputOption::VALUE_NONE,
             'Show summary of rules applied during the run.'
         );
+
+        $command->addOption(
+            Option::MAX_CHANGES,
+            null,
+            InputOption::VALUE_REQUIRED,
+            'Stop after this many files are changed, leaving the rest untouched. Forces non-parallel run.'
+        );
     }
 }

src/ValueObject/Configuration.php

@@ -39,9 +39,15 @@ public function __construct(
         private bool $isComposerBased = false,
         private bool $isPhpOnly = false,
         private array $filters = [],
+        private ?int $maxChanges = null,
     ) {
     }
 
+    public function getMaxChanges(): ?int
+    {
+        return $this->maxChanges;
+    }
+
     public function isComposerBased(): bool
     {
         return $this->isComposerBased;

tests/Application/ApplicationFileProcessor/ApplicationFileProcessorTest.php

@@ -76,4 +76,24 @@ public function testOnlySuffixRunCachesUnderOwnScopeWithoutPoisoningFullRun(): v
         $this->changedFilesDetector->setActiveScope(null, null);
         $this->assertTrue($this->changedFilesDetector->hasFileChanged($filePath));
     }
+
+    public function testMaxChangesStopsAfterLimit(): void
+    {
+        self::$rectorConfig = null;
+        $this->bootFromConfigFiles([__DIR__ . '/config-max-changes.php']);
+        $applicationFileProcessor = $this->make(ApplicationFileProcessor::class);
+
+        $filePaths = [
+            __DIR__ . '/Source/WithEmptyMethodFirst.php',
+            __DIR__ . '/Source/WithEmptyMethodSecond.php',
+        ];
+
+        $processResult = $applicationFileProcessor->processFiles($filePaths, new Configuration(
+            isDryRun: true,
+            maxChanges: 1,
+        ));
+
+        // both files would change, but the limit stops the run after the first
+        $this->assertSame(1, $processResult->getTotalChanged());
+    }
 }

tests/Application/ApplicationFileProcessor/Source/WithEmptyMethodFirst.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Application\ApplicationFileProcessor\Source;
+
+final class WithEmptyMethodFirst
+{
+    public function run(): void
+    {
+    }
+}

tests/Application/ApplicationFileProcessor/Source/WithEmptyMethodSecond.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Application\ApplicationFileProcessor\Source;
+
+final class WithEmptyMethodSecond
+{
+    public function run(): void
+    {
+    }
+}

tests/Application/ApplicationFileProcessor/config-max-changes.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->cacheDirectory(sys_get_temp_dir() . '/_rector_max_changes_test');
+    $rectorConfig->rule(RemoveEmptyClassMethodRector::class);
+};