Repository navigation
Expand file tree
/
Copy pathNarrowUnusedSetUpDefinedPropertyRector.php
More file actions
250 lines (204 loc) · 7.2 KB
/
Copy pathNarrowUnusedSetUpDefinedPropertyRector.php
File metadata and controls
250 lines (204 loc) · 7.2 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
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
<?php
declare(strict_types=1);
namespace Rector\PHPUnit\CodeQuality\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Property;
use PhpParser\NodeFinder;
use PHPStan\Reflection\ClassReflection;
use Rector\NodeManipulator\PropertyManipulator;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\Rector\AbstractRector;
use Rector\Reflection\ReflectionResolver;
use Rector\ValueObject\MethodName;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\NarrowUnusedSetUpDefinedPropertyRector\NarrowUnusedSetUpDefinedPropertyRectorTest
*/
final class NarrowUnusedSetUpDefinedPropertyRector extends AbstractRector
{
private readonly NodeFinder $nodeFinder;
public function __construct(
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
private readonly ReflectionResolver $reflectionResolver,
private readonly PropertyManipulator $propertyManipulator,
) {
$this->nodeFinder = new NodeFinder();
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Turn property used only in setUp() to variable', [
new CodeSample(
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
class SomeServiceTest extends TestCase
{
private $someServiceMock;
public function setUp(): void
{
$this->someServiceMock = $this->createMock(SomeService::class);
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
class SomeServiceTest extends TestCase
{
public function setUp(): void
{
$someServiceMock = $this->createMock(SomeService::class);
}
}
CODE_SAMPLE
,
),
]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(Node $node): ?Node
{
if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
return null;
}
$setUpClassMethod = $node->getMethod(MethodName::SET_UP);
if (! $setUpClassMethod instanceof ClassMethod) {
return null;
}
$hasChanged = false;
$isFinalClass = $node->isFinal();
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
if (! $classReflection instanceof ClassReflection) {
return null;
}
foreach ($node->stmts as $key => $classStmt) {
if (! $classStmt instanceof Property) {
continue;
}
$property = $classStmt;
if (count($property->props) !== 1) {
continue;
}
$propertyName = $property->props[0]->name->toString();
if ($this->shouldSkipProperty($isFinalClass, $property, $classReflection, $propertyName)) {
continue;
}
if ($this->isPropertyUsedOutsideSetUpClassMethod($node, $setUpClassMethod, $property)) {
continue;
}
// referenced inside a nested closure that may run after setUp() - turning it into a local
// variable would leave it out of the closure scope, as there is no "use" binding to add it
if ($this->isPropertyUsedInNestedClosure($setUpClassMethod, $propertyName)) {
continue;
}
$hasChanged = true;
unset($node->stmts[$key]);
// change property to variable in setUp() method
$this->traverseNodesWithCallable($setUpClassMethod, function (Node $node) use (
$propertyName
): ?Variable {
if (! $node instanceof PropertyFetch) {
return null;
}
if (! $this->isName($node->var, 'this')) {
return null;
}
if (! $this->isName($node->name, $propertyName)) {
return null;
}
return new Variable($propertyName);
});
}
if ($hasChanged) {
return $node;
}
return null;
}
private function isPropertyUsedOutsideSetUpClassMethod(
Class_ $class,
ClassMethod $setUpClassMethod,
Property $property
): bool {
$isPropertyUsed = false;
$propertyName = $property->props[0]->name->toString();
foreach ($class->getMethods() as $classMethod) {
// skip setUp() method
if ($classMethod === $setUpClassMethod) {
continue;
}
// check if property is used anywhere else than setup
$usedPropertyFetch = $this->nodeFinder->findFirst($classMethod, function (Node $node) use (
$propertyName
): bool {
if (! $node instanceof PropertyFetch) {
return false;
}
if (! $this->isName($node->var, 'this')) {
return false;
}
return $this->isName($node->name, $propertyName);
});
if ($usedPropertyFetch instanceof PropertyFetch) {
$isPropertyUsed = true;
}
}
return $isPropertyUsed;
}
private function isPropertyUsedInNestedClosure(ClassMethod $setUpClassMethod, string $propertyName): bool
{
// only regular closures are unsafe: they do not capture outer variables without an
// explicit "use" binding. Arrow functions auto-capture by value, so narrowing is safe there.
$closures = $this->nodeFinder->findInstanceOf($setUpClassMethod, Closure::class);
foreach ($closures as $closure) {
$usedPropertyFetch = $this->nodeFinder->findFirst($closure, function (Node $node) use (
$propertyName
): bool {
if (! $node instanceof PropertyFetch) {
return false;
}
if (! $this->isName($node->var, 'this')) {
return false;
}
return $this->isName($node->name, $propertyName);
});
if ($usedPropertyFetch instanceof PropertyFetch) {
return true;
}
}
return false;
}
private function shouldSkipProperty(
bool $isFinalClass,
Property $property,
ClassReflection $classReflection,
string $propertyName
): bool {
// possibly used by child
if (! $isFinalClass && ! $property->isPrivate()) {
return true;
}
// possibly used for caching or re-use
if ($property->isStatic()) {
return true;
}
if ($property->props[0]->default instanceof Expr) {
return true;
}
return $this->propertyManipulator->isUsedByTrait($classReflection, $propertyName);
}
}