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
|
<?php
/**
* Tests the retokenization of the `default` keyword to T_MATCH_DEFAULT for PHP 8.0 match structures
* and makes sure that the tokenization of switch `T_DEFAULT` structures is not aversely affected.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2020-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;
final class DefaultKeywordTest extends AbstractTokenizerTestCase
{
/**
* Test the retokenization of the `default` keyword for match structure to `T_MATCH_DEFAULT`.
*
* Note: Cases and default structures within a match structure do *NOT* get case/default scope
* conditions, in contrast to case and default structures in switch control structures.
*
* @param string $testMarker The comment prefacing the target token.
* @param string $testContent The token content to look for.
*
* @dataProvider dataMatchDefault
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*
* @return void
*/
public function testMatchDefault($testMarker, $testContent='default')
{
$tokens = $this->phpcsFile->getTokens();
$token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent);
$tokenArray = $tokens[$token];
$this->assertSame(T_MATCH_DEFAULT, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH_DEFAULT (code)');
$this->assertSame('T_MATCH_DEFAULT', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH_DEFAULT (type)');
}//end testMatchDefault()
/**
* Data provider.
*
* @see testMatchDefault()
*
* @return array<string, array<string, string>>
*/
public static function dataMatchDefault()
{
return [
'simple_match_default' => [
'testMarker' => '/* testSimpleMatchDefault */',
],
'match_default_in_switch_case_1' => [
'testMarker' => '/* testMatchDefaultNestedInSwitchCase1 */',
],
'match_default_in_switch_case_2' => [
'testMarker' => '/* testMatchDefaultNestedInSwitchCase2 */',
],
'match_default_in_switch_default' => [
'testMarker' => '/* testMatchDefaultNestedInSwitchDefault */',
],
'match_default_containing_switch' => [
'testMarker' => '/* testMatchDefault */',
],
'match_default_with_nested_long_array_and_default_key' => [
'testMarker' => '/* testMatchDefaultWithNestedLongArrayWithClassConstantKey */',
'testContent' => 'DEFAULT',
],
'match_default_with_nested_long_array_and_default_key_2' => [
'testMarker' => '/* testMatchDefaultWithNestedLongArrayWithClassConstantKeyLevelDown */',
'testContent' => 'DEFAULT',
],
'match_default_with_nested_short_array_and_default_key' => [
'testMarker' => '/* testMatchDefaultWithNestedShortArrayWithClassConstantKey */',
'testContent' => 'DEFAULT',
],
'match_default_with_nested_short_array_and_default_key_2' => [
'testMarker' => '/* testMatchDefaultWithNestedShortArrayWithClassConstantKeyLevelDown */',
'testContent' => 'DEFAULT',
],
'match_default_in_long_array' => [
'testMarker' => '/* testMatchDefaultNestedInLongArray */',
'testContent' => 'DEFAULT',
],
'match_default_in_short_array' => [
'testMarker' => '/* testMatchDefaultNestedInShortArray */',
'testContent' => 'DEFAULT',
],
];
}//end dataMatchDefault()
/**
* Verify that the retokenization of `T_DEFAULT` tokens in match constructs, doesn't negatively
* impact the tokenization of `T_DEFAULT` tokens in switch control structures.
*
* @param string $testMarker The comment prefacing the target token.
* @param string $testContent The token content to look for.
*
* @dataProvider dataSwitchDefault
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*
* @return void
*/
public function testSwitchDefault($testMarker, $testContent='default')
{
$tokens = $this->phpcsFile->getTokens();
$token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent);
$tokenArray = $tokens[$token];
$this->assertSame(T_DEFAULT, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_DEFAULT (code)');
$this->assertSame('T_DEFAULT', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_DEFAULT (type)');
}//end testSwitchDefault()
/**
* Data provider.
*
* @see testSwitchDefault()
*
* @return array<string, array<string, string|int>>
*/
public static function dataSwitchDefault()
{
return [
'simple_switch_default' => [
'testMarker' => '/* testSimpleSwitchDefault */',
],
'simple_switch_default_with_curlies' => [
'testMarker' => '/* testSimpleSwitchDefaultWithCurlies */',
],
'switch_default_toplevel' => [
'testMarker' => '/* testSwitchDefault */',
],
'switch_default_nested_in_match_case' => [
'testMarker' => '/* testSwitchDefaultNestedInMatchCase */',
],
'switch_default_nested_in_match_default' => [
'testMarker' => '/* testSwitchDefaultNestedInMatchDefault */',
],
];
}//end dataSwitchDefault()
/**
* Verify that the retokenization of `T_DEFAULT` tokens in match constructs, doesn't negatively
* impact the tokenization of `T_STRING` tokens with the contents 'default' which aren't in
* actual fact the default keyword.
*
* @param string $testMarker The comment prefacing the target token.
* @param string $testContent The token content to look for.
*
* @dataProvider dataNotDefaultKeyword
* @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional
*
* @return void
*/
public function testNotDefaultKeyword($testMarker, $testContent='DEFAULT')
{
$tokens = $this->phpcsFile->getTokens();
$token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent);
$tokenArray = $tokens[$token];
$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 testNotDefaultKeyword()
/**
* Data provider.
*
* @see testNotDefaultKeyword()
*
* @return array<string, array<string, string>>
*/
public static function dataNotDefaultKeyword()
{
return [
'class-constant-as-short-array-key' => [
'testMarker' => '/* testClassConstantAsShortArrayKey */',
],
'class-property-as-short-array-key' => [
'testMarker' => '/* testClassPropertyAsShortArrayKey */',
],
'namespaced-constant-as-short-array-key' => [
'testMarker' => '/* testNamespacedConstantAsShortArrayKey */',
],
'fqn-global-constant-as-short-array-key' => [
'testMarker' => '/* testFQNGlobalConstantAsShortArrayKey */',
],
'class-constant-as-long-array-key' => [
'testMarker' => '/* testClassConstantAsLongArrayKey */',
],
'class-constant-as-yield-key' => [
'testMarker' => '/* testClassConstantAsYieldKey */',
],
'class-constant-as-long-array-key-nested-in-match' => [
'testMarker' => '/* testClassConstantAsLongArrayKeyNestedInMatch */',
],
'class-constant-as-long-array-key-nested-in-match-2' => [
'testMarker' => '/* testClassConstantAsLongArrayKeyNestedInMatchLevelDown */',
],
'class-constant-as-short-array-key-nested-in-match' => [
'testMarker' => '/* testClassConstantAsShortArrayKeyNestedInMatch */',
],
'class-constant-as-short-array-key-nested-in-match-2' => [
'testMarker' => '/* testClassConstantAsShortArrayKeyNestedInMatchLevelDown */',
],
'class-constant-as-long-array-key-with-nested-match' => [
'testMarker' => '/* testClassConstantAsLongArrayKeyWithNestedMatch */',
],
'class-constant-as-short-array-key-with-nested-match' => [
'testMarker' => '/* testClassConstantAsShortArrayKeyWithNestedMatch */',
],
'class-constant-in-switch-case' => [
'testMarker' => '/* testClassConstantInSwitchCase */',
],
'class-property-in-switch-case' => [
'testMarker' => '/* testClassPropertyInSwitchCase */',
],
'namespaced-constant-in-switch-case' => [
'testMarker' => '/* testNamespacedConstantInSwitchCase */',
],
'namespace-relative-constant-in-switch-case' => [
'testMarker' => '/* testNamespaceRelativeConstantInSwitchCase */',
],
'class-constant-declaration' => [
'testMarker' => '/* testClassConstant */',
],
'class-method-declaration' => [
'testMarker' => '/* testMethodDeclaration */',
'testContent' => 'default',
],
];
}//end dataNotDefaultKeyword()
}//end class
|
