PostFileProcessor.php

<?php

declare(strict_types=1);

namespace Rector\PostRector\Application;

use PhpParser\Node\Stmt;
use PhpParser\NodeTraverser;
use Rector\Configuration\Option;
use Rector\Configuration\Parameter\SimpleParameterProvider;
use Rector\Configuration\RenamedClassesDataCollector;
use Rector\Contract\DependencyInjection\ResettableInterface;
use Rector\PostRector\Contract\Rector\PostRectorInterface;
use Rector\PostRector\Rector\ClassRenamingPostRector;
use Rector\PostRector\Rector\DocblockNameImportingPostRector;
use Rector\PostRector\Rector\NameImportingPostRector;
use Rector\PostRector\Rector\UnusedImportRemovingPostRector;
use Rector\PostRector\Rector\UseAddingPostRector;
use Rector\Renaming\Rector\Name\RenameClassRector;
use Rector\Skipper\Skipper\Skipper;
use Rector\ValueObject\Application\File;

final class PostFileProcessor implements ResettableInterface
{
    /**
     * @var PostRectorInterface[]
     */
    private array $postRectors = [];

    public function __construct(
        private readonly Skipper $skipper,
        private readonly UseAddingPostRector $useAddingPostRector,
        private readonly NameImportingPostRector $nameImportingPostRector,
        private readonly ClassRenamingPostRector $classRenamingPostRector,
        private readonly DocblockNameImportingPostRector $docblockNameImportingPostRector,
        private readonly UnusedImportRemovingPostRector $unusedImportRemovingPostRector,
        private readonly RenamedClassesDataCollector $renamedClassesDataCollector
    ) {
    }

    public function reset(): void
    {
        $this->postRectors = [];
    }

    /**
     * @param Stmt[] $stmts
     * @return Stmt[]
     */
    public function traverse(array $stmts, File $file): array
    {
        foreach ($this->getPostRectors() as $postRector) {
            // file must be set early into PostRector class to ensure its usage
            // always match on skipping process
            $postRector->setFile($file);

            if ($this->shouldSkipPostRector($postRector, $file->getFilePath(), $stmts)) {
                continue;
            }

            $nodeTraverser = new NodeTraverser($postRector);
            $stmts = $nodeTraverser->traverse($stmts);
        }

        return $stmts;
    }

    /**
     * @param Stmt[] $stmts
     */
    private function shouldSkipPostRector(PostRectorInterface $postRector, string $filePath, array $stmts): bool
    {
        if ($this->skipper->shouldSkipElementAndFilePath($postRector, $filePath)) {
            return true;
        }

        // skip renaming if rename class rector is skipped
        if ($postRector instanceof ClassRenamingPostRector && $this->skipper->shouldSkipElementAndFilePath(
            RenameClassRector::class,
            $filePath
        )) {
            return true;
        }

        return ! $postRector->shouldTraverse($stmts);
    }

    /**
     * Load on the fly, to allow test reset with different configuration
     * @return PostRectorInterface[]
     */
    private function getPostRectors(): array
    {
        if ($this->postRectors !== []) {
            return $this->postRectors;
        }

        $isRenamedClassEnabled = $this->renamedClassesDataCollector->getOldToNewClasses() !== [];
        $isNameImportingEnabled = SimpleParameterProvider::provideBoolParameter(Option::AUTO_IMPORT_NAMES);

        $isRemovingUnusedImportsEnabled = SimpleParameterProvider::provideBoolParameter(Option::REMOVE_UNUSED_IMPORTS);

        $postRectors = [];

        // sorted by priority, to keep removed imports in order
        if ($isRenamedClassEnabled) {
            $postRectors[] = $this->classRenamingPostRector;
        }

        // import names
        if ($isNameImportingEnabled) {
            $postRectors[] = $this->nameImportingPostRector;

            // import docblocks
            if (SimpleParameterProvider::provideBoolParameter(Option::AUTO_IMPORT_DOC_BLOCK_NAMES)) {
                $postRectors[] = $this->docblockNameImportingPostRector;
            }
        }

        $postRectors[] = $this->useAddingPostRector;

        if ($isRemovingUnusedImportsEnabled) {
            $postRectors[] = $this->unusedImportRemovingPostRector;
        }

        $this->postRectors = $postRectors;

        return $this->postRectors;
    }
}