-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
PhpdocToParamTypeFixerTest.php
439 lines (431 loc) · 18.2 KB
/
PhpdocToParamTypeFixerTest.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
<?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 Jan Gantzert <jan@familie-gantzert.de>
*
* @internal
*
* @covers \PhpCsFixer\Fixer\FunctionNotation\PhpdocToParamTypeFixer
*/
final class PhpdocToParamTypeFixerTest extends AbstractFixerTestCase
{
/**
* @dataProvider provideFixCases
*/
public function testFix(string $expected, ?string $input = null, ?int $versionSpecificFix = null, array $config = null): void
{
if (
null !== $input
&& (null !== $versionSpecificFix && \PHP_VERSION_ID < $versionSpecificFix)
) {
$expected = $input;
$input = null;
}
if (null !== $config) {
$this->fixer->configure($config);
}
$this->doTest($expected, $input);
}
public function provideFixCases(): array
{
return [
'typehint already defined' => [
'<?php /** @param int $foo */ function foo(int $foo) {}',
],
'typehint already defined with wrong phpdoc typehint' => [
'<?php /** @param string $foo */ function foo(int $foo) {}',
],
'no phpdoc param' => [
'<?php function my_foo() {}',
],
'invalid - phpdoc param without variable' => [
'<?php /** @param */ function my_foo($bar) {}',
],
'invalid - phpdoc param with non existing class' => [
'<?php /** @param \9 */ function my_foo($bar) {}',
],
'invalid - phpdoc param with false class hint' => [
'<?php /** @param $foo \\Foo\\\\Bar */ function my_foo($foo) {}',
],
'invalid - phpdoc param with false param order' => [
'<?php /** @param $foo string */ function my_foo($foo) {}',
],
'invalid - phpdoc param with hint for next method' => [
'<?php
/**
* @param string $bar
*/
function my_foo() {}
function my_foo2($bar) {}
',
],
'invalid - phpdoc param with keyword' => [
'<?php
/** @param Break $foo */ function foo_break($foo) {}
/** @param __CLASS__ $foo */ function foo_class($foo) {}
/** @param I\Want\To\Break\\\\Free $foo */ function foo_queen($foo) {}
',
],
'non-root class with single int param' => [
'<?php /** @param int $bar */ function my_foo(int $bar) {}',
'<?php /** @param int $bar */ function my_foo($bar) {}',
],
'non-root class with single float param' => [
'<?php /** @param float $bar */ function my_foo(float $bar) {}',
'<?php /** @param float $bar */ function my_foo($bar) {}',
],
'non-root class with multiple string params' => [
'<?php
/**
* @param string $bar
* @param string $baz
*/
function my_foo(string $bar, string $baz) {}',
'<?php
/**
* @param string $bar
* @param string $baz
*/
function my_foo($bar, $baz) {}',
],
'non-root class with not sorted multiple string params' => [
'<?php
/**
* @param int $foo
* @param string $bar
*/
function my_foo(string $bar, int $foo) {}',
'<?php
/**
* @param int $foo
* @param string $bar
*/
function my_foo($bar, $foo) {}',
],
'non-root class with not sorted multiple params and different types' => [
'<?php
/**
* @param int $foo
* @param string $bar
* @param Baz $hey
* @param float $tab
* @param bool $baz
*/
function my_foo(string $bar, int $foo, bool $baz, float $tab, Baz $hey) {}',
'<?php
/**
* @param int $foo
* @param string $bar
* @param Baz $hey
* @param float $tab
* @param bool $baz
*/
function my_foo($bar, $foo, $baz, $tab, $hey) {}',
],
'non-root class with massive string params' => [
'<?php
/**
* @param string $bar
* @param string $baz
* @param string $tab
* @param string $foo
*/
function my_foo(string $bar, string $baz, string $tab, string $foo) {}',
'<?php
/**
* @param string $bar
* @param string $baz
* @param string $tab
* @param string $foo
*/
function my_foo($bar, $baz, $tab, $foo) {}',
],
'non-root class with different types of params' => [
'<?php
/**
* @param string $bar
* @param int $baz
* @param float $tab
*/
function my_foo(string $bar, int $baz, float $tab) {}',
'<?php
/**
* @param string $bar
* @param int $baz
* @param float $tab
*/
function my_foo($bar, $baz, $tab) {}',
],
'non-root class with mixed type of param' => [
'<?php
/**
* @param mixed $bar
*/
function my_foo($bar) {}',
],
'non-root namespaced class' => [
'<?php /** @param My\Bar $foo */ function my_foo(My\Bar $foo) {}',
'<?php /** @param My\Bar $foo */ function my_foo($foo) {}',
],
'root class' => [
'<?php /** @param \My\Bar $foo */ function my_foo(\My\Bar $foo) {}',
'<?php /** @param \My\Bar $foo */ function my_foo($foo) {}',
],
'interface' => [
'<?php interface Foo { /** @param Bar $bar */ function my_foo(Bar $bar); }',
'<?php interface Foo { /** @param Bar $bar */ function my_foo($bar); }',
],
'iterable return on ^7.1' => [
'<?php /** @param iterable $counter */ function my_foo(iterable $counter) {}',
'<?php /** @param iterable $counter */ function my_foo($counter) {}',
],
'array native type' => [
'<?php /** @param array $foo */ function my_foo(array $foo) {}',
'<?php /** @param array $foo */ function my_foo($foo) {}',
],
'callable type' => [
'<?php /** @param callable $foo */ function my_foo(callable $foo) {}',
'<?php /** @param callable $foo */ function my_foo($foo) {}',
],
'self accessor' => [
'<?php
class Foo {
/** @param self $foo */ function my_foo(self $foo) {}
}
',
'<?php
class Foo {
/** @param self $foo */ function my_foo($foo) {}
}
',
],
'report static as self' => [
'<?php
class Foo {
/** @param static $foo */ function my_foo(self $foo) {}
}
',
'<?php
class Foo {
/** @param static $foo */ function my_foo($foo) {}
}
',
],
'skip resource special type' => [
'<?php /** @param $bar resource */ function my_foo($bar) {}',
],
'skip mixed special type' => [
'<?php /** @param $bar mixed */ function my_foo($bar) {}',
],
'null alone cannot be a param type' => [
'<?php /** @param $bar null */ function my_foo($bar) {}',
],
'skip mixed types' => [
'<?php /** @param Foo|Bar $bar */ function my_foo($bar) {}',
],
'skip mixed types including array' => [
'<?php /** @param array|Foo $expected */ function testResolveIntersectionOfPaths($expected) {}',
],
'skip primitive or array types' => [
'<?php /** @param string|string[] $expected */ function testResolveIntersectionOfPaths($expected) {}',
],
'array of types' => [
'<?php /** @param Foo[] $foo */ function my_foo(array $foo) {}',
'<?php /** @param Foo[] $foo */ function my_foo($foo) {}',
],
'nullable array of types' => [
'<?php /** @param null|Foo[] $foo */ function my_foo(?array $foo) {}',
'<?php /** @param null|Foo[] $foo */ function my_foo($foo) {}',
],
'nullable and mixed types of arrays' => [
'<?php /** @param null|Foo[]|Bar[] $foo */ function my_foo(?array $foo) {}',
'<?php /** @param null|Foo[]|Bar[] $foo */ function my_foo($foo) {}',
],
'nullable and array and array of types' => [
'<?php /** @param null|Foo[]|array $foo */ function my_foo(?array $foo) {}',
'<?php /** @param null|Foo[]|array $foo */ function my_foo($foo) {}',
],
'nullable array of array of types' => [
'<?php /** @param null|Foo[][] $foo */ function my_foo(?array $foo) {}',
'<?php /** @param null|Foo[][] $foo */ function my_foo($foo) {}',
],
'nullable and string param' => [
'<?php /** @param null|string $foo */ function my_foo(?string $foo) {}',
'<?php /** @param null|string $foo */ function my_foo($foo) {}',
],
'nullable and int param' => [
'<?php /** @param null|int $foo */ function my_foo(?int $foo) {}',
'<?php /** @param null|int $foo */ function my_foo($foo) {}',
],
'nullable and float param' => [
'<?php /** @param null|float $foo */ function my_foo(?float $foo) {}',
'<?php /** @param null|float $foo */ function my_foo($foo) {}',
],
'nullable and bool param' => [
'<?php /** @param null|bool $foo */ function my_foo(?bool $foo) {}',
'<?php /** @param null|bool $foo */ function my_foo($foo) {}',
],
'nullable and callable param' => [
'<?php /** @param null|callable $foo */ function my_foo(?callable $foo) {}',
'<?php /** @param null|callable $foo */ function my_foo($foo) {}',
],
'nullable and iterable param' => [
'<?php /** @param null|iterable $foo */ function my_foo(?iterable $foo) {}',
'<?php /** @param null|iterable $foo */ function my_foo($foo) {}',
],
'nullable and class name param' => [
'<?php /** @param null|Foo $foo */ function my_foo(?Foo $foo) {}',
'<?php /** @param null|Foo $foo */ function my_foo($foo) {}',
],
'array and iterable param' => [
'<?php /** @param Foo[]|iterable $foo */ function my_foo(iterable $foo) {}',
'<?php /** @param Foo[]|iterable $foo */ function my_foo($foo) {}',
],
'object param' => [
'<?php /** @param object $foo */ function my_foo(object $foo) {}',
'<?php /** @param object $foo */ function my_foo($foo) {}',
70200,
],
'nullable and object param' => [
'<?php /** @param null|object $foo */ function my_foo(?object $foo) {}',
'<?php /** @param null|object $foo */ function my_foo($foo) {}',
70200,
],
'generics with single type' => [
'<?php /** @param array<foo> $foo */ function my_foo(array $foo) {}',
'<?php /** @param array<foo> $foo */ function my_foo($foo) {}',
],
'generics with multiple types' => [
'<?php /** @param array<int, string> $foo */ function my_foo(array $foo) {}',
'<?php /** @param array<int, string> $foo */ function my_foo($foo) {}',
],
'stop searching last token' => [
'<?php class Foo { /** @param Bar $bar */ public function foo($tab) { } }',
],
'param by reference' => [
'<?php /** @param array $data */ function foo(array &$data) {}',
'<?php /** @param array $data */ function foo(&$data) {}',
],
'optional param by reference' => [
'<?php /** @param null|string[] $matches */ function matchAll(?array &$matches) {}',
'<?php /** @param null|string[] $matches */ function matchAll(&$matches) {}',
],
'void as type in phpdoc' => [
'<?php /** @param void $bar */ function foo($bar) {}',
],
'array and traversable' => [
'<?php /** @param array|Traversable $foo */ function my_foo(iterable $foo) {}',
'<?php /** @param array|Traversable $foo */ function my_foo($foo) {}',
],
'array and traversable with leading slash' => [
'<?php /** @param array|\Traversable $foo */ function my_foo(iterable $foo) {}',
'<?php /** @param array|\Traversable $foo */ function my_foo($foo) {}',
],
'array and traversable in a namespace' => [
'<?php
namespace App;
/** @param array|Traversable $foo */
function my_foo($foo) {}
',
],
'array and traversable with leading slash in a namespace' => [
'<?php
namespace App;
/** @param array|\Traversable $foo */
function my_foo(iterable $foo) {}
',
'<?php
namespace App;
/** @param array|\Traversable $foo */
function my_foo($foo) {}
',
],
'array and imported traversable in a namespace' => [
'<?php
namespace App;
use Traversable;
/** @param array|Traversable $foo */
function my_foo(iterable $foo) {}
',
'<?php
namespace App;
use Traversable;
/** @param array|Traversable $foo */
function my_foo($foo) {}
',
],
'array and object aliased as traversable in a namespace' => [
'<?php
namespace App;
use Foo as Traversable;
/** @param array|Traversable $foo */
function my_foo($foo) {}
',
],
'array of object and traversable' => [
'<?php /** @param Foo[]|Traversable $foo */ function my_foo(iterable $foo) {}',
'<?php /** @param Foo[]|Traversable $foo */ function my_foo($foo) {}',
70100,
],
'array of object and iterable' => [
'<?php /** @param Foo[]|iterable $foo */ function my_foo(iterable $foo) {}',
'<?php /** @param Foo[]|iterable $foo */ function my_foo($foo) {}',
],
'array of string and array of int' => [
'<?php /** @param string[]|int[] $foo */ function my_foo(array $foo) {}',
'<?php /** @param string[]|int[] $foo */ function my_foo($foo) {}',
],
'do not fix scalar types when configured as such' => [
'<?php /** @param int $foo */ function my_foo($foo) {}',
null,
null,
['scalar_types' => false],
],
'do not fix function call' => [
'<?php
/** @param string $foo */
function bar($notFoo) {
return baz($foo);
}
',
],
'do not fix function call when no parameter' => [
'<?php
/** @param string $foo */
function bar() {
return baz($foo);
}
',
],
'intersection types' => [
'<?php
/** @param Bar&Baz $x */
function bar($x) {}
',
],
'very long class name before ampersand' => [
'<?php
/** @param Baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaar&Baz $x */
function bar($x) {}
',
],
'very long class name after ampersand' => [
'<?php
/** @param Bar&Baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaz $x */
function bar($x) {}
',
],
];
}
}