-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
PhpdocReturnSelfReferenceFixerTest.php
275 lines (236 loc) · 6.5 KB
/
PhpdocReturnSelfReferenceFixerTest.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
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
<?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\Tests\Fixer\Phpdoc;
use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
/**
* @internal
*
* @covers \PhpCsFixer\Fixer\Phpdoc\PhpdocReturnSelfReferenceFixer
*/
final class PhpdocReturnSelfReferenceFixerTest extends AbstractFixerTestCase
{
/**
* @dataProvider provideFixWithDefaultConfigurationCases
*/
public function testFixWithDefaultConfiguration(string $expected, ?string $input = null): void
{
$this->fixer->configure([]);
$this->doTest($expected, $input);
}
public static function provideFixWithDefaultConfigurationCases(): iterable
{
yield [
'<?php interface A{/** @return $this */public function test();}',
'<?php interface A{/** @return this */public function test();}',
];
yield [
'<?php interface B{/** @return self|int */function test();}',
'<?php interface B{/** @return $SELF|int */function test();}',
];
yield [
'<?php class D {} /** @return {@this} */ require_once($a);echo 1;echo 1;echo 1;echo 1;echo 1;echo 1;echo 1;echo 1;',
];
yield [
'<?php /** @return this */ require_once($a);echo 1;echo 1;echo 1;echo 1;echo 1;echo 1;echo 1;echo 1; class E {}',
];
yield [
'<?php
trait SomeTrait
{
/** @return $this */
public function someTest(): self
{
return $this;
}
}
// class Foo { use Bla; } $a = (new Foo())->someTest();',
'<?php
trait SomeTrait
{
/** @return this */
public function someTest(): self
{
return $this;
}
}
// class Foo { use Bla; } $a = (new Foo())->someTest();',
];
}
/**
* @param array<string, string> $configuration
*
* @dataProvider provideFixCases
*/
public function testFix(string $expected, ?string $input = null, array $configuration = []): void
{
$this->fixer->configure(['replacements' => $configuration]);
$this->doTest($expected, $input);
}
public static function provideFixCases(): iterable
{
yield [
'<?php interface C{/** @return $self|int */function test();}',
null,
['$static' => 'static'],
];
}
/**
* @dataProvider provideGeneratedFixCases
*/
public function testGeneratedFix(string $expected, string $input): void
{
$config = ['replacements' => [$input => $expected]];
$this->fixer->configure($config);
$expected = sprintf('<?php
/**
* Please do not use @return %s|static|self|this|$static|$self|@static|@self|@this as return type declaration
*/
class F
{
/**
* @param %s
*
* @return %s
*/
public function AB($self)
{
return $this; // %s
}
}
', $input, $input, $expected, $input);
$input = sprintf('<?php
/**
* Please do not use @return %s|static|self|this|$static|$self|@static|@self|@this as return type declaration
*/
class F
{
/**
* @param %s
*
* @return %s
*/
public function AB($self)
{
return $this; // %s
}
}
', $input, $input, $input, $input);
$this->doTest($expected, $input);
}
public static function provideGeneratedFixCases(): iterable
{
yield ['$this', 'this'];
yield ['$this', '@this'];
yield ['self', '$self'];
yield ['self', '@self'];
yield ['static', '$static'];
yield ['static', '@STATIC'];
}
/**
* @param array<string, mixed> $configuration
*
* @dataProvider provideInvalidConfigurationCases
*/
public function testInvalidConfiguration(array $configuration, string $message): void
{
$this->expectException(InvalidFixerConfigurationException::class);
$this->expectExceptionMessageMatches(sprintf('/^\[phpdoc_return_self_reference\] %s$/', preg_quote($message, '/')));
$this->fixer->configure($configuration);
}
public static function provideInvalidConfigurationCases(): iterable
{
yield [
['replacements' => [1 => 'a']],
'Invalid configuration: Unknown key "integer#1", expected any of "this", "@this", "$self", "@self", "$static" and "@static".',
];
yield [
['replacements' => [
'this' => 'foo',
]],
'Invalid configuration: Unknown value "string#foo", expected any of "$this", "static" and "self".',
];
}
public function testAnonymousClassFixing(): void
{
$this->doTest(
'<?php
$a = new class() {
/** @return $this */
public function a() {
}
};
class C
{
public function A()
{
$a = new class() {
/** @return $this */
public function a() {}
};
}
}
',
'<?php
$a = new class() {
/** @return @this */
public function a() {
}
};
class C
{
public function A()
{
$a = new class() {
/** @return @this */
public function a() {}
};
}
}
'
);
}
/**
* @dataProvider provideFix81Cases
*
* @requires PHP 8.1
*/
public function testFix81(string $expected, string $input): void
{
$this->doTest($expected, $input);
}
public static function provideFix81Cases(): iterable
{
yield [
'<?php
enum Foo {
case CAT;
/** @return $this */
public function test(): self {
return $this;
}
}
var_dump(Foo::CAT->test());
',
'<?php
enum Foo {
case CAT;
/** @return this */
public function test(): self {
return $this;
}
}
var_dump(Foo::CAT->test());
',
];
}
}