-
-
Notifications
You must be signed in to change notification settings - Fork 336
/
AbstractRector.php
456 lines (366 loc) · 14.9 KB
/
AbstractRector.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
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
<?php
declare(strict_types=1);
namespace Rector\Core\Rector;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\ParentConnectingVisitor;
use PhpParser\NodeVisitorAbstract;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
use Rector\Core\Application\ChangedNodeScopeRefresher;
use Rector\Core\Configuration\CurrentNodeProvider;
use Rector\Core\Console\Output\RectorOutputStyle;
use Rector\Core\Contract\Rector\PhpRectorInterface;
use Rector\Core\Exception\ShouldNotHappenException;
use Rector\Core\Exclusion\ExclusionManager;
use Rector\Core\Logging\CurrentRectorProvider;
use Rector\Core\NodeAnalyzer\UnreachableStmtAnalyzer;
use Rector\Core\NodeDecorator\CreatedByRuleDecorator;
use Rector\Core\PhpParser\Comparing\NodeComparator;
use Rector\Core\PhpParser\Node\BetterNodeFinder;
use Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\Core\PhpParser\Node\NodeFactory;
use Rector\Core\PhpParser\Node\Value\ValueResolver;
use Rector\Core\ProcessAnalyzer\RectifiedAnalyzer;
use Rector\Core\Provider\CurrentFileProvider;
use Rector\Core\ValueObject\Application\File;
use Rector\Core\ValueObject\RectifiedNode;
use Rector\NodeNameResolver\NodeNameResolver;
use Rector\NodeRemoval\NodeRemover;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\NodeTypeResolver;
use Rector\PostRector\Collector\NodesToAddCollector;
use Rector\PostRector\Collector\NodesToRemoveCollector;
use Rector\StaticTypeMapper\StaticTypeMapper;
use Symfony\Contracts\Service\Attribute\Required;
use Symplify\Astral\NodeTraverser\SimpleCallableNodeTraverser;
use Symplify\Skipper\Skipper\Skipper;
abstract class AbstractRector extends NodeVisitorAbstract implements PhpRectorInterface
{
/**
* @var string[]
*/
private const ATTRIBUTES_TO_MIRROR = [
AttributeKey::SCOPE,
AttributeKey::RESOLVED_NAME,
AttributeKey::PARENT_NODE,
];
/**
* @var string
*/
private const EMPTY_NODE_ARRAY_MESSAGE = <<<CODE_SAMPLE
Array of nodes cannot be empty. Ensure "%s->refactor()" returns non-empty array for Nodes.
A) Return null for no change:
return null;
B) Remove the Node:
\$this->removeNode(\$node);
return \$node;
CODE_SAMPLE;
protected NodeNameResolver $nodeNameResolver;
protected NodeTypeResolver $nodeTypeResolver;
protected StaticTypeMapper $staticTypeMapper;
protected PhpDocInfoFactory $phpDocInfoFactory;
protected NodeFactory $nodeFactory;
protected ValueResolver $valueResolver;
protected BetterNodeFinder $betterNodeFinder;
protected NodeRemover $nodeRemover;
protected NodeComparator $nodeComparator;
protected NodesToRemoveCollector $nodesToRemoveCollector;
protected File $file;
protected NodesToAddCollector $nodesToAddCollector;
protected ChangedNodeScopeRefresher $changedNodeScopeRefresher;
private SimpleCallableNodeTraverser $simpleCallableNodeTraverser;
private ExclusionManager $exclusionManager;
private CurrentRectorProvider $currentRectorProvider;
private CurrentNodeProvider $currentNodeProvider;
private Skipper $skipper;
private CurrentFileProvider $currentFileProvider;
/**
* @var array<string, Node[]|Node>
*/
private array $nodesToReturn = [];
private RectifiedAnalyzer $rectifiedAnalyzer;
private CreatedByRuleDecorator $createdByRuleDecorator;
private UnreachableStmtAnalyzer $unreachableStmtAnalyzer;
private RectorOutputStyle $rectorOutputStyle;
#[Required]
public function autowire(
NodesToRemoveCollector $nodesToRemoveCollector,
NodesToAddCollector $nodesToAddCollector,
NodeRemover $nodeRemover,
NodeNameResolver $nodeNameResolver,
NodeTypeResolver $nodeTypeResolver,
SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
NodeFactory $nodeFactory,
PhpDocInfoFactory $phpDocInfoFactory,
ExclusionManager $exclusionManager,
StaticTypeMapper $staticTypeMapper,
CurrentRectorProvider $currentRectorProvider,
CurrentNodeProvider $currentNodeProvider,
Skipper $skipper,
ValueResolver $valueResolver,
BetterNodeFinder $betterNodeFinder,
NodeComparator $nodeComparator,
CurrentFileProvider $currentFileProvider,
RectifiedAnalyzer $rectifiedAnalyzer,
CreatedByRuleDecorator $createdByRuleDecorator,
ChangedNodeScopeRefresher $changedNodeScopeRefresher,
UnreachableStmtAnalyzer $unreachableStmtAnalyzer,
RectorOutputStyle $rectorOutputStyle,
): void {
$this->nodesToRemoveCollector = $nodesToRemoveCollector;
$this->nodesToAddCollector = $nodesToAddCollector;
$this->nodeRemover = $nodeRemover;
$this->nodeNameResolver = $nodeNameResolver;
$this->nodeTypeResolver = $nodeTypeResolver;
$this->simpleCallableNodeTraverser = $simpleCallableNodeTraverser;
$this->nodeFactory = $nodeFactory;
$this->phpDocInfoFactory = $phpDocInfoFactory;
$this->exclusionManager = $exclusionManager;
$this->staticTypeMapper = $staticTypeMapper;
$this->currentRectorProvider = $currentRectorProvider;
$this->currentNodeProvider = $currentNodeProvider;
$this->skipper = $skipper;
$this->valueResolver = $valueResolver;
$this->betterNodeFinder = $betterNodeFinder;
$this->nodeComparator = $nodeComparator;
$this->currentFileProvider = $currentFileProvider;
$this->rectifiedAnalyzer = $rectifiedAnalyzer;
$this->createdByRuleDecorator = $createdByRuleDecorator;
$this->changedNodeScopeRefresher = $changedNodeScopeRefresher;
$this->unreachableStmtAnalyzer = $unreachableStmtAnalyzer;
$this->rectorOutputStyle = $rectorOutputStyle;
}
/**
* @return Node[]|null
*/
public function beforeTraverse(array $nodes): ?array
{
// workaround for file around refactor()
$file = $this->currentFileProvider->getFile();
if (! $file instanceof File) {
throw new ShouldNotHappenException(
'File object is missing. Make sure you call $this->currentFileProvider->setFile(...) before traversing.'
);
}
$this->file = $file;
return parent::beforeTraverse($nodes);
}
/**
* @return Node|null
*/
final public function enterNode(Node $node)
{
$nodeClass = $node::class;
if (! $this->isMatchingNodeType($nodeClass)) {
return null;
}
if ($this->shouldSkipCurrentNode($node)) {
return null;
}
/** @var Node $originalNode */
$originalNode = $node->getAttribute(AttributeKey::ORIGINAL_NODE) ?? clone $node;
$createdByRule = $originalNode->getAttribute(AttributeKey::CREATED_BY_RULE) ?? [];
if (in_array(static::class, $createdByRule, true)) {
return null;
}
$this->currentRectorProvider->changeCurrentRector($this);
// for PHP doc info factory and change notifier
$this->currentNodeProvider->setNode($node);
$originalAttributes = $node->getAttributes();
$this->printDebugCurrentFileAndRule();
$node = $this->refactor($node);
// nothing to change → continue
if ($node === null) {
return null;
}
if ($node === []) {
$errorMessage = sprintf(self::EMPTY_NODE_ARRAY_MESSAGE, static::class);
throw new ShouldNotHappenException($errorMessage);
}
/** @var Node[]|Node $node */
$this->createdByRuleDecorator->decorate($node, $originalNode, static::class);
/** @var Node $originalNode */
$rectorWithLineChange = new RectorWithLineChange($this::class, $originalNode->getLine());
$this->file->addRectorClassWithLine($rectorWithLineChange);
/** @var Node $originalNode */
if (is_array($node)) {
$originalNodeHash = spl_object_hash($originalNode);
$this->nodesToReturn[$originalNodeHash] = $node;
$firstNodeKey = array_key_first($node);
$this->mirrorComments($node[$firstNodeKey], $originalNode);
// will be replaced in leaveNode() the original node must be passed
return $originalNode;
}
// update parents relations - must run before connectParentNodes()
/** @var Node $node */
$this->mirrorAttributes($originalAttributes, $node);
$currentScope = $originalNode->getAttribute(AttributeKey::SCOPE);
$requiresScopeRefresh = true;
// names do not have scope in PHPStan
if (! $node instanceof Name && ! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace && ! $node instanceof Identifier) {
if ($currentScope === null) {
$parent = $node->getAttribute(AttributeKey::PARENT_NODE);
// in case of unreachable stmts, no other node will have available scope
// loop all previous expressions, until we find nothing or is_unreachable
$currentStmt = $this->betterNodeFinder->resolveCurrentStatement($parent);
if ($currentStmt instanceof Stmt && $this->unreachableStmtAnalyzer->isStmtPHPStanUnreachable(
$currentStmt
)) {
$requiresScopeRefresh = false;
}
if ($requiresScopeRefresh) {
$errorMessage = sprintf(
'Node "%s" with parent of "%s" is missing scope required for scope refresh.',
$node::class,
$parent instanceof Node ? $parent::class : null
);
throw new ShouldNotHappenException($errorMessage);
}
}
if ($requiresScopeRefresh) {
$this->changedNodeScopeRefresher->refresh($node, $this->file->getSmartFileInfo(), $currentScope);
}
}
$this->connectParentNodes($node);
// is equals node type? return node early
if ($originalNode::class === $node::class) {
return $node;
}
// search "infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
$originalNodeHash = spl_object_hash($originalNode);
if ($originalNode instanceof Stmt && $node instanceof Expr) {
$node = new Expression($node);
}
$this->nodesToReturn[$originalNodeHash] = $node;
return $node;
}
/**
* Replacing nodes in leaveNode() method avoids infinite recursion
* see"infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
*/
public function leaveNode(Node $node)
{
$objectHash = spl_object_hash($node);
// update parents relations!!!
return $this->nodesToReturn[$objectHash] ?? $node;
}
protected function isName(Node $node, string $name): bool
{
return $this->nodeNameResolver->isName($node, $name);
}
/**
* @param string[] $names
*/
protected function isNames(Node $node, array $names): bool
{
return $this->nodeNameResolver->isNames($node, $names);
}
protected function getName(Node $node): ?string
{
return $this->nodeNameResolver->getName($node);
}
protected function isObjectType(Node $node, ObjectType $objectType): bool
{
return $this->nodeTypeResolver->isObjectType($node, $objectType);
}
/**
* Use this method for getting expr|node type
*/
protected function getType(Node $node): Type
{
return $this->nodeTypeResolver->getType($node);
}
/**
* @param Node|Node[] $nodes
* @param callable(Node $node): (Node|null|int) $callable
*/
protected function traverseNodesWithCallable(Node | array $nodes, callable $callable): void
{
$this->simpleCallableNodeTraverser->traverseNodesWithCallable($nodes, $callable);
}
protected function mirrorComments(Node $newNode, Node $oldNode): void
{
$newNode->setAttribute(AttributeKey::PHP_DOC_INFO, $oldNode->getAttribute(AttributeKey::PHP_DOC_INFO));
$newNode->setAttribute(AttributeKey::COMMENTS, $oldNode->getAttribute(AttributeKey::COMMENTS));
}
/**
* @param Arg[] $currentArgs
* @param Arg[] $appendingArgs
* @return Arg[]
*/
protected function appendArgs(array $currentArgs, array $appendingArgs): array
{
foreach ($appendingArgs as $appendingArg) {
$currentArgs[] = new Arg($appendingArg->value);
}
return $currentArgs;
}
protected function removeNode(Node $node): void
{
$this->nodeRemover->removeNode($node);
}
/**
* @param class-string<Node> $nodeClass
*/
private function isMatchingNodeType(string $nodeClass): bool
{
foreach ($this->getNodeTypes() as $nodeType) {
if (is_a($nodeClass, $nodeType, true)) {
return true;
}
}
return false;
}
private function shouldSkipCurrentNode(Node $node): bool
{
if ($this->nodesToRemoveCollector->isNodeRemoved($node)) {
return true;
}
if ($this->exclusionManager->isNodeSkippedByRector($node, $this)) {
return true;
}
$smartFileInfo = $this->file->getSmartFileInfo();
if ($this->skipper->shouldSkipElementAndFileInfo($this, $smartFileInfo)) {
return true;
}
$rectifiedNode = $this->rectifiedAnalyzer->verify($this, $node, $this->file);
return $rectifiedNode instanceof RectifiedNode;
}
/**
* @param array<string, mixed> $originalAttributes
*/
private function mirrorAttributes(array $originalAttributes, Node $newNode): void
{
foreach ($originalAttributes as $attributeName => $oldAttributeValue) {
if (! in_array($attributeName, self::ATTRIBUTES_TO_MIRROR, true)) {
continue;
}
$newNode->setAttribute($attributeName, $oldAttributeValue);
}
}
private function connectParentNodes(Node $node): void
{
$nodeTraverser = new NodeTraverser();
$nodeTraverser->addVisitor(new ParentConnectingVisitor());
$nodeTraverser->traverse([$node]);
}
private function printDebugCurrentFileAndRule(): void
{
if (! $this->rectorOutputStyle->isDebug()) {
return;
}
$this->rectorOutputStyle->writeln('[file] ' . $this->file->getRelativeFilePath());
$this->rectorOutputStyle->writeln('[rule] ' . static::class);
$this->rectorOutputStyle->newLine(1);
}
}