ProcessCommand.php

<?php

declare(strict_types=1);

namespace Rector\Console\Command;

use Rector\Application\ApplicationFileProcessor;
use Rector\Autoloading\AdditionalAutoloader;
use Rector\Caching\Detector\ChangedFilesDetector;
use Rector\ChangesReporting\Output\JsonOutputFormatter;
use Rector\Configuration\ConfigInitializer;
use Rector\Configuration\ConfigurationFactory;
use Rector\Configuration\ConfigurationRuleFilter;
use Rector\Configuration\Option;
use Rector\Configuration\Parameter\SimpleParameterProvider;
use Rector\Console\ExitCode;
use Rector\Console\Output\OutputFormatterCollector;
use Rector\Console\ProcessConfigureDecorator;
use Rector\Exception\ShouldNotHappenException;
use Rector\Reporting\DeprecatedRulesReporter;
use Rector\Reporting\MissConfigurationReporter;
use Rector\Skipper\SkipCriteriaResolver\SkippedClassResolver;
use Rector\StaticReflection\DynamicSourceLocatorDecorator;
use Rector\Util\MemoryLimiter;
use Rector\ValueObject\Configuration;
use Rector\ValueObject\Configuration\LevelOverflow;
use Rector\ValueObject\ProcessResult;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

final class ProcessCommand extends Command
{
    public function __construct(
        private readonly AdditionalAutoloader $additionalAutoloader,
        private readonly ChangedFilesDetector $changedFilesDetector,
        private readonly ConfigInitializer $configInitializer,
        private readonly ApplicationFileProcessor $applicationFileProcessor,
        private readonly DynamicSourceLocatorDecorator $dynamicSourceLocatorDecorator,
        private readonly OutputFormatterCollector $outputFormatterCollector,
        private readonly SymfonyStyle $symfonyStyle,
        private readonly MemoryLimiter $memoryLimiter,
        private readonly ConfigurationFactory $configurationFactory,
        private readonly DeprecatedRulesReporter $deprecatedRulesReporter,
        private readonly MissConfigurationReporter $missConfigurationReporter,
        private readonly ConfigurationRuleFilter $configurationRuleFilter,
        private readonly SkippedClassResolver $skippedClassResolver,
    ) {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this->setName('process');
        $this->setAliases(['p']);
        $this->setDescription('Upgrades or refactors source code with provided Rector rules');
        $this->setHelp(
            <<<'EOF'
The <info>%command.name%</info> command will run Rector main feature:

  <info>vendor/bin/rector</info>

To specify a folder or a file, you can run:

  <info>vendor/bin/rector src/Controller</info>

You can also dry run to see the changes that Rector will make with the <comment>--dry-run</comment> option:

  <info>vendor/bin/rector src/Controller --dry-run</info>

It's also possible to get debug via the <comment>--debug</comment> option:

  <info>vendor/bin/rector src/Controller --dry-run --debug</info>
EOF
        );

        ProcessConfigureDecorator::decorate($this);

        parent::configure();
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        // missing config? add it :)
        if (! $this->configInitializer->areSomeRectorsLoaded()) {
            $this->configInitializer->createConfig(getcwd());
            return self::SUCCESS;
        }

        $configuration = $this->configurationFactory->createFromInput($input);

        $this->memoryLimiter->adjust($configuration);
        $this->configurationRuleFilter->setConfiguration($configuration);

        // disable console output in case of json output formatter
        if ($configuration->getOutputFormat() === JsonOutputFormatter::NAME) {
            $this->symfonyStyle->setVerbosity(OutputInterface::VERBOSITY_QUIET);
        }

        $this->additionalAutoloader->autoloadInput($input);

        $paths = $configuration->getPaths();

        // 0. warn about too high levels
        foreach ($configuration->getLevelOverflows() as $levelOverflow) {
            $this->reportLevelOverflow($levelOverflow);
        }

        // 0. warn about skipped rules that are deprecated
        if ($this->skippedClassResolver->resolveDeprecatedSkippedClasses() !== []) {
            $this->symfonyStyle->warning(sprintf(
                'These rules are skipped, but are deprecated. Most likely you do not need to skip them anymore as not part of any set and remove them: %s* %s',
                "\n\n",
                implode(' * ', $this->skippedClassResolver->resolveDeprecatedSkippedClasses()) . "\n"
            ));
        }

        // 1. warn about rules registered in both withRules() and sets to avoid bloated rector.php configs
        $setAndRulesDuplicatedRegistrations = $configuration->getBothSetAndRulesDuplicatedRegistrations();
        if ($setAndRulesDuplicatedRegistrations !== []) {
            $this->symfonyStyle->warning(sprintf(
                'These rules are registered in both sets and "withRules()". Remove them from "withRules()" to avoid duplications: %s* %s',
                "\n\n",
                implode(' * ', $setAndRulesDuplicatedRegistrations) . "\n"
            ));
        }

        // 2. add files and directories to static locator
        $this->dynamicSourceLocatorDecorator->addPaths($paths);
        if ($this->dynamicSourceLocatorDecorator->arePathsEmpty()) {
            // read from rector.php, no paths definition needs withPaths() config
            if ($paths === []) {
                $this->symfonyStyle->error(
                    'Provide paths in Rector config. See ways: https://getrector.com/documentation/define-paths'
                );

                return ExitCode::FAILURE;
            }

            // read from cli paths arguments, eg: vendor/bin/rector process A B C which A, B, and C not exists
            $isSingular = count($paths) === 1;
            $this->symfonyStyle->error(
                sprintf(
                    'The following given path%s do%s not match any file%s or director%s: %s%s',
                    $isSingular ? '' : 's',
                    $isSingular ? 'es' : '',
                    $isSingular ? '' : 's',
                    $isSingular ? 'y' : 'ies',
                    "\n\n" . ' - ',
                    implode("\n" . ' - ', $paths)
                )
            );

            return ExitCode::FAILURE;
        }

        // autoload paths is register to DynamicSourceLocatorProvider,
        // so check after arePathsEmpty() above
        // check in no parallel since parallel will require register on its own process
        if (! $configuration->isParallel()) {
            $this->additionalAutoloader->autoloadPaths();
        }

        // show debug info
        if ($configuration->isDebug()) {
            $this->reportLoadedComposerBasedSets();
        }

        // MAIN PHASE
        // 2. run Rector
        $processResult = $this->applicationFileProcessor->run($configuration, $input);

        // REPORTING PHASE
        // 3. reporting phaseRunning 2nd time with collectors data
        // report diffs and errors
        $outputFormat = $configuration->getOutputFormat();
        $outputFormatter = $this->outputFormatterCollector->getByName($outputFormat);

        $outputFormatter->report($processResult, $configuration);

        // 4. Deprecations reporter
        $this->deprecatedRulesReporter->reportDeprecatedRules();
        $this->deprecatedRulesReporter->reportDeprecatedSkippedRules();
        $this->deprecatedRulesReporter->reportDeprecatedNodeTypes();
        $this->deprecatedRulesReporter->reportDeprecatedRectorUnsupportedMethods();

        $this->missConfigurationReporter->reportSkippedNeverRegisteredRules();

        return $this->resolveReturnCode($processResult, $configuration);
    }

