-
-
Notifications
You must be signed in to change notification settings - Fork 336
/
UseAddingPostRector.php
142 lines (119 loc) · 4.6 KB
/
UseAddingPostRector.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
<?php
declare(strict_types=1);
namespace Rector\PostRector\Rector;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Namespace_;
use Rector\CodingStyle\Application\UseImportsAdder;
use Rector\CodingStyle\Application\UseImportsRemover;
use Rector\Core\Configuration\RenamedClassesDataCollector;
use Rector\Core\PhpParser\Node\BetterNodeFinder;
use Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\Core\Provider\CurrentFileProvider;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PostRector\Collector\UseNodesToAddCollector;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
final class UseAddingPostRector extends AbstractPostRector
{
public function __construct(
private readonly BetterNodeFinder $betterNodeFinder,
private readonly TypeFactory $typeFactory,
private readonly UseImportsAdder $useImportsAdder,
private readonly UseImportsRemover $useImportsRemover,
private readonly UseNodesToAddCollector $useNodesToAddCollector,
private readonly CurrentFileProvider $currentFileProvider,
private readonly RenamedClassesDataCollector $renamedClassesDataCollector,
) {
}
/**
* @param Stmt[] $nodes
* @return Stmt[]
*/
public function beforeTraverse(array $nodes): array
{
// no nodes → just return
if ($nodes === []) {
return $nodes;
}
$file = $this->currentFileProvider->getFile();
$smartFileInfo = $file->getSmartFileInfo();
$useImportTypes = $this->useNodesToAddCollector->getObjectImportsByFileInfo($smartFileInfo);
$functionUseImportTypes = $this->useNodesToAddCollector->getFunctionImportsByFileInfo($smartFileInfo);
$oldToNewClasses = $this->renamedClassesDataCollector->getOldToNewClasses();
// nothing to import or remove
if ($useImportTypes === [] && $functionUseImportTypes === [] && $oldToNewClasses === []) {
return $nodes;
}
/** @var FullyQualifiedObjectType[] $useImportTypes */
$useImportTypes = $this->typeFactory->uniquateTypes($useImportTypes);
// A. has namespace? add under it
$namespace = $this->betterNodeFinder->findFirstInstanceOf($nodes, Namespace_::class);
if ($namespace instanceof Namespace_) {
// first clean
//$this->useImportsRemover->removeImportsFromNamespace($namespace, $removedShortUses);
// then add, to prevent adding + removing false positive of same short use
$this->useImportsAdder->addImportsToNamespace($namespace, $useImportTypes, $functionUseImportTypes);
return $nodes;
}
$firstNode = $nodes[0];
if ($firstNode instanceof FileWithoutNamespace) {
$nodes = $firstNode->stmts;
}
$removedShortUses = $this->renamedClassesDataCollector->getOldClasses();
// B. no namespace? add in the top
// first clean
$nodes = $this->useImportsRemover->removeImportsFromStmts($nodes, $removedShortUses);
$useImportTypes = $this->filterOutNonNamespacedNames($useImportTypes);
// then add, to prevent adding + removing false positive of same short use
return $this->useImportsAdder->addImportsToStmts($nodes, $useImportTypes, $functionUseImportTypes);
}
public function getPriority(): int
{
// must be after name importing
return 500;
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Add unique use imports collected during Rector run',
[
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
public function run(AnotherClass $anotherClass)
{
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use App\AnotherClass;
class SomeClass
{
public function run(AnotherClass $anotherClass)
{
}
}
CODE_SAMPLE
), ]
);
}
/**
* Prevents
* @param FullyQualifiedObjectType[] $useImportTypes
* @return FullyQualifiedObjectType[]
*/
private function filterOutNonNamespacedNames(array $useImportTypes): array
{
$namespacedUseImportTypes = [];
foreach ($useImportTypes as $useImportType) {
if (! \str_contains($useImportType->getClassName(), '\\')) {
continue;
}
$namespacedUseImportTypes[] = $useImportType;
}
return $namespacedUseImportTypes;
}
}