-
-
Notifications
You must be signed in to change notification settings - Fork 336
/
ExplicitMethodCallOverMagicGetSetRector.php
222 lines (181 loc) · 6.32 KB
/
ExplicitMethodCallOverMagicGetSetRector.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
<?php
declare(strict_types=1);
namespace Rector\CodeQuality\Rector\PropertyFetch;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\PropertyFetch;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\Reflection\ResolvedMethodReflection;
use PHPStan\Type\ObjectType;
use Rector\Core\Rector\AbstractScopeAwareRector;
use Rector\Core\ValueObject\MethodName;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://github.com/symplify/phpstan-rules/blob/main/docs/rules_overview.md#explicitmethodcallovermagicgetsetrule
*
* @inspired by \Rector\Transform\Rector\Assign\GetAndSetToMethodCallRector
* @phpstan-rule https://github.com/symplify/phpstan-rules/blob/main/src/Rules/Explicit/ExplicitMethodCallOverMagicGetSetRule.php
*
* @see \Rector\Tests\CodeQuality\Rector\PropertyFetch\ExplicitMethodCallOverMagicGetSetRector\ExplicitMethodCallOverMagicGetSetRectorTest
*/
final class ExplicitMethodCallOverMagicGetSetRector extends AbstractScopeAwareRector
{
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Replace magic property fetch using __get() and __set() with existing method get*()/set*() calls',
[
new CodeSample(
<<<'CODE_SAMPLE'
class MagicCallsObject
{
// adds magic __get() and __set() methods
use \Nette\SmartObject;
private $name;
public function getName()
{
return $this->name;
}
}
class SomeClass
{
public function run(MagicObject $magicObject)
{
return $magicObject->name;
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class MagicCallsObject
{
// adds magic __get() and __set() methods
use \Nette\SmartObject;
private $name;
public function getName()
{
return $this->name;
}
}
class SomeClass
{
public function run(MagicObject $magicObject)
{
return $magicObject->getName();
}
}
CODE_SAMPLE
),
]
);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [PropertyFetch::class, Assign::class];
}
/**
* @param PropertyFetch|Assign $node
*/
public function refactorWithScope(Node $node, Scope $scope): ?Node
{
if ($node instanceof Assign) {
if ($node->var instanceof PropertyFetch) {
return $this->refactorMagicSet($node->expr, $node->var, $scope);
}
return null;
}
if ($this->shouldSkipPropertyFetch($node)) {
return null;
}
return $this->refactorPropertyFetch($node, $scope);
}
/**
* @return string[]
*/
public function resolvePossibleGetMethodNames(string $propertyName): array
{
return ['get' . ucfirst($propertyName), 'has' . ucfirst($propertyName), 'is' . ucfirst($propertyName)];
}
private function shouldSkipPropertyFetch(PropertyFetch $propertyFetch): bool
{
$parent = $propertyFetch->getAttribute(AttributeKey::PARENT_NODE);
if (! $parent instanceof Assign) {
return false;
}
return $parent->var === $propertyFetch;
}
private function refactorPropertyFetch(PropertyFetch $propertyFetch, Scope $scope): MethodCall|null
{
$callerType = $this->getType($propertyFetch->var);
if (! $callerType instanceof ObjectType) {
return null;
}
// has magic methods?
if (! $callerType->hasMethod(MethodName::__GET)->yes()) {
return null;
}
$propertyName = $this->getName($propertyFetch->name);
if ($propertyName === null) {
return null;
}
$property = $callerType->getProperty($propertyName, $scope);
$propertyType = $property->getReadableType();
$possibleGetterMethodNames = $this->resolvePossibleGetMethodNames($propertyName);
foreach ($possibleGetterMethodNames as $possibleGetterMethodName) {
if (! $callerType->hasMethod($possibleGetterMethodName)->yes()) {
continue;
}
$methodReflection = $callerType->getMethod($possibleGetterMethodName, $scope);
$variant = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants());
$returnType = $variant->getReturnType();
if (! $propertyType->isSuperTypeOf($returnType)->yes()) {
continue;
}
return $this->nodeFactory->createMethodCall($propertyFetch->var, $possibleGetterMethodName);
}
return null;
}
private function refactorMagicSet(Expr $expr, PropertyFetch $propertyFetch, Scope $scope): MethodCall|null
{
$propertyCallerType = $this->getType($propertyFetch->var);
if (! $propertyCallerType instanceof ObjectType) {
return null;
}
if (! $propertyCallerType->hasMethod(MethodName::__SET)->yes()) {
return null;
}
$propertyName = $this->getName($propertyFetch->name);
if ($propertyName === null) {
return null;
}
$setterMethodName = 'set' . ucfirst($propertyName);
if (! $propertyCallerType->hasMethod($setterMethodName)->yes()) {
return null;
}
if ($this->hasNoParamOrVariadic($propertyCallerType, $setterMethodName, $scope)) {
return null;
}
return $this->nodeFactory->createMethodCall($propertyFetch->var, $setterMethodName, [$expr]);
}
private function hasNoParamOrVariadic(ObjectType $objectType, string $setterMethodName, Scope $scope): bool
{
$methodReflection = $objectType->getMethod($setterMethodName, $scope);
if (! $methodReflection instanceof ResolvedMethodReflection) {
return false;
}
$parametersAcceptor = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants());
$parameters = $parametersAcceptor->getParameters();
if (count($parameters) !== 1) {
return true;
}
return $parameters[0]->isVariadic();
}
}