Repository navigation
Expand file tree
/
Copy pathRemoveUnusedPrivateClassConstantRector.php
More file actions
131 lines (110 loc) · 3.32 KB
/
Copy pathRemoveUnusedPrivateClassConstantRector.php
File metadata and controls
131 lines (110 loc) · 3.32 KB
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?php
declare(strict_types=1);
namespace Rector\DeadCode\Rector\ClassConst;
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\Enum_;
use PHPStan\Reflection\ClassReflection;
use Rector\NodeManipulator\ClassConstManipulator;
use Rector\PHPStan\ScopeFetcher;
use Rector\Rector\AbstractRector;
use Rector\Reflection\ReflectionResolver;
use Rector\RuleDoc\CodeSample\CodeSample;
use Rector\RuleDoc\RuleDefinition;
/**
* @see \Rector\Tests\DeadCode\Rector\ClassConst\RemoveUnusedPrivateClassConstantRector\RemoveUnusedPrivateClassConstantRectorTest
*/
final class RemoveUnusedPrivateClassConstantRector extends AbstractRector
{
public function __construct(
private readonly ClassConstManipulator $classConstManipulator,
private readonly ReflectionResolver $reflectionResolver
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Remove unused class constants', [
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
private const SOME_CONST = 'dead';
public function run()
{
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class SomeClass
{
public function run()
{
}
}
CODE_SAMPLE
),
]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [Class_::class, Enum_::class];
}
/**
* @param Class_|Enum_ $node
*/
public function refactor(Node $node): ?Node
{
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
if (! $classReflection instanceof ClassReflection) {
return null;
}
$unusedClassConstKeys = [];
foreach ($node->stmts as $key => $stmt) {
if (! $stmt instanceof ClassConst) {
continue;
}
if ($this->shouldSkipClassConst($stmt)) {
continue;
}
if ($this->classConstManipulator->hasClassConstFetch($stmt, $classReflection, $node)) {
continue;
}
$unusedClassConstKeys[] = $key;
}
if ($unusedClassConstKeys === []) {
return null;
}
// remove only after all constants are checked, so a constant used by another removed one is kept
foreach ($unusedClassConstKeys as $unusedClassConstKey) {
unset($node->stmts[$unusedClassConstKey]);
}
return $node;
}
private function shouldSkipClassConst(ClassConst $classConst): bool
{
if (! $classConst->isPrivate()) {
return true;
}
if (count($classConst->consts) !== 1) {
return true;
}
$scope = ScopeFetcher::fetch($classConst);
$classReflection = $scope->getClassReflection();
if (! $classReflection instanceof ClassReflection) {
return false;
}
return $this->hasParentClassOfEnumSuffix($classReflection);
}
private function hasParentClassOfEnumSuffix(ClassReflection $classReflection): bool
{
return array_any(
$classReflection->getParentClassesNames(),
fn (string $parentClassesName): bool => str_ends_with($parentClassesName, 'Enum')
);
}
}