-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
PhpdocToReturnTypeFixerTest.php
442 lines (423 loc) · 15.8 KB
/
PhpdocToReturnTypeFixerTest.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
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
<?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\FunctionNotation;
use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
/**
* @author Filippo Tessarotto <zoeslam@gmail.com>
*
* @internal
*
* @covers \PhpCsFixer\Fixer\FunctionNotation\PhpdocToReturnTypeFixer
*/
final class PhpdocToReturnTypeFixerTest extends AbstractFixerTestCase
{
/**
* @dataProvider provideFixCases
*/
public function testFix(string $expected, ?string $input = null, ?int $versionSpecificFix = null, array $config = []): void
{
if (
null !== $input
&& (null !== $versionSpecificFix && \PHP_VERSION_ID < $versionSpecificFix)
) {
$expected = $input;
$input = null;
}
$this->fixer->configure($config);
$this->doTest($expected, $input);
}
public function provideFixCases(): \Generator
{
yield from [
'no phpdoc return' => [
'<?php function my_foo() {}',
],
'invalid return' => [
'<?php /** @return */ function my_foo() {}',
],
'invalid class 1' => [
'<?php /** @return \9 */ function my_foo() {}',
],
'invalid class 2' => [
'<?php /** @return \\Foo\\\\Bar */ function my_foo() {}',
],
'invalid class 3' => [
'<?php /** @return Break */ function my_foo() {}',
],
'invalid class 4' => [
'<?php /** @return __CLASS__ */ function my_foo() {}',
],
'invalid class 5' => [
'<?php /** @return I\Want\To\Bre\\\\ak\Free */ function queen() {}',
],
'excluded class methods' => [
'<?php
class Foo
{
/** @return Bar */
function __construct() {}
/** @return Bar */
function __destruct() {}
/** @return Bar */
function __clone() {}
}
',
],
'multiple returns' => [
'<?php
/**
* @return Bar
* @return Baz
*/
function xyz() {}
',
],
'non-root class' => [
'<?php /** @return Bar */ function my_foo(): Bar {}',
'<?php /** @return Bar */ function my_foo() {}',
],
'non-root namespaced class' => [
'<?php /** @return My\Bar */ function my_foo(): My\Bar {}',
'<?php /** @return My\Bar */ function my_foo() {}',
],
'root class' => [
'<?php /** @return \My\Bar */ function my_foo(): \My\Bar {}',
'<?php /** @return \My\Bar */ function my_foo() {}',
],
'interface' => [
'<?php interface Foo { /** @return Bar */ function my_foo(): Bar; }',
'<?php interface Foo { /** @return Bar */ function my_foo(); }',
],
'void return on ^7.1' => [
'<?php /** @return void */ function my_foo(): void {}',
'<?php /** @return void */ function my_foo() {}',
],
'invalid void return on ^7.1' => [
'<?php /** @return null|void */ function my_foo() {}',
],
'iterable return on ^7.1' => [
'<?php /** @return iterable */ function my_foo(): iterable {}',
'<?php /** @return iterable */ function my_foo() {}',
],
'object return on ^7.2' => [
'<?php /** @return object */ function my_foo(): object {}',
'<?php /** @return object */ function my_foo() {}',
70200,
],
'fix scalar types by default, int' => [
'<?php /** @return int */ function my_foo(): int {}',
'<?php /** @return int */ function my_foo() {}',
],
'fix scalar types by default, float' => [
'<?php /** @return float */ function my_foo(): float {}',
'<?php /** @return float */ function my_foo() {}',
],
'fix scalar types by default, string' => [
'<?php /** @return string */ function my_foo(): string {}',
'<?php /** @return string */ function my_foo() {}',
],
'fix scalar types by default, bool' => [
'<?php /** @return bool */ function my_foo(): bool {}',
'<?php /** @return bool */ function my_foo() {}',
],
'fix scalar types by default, bool, make unqualified' => [
'<?php /** @return \bool */ function my_foo(): bool {}',
'<?php /** @return \bool */ function my_foo() {}',
],
'fix scalar types by default, false' => [
'<?php /** @return false */ function my_foo(): bool {}',
'<?php /** @return false */ function my_foo() {}',
],
'fix scalar types by default, true' => [
'<?php /** @return true */ function my_foo(): bool {}',
'<?php /** @return true */ function my_foo() {}',
],
'do not fix scalar types when configured as such' => [
'<?php /** @return int */ function my_foo() {}',
null,
null,
['scalar_types' => false],
],
'array native type' => [
'<?php /** @return array */ function my_foo(): array {}',
'<?php /** @return array */ function my_foo() {}',
],
'callable type' => [
'<?php /** @return callable */ function my_foo(): callable {}',
'<?php /** @return callable */ function my_foo() {}',
],
'self accessor' => [
'<?php
class Foo {
/** @return self */ function my_foo(): self {}
}
',
'<?php
class Foo {
/** @return self */ function my_foo() {}
}
',
],
'nullable self accessor' => [
'<?php
class Foo {
/** @return self|null */ function my_foo(): ?self {}
}
',
'<?php
class Foo {
/** @return self|null */ function my_foo() {}
}
',
],
'skip resource special type' => [
'<?php /** @return resource */ function my_foo() {}',
],
'null alone cannot be a return type' => [
'<?php /** @return null */ function my_foo() {}',
],
'skip mixed types' => [
'<?php /** @return Foo|Bar */ function my_foo() {}',
],
'nullable type' => [
'<?php /** @return null|Bar */ function my_foo(): ?Bar {}',
'<?php /** @return null|Bar */ function my_foo() {}',
],
'nullable type reverse order' => [
'<?php /** @return Bar|null */ function my_foo(): ?Bar {}',
'<?php /** @return Bar|null */ function my_foo() {}',
],
'nullable native type' => [
'<?php /** @return null|array */ function my_foo(): ?array {}',
'<?php /** @return null|array */ function my_foo() {}',
],
'skip primitive or array types' => [
'<?php /** @return string|string[] */ function my_foo() {}',
],
'skip mixed nullable types' => [
'<?php /** @return null|Foo|Bar */ function my_foo() {}',
],
'generics' => [
'<?php /** @return array<int, bool> */ function my_foo(): array {}',
'<?php /** @return array<int, bool> */ function my_foo() {}',
],
'array of types' => [
'<?php /** @return Foo[] */ function my_foo(): array {}',
'<?php /** @return Foo[] */ function my_foo() {}',
],
'array of array of types' => [
'<?php /** @return Foo[][] */ function my_foo(): array {}',
'<?php /** @return Foo[][] */ function my_foo() {}',
],
'nullable array of types' => [
'<?php /** @return null|Foo[] */ function my_foo(): ?array {}',
'<?php /** @return null|Foo[] */ function my_foo() {}',
],
'comments' => [
'<?php
class A
{
// comment 0
/** @return Foo */ # comment 1
final/**/public/**/static/**/function/**/bar/**/(/**/$var/**/=/**/1/**/): Foo/**/{# comment 2
} // comment 3
}
',
'<?php
class A
{
// comment 0
/** @return Foo */ # comment 1
final/**/public/**/static/**/function/**/bar/**/(/**/$var/**/=/**/1/**/)/**/{# comment 2
} // comment 3
}
',
],
'array and traversable' => [
'<?php /** @return array|Traversable */ function my_foo(): iterable {}',
'<?php /** @return array|Traversable */ function my_foo() {}',
],
'array and traversable with leading slash' => [
'<?php /** @return array|\Traversable */ function my_foo(): iterable {}',
'<?php /** @return array|\Traversable */ function my_foo() {}',
],
'array and traversable in a namespace' => [
'<?php
namespace App;
/** @return array|Traversable */
function my_foo() {}
',
],
'array and traversable with leading slash in a namespace' => [
'<?php
namespace App;
/** @return array|\Traversable */
function my_foo(): iterable {}
',
'<?php
namespace App;
/** @return array|\Traversable */
function my_foo() {}
',
],
'array and imported traversable in a namespace' => [
'<?php
namespace App;
use Traversable;
/** @return array|Traversable */
function my_foo(): iterable {}
',
'<?php
namespace App;
use Traversable;
/** @return array|Traversable */
function my_foo() {}
',
],
'array and object aliased as traversable in a namespace' => [
'<?php
namespace App;
use Foo as Traversable;
/** @return array|Traversable */
function my_foo() {}
',
],
'array of object and traversable' => [
'<?php /** @return Foo[]|Traversable */ function my_foo(): iterable {}',
'<?php /** @return Foo[]|Traversable */ function my_foo() {}',
],
'array of object and iterable' => [
'<?php /** @return Foo[]|iterable */ function my_foo(): iterable {}',
'<?php /** @return Foo[]|iterable */ function my_foo() {}',
],
'array of string and array of int' => [
'<?php /** @return string[]|int[] */ function my_foo(): array {}',
'<?php /** @return string[]|int[] */ function my_foo() {}',
],
'intersection types' => [
'<?php
/** @return Bar&Baz */
function bar() {}
',
],
'very long class name before ampersand' => [
'<?php
/** @return Baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaar&Baz */
function bar() {}
',
],
'very long class name after ampersand' => [
'<?php
/** @return Bar&Baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaz */
function bar() {}
',
],
];
}
/**
* @dataProvider provideFixPhp74Cases
* @requires PHP 7.4
*/
public function testFixPhp74(string $expected, ?string $input = null): void
{
$this->doTest($expected, $input);
}
public function provideFixPhp74Cases(): array
{
return [
'arrow function' => [
'<?php /** @return int */ fn(): int => 1;',
'<?php /** @return int */ fn() => 1;',
70400,
],
];
}
/**
* @dataProvider provideFixPre80Cases
* @requires PHP <8.0
*/
public function testFixPre80(string $expected, string $input = null): void
{
$this->doTest($expected, $input);
}
public function provideFixPre80Cases(): \Generator
{
yield 'report static as self' => [
'<?php
class Foo {
/** @return static */ function my_foo(): self {}
}
',
'<?php
class Foo {
/** @return static */ function my_foo() {}
}
',
];
yield 'skip mixed special type' => [
'<?php /** @return mixed */ function my_foo() {}',
];
}
/**
* @dataProvider provideFixPhp80Cases
* @requires PHP 8.0
*/
public function testFixPhp80(string $expected, ?string $input = null): void
{
$this->doTest($expected, $input);
}
public function provideFixPhp80Cases(): \Generator
{
yield 'static' => [
'<?php
final class Foo {
/** @return static */
public function something(): static {}
}
',
'<?php
final class Foo {
/** @return static */
public function something() {}
}
',
];
yield 'nullable static' => [
'<?php
final class Foo {
/** @return null|static */
public function something(): ?static {}
}
',
'<?php
final class Foo {
/** @return null|static */
public function something() {}
}
',
];
yield 'mixed' => [
'<?php
final class Foo {
/** @return mixed */
public function something(): mixed {}
}
',
'<?php
final class Foo {
/** @return mixed */
public function something() {}
}
',
];
}
}