2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
2021-05-09 20:15:43 +00:00
|
|
|
declare (strict_types=1);
|
2022-06-06 17:12:56 +00:00
|
|
|
namespace Rector\Transform\Rector\Class_;
|
2017-08-06 17:49:19 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Name;
|
2023-06-08 22:00:17 +00:00
|
|
|
use PhpParser\Node\Name\FullyQualified;
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node\Stmt\Class_;
|
2023-06-08 22:00:17 +00:00
|
|
|
use PhpParser\Node\Stmt\TraitUse;
|
2024-01-02 02:40:38 +00:00
|
|
|
use Rector\Contract\Rector\ConfigurableRectorInterface;
|
|
|
|
use Rector\NodeAnalyzer\ClassAnalyzer;
|
|
|
|
use Rector\Rector\AbstractRector;
|
2022-06-06 17:12:56 +00:00
|
|
|
use Rector\Transform\ValueObject\ParentClassToTraits;
|
2022-06-07 09:18:30 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2024-05-02 02:21:56 +00:00
|
|
|
use RectorPrefix202405\Webmozart\Assert\Assert;
|
2017-08-06 17:49:19 +00:00
|
|
|
/**
|
2018-06-06 14:02:47 +00:00
|
|
|
* Can handle cases like:
|
|
|
|
* - https://doc.nette.org/en/2.4/migration-2-4#toc-nette-smartobject
|
2018-07-31 06:16:29 +00:00
|
|
|
* - https://github.com/silverstripe/silverstripe-upgrader/issues/71#issue-320145944
|
2020-07-29 23:39:41 +00:00
|
|
|
*
|
2021-03-12 22:20:25 +00:00
|
|
|
* @see \Rector\Tests\Transform\Rector\Class_\ParentClassToTraitsRector\ParentClassToTraitsRectorTest
|
2017-08-06 17:49:19 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
final class ParentClassToTraitsRector extends AbstractRector implements ConfigurableRectorInterface
|
2017-08-06 17:49:19 +00:00
|
|
|
{
|
2021-04-23 19:32:59 +00:00
|
|
|
/**
|
2023-06-11 23:01:39 +00:00
|
|
|
* @readonly
|
2024-01-02 02:40:38 +00:00
|
|
|
* @var \Rector\NodeAnalyzer\ClassAnalyzer
|
2021-04-23 19:32:59 +00:00
|
|
|
*/
|
|
|
|
private $classAnalyzer;
|
2023-06-08 22:00:17 +00:00
|
|
|
/**
|
|
|
|
* @var ParentClassToTraits[]
|
|
|
|
*/
|
|
|
|
private $parentClassToTraits = [];
|
|
|
|
public function __construct(ClassAnalyzer $classAnalyzer)
|
2018-11-03 19:41:43 +00:00
|
|
|
{
|
2021-04-23 19:32:59 +00:00
|
|
|
$this->classAnalyzer = $classAnalyzer;
|
2017-08-06 21:24:58 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2018-04-07 23:35:59 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new RuleDefinition('Replaces parent class to specific traits', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
2018-06-01 13:29:28 +00:00
|
|
|
class SomeClass extends Nette\Object
|
|
|
|
{
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2018-06-01 13:29:28 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
use Nette\SmartObject;
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2022-06-07 09:46:15 +00:00
|
|
|
, [new ParentClassToTraits('Nette\\Object', ['Nette\\SmartObject'])])]);
|
2018-04-07 23:35:59 +00:00
|
|
|
}
|
2018-08-14 22:12:41 +00:00
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2018-08-14 22:12:41 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2017-08-06 17:49:19 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return [Class_::class];
|
2017-08-06 17:49:19 +00:00
|
|
|
}
|
2017-08-07 15:27:04 +00:00
|
|
|
/**
|
2021-12-10 10:22:23 +00:00
|
|
|
* @param Class_ $node
|
2017-08-07 15:27:04 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
public function refactor(Node $node) : ?Node
|
2017-08-06 17:49:19 +00:00
|
|
|
{
|
2022-02-07 19:38:34 +00:00
|
|
|
$parentExtends = $node->extends;
|
2022-06-07 08:22:29 +00:00
|
|
|
if (!$parentExtends instanceof Name) {
|
2020-12-24 16:28:56 +00:00
|
|
|
return null;
|
|
|
|
}
|
2021-04-18 13:01:22 +00:00
|
|
|
if ($this->classAnalyzer->isAnonymousClass($node)) {
|
2018-08-14 21:33:39 +00:00
|
|
|
return null;
|
|
|
|
}
|
2023-06-08 22:00:17 +00:00
|
|
|
$traitUses = [];
|
2021-01-29 00:29:12 +00:00
|
|
|
foreach ($this->parentClassToTraits as $parentClassToTrait) {
|
2022-02-07 19:38:34 +00:00
|
|
|
if (!$this->isName($parentExtends, $parentClassToTrait->getParentType())) {
|
2021-01-29 00:29:12 +00:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
foreach ($parentClassToTrait->getTraitNames() as $traitName) {
|
2023-06-08 22:00:17 +00:00
|
|
|
$traitUses[] = new TraitUse([new FullyQualified($traitName)]);
|
2021-01-29 00:29:12 +00:00
|
|
|
}
|
|
|
|
$this->removeParentClass($node);
|
|
|
|
}
|
2023-06-08 22:00:17 +00:00
|
|
|
if ($traitUses === []) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
$node->stmts = \array_merge($traitUses, $node->stmts);
|
|
|
|
return $node;
|
2017-08-06 21:24:58 +00:00
|
|
|
}
|
2021-01-29 00:29:12 +00:00
|
|
|
/**
|
2021-11-28 17:01:20 +00:00
|
|
|
* @param mixed[] $configuration
|
2021-01-29 00:29:12 +00:00
|
|
|
*/
|
2021-12-10 10:22:23 +00:00
|
|
|
public function configure(array $configuration) : void
|
2020-07-29 23:39:41 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
Assert::allIsAOf($configuration, ParentClassToTraits::class);
|
2022-02-18 01:46:17 +00:00
|
|
|
$this->parentClassToTraits = $configuration;
|
2020-07-29 23:39:41 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
private function removeParentClass(Class_ $class) : void
|
2018-10-31 15:34:37 +00:00
|
|
|
{
|
2020-06-29 21:19:37 +00:00
|
|
|
$class->extends = null;
|
2018-10-31 15:34:37 +00:00
|
|
|
}
|
2017-08-06 17:49:19 +00:00
|
|
|
}
|