Repository navigation
Expand file tree
/
Copy pathNarrowIdenticalWithConsecutiveRector.php
More file actions
150 lines (127 loc) · 3.84 KB
/
Copy pathNarrowIdenticalWithConsecutiveRector.php
File metadata and controls
150 lines (127 loc) · 3.84 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
<?php
declare(strict_types=1);
namespace Rector\PHPUnit\CodeQuality\Rector\MethodCall;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\Identifier;
use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\PHPUnit\Tests\CodeQuality\Rector\MethodCall\NarrowIdenticalWithConsecutiveRector\NarrowIdenticalWithConsecutiveRectorTest
*/
final class NarrowIdenticalWithConsecutiveRector extends AbstractRector
{
public function __construct(
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
private readonly BetterNodeFinder $betterNodeFinder
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Narrow identical withConsecutive() and willReturnOnConsecutiveCalls() to single call',
[
new CodeSample(
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
final class SomeTest extends TestCase
{
public function run()
{
$this->personServiceMock->expects($this->exactly(3))
->method('prepare')
->withConsecutive(
[1],
[1],
[1],
)
->willReturnOnConsecutiveCalls(
[2],
[2],
[2],
);
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
final class SomeTest extends TestCase
{
public function run()
{
$this->personServiceMock->expects($this->exactly(3))
->method('prepare')
->with([1])
->willReturn([2]);
}
}
CODE_SAMPLE
),
]
);
}
/**
* @return array<class-string<MethodCall>>
*/
public function getNodeTypes(): array
{
return [MethodCall::class];
}
/**
* @param MethodCall $node
*/
public function refactor(Node $node): MethodCall|null
{
if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
return null;
}
if (! $this->isNames($node->name, ['withConsecutive', 'willReturnOnConsecutiveCalls'])) {
return null;
}
if ($node->isFirstClassCallable()) {
return null;
}
$firstArg = $node->getArgs()[0];
// skip as most likely nested array of unique values
if ($firstArg->unpack) {
return null;
}
// skip new object instances, as each creates a fresh instance with possible property dependency
if ($this->betterNodeFinder->hasInstancesOf($node->getArgs(), [New_::class])) {
return null;
}
$uniqueArgValues = $this->resolveUniqueArgValues($node);
// multiple unique values
if (count($uniqueArgValues) !== 1) {
return null;
}
$firstArg = $node->getArgs()[0];
if ($this->isName($node->name, 'withConsecutive')) {
$node->name = new Identifier('with');
} else {
$node->name = new Identifier('willReturn');
}
// use simpler with() instead
$node->args = [new Arg($firstArg->value)];
return $node;
}
/**
* @return string[]
*/
private function resolveUniqueArgValues(MethodCall $methodCall): array
{
$printerStandard = new Standard();
$printedValues = [];
foreach ($methodCall->getArgs() as $arg) {
$printedValues[] = $printerStandard->prettyPrintExpr($arg->value);
}
return array_unique($printedValues);
}
}