DowngradeAttributeToAnnotationRector.php

<?php

declare(strict_types=1);

namespace Rector\DowngradePhp80\Rector\Class_;

use PhpParser\Node;
use PhpParser\Node\Attribute;
use PhpParser\Node\AttributeGroup;
use PhpParser\Node\Param;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PhpParser\Node\Stmt\Interface_;
use PhpParser\Node\Stmt\Property;
use PHPStan\Analyser\Scope;
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\DowngradePhp80\ValueObject\DowngradeAttributeToAnnotation;
use Rector\NodeFactory\DoctrineAnnotationFactory;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use Webmozart\Assert\Assert;

/**
 * @changelog https://php.watch/articles/php-attributes#syntax
 *
 * @see \Rector\Tests\DowngradePhp80\Rector\Class_\DowngradeAttributeToAnnotationRector\DowngradeAttributeToAnnotationRectorTest
 */
final class DowngradeAttributeToAnnotationRector extends AbstractRector implements ConfigurableRectorInterface
{
    /**
     * @var string[]
     */
    private const SKIPPED_ATTRIBUTES = ['Attribute', 'ReturnTypeWillChange', 'AllowDynamicProperties', 'Override'];

    /**
     * @var DowngradeAttributeToAnnotation[]
     */
    private array $attributesToAnnotations = [];

    private bool $isDowngraded = false;

    public function __construct(
        private readonly DoctrineAnnotationFactory $doctrineAnnotationFactory,
        private readonly DocBlockUpdater $docBlockUpdater,
        private readonly PhpDocInfoFactory $phpDocInfoFactory
    ) {
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Refactor PHP attribute markers to annotations notation', [
            new ConfiguredCodeSample(
                <<<'CODE_SAMPLE'
use Symfony\Component\Routing\Annotation\Route;

class SymfonyRoute
{
    #[Route(path: '/path', name: 'action')]
    public function action()
    {
    }
}
CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
use Symfony\Component\Routing\Annotation\Route;

class SymfonyRoute
{
    /**
     * @Route("/path", name="action")
     */
    public function action()
    {
    }
}
CODE_SAMPLE
                ,
                [new DowngradeAttributeToAnnotation('Symfony\Component\Routing\Annotation\Route')]
            ),
        ]);
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [Class_::class, ClassMethod::class, Property::class, Interface_::class, Param::class, Function_::class];
    }

    /**
     * @param Class_|ClassMethod|Property|Interface_|Param|Function_  $node
     */
    public function refactor(Node $node): ?Node
    {
        if ($node->attrGroups === []) {
            return null;
        }

        $this->isDowngraded = false;

        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
        $oldTokens = $this->file->getOldTokens();

        foreach ($node->attrGroups as $attrGroup) {
            foreach ($attrGroup->attrs as $key => $attribute) {
                if ($this->shouldSkipAttribute($attribute)) {
                    if (isset($oldTokens[$attrGroup->getEndTokenPos() + 1]) && ! str_contains(
                        (string) $oldTokens[$attrGroup->getEndTokenPos() + 1],
                        "\n"
                    )) {
                        // add new line
                        $oldTokens[$attrGroup->getEndTokenPos() + 1]->text = "\n" . $this->resolveIndentation(
                            $node,
                            $attrGroup,
                            $attribute
                        ) . $oldTokens[$attrGroup->getEndTokenPos() + 1]->text;
                        $this->isDowngraded = true;
                    }

                    continue;
                }

                $attributeToAnnotation = $this->matchAttributeToAnnotation($attribute, $this->attributesToAnnotations);
                if (! $attributeToAnnotation instanceof DowngradeAttributeToAnnotation) {
                    // clear the attribute to avoid inlining to a comment that will ignore the rest of the line

                    unset($attrGroup->attrs[$key]);

                    continue;
                }

                unset($attrGroup->attrs[$key]);

                $this->isDowngraded = true;
                if (! \str_contains($attributeToAnnotation->getTag(), '\\')) {
                    $phpDocInfo->addPhpDocTagNode(
                        new PhpDocTagNode('@' . $attributeToAnnotation->getTag(), new GenericTagValueNode(''))
                    );
                    $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);

                    continue;
                }

                $doctrineAnnotation = $this->doctrineAnnotationFactory->createFromAttribute(
                    $attribute,
                    $attributeToAnnotation->getTag()
                );
                $phpDocInfo->addTagValueNode($doctrineAnnotation);
                $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
            }
        }

        // cleanup empty attr groups
        $this->cleanupEmptyAttrGroups($node);

        if (! $this->isDowngraded) {
            return null;
        }

        return $node;
    }

    /**
     * @param DowngradeAttributeToAnnotation[] $configuration
     */
    public function configure(array $configuration): void
    {
        Assert::allIsAOf($configuration, DowngradeAttributeToAnnotation::class);

        $this->attributesToAnnotations = $configuration;
    }

    private function resolveIndentation(Node $node, AttributeGroup $attributeGroup, Attribute $attribute): string
    {
        $scope = $node->getAttribute(AttributeKey::SCOPE);

        if (! $scope instanceof Scope) {
            return '';
        }

        if (
            ($node->getStartTokenPos() === strlen($attribute->name->toString()) - 2)
            || ($node instanceof Class_ && $scope->isInFirstLevelStatement())
        ) {
            return '';
        }

        $indent = $attributeGroup->getEndTokenPos() - $node->getStartTokenPos() + 2;
        return $indent > 0 ? str_repeat(' ', $indent) : '';
    }

    private function cleanupEmptyAttrGroups(
        ClassMethod | Property | Class_ | Interface_ | Param | Function_ $node
    ): void {
        foreach ($node->attrGroups as $key => $attrGroup) {
            if ($attrGroup->attrs !== []) {
                continue;
            }

            unset($node->attrGroups[$key]);
            $this->isDowngraded = true;
        }
    }

    /**
     * @param DowngradeAttributeToAnnotation[] $attributesToAnnotations
     */
    private function matchAttributeToAnnotation(
        Attribute $attribute,
        array $attributesToAnnotations
    ): ?DowngradeAttributeToAnnotation {
        foreach ($attributesToAnnotations as $attributeToAnnotation) {
            if (! $this->isName($attribute->name, $attributeToAnnotation->getAttributeClass())) {
                continue;
            }

            return $attributeToAnnotation;
        }

        return null;
    }

    private function shouldSkipAttribute(Attribute $attribute): bool
    {
        $attributeName = $attribute->name->toString();
        return in_array($attributeName, self::SKIPPED_ATTRIBUTES, true);
    }
}