RenamePropertyRector.php

<?php

declare(strict_types=1);

namespace Rector\Renaming\Rector\PropertyFetch;

use PhpParser\Node;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Expr\StaticPropertyFetch;
use PhpParser\Node\Identifier;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Property;
use PhpParser\Node\VarLikeIdentifier;
use PHPStan\Type\ObjectType;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\Rector\AbstractRector;
use Rector\Renaming\ValueObject\RenameProperty;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use Webmozart\Assert\Assert;

/**
 * @see \Rector\Tests\Renaming\Rector\PropertyFetch\RenamePropertyRector\RenamePropertyRectorTest
 */
final class RenamePropertyRector extends AbstractRector implements ConfigurableRectorInterface
{
    /**
     * @var RenameProperty[]
     */
    private array $renamedProperties = [];

    private bool $hasChanged = false;

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Replace defined old properties by new ones', [
            new ConfiguredCodeSample(
                '$someObject->someOldProperty;',
                '$someObject->someNewProperty;',
                [new RenameProperty('SomeClass', 'someOldProperty', 'someNewProperty')]
            ),
        ]);
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [PropertyFetch::class, StaticPropertyFetch::class, ClassLike::class];
    }

    /**
     * @param PropertyFetch|StaticPropertyFetch|ClassLike $node
     */
    public function refactor(Node $node): ?Node
    {
        if ($node instanceof ClassLike) {
            $this->hasChanged = false;

            foreach ($this->renamedProperties as $renamedProperty) {
                $this->renameProperty($node, $renamedProperty);
            }

            if ($this->hasChanged) {
                return $node;
            }

            return null;
        }

        return $this->refactorPropertyFetch($node);
    }

    /**
     * @param mixed[] $configuration
     */
    public function configure(array $configuration): void
    {
        Assert::allIsAOf($configuration, RenameProperty::class);
        $this->renamedProperties = $configuration;
    }

    private function renameProperty(ClassLike $classLike, RenameProperty $renameProperty): void
    {
        $classLikeName = (string) $this->getName($classLike);
        $renamePropertyObjectType = $renameProperty->getObjectType();
        $className = $renamePropertyObjectType->getClassName();

        $classLikeNameObjectType = new ObjectType($classLikeName);
        $classNameObjectType = new ObjectType($className);

        $isSuperType = $classNameObjectType->isSuperTypeOf($classLikeNameObjectType)
            ->yes();
        if ($classLikeName !== $className && ! $isSuperType) {
            return;
        }

        $property = $classLike->getProperty($renameProperty->getOldProperty());
        if (! $property instanceof Property) {
            return;
        }

        $newProperty = $renameProperty->getNewProperty();
        $targetNewProperty = $classLike->getProperty($newProperty);
        if ($targetNewProperty instanceof Property) {
            return;
        }

        $this->hasChanged = true;
        $property->props[0]->name = new VarLikeIdentifier($newProperty);
    }

    private function refactorPropertyFetch(PropertyFetch|StaticPropertyFetch $propertyFetch): null|PropertyFetch|StaticPropertyFetch
    {
        foreach ($this->renamedProperties as $renamedProperty) {
            $oldProperty = $renamedProperty->getOldProperty();
            if (! $this->isName($propertyFetch, $oldProperty)) {
                continue;
            }

            $varPropertyFetch = $propertyFetch instanceof PropertyFetch ? $propertyFetch->var : $propertyFetch->class;
            if (! $this->isObjectType($varPropertyFetch, $renamedProperty->getObjectType())) {
                continue;
            }

            $propertyFetch->name = $propertyFetch instanceof PropertyFetch
                ? new Identifier($renamedProperty->getNewProperty())
                : new VarLikeIdentifier($renamedProperty->getNewProperty());
            return $propertyFetch;
        }

        return null;
    }
}