-
-
Notifications
You must be signed in to change notification settings - Fork 680
/
AddParamBasedOnParentClassMethodRector.php
237 lines (233 loc) · 8.96 KB
/
AddParamBasedOnParentClassMethodRector.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
<?php
declare (strict_types=1);
namespace Rector\Php80\Rector\ClassMethod;
use PhpParser\Comment;
use PhpParser\Node;
use PhpParser\Node\ComplexType;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Param;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\MethodReflection;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\PhpParser\AstResolver;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Printer\BetterStandardPrinter;
use Rector\Rector\AbstractRector;
use Rector\Reflection\ReflectionResolver;
use Rector\ValueObject\MethodName;
use Rector\ValueObject\PhpVersionFeature;
use Rector\VendorLocker\ParentClassMethodTypeOverrideGuard;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\Php80\Rector\ClassMethod\AddParamBasedOnParentClassMethodRector\AddParamBasedOnParentClassMethodRectorTest
*/
final class AddParamBasedOnParentClassMethodRector extends AbstractRector implements MinPhpVersionInterface
{
/**
* @readonly
* @var \Rector\VendorLocker\ParentClassMethodTypeOverrideGuard
*/
private $parentClassMethodTypeOverrideGuard;
/**
* @readonly
* @var \Rector\PhpParser\AstResolver
*/
private $astResolver;
/**
* @readonly
* @var \Rector\PhpParser\Printer\BetterStandardPrinter
*/
private $betterStandardPrinter;
/**
* @readonly
* @var \Rector\PhpParser\Node\BetterNodeFinder
*/
private $betterNodeFinder;
/**
* @readonly
* @var \Rector\Reflection\ReflectionResolver
*/
private $reflectionResolver;
public function __construct(ParentClassMethodTypeOverrideGuard $parentClassMethodTypeOverrideGuard, AstResolver $astResolver, BetterStandardPrinter $betterStandardPrinter, BetterNodeFinder $betterNodeFinder, ReflectionResolver $reflectionResolver)
{
$this->parentClassMethodTypeOverrideGuard = $parentClassMethodTypeOverrideGuard;
$this->astResolver = $astResolver;
$this->betterStandardPrinter = $betterStandardPrinter;
$this->betterNodeFinder = $betterNodeFinder;
$this->reflectionResolver = $reflectionResolver;
}
public function provideMinPhpVersion() : int
{
return PhpVersionFeature::FATAL_ERROR_ON_INCOMPATIBLE_METHOD_SIGNATURE;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Add missing parameter based on parent class method', [new CodeSample(<<<'CODE_SAMPLE'
class A
{
public function execute($foo)
{
}
}
class B extends A{
public function execute()
{
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class A
{
public function execute($foo)
{
}
}
class B extends A{
public function execute($foo)
{
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [ClassMethod::class];
}
/**
* @param ClassMethod $node
*/
public function refactor(Node $node) : ?Node
{
if ($this->nodeNameResolver->isName($node, MethodName::CONSTRUCT)) {
return null;
}
$parentMethodReflection = $this->parentClassMethodTypeOverrideGuard->getParentClassMethod($node);
if (!$parentMethodReflection instanceof MethodReflection) {
return null;
}
if ($parentMethodReflection->isPrivate()) {
return null;
}
$currentClassReflection = $this->reflectionResolver->resolveClassReflection($node);
$isPDO = $currentClassReflection instanceof ClassReflection && $currentClassReflection->isSubclassOf('PDO');
// It relies on phpstorm stubs that define 2 kind of query method for both php 7.4 and php 8.0
// @see https://github.com/JetBrains/phpstorm-stubs/blob/e2e898a29929d2f520fe95bdb2109d8fa895ba4a/PDO/PDO.php#L1096-L1126
if ($isPDO && $parentMethodReflection->getName() === 'query') {
return null;
}
$parentClassMethod = $this->astResolver->resolveClassMethodFromMethodReflection($parentMethodReflection);
if (!$parentClassMethod instanceof ClassMethod) {
return null;
}
$currentClassMethodParams = $node->getParams();
$parentClassMethodParams = $parentClassMethod->getParams();
$countCurrentClassMethodParams = \count($currentClassMethodParams);
$countParentClassMethodParams = \count($parentClassMethodParams);
if ($countCurrentClassMethodParams === $countParentClassMethodParams) {
return null;
}
if ($countCurrentClassMethodParams < $countParentClassMethodParams) {
return $this->processReplaceClassMethodParams($node, $parentClassMethod, $currentClassMethodParams, $parentClassMethodParams);
}
return $this->processAddNullDefaultParam($node, $currentClassMethodParams, $parentClassMethodParams);
}
/**
* @param Param[] $currentClassMethodParams
* @param Param[] $parentClassMethodParams
*/
private function processAddNullDefaultParam(ClassMethod $classMethod, array $currentClassMethodParams, array $parentClassMethodParams) : ?ClassMethod
{
$hasChanged = \false;
foreach ($currentClassMethodParams as $key => $currentClassMethodParam) {
if (isset($parentClassMethodParams[$key])) {
continue;
}
if ($currentClassMethodParam->default instanceof Expr) {
continue;
}
if ($currentClassMethodParam->variadic) {
continue;
}
$currentClassMethodParams[$key]->default = $this->nodeFactory->createNull();
$hasChanged = \true;
}
if (!$hasChanged) {
return null;
}
return $classMethod;
}
/**
* @param array<int, Param> $currentClassMethodParams
* @param array<int, Param> $parentClassMethodParams
*/
private function processReplaceClassMethodParams(ClassMethod $node, ClassMethod $parentClassMethod, array $currentClassMethodParams, array $parentClassMethodParams) : ?ClassMethod
{
$originalParams = $node->params;
foreach ($parentClassMethodParams as $key => $parentClassMethodParam) {
if (isset($currentClassMethodParams[$key])) {
$currentParamName = $this->nodeNameResolver->getName($currentClassMethodParams[$key]);
$collectParamNamesNextKey = $this->collectParamNamesNextKey($parentClassMethod, $key);
if (\in_array($currentParamName, $collectParamNamesNextKey, \true)) {
$node->params = $originalParams;
return null;
}
continue;
}
$isUsedInStmts = (bool) $this->betterNodeFinder->findFirstInFunctionLikeScoped($node, function (Node $subNode) use($parentClassMethodParam) : bool {
if (!$subNode instanceof Variable) {
return \false;
}
return $this->nodeComparator->areNodesEqual($subNode, $parentClassMethodParam->var);
});
if ($isUsedInStmts) {
$node->params = $originalParams;
return null;
}
$paramDefault = $parentClassMethodParam->default;
if ($paramDefault instanceof Expr) {
$paramDefault = $this->nodeFactory->createReprintedNode($paramDefault);
}
$paramName = $this->nodeNameResolver->getName($parentClassMethodParam);
$paramType = $this->resolveParamType($parentClassMethodParam);
$node->params[$key] = new Param(new Variable($paramName), $paramDefault, $paramType, $parentClassMethodParam->byRef, $parentClassMethodParam->variadic, [], $parentClassMethodParam->flags);
if ($parentClassMethodParam->attrGroups !== []) {
$attrGroupsAsComment = $this->betterStandardPrinter->print($parentClassMethodParam->attrGroups);
$node->params[$key]->setAttribute(AttributeKey::COMMENTS, [new Comment($attrGroupsAsComment)]);
}
}
return $node;
}
/**
* @return null|\PhpParser\Node\Identifier|\PhpParser\Node\Name|\PhpParser\Node\ComplexType
*/
private function resolveParamType(Param $param)
{
if ($param->type === null) {
return null;
}
return $this->nodeFactory->createReprintedNode($param->type);
}
/**
* @return string[]
*/
private function collectParamNamesNextKey(ClassMethod $classMethod, int $key) : array
{
$paramNames = [];
foreach ($classMethod->params as $paramKey => $param) {
if ($paramKey > $key) {
$paramNames[] = $this->nodeNameResolver->getName($param);
}
}
return $paramNames;
}
}