rector/rules/Transform/Rector/Class_/ParentClassToTraitsRector.php

103 lines
3.0 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\Transform\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\TraitUse;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\NodeAnalyzer\ClassAnalyzer;
use Rector\Rector\AbstractRector;
use Rector\Transform\ValueObject\ParentClassToTraits;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix202405\Webmozart\Assert\Assert;
/**
* Can handle cases like:
* - https://doc.nette.org/en/2.4/migration-2-4#toc-nette-smartobject
* - https://github.com/silverstripe/silverstripe-upgrader/issues/71#issue-320145944
*
* @see \Rector\Tests\Transform\Rector\Class_\ParentClassToTraitsRector\ParentClassToTraitsRectorTest
*/
final class ParentClassToTraitsRector extends AbstractRector implements ConfigurableRectorInterface
{
/**
* @readonly
* @var \Rector\NodeAnalyzer\ClassAnalyzer
*/
private $classAnalyzer;
/**
* @var ParentClassToTraits[]
*/
private $parentClassToTraits = [];
public function __construct(ClassAnalyzer $classAnalyzer)
{
$this->classAnalyzer = $classAnalyzer;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Replaces parent class to specific traits', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
class SomeClass extends Nette\Object
{
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClass
{
use Nette\SmartObject;
}
CODE_SAMPLE
, [new ParentClassToTraits('Nette\\Object', ['Nette\\SmartObject'])])]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(Node $node) : ?Node
{
$parentExtends = $node->extends;
if (!$parentExtends instanceof Name) {
return null;
}
if ($this->classAnalyzer->isAnonymousClass($node)) {
return null;
}
$traitUses = [];
foreach ($this->parentClassToTraits as $parentClassToTrait) {
if (!$this->isName($parentExtends, $parentClassToTrait->getParentType())) {
continue;
}
foreach ($parentClassToTrait->getTraitNames() as $traitName) {
$traitUses[] = new TraitUse([new FullyQualified($traitName)]);
}
$this->removeParentClass($node);
}
if ($traitUses === []) {
return null;
}
$node->stmts = \array_merge($traitUses, $node->stmts);
return $node;
}
/**
* @param mixed[] $configuration
*/
public function configure(array $configuration) : void
{
Assert::allIsAOf($configuration, ParentClassToTraits::class);
$this->parentClassToTraits = $configuration;
}
private function removeParentClass(Class_ $class) : void
{
$class->extends = null;
}
}