-
-
Notifications
You must be signed in to change notification settings - Fork 335
/
CompleteDynamicPropertiesRector.php
207 lines (173 loc) · 5.99 KB
/
CompleteDynamicPropertiesRector.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
<?php
declare(strict_types=1);
namespace Rector\CodeQuality\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use Rector\CodeQuality\NodeAnalyzer\ClassLikeAnalyzer;
use Rector\CodeQuality\NodeAnalyzer\LocalPropertyAnalyzer;
use Rector\CodeQuality\NodeFactory\MissingPropertiesFactory;
use Rector\NodeAnalyzer\ClassAnalyzer;
use Rector\NodeAnalyzer\PropertyPresenceChecker;
use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
use Rector\PostRector\ValueObject\PropertyMetadata;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://3v4l.org/GL6II
* @changelog https://3v4l.org/eTrhZ
* @changelog https://3v4l.org/C554W
*
* @see \Rector\Tests\CodeQuality\Rector\Class_\CompleteDynamicPropertiesRector\CompleteDynamicPropertiesRectorTest
*/
final class CompleteDynamicPropertiesRector extends AbstractRector
{
public function __construct(
private readonly MissingPropertiesFactory $missingPropertiesFactory,
private readonly LocalPropertyAnalyzer $localPropertyAnalyzer,
private readonly ClassLikeAnalyzer $classLikeAnalyzer,
private readonly ReflectionProvider $reflectionProvider,
private readonly ClassAnalyzer $classAnalyzer,
private readonly PropertyPresenceChecker $propertyPresenceChecker,
private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Add missing dynamic properties', [
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
public function set()
{
$this->value = 5;
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class SomeClass
{
/**
* @var int
*/
public $value;
public function set()
{
$this->value = 5;
}
}
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->shouldSkipClass($node)) {
return null;
}
$className = $this->getName($node);
if ($className === null) {
return null;
}
if (! $this->reflectionProvider->hasClass($className)) {
return null;
}
$classReflection = $this->reflectionProvider->getClass($className);
// special case for Laravel Collection macro magic
$fetchedLocalPropertyNameToTypes = $this->localPropertyAnalyzer->resolveFetchedPropertiesToTypesFromClass(
$node
);
$propertiesToComplete = $this->resolvePropertiesToComplete($node, $fetchedLocalPropertyNameToTypes);
if ($propertiesToComplete === []) {
return null;
}
$propertiesToComplete = $this->filterOutExistingProperties($node, $classReflection, $propertiesToComplete);
$newProperties = $this->missingPropertiesFactory->create(
$fetchedLocalPropertyNameToTypes,
$propertiesToComplete
);
if ($newProperties === []) {
return null;
}
$node->stmts = array_merge($newProperties, $node->stmts);
return $node;
}
private function shouldSkipClass(Class_ $class): bool
{
if ($this->classAnalyzer->isAnonymousClass($class)) {
return true;
}
$className = (string) $this->nodeNameResolver->getName($class);
if (! $this->reflectionProvider->hasClass($className)) {
return true;
}
if ($this->phpAttributeAnalyzer->hasPhpAttribute($class, 'AllowDynamicProperties')) {
return true;
}
$classReflection = $this->reflectionProvider->getClass($className);
// properties are accessed via magic, nothing we can do
if ($classReflection->hasMethod('__set')) {
return true;
}
if ($classReflection->hasMethod('__get')) {
return true;
}
return $class->extends instanceof FullyQualified && ! $this->reflectionProvider->hasClass($class->extends->toString());
}
/**
* @param array<string, Type> $fetchedLocalPropertyNameToTypes
* @return string[]
*/
private function resolvePropertiesToComplete(Class_ $class, array $fetchedLocalPropertyNameToTypes): array
{
$propertyNames = $this->classLikeAnalyzer->resolvePropertyNames($class);
/** @var string[] $fetchedLocalPropertyNames */
$fetchedLocalPropertyNames = array_keys($fetchedLocalPropertyNameToTypes);
return array_diff($fetchedLocalPropertyNames, $propertyNames);
}
/**
* @param string[] $propertiesToComplete
* @return string[]
*/
private function filterOutExistingProperties(
Class_ $class,
ClassReflection $classReflection,
array $propertiesToComplete
): array {
$missingPropertyNames = [];
$className = $classReflection->getName();
// remove other properties that are accessible from this scope
foreach ($propertiesToComplete as $propertyToComplete) {
if ($classReflection->hasProperty($propertyToComplete)) {
continue;
}
$propertyMetadata = new PropertyMetadata($propertyToComplete, new ObjectType($className));
$hasClassContextProperty = $this->propertyPresenceChecker->hasClassContextProperty(
$class,
$propertyMetadata
);
if ($hasClassContextProperty) {
continue;
}
$missingPropertyNames[] = $propertyToComplete;
}
return $missingPropertyNames;
}
}