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
443
444
445
446
447
448
|
<?php
/**
* Tests the tokenization of the `yield` and `yield from` keywords.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2021 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\Tokenizers\PHP;
use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase;
use PHP_CodeSniffer\Util\Tokens;
/**
* Tests the tokenization of the `yield` and `yield from` keywords.
*
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*/
final class YieldTest extends AbstractTokenizerTestCase
{
/**
* Test that the yield keyword is tokenized as such.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $expectedContent Expected token content.
*
* @dataProvider dataYieldKeyword
*
* @return void
*/
public function testYieldKeyword($testMarker, $expectedContent)
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]);
$tokenArray = $tokens[$target];
$this->assertSame(T_YIELD, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD (code)');
// This assertion would fail on PHP 5.4 with PHPUnit 4 as PHPUnit polyfills the `T_YIELD` token too, but
// with a different value, which causes the token 'type' to be set to `UNKNOWN`.
// This issue _only_ occurs when running the tests, not when running PHPCS outside of a test situation.
// The PHPUnit polyfilled token is declared in the PHP_CodeCoverage_Report_HTML_Renderer_File class
// in vendor/phpunit/php-code-coverage/src/CodeCoverage/Report/HTML/Renderer/File.php.
if (PHP_VERSION_ID >= 50500) {
$this->assertSame('T_YIELD', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD (type)');
}
$this->assertSame($expectedContent, $tokenArray['content'], 'Token content does not match expectation');
}//end testYieldKeyword()
/**
* Data provider.
*
* @see testYieldKeyword()
*
* @return array<string, array<string>>
*/
public static function dataYieldKeyword()
{
return [
'yield' => [
'testMarker' => '/* testYield */',
'expectedContent' => 'yield',
],
'yield followed by comment' => [
'testMarker' => '/* testYieldFollowedByComment */',
'expectedContent' => 'YIELD',
],
'yield at end of file, live coding' => [
'testMarker' => '/* testYieldLiveCoding */',
'expectedContent' => 'yield',
],
];
}//end dataYieldKeyword()
/**
* Test that the yield from keyword is tokenized as a single token when it in on a single line
* and only has whitespace between the words.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $expectedContent Expected token content.
*
* @dataProvider dataYieldFromKeywordSingleToken
*
* @return void
*/
public function testYieldFromKeywordSingleToken($testMarker, $expectedContent)
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]);
$tokenArray = $tokens[$target];
$this->assertSame(T_YIELD_FROM, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD_FROM (code)');
$this->assertSame('T_YIELD_FROM', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD_FROM (type)');
if (isset($tokenArray['orig_content']) === true) {
$this->assertSame($expectedContent, $tokenArray['orig_content'], 'Token (orig) content does not match expectation');
} else {
$this->assertSame($expectedContent, $tokenArray['content'], 'Token content does not match expectation');
}
}//end testYieldFromKeywordSingleToken()
/**
* Data provider.
*
* @see testYieldFromKeywordSingleToken()
*
* @return array<string, array<string>>
*/
public static function dataYieldFromKeywordSingleToken()
{
return [
'yield from' => [
'testMarker' => '/* testYieldFrom */',
'expectedContent' => 'yield from',
],
'yield from with extra space between' => [
'testMarker' => '/* testYieldFromWithExtraSpacesBetween */',
'expectedContent' => 'Yield From',
],
'yield from with tab between' => [
'testMarker' => '/* testYieldFromWithTabBetween */',
'expectedContent' => 'yield from',
],
];
}//end dataYieldFromKeywordSingleToken()
/**
* Test that the yield from keyword is tokenized as a single token when it in on a single line
* and only has whitespace between the words.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array<array<string, string>> $expectedTokens The tokenization expected.
*
* @dataProvider dataYieldFromKeywordMultiToken
*
* @return void
*/
public function testYieldFromKeywordMultiToken($testMarker, $expectedTokens)
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]);
foreach ($expectedTokens as $nr => $tokenInfo) {
$this->assertSame(
constant($tokenInfo['type']),
$tokens[$target]['code'],
'Token tokenized as '.Tokens::tokenName($tokens[$target]['code']).', not '.$tokenInfo['type'].' (code)'
);
$this->assertSame(
$tokenInfo['type'],
$tokens[$target]['type'],
'Token tokenized as '.$tokens[$target]['type'].', not '.$tokenInfo['type'].' (type)'
);
$this->assertSame(
$tokenInfo['content'],
$tokens[$target]['content'],
'Content of token '.($nr + 1).' ('.$tokens[$target]['type'].') does not match expectations'
);
++$target;
}
}//end testYieldFromKeywordMultiToken()
/**
* Data provider.
*
* @see testYieldFromKeywordMultiToken()
*
* @return array<string, array<string, string|array<array<string, string>>>>
*/
public static function dataYieldFromKeywordMultiToken()
{
return [
'yield from with new line' => [
'testMarker' => '/* testYieldFromSplitByNewLines */',
'expectedTokens' => [
[
'type' => 'T_YIELD_FROM',
'content' => 'yield',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_YIELD_FROM',
'content' => 'FROM',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
],
],
'yield from with comment' => [
'testMarker' => '/* testYieldFromSplitByComment */',
'expectedTokens' => [
[
'type' => 'T_YIELD_FROM',
'content' => 'yield',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_COMMENT',
'content' => '/* comment */',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_YIELD_FROM',
'content' => 'from',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
],
],
'yield from with trailing comment' => [
'testMarker' => '/* testYieldFromWithTrailingComment */',
'expectedTokens' => [
[
'type' => 'T_YIELD_FROM',
'content' => 'yield',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_COMMENT',
'content' => '// comment
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_YIELD_FROM',
'content' => 'from',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
],
],
'yield from with trailing annotation' => [
'testMarker' => '/* testYieldFromWithTrailingAnnotation */',
'expectedTokens' => [
[
'type' => 'T_YIELD_FROM',
'content' => 'yield',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_PHPCS_IGNORE',
'content' => '// phpcs:ignore Stnd.Cat.Sniff -- for reasons.
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_YIELD_FROM',
'content' => 'from',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
],
],
'yield from with new line and comment' => [
'testMarker' => '/* testYieldFromSplitByNewLineAndComments */',
'expectedTokens' => [
[
'type' => 'T_YIELD_FROM',
'content' => 'yield',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_COMMENT',
'content' => '/* comment line 1
',
],
[
'type' => 'T_COMMENT',
'content' => ' line 2 */',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_COMMENT',
'content' => '// another comment
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_YIELD_FROM',
'content' => 'from',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
],
],
'yield from with new line and annotation' => [
'testMarker' => '/* testYieldFromSplitByNewLineAndAnnotation */',
'expectedTokens' => [
[
'type' => 'T_YIELD_FROM',
'content' => 'YIELD',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_PHPCS_DISABLE',
'content' => '// @phpcs:disable Stnd.Cat.Sniff -- for reasons.
',
],
[
'type' => 'T_WHITESPACE',
'content' => ' ',
],
[
'type' => 'T_YIELD_FROM',
'content' => 'From',
],
[
'type' => 'T_WHITESPACE',
'content' => '
',
],
],
],
];
}//end dataYieldFromKeywordMultiToken()
/**
* Test that 'yield' or 'from' when not used as the reserved keyword are tokenized as `T_STRING`.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
*
* @dataProvider dataYieldNonKeyword
*
* @return void
*/
public function testYieldNonKeyword($testMarker)
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]);
$tokenArray = $tokens[$target];
$this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)');
$this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)');
}//end testYieldNonKeyword()
/**
* Data provider.
*
* @see testYieldNonKeyword()
*
* @return array<string, array<string>>
*/
public static function dataYieldNonKeyword()
{
return [
'yield used as class name' => ['/* testYieldUsedAsClassName */'],
'yield used as class constant name' => ['/* testYieldUsedAsClassConstantName */'],
'yield used as method name' => ['/* testYieldUsedAsMethodName */'],
'yield used as property access 1' => ['/* testYieldUsedAsPropertyName1 */'],
'yield used as property access 2' => ['/* testYieldUsedAsPropertyName2 */'],
'yield used as class constant access' => ['/* testYieldUsedForClassConstantAccess1 */'],
'from used as class constant access' => ['/* testFromUsedForClassConstantAccess1 */'],
'yield used as method name with ref' => ['/* testYieldUsedAsMethodNameReturnByRef */'],
];
}//end dataYieldNonKeyword()
}//end class
|
