-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
PhpUnitDataProviderNameFixer.php
172 lines (153 loc) · 5.45 KB
/
PhpUnitDataProviderNameFixer.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
<?php
declare(strict_types=1);
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer\Fixer\PhpUnit;
use PhpCsFixer\Fixer\AbstractPhpUnitFixer;
use PhpCsFixer\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Preg;
use PhpCsFixer\Tokenizer\Analyzer\DataProviderAnalyzer;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Kuba Werłos <werlos@gmail.com>
*/
final class PhpUnitDataProviderNameFixer extends AbstractPhpUnitFixer implements ConfigurableFixerInterface
{
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Data provider names must match the name of the test.',
[
new CodeSample(
'<?php
class FooTest extends TestCase {
/**
* @dataProvider dataProvider
*/
public function testSomething($expected, $actual) {}
public function dataProvider() {}
}
',
),
new CodeSample(
'<?php
class FooTest extends TestCase {
/**
* @dataProvider dt_prvdr_ftr
*/
public function test_feature($expected, $actual) {}
public function dt_prvdr_ftr() {}
}
',
[
'prefix' => 'data_',
'suffix' => '',
]
),
new CodeSample(
'<?php
class FooTest extends TestCase {
/**
* @dataProvider dataProviderUsedInMultipleTests
*/
public function testA($expected, $actual) {}
/**
* @dataProvider dataProviderUsedInMultipleTests
*/
public function testB($expected, $actual) {}
/**
* @dataProvider dataProviderUsedInSingleTest
*/
public function testC($expected, $actual) {}
/**
* @dataProvider dataProviderUsedAsFirstInTest
* @dataProvider dataProviderUsedAsSecondInTest
*/
public function testD($expected, $actual) {}
public function dataProviderUsedInMultipleTests() {}
public function dataProviderUsedInSingleTest() {}
public function dataProviderUsedAsFirstInTest() {}
public function dataProviderUsedAsSecondInTest() {}
}
',
[
'prefix' => 'provides',
'suffix' => 'Data',
]
),
],
null,
'Fixer could be risky if one is calling data provider by name as function.'
);
}
public function getPriority(): int
{
return 0;
}
public function isRisky(): bool
{
return true;
}
protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
{
return new FixerConfigurationResolver([
(new FixerOptionBuilder('prefix', 'Prefix that replaces "test".'))
->setAllowedTypes(['string'])
->setDefault('provide')
->getOption(),
(new FixerOptionBuilder('suffix', 'Suffix to be present at the end.'))
->setAllowedTypes(['string'])
->setDefault('Cases')
->getOption(),
]);
}
protected function applyPhpUnitClassFix(Tokens $tokens, int $startIndex, int $endIndex): void
{
$dataProviderAnalyzer = new DataProviderAnalyzer();
foreach ($dataProviderAnalyzer->getDataProviders($tokens, $startIndex, $endIndex) as $dataProviderAnalysis) {
if (\count($dataProviderAnalysis->getUsageIndices()) > 1) {
continue;
}
$usageIndex = $dataProviderAnalysis->getUsageIndices()[0];
if (substr_count($tokens[$usageIndex]->getContent(), '@dataProvider') > 1) {
continue;
}
$testNameIndex = $tokens->getNextTokenOfKind($usageIndex, [[T_STRING]]);
$dataProviderNewName = $this->getProviderNameForTestName($tokens[$testNameIndex]->getContent());
if (null !== $tokens->findSequence([[T_FUNCTION], [T_STRING, $dataProviderNewName]], $startIndex, $endIndex)) {
continue;
}
$tokens[$dataProviderAnalysis->getNameIndex()] = new Token([T_STRING, $dataProviderNewName]);
$newCommentContent = Preg::replace(
sprintf('/(@dataProvider\s+)%s/', $dataProviderAnalysis->getName()),
sprintf('$1%s', $dataProviderNewName),
$tokens[$usageIndex]->getContent(),
);
$tokens[$usageIndex] = new Token([T_DOC_COMMENT, $newCommentContent]);
}
}
private function getProviderNameForTestName(string $name): string
{
$name = Preg::replace('/^test_*/i', '', $name);
if ('' === $this->configuration['prefix']) {
$name = lcfirst($name);
} elseif ('_' !== substr($this->configuration['prefix'], -1)) {
$name = ucfirst($name);
}
return $this->configuration['prefix'].$name.$this->configuration['suffix'];
}
}