-
-
Notifications
You must be signed in to change notification settings - Fork 344
/
NameImportingPhpDocNodeVisitor.php
270 lines (219 loc) · 8.94 KB
/
NameImportingPhpDocNodeVisitor.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
<?php
declare(strict_types=1);
namespace Rector\NodeTypeResolver\PhpDocNodeVisitor;
use Nette\Utils\Strings;
use PhpParser\Node as PhpParserNode;
use PHPStan\PhpDocParser\Ast\Node;
use PHPStan\PhpDocParser\Ast\PhpDoc\TemplateTagValueNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\ObjectType;
use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
use Rector\BetterPhpDocParser\PhpDoc\SpacelessPhpDocTagNode;
use Rector\BetterPhpDocParser\ValueObject\PhpDocAttributeKey;
use Rector\CodingStyle\ClassNameImport\ClassNameImportSkipper;
use Rector\Core\Configuration\Option;
use Rector\Core\Configuration\Parameter\SimpleParameterProvider;
use Rector\Core\Exception\ShouldNotHappenException;
use Rector\Core\Provider\CurrentFileProvider;
use Rector\Core\ValueObject\Application\File;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeVisitor\AbstractPhpDocNodeVisitor;
use Rector\PostRector\Collector\UseNodesToAddCollector;
use Rector\StaticTypeMapper\PhpDocParser\IdentifierTypeMapper;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;
final class NameImportingPhpDocNodeVisitor extends AbstractPhpDocNodeVisitor
{
private ?PhpParserNode $currentPhpParserNode = null;
public function __construct(
private readonly ClassNameImportSkipper $classNameImportSkipper,
private readonly UseNodesToAddCollector $useNodesToAddCollector,
private readonly CurrentFileProvider $currentFileProvider,
private readonly ReflectionProvider $reflectionProvider,
private readonly IdentifierTypeMapper $identifierTypeMapper,
) {
}
public function beforeTraverse(Node $node): void
{
if (! $this->currentPhpParserNode instanceof PhpParserNode) {
throw new ShouldNotHappenException('Set "$currentPhpParserNode" first');
}
}
public function enterNode(Node $node): ?Node
{
if ($node instanceof SpacelessPhpDocTagNode) {
return $this->enterSpacelessPhpDocTagNode($node);
}
if ($node instanceof DoctrineAnnotationTagValueNode) {
$this->processDoctrineAnnotationTagValueNode($node);
return $node;
}
if (! $node instanceof IdentifierTypeNode) {
return null;
}
$staticType = $this->identifierTypeMapper->mapIdentifierTypeNode($node, $this->currentPhpParserNode);
if (! $staticType instanceof FullyQualifiedObjectType) {
return null;
}
// Importing root namespace classes (like \DateTime) is optional
if ($this->shouldSkipShortClassName($staticType)) {
return null;
}
$file = $this->currentFileProvider->getFile();
if (! $file instanceof File) {
return null;
}
if (! $this->currentPhpParserNode instanceof PhpParserNode) {
throw new ShouldNotHappenException();
}
return $this->processFqnNameImport($this->currentPhpParserNode, $node, $staticType, $file);
}
public function setCurrentNode(PhpParserNode $phpParserNode): void
{
$this->currentPhpParserNode = $phpParserNode;
}
private function processFqnNameImport(
PhpParserNode $phpParserNode,
IdentifierTypeNode $identifierTypeNode,
FullyQualifiedObjectType $fullyQualifiedObjectType,
File $file
): ?IdentifierTypeNode {
$parentNode = $identifierTypeNode->getAttribute(PhpDocAttributeKey::PARENT);
if ($parentNode instanceof TemplateTagValueNode) {
// might break
return null;
}
if (str_starts_with($fullyQualifiedObjectType->getClassName(), '@')) {
$fullyQualifiedObjectType = new FullyQualifiedObjectType(ltrim(
$fullyQualifiedObjectType->getClassName(),
'@'
));
}
if ($this->classNameImportSkipper->shouldSkipNameForFullyQualifiedObjectType(
$file,
$phpParserNode,
$fullyQualifiedObjectType
)) {
return null;
}
$newNode = new IdentifierTypeNode($fullyQualifiedObjectType->getShortName());
// should skip because its already used
if ($this->useNodesToAddCollector->isShortImported($file, $fullyQualifiedObjectType)
&& ! $this->useNodesToAddCollector->isImportShortable($file, $fullyQualifiedObjectType)) {
return null;
}
if ($this->shouldImport($newNode, $identifierTypeNode, $fullyQualifiedObjectType)) {
$this->useNodesToAddCollector->addUseImport($fullyQualifiedObjectType);
return $newNode;
}
return null;
}
private function shouldImport(
IdentifierTypeNode $newNode,
IdentifierTypeNode $identifierTypeNode,
FullyQualifiedObjectType $fullyQualifiedObjectType
): bool {
if ($newNode->name === $identifierTypeNode->name) {
return false;
}
if (str_starts_with($identifierTypeNode->name, '\\')) {
return true;
}
$className = $fullyQualifiedObjectType->getClassName();
if (! $this->reflectionProvider->hasClass($className)) {
return false;
}
$firstPath = Strings::before($identifierTypeNode->name, '\\' . $newNode->name);
if ($firstPath === null) {
return true;
}
if ($firstPath === '') {
return true;
}
$namespaceParts = explode('\\', ltrim($firstPath, '\\'));
return count($namespaceParts) > 1;
}
private function shouldSkipShortClassName(FullyQualifiedObjectType $fullyQualifiedObjectType): bool
{
$importShortClasses = SimpleParameterProvider::provideBoolParameter(Option::IMPORT_SHORT_CLASSES);
if ($importShortClasses) {
return false;
}
return substr_count($fullyQualifiedObjectType->getClassName(), '\\') === 0;
}
private function processDoctrineAnnotationTagValueNode(
DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode
): void {
$currentPhpParserNode = $this->currentPhpParserNode;
if (! $currentPhpParserNode instanceof PhpParserNode) {
throw new ShouldNotHappenException();
}
$identifierTypeNode = $doctrineAnnotationTagValueNode->identifierTypeNode;
$staticType = $this->identifierTypeMapper->mapIdentifierTypeNode(
$identifierTypeNode,
$currentPhpParserNode
);
if (! $staticType instanceof FullyQualifiedObjectType) {
if (! $staticType instanceof ObjectType) {
return;
}
$staticType = new FullyQualifiedObjectType($staticType->getClassName());
}
$file = $this->currentFileProvider->getFile();
if (! $file instanceof File) {
return;
}
$shortentedIdentifierTypeNode = $this->processFqnNameImport(
$currentPhpParserNode,
$identifierTypeNode,
$staticType,
$file
);
if (! $shortentedIdentifierTypeNode instanceof IdentifierTypeNode) {
return;
}
$doctrineAnnotationTagValueNode->identifierTypeNode = $shortentedIdentifierTypeNode;
$doctrineAnnotationTagValueNode->markAsChanged();
}
private function enterSpacelessPhpDocTagNode(
SpacelessPhpDocTagNode $spacelessPhpDocTagNode
): SpacelessPhpDocTagNode | null {
if (! $spacelessPhpDocTagNode->value instanceof DoctrineAnnotationTagValueNode) {
return null;
}
// special case for doctrine annotation
if (! str_starts_with($spacelessPhpDocTagNode->name, '@')) {
return null;
}
$attributeClass = ltrim($spacelessPhpDocTagNode->name, '@\\');
$identifierTypeNode = new IdentifierTypeNode($attributeClass);
$currentPhpParserNode = $this->currentPhpParserNode;
if (! $currentPhpParserNode instanceof PhpParserNode) {
throw new ShouldNotHappenException();
}
$staticType = $this->identifierTypeMapper->mapIdentifierTypeNode(
new IdentifierTypeNode($attributeClass),
$currentPhpParserNode
);
if (! $staticType instanceof FullyQualifiedObjectType) {
if (! $staticType instanceof ObjectType) {
return null;
}
$staticType = new FullyQualifiedObjectType($staticType->getClassName());
}
$file = $this->currentFileProvider->getFile();
if (! $file instanceof File) {
return null;
}
$importedName = $this->processFqnNameImport(
$currentPhpParserNode,
$identifierTypeNode,
$staticType,
$file
);
if ($importedName instanceof IdentifierTypeNode) {
$spacelessPhpDocTagNode->name = '@' . $importedName->name;
return $spacelessPhpDocTagNode;
}
return null;
}
}