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
|
<?php
/**
* Tests the support of PHP 8.1 "enum" keyword.
*
* @author Jaroslav Hanslík <kukulich@kukulich.cz>
* @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;
final class BackfillEnumTest extends AbstractTokenizerTestCase
{
/**
* Test that the "enum" keyword is tokenized as such.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $testContent The token content to look for.
* @param int $openerOffset Offset to find expected scope opener.
* @param int $closerOffset Offset to find expected scope closer.
*
* @dataProvider dataEnums
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*
* @return void
*/
public function testEnums($testMarker, $testContent, $openerOffset, $closerOffset)
{
$tokens = $this->phpcsFile->getTokens();
$enum = $this->getTargetToken($testMarker, [T_ENUM, T_STRING], $testContent);
$tokenArray = $tokens[$enum];
$this->assertSame(T_ENUM, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM (code)');
$this->assertSame('T_ENUM', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM (type)');
$this->assertArrayHasKey('scope_condition', $tokenArray);
$this->assertArrayHasKey('scope_opener', $tokenArray);
$this->assertArrayHasKey('scope_closer', $tokenArray);
$this->assertSame($enum, $tokenArray['scope_condition']);
$scopeOpener = $tokenArray['scope_opener'];
$scopeCloser = $tokenArray['scope_closer'];
$expectedScopeOpener = ($enum + $openerOffset);
$expectedScopeCloser = ($enum + $closerOffset);
$this->assertSame($expectedScopeOpener, $scopeOpener);
$this->assertArrayHasKey('scope_condition', $tokens[$scopeOpener]);
$this->assertArrayHasKey('scope_opener', $tokens[$scopeOpener]);
$this->assertArrayHasKey('scope_closer', $tokens[$scopeOpener]);
$this->assertSame($enum, $tokens[$scopeOpener]['scope_condition']);
$this->assertSame($scopeOpener, $tokens[$scopeOpener]['scope_opener']);
$this->assertSame($scopeCloser, $tokens[$scopeOpener]['scope_closer']);
$this->assertSame($expectedScopeCloser, $scopeCloser);
$this->assertArrayHasKey('scope_condition', $tokens[$scopeCloser]);
$this->assertArrayHasKey('scope_opener', $tokens[$scopeCloser]);
$this->assertArrayHasKey('scope_closer', $tokens[$scopeCloser]);
$this->assertSame($enum, $tokens[$scopeCloser]['scope_condition']);
$this->assertSame($scopeOpener, $tokens[$scopeCloser]['scope_opener']);
$this->assertSame($scopeCloser, $tokens[$scopeCloser]['scope_closer']);
}//end testEnums()
/**
* Data provider.
*
* @see testEnums()
*
* @return array<string, array<string, string|int>>
*/
public static function dataEnums()
{
return [
'enum - pure' => [
'testMarker' => '/* testPureEnum */',
'testContent' => 'enum',
'openerOffset' => 4,
'closerOffset' => 12,
],
'enum - backed int' => [
'testMarker' => '/* testBackedIntEnum */',
'testContent' => 'enum',
'openerOffset' => 7,
'closerOffset' => 29,
],
'enum - backed string' => [
'testMarker' => '/* testBackedStringEnum */',
'testContent' => 'enum',
'openerOffset' => 8,
'closerOffset' => 30,
],
'enum - backed int + implements' => [
'testMarker' => '/* testComplexEnum */',
'testContent' => 'enum',
'openerOffset' => 11,
'closerOffset' => 72,
],
'enum keyword when "enum" is the name for the construct (yes, this is allowed)' => [
'testMarker' => '/* testEnumWithEnumAsClassName */',
'testContent' => 'enum',
'openerOffset' => 6,
'closerOffset' => 7,
],
'enum - keyword is case insensitive' => [
'testMarker' => '/* testEnumIsCaseInsensitive */',
'testContent' => 'EnUm',
'openerOffset' => 4,
'closerOffset' => 5,
],
'enum - declaration containing comment' => [
'testMarker' => '/* testDeclarationContainingComment */',
'testContent' => 'enum',
'openerOffset' => 6,
'closerOffset' => 14,
],
];
}//end dataEnums()
/**
* Test that "enum" when not used as the keyword is still tokenized as `T_STRING`.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $testContent The token content to look for.
*
* @dataProvider dataNotEnums
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*
* @return void
*/
public function testNotEnums($testMarker, $testContent)
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, [T_ENUM, T_STRING], $testContent);
$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 testNotEnums()
/**
* Data provider.
*
* @see testNotEnums()
*
* @return array<string, array<string, string>>
*/
public static function dataNotEnums()
{
return [
'not enum - construct named enum' => [
'testMarker' => '/* testEnumAsClassNameAfterEnumKeyword */',
'testContent' => 'Enum',
],
'not enum - class named enum' => [
'testMarker' => '/* testEnumUsedAsClassName */',
'testContent' => 'Enum',
],
'not enum - class constant named enum' => [
'testMarker' => '/* testEnumUsedAsClassConstantName */',
'testContent' => 'ENUM',
],
'not enum - method named enum' => [
'testMarker' => '/* testEnumUsedAsMethodName */',
'testContent' => 'enum',
],
'not enum - class property named enum' => [
'testMarker' => '/* testEnumUsedAsPropertyName */',
'testContent' => 'enum',
],
'not enum - global function named enum' => [
'testMarker' => '/* testEnumUsedAsFunctionName */',
'testContent' => 'enum',
],
'not enum - namespace named enum' => [
'testMarker' => '/* testEnumUsedAsNamespaceName */',
'testContent' => 'Enum',
],
'not enum - part of namespace named enum' => [
'testMarker' => '/* testEnumUsedAsPartOfNamespaceName */',
'testContent' => 'Enum',
],
'not enum - class instantiation for class enum' => [
'testMarker' => '/* testEnumUsedInObjectInitialization */',
'testContent' => 'Enum',
],
'not enum - function call' => [
'testMarker' => '/* testEnumAsFunctionCall */',
'testContent' => 'enum',
],
'not enum - namespace relative function call' => [
'testMarker' => '/* testEnumAsFunctionCallWithNamespace */',
'testContent' => 'enum',
],
'not enum - class constant fetch with enum as class name' => [
'testMarker' => '/* testClassConstantFetchWithEnumAsClassName */',
'testContent' => 'Enum',
],
'not enum - class constant fetch with enum as constant name' => [
'testMarker' => '/* testClassConstantFetchWithEnumAsConstantName */',
'testContent' => 'ENUM',
],
'parse error, not enum - enum declaration without name' => [
'testMarker' => '/* testParseErrorMissingName */',
'testContent' => 'enum',
],
'parse error, not enum - enum declaration with curlies' => [
'testMarker' => '/* testParseErrorLiveCoding */',
'testContent' => 'enum',
],
];
}//end dataNotEnums()
}//end class
|
