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
|
<?php
/**
* Tests for the \PHP_CodeSniffer\Files\File::isReference method.
*
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\File;
use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTestCase;
/**
* Tests for the \PHP_CodeSniffer\Files\File::isReference method.
*
* @covers \PHP_CodeSniffer\Files\File::isReference
*/
final class IsReferenceTest extends AbstractMethodUnitTestCase
{
/**
* Test that false is returned when a non-"bitwise and" token is passed.
*
* @param string $testMarker Comment which precedes the test case.
* @param array<int|string> $targetTokens Type of tokens to look for.
*
* @dataProvider dataNotBitwiseAndToken
*
* @return void
*/
public function testNotBitwiseAndToken($testMarker, $targetTokens)
{
$targetTokens[] = T_BITWISE_AND;
$target = $this->getTargetToken($testMarker, $targetTokens);
$this->assertFalse(self::$phpcsFile->isReference($target));
}//end testNotBitwiseAndToken()
/**
* Data provider.
*
* @see testNotBitwiseAndToken()
*
* @return array<string, array<string, string|array<int|string>>>
*/
public static function dataNotBitwiseAndToken()
{
return [
'Not ampersand token at all' => [
'testMarker' => '/* testBitwiseAndA */',
'targetTokens' => [T_STRING],
],
'ampersand in intersection type' => [
'testMarker' => '/* testIntersectionIsNotReference */',
'targetTokens' => [T_TYPE_INTERSECTION],
],
'ampersand in DNF type' => [
'testMarker' => '/* testDNFTypeIsNotReference */',
'targetTokens' => [T_TYPE_INTERSECTION],
],
];
}//end dataNotBitwiseAndToken()
/**
* Test correctly identifying whether a "bitwise and" token is a reference or not.
*
* @param string $testMarker Comment which precedes the test case.
* @param bool $expected Expected function output.
*
* @dataProvider dataIsReference
*
* @return void
*/
public function testIsReference($testMarker, $expected)
{
$bitwiseAnd = $this->getTargetToken($testMarker, T_BITWISE_AND);
$result = self::$phpcsFile->isReference($bitwiseAnd);
$this->assertSame($expected, $result);
}//end testIsReference()
/**
* Data provider for the IsReference test.
*
* @see testIsReference()
*
* @return array<string, array<string, string|bool>>
*/
public static function dataIsReference()
{
return [
'issue-1971-list-first-in-file' => [
'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271A */',
'expected' => true,
],
'issue-1971-list-first-in-file-nested' => [
'testMarker' => '/* testTokenizerIssue1971PHPCSlt330gt271B */',
'expected' => true,
],
'bitwise and: param in function call' => [
'testMarker' => '/* testBitwiseAndA */',
'expected' => false,
],
'bitwise and: in unkeyed short array, first value' => [
'testMarker' => '/* testBitwiseAndB */',
'expected' => false,
],
'bitwise and: in unkeyed short array, last value' => [
'testMarker' => '/* testBitwiseAndC */',
'expected' => false,
],
'bitwise and: in unkeyed long array, last value' => [
'testMarker' => '/* testBitwiseAndD */',
'expected' => false,
],
'bitwise and: in keyed short array, last value' => [
'testMarker' => '/* testBitwiseAndE */',
'expected' => false,
],
'bitwise and: in keyed long array, last value' => [
'testMarker' => '/* testBitwiseAndF */',
'expected' => false,
],
'bitwise and: in assignment' => [
'testMarker' => '/* testBitwiseAndG */',
'expected' => false,
],
'bitwise and: in param default value in function declaration' => [
'testMarker' => '/* testBitwiseAndH */',
'expected' => false,
],
'bitwise and: in param default value in closure declaration' => [
'testMarker' => '/* testBitwiseAndI */',
'expected' => false,
],
'reference: function declared to return by reference' => [
'testMarker' => '/* testFunctionReturnByReference */',
'expected' => true,
],
'reference: only param in function declaration, pass by reference' => [
'testMarker' => '/* testFunctionPassByReferenceA */',
'expected' => true,
],
'reference: last param in function declaration, pass by reference' => [
'testMarker' => '/* testFunctionPassByReferenceB */',
'expected' => true,
],
'reference: only param in closure declaration, pass by reference' => [
'testMarker' => '/* testFunctionPassByReferenceC */',
'expected' => true,
],
'reference: last param in closure declaration, pass by reference' => [
'testMarker' => '/* testFunctionPassByReferenceD */',
'expected' => true,
],
'reference: typed param in function declaration, pass by reference' => [
'testMarker' => '/* testFunctionPassByReferenceE */',
'expected' => true,
],
'reference: typed param in closure declaration, pass by reference' => [
'testMarker' => '/* testFunctionPassByReferenceF */',
'expected' => true,
],
'reference: variadic param in function declaration, pass by reference' => [
'testMarker' => '/* testFunctionPassByReferenceG */',
'expected' => true,
],
'reference: foreach value' => [
'testMarker' => '/* testForeachValueByReference */',
'expected' => true,
],
'reference: foreach key' => [
'testMarker' => '/* testForeachKeyByReference */',
'expected' => true,
],
'reference: keyed short array, first value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceA */',
'expected' => true,
],
'reference: keyed short array, last value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceB */',
'expected' => true,
],
'reference: unkeyed short array, only value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceC */',
'expected' => true,
],
'reference: unkeyed short array, last value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceD */',
'expected' => true,
],
'reference: keyed long array, first value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceE */',
'expected' => true,
],
'reference: keyed long array, last value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceF */',
'expected' => true,
],
'reference: unkeyed long array, only value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceG */',
'expected' => true,
],
'reference: unkeyed long array, last value, value by reference' => [
'testMarker' => '/* testArrayValueByReferenceH */',
'expected' => true,
],
'reference: variable, assign by reference' => [
'testMarker' => '/* testAssignByReferenceA */',
'expected' => true,
],
'reference: variable, assign by reference, spacing variation' => [
'testMarker' => '/* testAssignByReferenceB */',
'expected' => true,
],
'reference: variable, assign by reference, concat assign' => [
'testMarker' => '/* testAssignByReferenceC */',
'expected' => true,
],
'reference: property, assign by reference' => [
'testMarker' => '/* testAssignByReferenceD */',
'expected' => true,
],
'reference: function return value, assign by reference' => [
'testMarker' => '/* testAssignByReferenceE */',
'expected' => true,
],
'reference: function return value, assign by reference, null coalesce assign' => [
'testMarker' => '/* testAssignByReferenceF */',
'expected' => true,
],
'reference: unkeyed short list, first var, assign by reference' => [
'testMarker' => '/* testShortListAssignByReferenceNoKeyA */',
'expected' => true,
],
'reference: unkeyed short list, second var, assign by reference' => [
'testMarker' => '/* testShortListAssignByReferenceNoKeyB */',
'expected' => true,
],
'reference: unkeyed short list, nested var, assign by reference' => [
'testMarker' => '/* testNestedShortListAssignByReferenceNoKey */',
'expected' => true,
],
'reference: unkeyed long list, second var, assign by reference' => [
'testMarker' => '/* testLongListAssignByReferenceNoKeyA */',
'expected' => true,
],
'reference: unkeyed long list, first nested var, assign by reference' => [
'testMarker' => '/* testLongListAssignByReferenceNoKeyB */',
'expected' => true,
],
'reference: unkeyed long list, last nested var, assign by reference' => [
'testMarker' => '/* testLongListAssignByReferenceNoKeyC */',
'expected' => true,
],
'reference: keyed short list, first nested var, assign by reference' => [
'testMarker' => '/* testNestedShortListAssignByReferenceWithKeyA */',
'expected' => true,
],
'reference: keyed short list, last nested var, assign by reference' => [
'testMarker' => '/* testNestedShortListAssignByReferenceWithKeyB */',
'expected' => true,
],
'reference: keyed long list, only var, assign by reference' => [
'testMarker' => '/* testLongListAssignByReferenceWithKeyA */',
'expected' => true,
],
'reference: first param in function call, pass by reference' => [
'testMarker' => '/* testPassByReferenceA */',
'expected' => true,
],
'reference: last param in function call, pass by reference' => [
'testMarker' => '/* testPassByReferenceB */',
'expected' => true,
],
'reference: property in function call, pass by reference' => [
'testMarker' => '/* testPassByReferenceC */',
'expected' => true,
],
'reference: hierarchical self property in function call, pass by reference' => [
'testMarker' => '/* testPassByReferenceD */',
'expected' => true,
],
'reference: hierarchical parent property in function call, pass by reference' => [
'testMarker' => '/* testPassByReferenceE */',
'expected' => true,
],
'reference: hierarchical static property in function call, pass by reference' => [
'testMarker' => '/* testPassByReferenceF */',
'expected' => true,
],
'reference: static property in function call, pass by reference' => [
'testMarker' => '/* testPassByReferenceG */',
'expected' => true,
],
'reference: static property in function call, first with FQN, pass by reference' => [
'testMarker' => '/* testPassByReferenceH */',
'expected' => true,
],
'reference: static property in function call, last with FQN, pass by reference' => [
'testMarker' => '/* testPassByReferenceI */',
'expected' => true,
],
'reference: static property in function call, last with namespace relative name, pass by reference' => [
'testMarker' => '/* testPassByReferenceJ */',
'expected' => true,
],
'reference: static property in function call, last with PQN, pass by reference' => [
'testMarker' => '/* testPassByReferencePartiallyQualifiedName */',
'expected' => true,
],
'reference: new by reference' => [
'testMarker' => '/* testNewByReferenceA */',
'expected' => true,
],
'reference: new by reference as function call param' => [
'testMarker' => '/* testNewByReferenceB */',
'expected' => true,
],
'reference: closure use by reference' => [
'testMarker' => '/* testUseByReference */',
'expected' => true,
],
'reference: closure use by reference, first param, with comment' => [
'testMarker' => '/* testUseByReferenceWithCommentFirstParam */',
'expected' => true,
],
'reference: closure use by reference, last param, with comment' => [
'testMarker' => '/* testUseByReferenceWithCommentSecondParam */',
'expected' => true,
],
'reference: arrow fn declared to return by reference' => [
'testMarker' => '/* testArrowFunctionReturnByReference */',
'expected' => true,
],
'bitwise and: first param default value in closure declaration' => [
'testMarker' => '/* testBitwiseAndExactParameterA */',
'expected' => false,
],
'reference: param in closure declaration, pass by reference' => [
'testMarker' => '/* testPassByReferenceExactParameterB */',
'expected' => true,
],
'reference: variadic param in closure declaration, pass by reference' => [
'testMarker' => '/* testPassByReferenceExactParameterC */',
'expected' => true,
],
'bitwise and: last param default value in closure declaration' => [
'testMarker' => '/* testBitwiseAndExactParameterD */',
'expected' => false,
],
'reference: typed param in arrow fn declaration, pass by reference' => [
'testMarker' => '/* testArrowFunctionPassByReferenceA */',
'expected' => true,
],
'reference: variadic param in arrow fn declaration, pass by reference' => [
'testMarker' => '/* testArrowFunctionPassByReferenceB */',
'expected' => true,
],
'reference: closure declared to return by reference' => [
'testMarker' => '/* testClosureReturnByReference */',
'expected' => true,
],
'bitwise and: param default value in arrow fn declaration' => [
'testMarker' => '/* testBitwiseAndArrowFunctionInDefault */',
'expected' => false,
],
'reference: param pass by ref in arrow function' => [
'testMarker' => '/* testParamPassByReference */',
'expected' => true,
],
'issue-1284-short-list-directly-after-close-curly-control-structure' => [
'testMarker' => '/* testTokenizerIssue1284PHPCSlt280A */',
'expected' => true,
],
'issue-1284-short-list-directly-after-close-curly-control-structure-second-item' => [
'testMarker' => '/* testTokenizerIssue1284PHPCSlt280B */',
'expected' => true,
],
'issue-1284-short-array-directly-after-close-curly-control-structure' => [
'testMarker' => '/* testTokenizerIssue1284PHPCSlt280C */',
'expected' => true,
],
];
}//end dataIsReference()
}//end class
|
