2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
2021-05-09 20:15:43 +00:00
|
|
|
declare (strict_types=1);
|
2021-01-29 08:08:55 +00:00
|
|
|
namespace Rector\Removing\Rector\Class_;
|
2019-03-09 17:36:27 +00:00
|
|
|
|
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Name;
|
|
|
|
use PhpParser\Node\Stmt\Class_;
|
|
|
|
use PhpParser\Node\Stmt\Trait_;
|
2020-07-29 23:39:41 +00:00
|
|
|
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
|
2021-02-08 12:33:17 +00:00
|
|
|
use Rector\Core\NodeManipulator\ClassManipulator;
|
2020-02-06 21:48:18 +00:00
|
|
|
use Rector\Core\Rector\AbstractRector;
|
2019-04-13 09:20:27 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2020-11-16 17:50:38 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2019-09-03 09:11:45 +00:00
|
|
|
/**
|
2021-03-12 22:20:25 +00:00
|
|
|
* @see \Rector\Tests\Removing\Rector\Class_\RemoveTraitRector\RemoveTraitRectorTest
|
2019-09-03 09:11:45 +00:00
|
|
|
*/
|
2021-05-10 22:10:16 +00:00
|
|
|
final class RemoveTraitRector extends AbstractRector implements ConfigurableRectorInterface
|
2019-03-09 17:36:27 +00:00
|
|
|
{
|
2020-07-29 23:39:41 +00:00
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
2021-01-29 08:08:55 +00:00
|
|
|
public const TRAITS_TO_REMOVE = 'traits_to_remove';
|
2019-03-09 17:36:27 +00:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
private $classHasChanged = \false;
|
2019-03-09 17:36:27 +00:00
|
|
|
/**
|
|
|
|
* @var string[]
|
|
|
|
*/
|
|
|
|
private $traitsToRemove = [];
|
|
|
|
/**
|
|
|
|
* @var ClassManipulator
|
|
|
|
*/
|
|
|
|
private $classManipulator;
|
2021-05-10 22:10:16 +00:00
|
|
|
public function __construct(ClassManipulator $classManipulator)
|
2019-03-09 17:36:27 +00:00
|
|
|
{
|
|
|
|
$this->classManipulator = $classManipulator;
|
|
|
|
}
|
2021-05-10 22:10:16 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2019-03-09 17:36:27 +00:00
|
|
|
{
|
2021-05-10 22:10:16 +00:00
|
|
|
return new RuleDefinition('Remove specific traits from code', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
2019-03-09 17:36:27 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
use SomeTrait;
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2019-03-09 17:36:27 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, [self::TRAITS_TO_REMOVE => ['TraitNameToRemove']])]);
|
2019-03-09 17:36:27 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2019-03-09 17:36:27 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2019-03-09 17:36:27 +00:00
|
|
|
{
|
2021-05-10 22:10:16 +00:00
|
|
|
return [Class_::class, Trait_::class];
|
2019-03-09 17:36:27 +00:00
|
|
|
}
|
|
|
|
/**
|
|
|
|
* @param Class_|Trait_ $node
|
|
|
|
*/
|
2021-05-10 22:10:16 +00:00
|
|
|
public function refactor(Node $node) : ?Node
|
2019-03-09 17:36:27 +00:00
|
|
|
{
|
|
|
|
$usedTraits = $this->classManipulator->getUsedTraits($node);
|
|
|
|
if ($usedTraits === []) {
|
|
|
|
return null;
|
|
|
|
}
|
2021-05-09 20:15:43 +00:00
|
|
|
$this->classHasChanged = \false;
|
2019-03-09 17:36:27 +00:00
|
|
|
$this->removeTraits($usedTraits);
|
|
|
|
// invoke re-print
|
|
|
|
if ($this->classHasChanged) {
|
2021-05-10 22:10:16 +00:00
|
|
|
$node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
|
2021-01-29 08:08:55 +00:00
|
|
|
return $node;
|
2019-03-09 17:36:27 +00:00
|
|
|
}
|
2021-01-29 08:08:55 +00:00
|
|
|
return null;
|
2019-03-09 17:36:27 +00:00
|
|
|
}
|
2021-05-02 10:46:55 +00:00
|
|
|
/**
|
|
|
|
* @param array<string, string[]> $configuration
|
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function configure(array $configuration) : void
|
2020-07-29 23:39:41 +00:00
|
|
|
{
|
|
|
|
$this->traitsToRemove = $configuration[self::TRAITS_TO_REMOVE] ?? [];
|
|
|
|
}
|
2019-03-09 17:36:27 +00:00
|
|
|
/**
|
|
|
|
* @param Name[] $usedTraits
|
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
private function removeTraits(array $usedTraits) : void
|
2019-03-09 17:36:27 +00:00
|
|
|
{
|
|
|
|
foreach ($usedTraits as $usedTrait) {
|
|
|
|
foreach ($this->traitsToRemove as $traitToRemove) {
|
2021-05-09 20:15:43 +00:00
|
|
|
if (!$this->isName($usedTrait, $traitToRemove)) {
|
2021-01-29 08:08:55 +00:00
|
|
|
continue;
|
2019-03-09 17:36:27 +00:00
|
|
|
}
|
2021-01-29 08:08:55 +00:00
|
|
|
$this->removeNode($usedTrait);
|
2021-05-09 20:15:43 +00:00
|
|
|
$this->classHasChanged = \true;
|
2021-01-29 08:08:55 +00:00
|
|
|
continue 2;
|
2019-03-09 17:36:27 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|