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
|
<?php
/**
* Tests the support of PHP 8.1 "readonly" 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 BackfillReadonlyTest extends AbstractTokenizerTestCase
{
/**
* Test that the "readonly" keyword is tokenized as such.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $testContent Optional. The token content to look for.
* Defaults to lowercase "readonly".
*
* @dataProvider dataReadonly
* @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional
*
* @return void
*/
public function testReadonly($testMarker, $testContent='readonly')
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, [T_READONLY, T_STRING], $testContent);
$tokenArray = $tokens[$target];
$this->assertSame(T_READONLY, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_READONLY (code)');
$this->assertSame('T_READONLY', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_READONLY (type)');
}//end testReadonly()
/**
* Data provider.
*
* @see testReadonly()
*
* @return array<string, array<string, string>>
*/
public static function dataReadonly()
{
return [
'property declaration, no visibility' => [
'testMarker' => '/* testReadonlyProperty */',
],
'property declaration, var keyword before' => [
'testMarker' => '/* testVarReadonlyProperty */',
],
'property declaration, var keyword after' => [
'testMarker' => '/* testReadonlyVarProperty */',
],
'property declaration, static before' => [
'testMarker' => '/* testStaticReadonlyProperty */',
],
'property declaration, static after' => [
'testMarker' => '/* testReadonlyStaticProperty */',
],
'constant declaration, with visibility' => [
'testMarker' => '/* testConstReadonlyProperty */',
],
'property declaration, missing type' => [
'testMarker' => '/* testReadonlyPropertyWithoutType */',
],
'property declaration, public before' => [
'testMarker' => '/* testPublicReadonlyProperty */',
],
'property declaration, protected before' => [
'testMarker' => '/* testProtectedReadonlyProperty */',
],
'property declaration, private before' => [
'testMarker' => '/* testPrivateReadonlyProperty */',
],
'property declaration, public after' => [
'testMarker' => '/* testPublicReadonlyPropertyWithReadonlyFirst */',
],
'property declaration, protected after' => [
'testMarker' => '/* testProtectedReadonlyPropertyWithReadonlyFirst */',
],
'property declaration, private after' => [
'testMarker' => '/* testPrivateReadonlyPropertyWithReadonlyFirst */',
],
'property declaration, private before, comments in declaration' => [
'testMarker' => '/* testReadonlyWithCommentsInDeclaration */',
],
'property declaration, private before, nullable type' => [
'testMarker' => '/* testReadonlyWithNullableProperty */',
],
'property declaration, private before, union type, null first' => [
'testMarker' => '/* testReadonlyNullablePropertyWithUnionTypeHintAndNullFirst */',
],
'property declaration, private before, union type, null last' => [
'testMarker' => '/* testReadonlyNullablePropertyWithUnionTypeHintAndNullLast */',
],
'property declaration, private before, array type' => [
'testMarker' => '/* testReadonlyPropertyWithArrayTypeHint */',
],
'property declaration, private before, self type' => [
'testMarker' => '/* testReadonlyPropertyWithSelfTypeHint */',
],
'property declaration, private before, parent type' => [
'testMarker' => '/* testReadonlyPropertyWithParentTypeHint */',
],
'property declaration, private before, FQN type' => [
'testMarker' => '/* testReadonlyPropertyWithFullyQualifiedTypeHint */',
],
'property declaration, public before, mixed case' => [
'testMarker' => '/* testReadonlyIsCaseInsensitive */',
'testContent' => 'ReAdOnLy',
],
'property declaration, constructor property promotion' => [
'testMarker' => '/* testReadonlyConstructorPropertyPromotion */',
],
'property declaration, constructor property promotion with reference, mixed case' => [
'testMarker' => '/* testReadonlyConstructorPropertyPromotionWithReference */',
'testContent' => 'ReadOnly',
],
'property declaration, in anonymous class' => [
'testMarker' => '/* testReadonlyPropertyInAnonymousClass */',
],
'property declaration, no visibility, DNF type, unqualified' => [
'testMarker' => '/* testReadonlyPropertyDNFTypeUnqualified */',
],
'property declaration, public before, DNF type, fully qualified' => [
'testMarker' => '/* testReadonlyPropertyDNFTypeFullyQualified */',
],
'property declaration, protected before, DNF type, partially qualified' => [
'testMarker' => '/* testReadonlyPropertyDNFTypePartiallyQualified */',
],
'property declaration, private before, DNF type, namespace relative name' => [
'testMarker' => '/* testReadonlyPropertyDNFTypeRelativeName */',
],
'property declaration, private before, DNF type, multiple sets' => [
'testMarker' => '/* testReadonlyPropertyDNFTypeMultipleSets */',
],
'property declaration, private before, DNF type, union with array' => [
'testMarker' => '/* testReadonlyPropertyDNFTypeWithArray */',
],
'property declaration, private before, DNF type, with spaces and comment' => [
'testMarker' => '/* testReadonlyPropertyDNFTypeWithSpacesAndComments */',
],
'property declaration, constructor property promotion, DNF type' => [
'testMarker' => '/* testReadonlyConstructorPropertyPromotionWithDNF */',
],
'property declaration, constructor property promotion, DNF type and reference' => [
'testMarker' => '/* testReadonlyConstructorPropertyPromotionWithDNFAndReference */',
],
'anon class declaration, with parentheses' => [
'testMarker' => '/* testReadonlyAnonClassWithParens */',
],
'anon class declaration, without parentheses' => [
'testMarker' => '/* testReadonlyAnonClassWithoutParens */',
'testContent' => 'Readonly',
],
'anon class declaration, with comments and whitespace' => [
'testMarker' => '/* testReadonlyAnonClassWithCommentsAndWhitespace */',
'testContent' => 'READONLY',
],
'live coding / parse error' => [
'testMarker' => '/* testParseErrorLiveCoding */',
],
];
}//end dataReadonly()
/**
* Test that "readonly" 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 Optional. The token content to look for.
* Defaults to lowercase "readonly".
*
* @dataProvider dataNotReadonly
* @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional
*
* @return void
*/
public function testNotReadonly($testMarker, $testContent='readonly')
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, [T_READONLY, 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 testNotReadonly()
/**
* Data provider.
*
* @see testNotReadonly()
*
* @return array<string, array<string, string>>
*/
public static function dataNotReadonly()
{
return [
'name of a constant, context: declaration using "const" keyword, uppercase' => [
'testMarker' => '/* testReadonlyUsedAsClassConstantName */',
'testContent' => 'READONLY',
],
'name of a method, context: declaration' => [
'testMarker' => '/* testReadonlyUsedAsMethodName */',
],
'name of a property, context: property access' => [
'testMarker' => '/* testReadonlyUsedAsPropertyName */',
],
'name of a property, context: property access in ternary' => [
'testMarker' => '/* testReadonlyPropertyInTernaryOperator */',
],
'name of a function, context: declaration' => [
'testMarker' => '/* testReadonlyUsedAsFunctionName */',
],
'name of a function, context: declaration with return by ref' => [
'testMarker' => '/* testReadonlyUsedAsFunctionNameWithReturnByRef */',
],
'name of namespace, context: declaration, mixed case' => [
'testMarker' => '/* testReadonlyUsedAsNamespaceName */',
'testContent' => 'Readonly',
],
'partial name of namespace, context: declaration, mixed case' => [
'testMarker' => '/* testReadonlyUsedAsPartOfNamespaceName */',
'testContent' => 'Readonly',
],
'name of a function, context: call' => [
'testMarker' => '/* testReadonlyAsFunctionCall */',
],
'name of a namespaced function, context: partially qualified call' => [
'testMarker' => '/* testReadonlyAsNamespacedFunctionCall */',
],
'name of a function, context: namespace relative call, mixed case' => [
'testMarker' => '/* testReadonlyAsNamespaceRelativeFunctionCall */',
'testContent' => 'ReadOnly',
],
'name of a method, context: method call on object' => [
'testMarker' => '/* testReadonlyAsMethodCall */',
],
'name of a method, context: nullsafe method call on object' => [
'testMarker' => '/* testReadonlyAsNullsafeMethodCall */',
'testContent' => 'readOnly',
],
'name of a method, context: static method call with space after' => [
'testMarker' => '/* testReadonlyAsStaticMethodCallWithSpace */',
],
'name of a constant, context: constant access - uppercase' => [
'testMarker' => '/* testClassConstantFetchWithReadonlyAsConstantName */',
'testContent' => 'READONLY',
],
'name of a function, context: call with space and comment between keyword and parens' => [
'testMarker' => '/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */',
],
'name of a method, context: declaration with DNF parameter' => [
'testMarker' => '/* testReadonlyUsedAsMethodNameWithDNFParam */',
],
];
}//end dataNotReadonly()
}//end class
|