    protected function initialize(InputInterface $input, OutputInterface $output): void
    {
        $application = $this->getApplication();
        if (! $application instanceof Application) {
            throw new ShouldNotHappenException();
        }

        $optionDebug = (bool) $input->getOption(Option::DEBUG);
        if ($optionDebug) {
            $application->setCatchExceptions(false);
        }

        // clear cache
        $optionClearCache = (bool) $input->getOption(Option::CLEAR_CACHE);
        if ($optionDebug || $optionClearCache) {
            $this->changedFilesDetector->clear();
        }
    }

    /**
     * @return ExitCode::*
     */
    private function resolveReturnCode(ProcessResult $processResult, Configuration $configuration): int
    {
        // some system errors were found → fail
        if ($processResult->getSystemErrors() !== []) {
            return ExitCode::FAILURE;
        }

        // inverse error code for CI dry-run
        if (! $configuration->isDryRun()) {
            return ExitCode::SUCCESS;
        }

        if ($processResult->getFileDiffs() !== []) {
            return ExitCode::CHANGED_CODE;
        }

        if ($processResult->getTotalChanged() > 0) {
            return ExitCode::CHANGED_CODE;
        }

        return ExitCode::SUCCESS;
    }

    private function reportLoadedComposerBasedSets(): void
    {
        if (! SimpleParameterProvider::hasParameter(Option::COMPOSER_BASED_SETS)) {
            return;
        }

        $composerBasedSets = SimpleParameterProvider::provideArrayParameter(Option::COMPOSER_BASED_SETS);
        if ($composerBasedSets === []) {
            return;
        }

        $this->symfonyStyle->writeln('[info] Sets loaded based on installed packages:');
        $this->symfonyStyle->listing($composerBasedSets);
    }

    private function reportLevelOverflow(LevelOverflow $levelOverflow): void
    {
        $suggestedSetMethod = PHP_VERSION_ID >= 80000 ? sprintf(
            '->withPreparedSets(%s: true)',
            $levelOverflow->getSuggestedRuleset()
        ) : sprintf('->withSets(SetList::%s)', $levelOverflow->getSuggestedSetListConstant());

        $this->symfonyStyle->warning(sprintf(
            'The "->%s()" level contains only %d rules, but you set level to %d.%sYou are using the full set now! Time to switch to more efficient "%s".',
            $levelOverflow->getConfigurationName(),
            $levelOverflow->getRuleCount(),
            $levelOverflow->getLevel(),
            "\n",
            $suggestedSetMethod,
        ));
    }
}