Repository navigation
Expand file tree
/
Copy pathWithConsecutiveRector.php
More file actions
310 lines (263 loc) · 10.8 KB
/
Copy pathWithConsecutiveRector.php
File metadata and controls
310 lines (263 loc) · 10.8 KB
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<?php
declare(strict_types=1);
namespace Rector\PHPUnit\PHPUnit100\Rector\StmtsAwareInterface;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\ArrayDimFetch;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Expr\Throw_;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Identifier;
use PhpParser\Node\Param;
use PhpParser\Node\Scalar\Int_;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Return_;
use Rector\Exception\ShouldNotHappenException;
use Rector\PHPUnit\Enum\ConsecutiveMethodName;
use Rector\PHPUnit\Enum\ConsecutiveVariable;
use Rector\PHPUnit\MethodCallRemover;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\PHPUnit\NodeFinder\MethodCallNodeFinder;
use Rector\PHPUnit\PHPUnit100\NodeDecorator\WillReturnIfNodeDecorator;
use Rector\PHPUnit\PHPUnit100\NodeFactory\WillReturnCallbackFactory;
use Rector\Rector\AbstractRector;
use Rector\VersionBonding\Contract\ComposerPackageConstraintInterface;
use Rector\VersionBonding\ValueObject\ComposerPackageConstraint;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\PHPUnit\Tests\PHPUnit100\Rector\StmtsAwareInterface\WithConsecutiveRector\WithConsecutiveRectorTest
*/
final class WithConsecutiveRector extends AbstractRector implements ComposerPackageConstraintInterface
{
/**
* inherited from the PHPUnit 10.0 set
*/
public function provideComposerPackageConstraint(): ComposerPackageConstraint
{
return new ComposerPackageConstraint('phpunit/phpunit', '>=10.0');
}
public function __construct(
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
private readonly WillReturnCallbackFactory $willReturnCallbackFactory,
private readonly MethodCallRemover $methodCallRemover,
private readonly MethodCallNodeFinder $methodCallNodeFinder,
private readonly ExpectsMethodCallDecorator $expectsMethodCallDecorator,
private readonly WillReturnIfNodeDecorator $willReturnIfNodeDecorator
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Refactor deprecated withConsecutive() to willReturnCallback() structure', [
new CodeSample(
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
final class SomeTest extends TestCase
{
public function run()
{
$this->personServiceMock->expects($this->exactly(2))
->method('prepare')
->withConsecutive(
[1, 2],
[3, 4],
);
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
final class SomeTest extends TestCase
{
public function run()
{
$matcher = $this->exactly(2);
$this->personServiceMock->expects($matcher)
->method('prepare')
->willReturnCallback(function (...$parameters) use ($matcher) {
if ($matcher->numberOfInvocations() === 1) {
self::assertEquals([1, 2], $parameters);
}
if ($matcher->numberOfInvocations() === 2) {
self::assertEquals([3, 4], $parameters),
};
});
}
}
CODE_SAMPLE
),
]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [Expression::class];
}
/**
* @param Expression $node
* @return null|Stmt[]|Expression
*/
public function refactor(Node $node): null|array|Expression
{
if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
return null;
}
$withConsecutiveMethodCall = $this->methodCallNodeFinder->findByName(
$node,
ConsecutiveMethodName::WITH_CONSECUTIVE
);
if (! $withConsecutiveMethodCall instanceof MethodCall) {
return null;
}
if ($this->methodCallNodeFinder->hasByNames($node, ['willReturnMap', 'will'])) {
return null;
}
$returnStmt = null;
$willReturn = $this->methodCallNodeFinder->findByName($node, ConsecutiveMethodName::WILL_RETURN);
if ($willReturn instanceof MethodCall) {
$this->methodCallRemover->removeMethodCall($node, ConsecutiveMethodName::WILL_RETURN);
$expr = $this->getFirstArgValue($willReturn);
$returnStmt = new Return_($expr);
}
$willReturnSelf = $this->methodCallNodeFinder->findByName($node, ConsecutiveMethodName::WILL_RETURN_SELF);
if ($willReturnSelf instanceof MethodCall) {
$this->methodCallRemover->removeMethodCall($node, ConsecutiveMethodName::WILL_RETURN_SELF);
$returnStmt = $this->createWillReturnSelfStmts($willReturnSelf);
}
$willReturnArgument = $this->methodCallNodeFinder->findByName(
$node,
ConsecutiveMethodName::WILL_RETURN_ARGUMENT
);
if ($willReturnArgument instanceof MethodCall) {
$this->methodCallRemover->removeMethodCall($node, ConsecutiveMethodName::WILL_RETURN_ARGUMENT);
$returnStmt = $this->createWillReturnArgument($willReturnArgument);
}
$willReturnOnConsecutiveMethodCall = $this->methodCallNodeFinder->findByName(
$node,
ConsecutiveMethodName::WILL_RETURN_ON_CONSECUTIVE_CALLS,
);
if ($willReturnOnConsecutiveMethodCall instanceof MethodCall) {
$this->methodCallRemover->removeMethodCall($node, ConsecutiveMethodName::WILL_RETURN_ON_CONSECUTIVE_CALLS);
}
$willThrowException = $this->methodCallNodeFinder->findByName(
$node,
ConsecutiveMethodName::WILL_THROW_EXCEPTION
);
if ($willThrowException instanceof MethodCall) {
$this->methodCallRemover->removeMethodCall($node, ConsecutiveMethodName::WILL_THROW_EXCEPTION);
$expr = $this->getFirstArgValue($willThrowException);
$returnStmt = new Expression(new Throw_($expr));
}
$willReturnReferenceArgument = $this->methodCallNodeFinder->findByName(
$node,
ConsecutiveMethodName::WILL_RETURN_REFERENCE
);
$referenceVariable = null;
if ($willReturnReferenceArgument instanceof MethodCall) {
$this->methodCallRemover->removeMethodCall($node, ConsecutiveMethodName::WILL_RETURN_REFERENCE);
$expr = $this->getFirstArgValue($willReturnReferenceArgument);
$returnStmt = new Return_($expr);
// returns passed args
$referenceVariable = new Variable('parameters');
}
$expectsCall = $this->expectsMethodCallDecorator->decorate($node);
if (! $expectsCall instanceof MethodCall && ! $expectsCall instanceof StaticCall) {
// fallback to default by case count
$int = new Int_(\count($withConsecutiveMethodCall->args));
$expectsCall = new MethodCall(new Variable('this'), new Identifier('exactly'), [new Arg($int)]);
}
// 2. does willReturnCallback() exist? just merge them together
$existingWillReturnCallback = $this->methodCallNodeFinder->findByName(
$node,
ConsecutiveMethodName::WILL_RETURN_CALLBACK
);
if ($existingWillReturnCallback instanceof MethodCall) {
return $this->refactorWithExistingWillReturnCallback(
$existingWillReturnCallback,
$withConsecutiveMethodCall,
$node
);
}
// 3. rename and replace withConsecutive()
return $this->refactorToWillReturnCallback(
$withConsecutiveMethodCall,
$returnStmt,
$referenceVariable,
$expectsCall,
$node,
$willReturnOnConsecutiveMethodCall
);
}
/**
* @return Stmt[]
*/
private function refactorToWillReturnCallback(
MethodCall $withConsecutiveMethodCall,
Return_|Expression|null $returnStmt,
Expr|Variable|null $referenceVariable,
StaticCall|MethodCall $expectsCall,
Expression $expression,
?MethodCall $willReturnOnConsecutiveMethodCall
): array {
$closure = $this->willReturnCallbackFactory->createClosure(
$withConsecutiveMethodCall,
$returnStmt,
$referenceVariable,
);
$withConsecutiveMethodCall->name = new Identifier(ConsecutiveMethodName::WILL_RETURN_CALLBACK);
$withConsecutiveMethodCall->args = [new Arg($closure)];
$matcherVariable = new Variable(ConsecutiveVariable::MATCHER);
$matcherAssign = new Assign($matcherVariable, $expectsCall);
$this->willReturnIfNodeDecorator->decorate($closure, $willReturnOnConsecutiveMethodCall);
return [new Expression($matcherAssign), $expression];
}
private function refactorWithExistingWillReturnCallback(
MethodCall $existingWillReturnCallback,
MethodCall $withConsecutiveMethodCall,
Expression $expression
): Expression {
$callbackArg = $existingWillReturnCallback->getArgs()[0];
if (! $callbackArg->value instanceof Closure) {
throw new ShouldNotHappenException();
}
$callbackClosure = $callbackArg->value;
$callbackClosure->params[] = new Param(new Variable(ConsecutiveVariable::PARAMETERS));
$parametersMatch = $this->willReturnCallbackFactory->createParametersMatch($withConsecutiveMethodCall);
$callbackClosure->stmts = array_merge($parametersMatch, $callbackClosure->stmts);
$this->methodCallRemover->removeMethodCall($expression, ConsecutiveMethodName::WITH_CONSECUTIVE);
return $expression;
}
private function createWillReturnSelfStmts(MethodCall $willReturnSelfMethodCall): Return_
{
$selfVariable = $willReturnSelfMethodCall;
while (true) {
if (! $selfVariable instanceof MethodCall) {
break;
}
$selfVariable = $selfVariable->var;
}
return new Return_($selfVariable);
}
private function createWillReturnArgument(MethodCall $willReturnArgumentMethodCall): Return_
{
$parametersVariable = new Variable(ConsecutiveVariable::PARAMETERS);
$expr = $this->getFirstArgValue($willReturnArgumentMethodCall);
return new Return_(new ArrayDimFetch($parametersVariable, $expr));
}
private function getFirstArgValue(MethodCall $methodCall): Expr
{
$firstArg = $methodCall->getArgs()[0] ?? null;
if (! $firstArg instanceof Arg) {
throw new ShouldNotHappenException();
}
return $firstArg->value;
}
}