-
-
Notifications
You must be signed in to change notification settings - Fork 680
/
RemoveUnusedPrivateMethodRector.php
166 lines (163 loc) · 5 KB
/
RemoveUnusedPrivateMethodRector.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
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<?php
declare (strict_types=1);
namespace Rector\DeadCode\Rector\ClassMethod;
use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use Rector\DeadCode\NodeAnalyzer\IsClassMethodUsedAnalyzer;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\Rector\AbstractScopeAwareRector;
use Rector\Reflection\ReflectionResolver;
use Rector\ValueObject\MethodName;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector\RemoveUnusedPrivateMethodRectorTest
*/
final class RemoveUnusedPrivateMethodRector extends AbstractScopeAwareRector
{
/**
* @readonly
* @var \Rector\DeadCode\NodeAnalyzer\IsClassMethodUsedAnalyzer
*/
private $isClassMethodUsedAnalyzer;
/**
* @readonly
* @var \Rector\Reflection\ReflectionResolver
*/
private $reflectionResolver;
/**
* @readonly
* @var \Rector\PhpParser\Node\BetterNodeFinder
*/
private $betterNodeFinder;
public function __construct(IsClassMethodUsedAnalyzer $isClassMethodUsedAnalyzer, ReflectionResolver $reflectionResolver, BetterNodeFinder $betterNodeFinder)
{
$this->isClassMethodUsedAnalyzer = $isClassMethodUsedAnalyzer;
$this->reflectionResolver = $reflectionResolver;
$this->betterNodeFinder = $betterNodeFinder;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Remove unused private method', [new CodeSample(<<<'CODE_SAMPLE'
final class SomeController
{
public function run()
{
return 5;
}
private function skip()
{
return 10;
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
final class SomeController
{
public function run()
{
return 5;
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactorWithScope(Node $node, Scope $scope) : ?Node
{
$classMethods = $node->getMethods();
if ($classMethods === []) {
return null;
}
$filter = static function (ClassMethod $classMethod) : bool {
return $classMethod->isPrivate();
};
if (\array_filter($classMethods, $filter) === []) {
return null;
}
if ($this->hasDynamicMethodCallOnFetchThis($classMethods)) {
return null;
}
$hasChanged = \false;
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
foreach ($node->stmts as $key => $stmt) {
if (!$stmt instanceof ClassMethod) {
continue;
}
if ($this->shouldSkip($stmt, $classReflection)) {
continue;
}
if ($this->isClassMethodUsedAnalyzer->isClassMethodUsed($node, $stmt, $scope)) {
continue;
}
unset($node->stmts[$key]);
$hasChanged = \true;
}
if ($hasChanged) {
return $node;
}
return null;
}
private function shouldSkip(ClassMethod $classMethod, ?ClassReflection $classReflection) : bool
{
if (!$classReflection instanceof ClassReflection) {
return \true;
}
// unreliable to detect trait, interface, anonymous class: doesn't make sense
if ($classReflection->isTrait()) {
return \true;
}
if ($classReflection->isInterface()) {
return \true;
}
if ($classReflection->isAnonymous()) {
return \true;
}
if (!$classMethod->isPrivate()) {
return \true;
}
// skip magic methods - @see https://www.php.net/manual/en/language.oop5.magic.php
if ($classMethod->isMagic()) {
return \true;
}
return $classReflection->hasMethod(MethodName::CALL);
}
/**
* @param ClassMethod[] $classMethods
*/
private function hasDynamicMethodCallOnFetchThis(array $classMethods) : bool
{
foreach ($classMethods as $classMethod) {
$isFound = (bool) $this->betterNodeFinder->findFirst((array) $classMethod->getStmts(), function (Node $subNode) : bool {
if (!$subNode instanceof MethodCall) {
return \false;
}
if (!$subNode->var instanceof Variable) {
return \false;
}
if (!$this->nodeNameResolver->isName($subNode->var, 'this')) {
return \false;
}
return $subNode->name instanceof Variable;
});
if ($isFound) {
return \true;
}
}
return \false;
}
}