-
-
Notifications
You must be signed in to change notification settings - Fork 335
/
RemoveAnnotationRector.php
103 lines (88 loc) · 2.57 KB
/
RemoveAnnotationRector.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<?php
declare(strict_types=1);
namespace Rector\DeadCode\Rector\ClassLike;
use PhpParser\Node;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Property;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagValueNode;
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
use Rector\Core\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use Webmozart\Assert\Assert;
/**
* @see \Rector\Tests\DeadCode\Rector\ClassLike\RemoveAnnotationRector\RemoveAnnotationRectorTest
*/
final class RemoveAnnotationRector extends AbstractRector implements ConfigurableRectorInterface
{
/**
* @var string[]
*/
private array $annotationsToRemove = [];
public function __construct(
private readonly PhpDocTagRemover $phpDocTagRemover
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Remove annotation by names', [
new ConfiguredCodeSample(
<<<'CODE_SAMPLE'
/**
* @method getName()
*/
final class SomeClass
{
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
final class SomeClass
{
}
CODE_SAMPLE
,
['method'],
),
]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [ClassLike::class, FunctionLike::class, Property::class, ClassConst::class];
}
/**
* @param ClassLike|FunctionLike|Property|ClassConst $node
*/
public function refactor(Node $node): ?Node
{
if ($this->annotationsToRemove === []) {
return null;
}
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
foreach ($this->annotationsToRemove as $annotationToRemove) {
$this->phpDocTagRemover->removeByName($phpDocInfo, $annotationToRemove);
if (! is_a($annotationToRemove, PhpDocTagValueNode::class, true)) {
continue;
}
$phpDocInfo->removeByType($annotationToRemove);
}
if ($phpDocInfo->hasChanged()) {
return $node;
}
return null;
}
/**
* @param mixed[] $configuration
*/
public function configure(array $configuration): void
{
Assert::allString($configuration);
$this->annotationsToRemove = $configuration;
}
}