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
|
<?php
/**
* Tests for the \PHP_CodeSniffer\Files\File::getDeclarationName method.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2022-2024 PHPCSStandards Contributors
* @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:getDeclarationName method.
*
* @covers \PHP_CodeSniffer\Files\File::getDeclarationName
*/
final class GetDeclarationNameTest extends AbstractMethodUnitTestCase
{
/**
* Test receiving an expected exception when a non-supported token is passed.
*
* @return void
*/
public function testInvalidTokenPassed()
{
$this->expectRunTimeException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM');
$target = $this->getTargetToken('/* testInvalidTokenPassed */', T_STRING);
self::$phpcsFile->getDeclarationName($target);
}//end testInvalidTokenPassed()
/**
* Test receiving "null" when passed an anonymous construct or in case of a parse error.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param int|string $targetType Token type of the token to get as stackPtr.
*
* @dataProvider dataGetDeclarationNameNull
*
* @return void
*/
public function testGetDeclarationNameNull($testMarker, $targetType)
{
$target = $this->getTargetToken($testMarker, $targetType);
$result = self::$phpcsFile->getDeclarationName($target);
$this->assertNull($result);
}//end testGetDeclarationNameNull()
/**
* Data provider.
*
* @see testGetDeclarationNameNull() For the array format.
*
* @return array<string, array<string, int|string>>
*/
public static function dataGetDeclarationNameNull()
{
return [
'closure' => [
'testMarker' => '/* testClosure */',
'targetType' => T_CLOSURE,
],
'anon-class-with-parentheses' => [
'testMarker' => '/* testAnonClassWithParens */',
'targetType' => T_ANON_CLASS,
],
'anon-class-with-parentheses-2' => [
'testMarker' => '/* testAnonClassWithParens2 */',
'targetType' => T_ANON_CLASS,
],
'anon-class-without-parentheses' => [
'testMarker' => '/* testAnonClassWithoutParens */',
'targetType' => T_ANON_CLASS,
],
'anon-class-extends-without-parentheses' => [
'testMarker' => '/* testAnonClassExtendsWithoutParens */',
'targetType' => T_ANON_CLASS,
],
'live-coding' => [
'testMarker' => '/* testLiveCoding */',
'targetType' => T_FUNCTION,
],
];
}//end dataGetDeclarationNameNull()
/**
* Test retrieving the name of a function or OO structure.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $expected Expected function output.
* @param int|string|null $targetType Token type of the token to get as stackPtr.
*
* @dataProvider dataGetDeclarationName
*
* @return void
*/
public function testGetDeclarationName($testMarker, $expected, $targetType=null)
{
if (isset($targetType) === false) {
$targetType = [
T_CLASS,
T_INTERFACE,
T_TRAIT,
T_ENUM,
T_FUNCTION,
];
}
$target = $this->getTargetToken($testMarker, $targetType);
$result = self::$phpcsFile->getDeclarationName($target);
$this->assertSame($expected, $result);
}//end testGetDeclarationName()
/**
* Data provider.
*
* @see testGetDeclarationName() For the array format.
*
* @return array<string, array<string, string>>
*/
public static function dataGetDeclarationName()
{
return [
'function' => [
'testMarker' => '/* testFunction */',
'expected' => 'functionName',
],
'function-return-by-reference' => [
'testMarker' => '/* testFunctionReturnByRef */',
'expected' => 'functionNameByRef',
],
'class' => [
'testMarker' => '/* testClass */',
'expected' => 'ClassName',
],
'method' => [
'testMarker' => '/* testMethod */',
'expected' => 'methodName',
],
'abstract-method' => [
'testMarker' => '/* testAbstractMethod */',
'expected' => 'abstractMethodName',
],
'method-return-by-reference' => [
'testMarker' => '/* testMethodReturnByRef */',
'expected' => 'MethodNameByRef',
],
'extended-class' => [
'testMarker' => '/* testExtendedClass */',
'expected' => 'ExtendedClass',
],
'interface' => [
'testMarker' => '/* testInterface */',
'expected' => 'InterfaceName',
],
'trait' => [
'testMarker' => '/* testTrait */',
'expected' => 'TraitName',
],
'function-name-ends-with-number' => [
'testMarker' => '/* testFunctionEndingWithNumber */',
'expected' => 'ValidNameEndingWithNumber5',
],
'class-with-numbers-in-name' => [
'testMarker' => '/* testClassWithNumber */',
'expected' => 'ClassWith1Number',
],
'interface-with-numbers-in-name' => [
'testMarker' => '/* testInterfaceWithNumbers */',
'expected' => 'InterfaceWith12345Numbers',
],
'class-with-comments-and-new-lines' => [
'testMarker' => '/* testClassWithCommentsAndNewLines */',
'expected' => 'ClassWithCommentsAndNewLines',
],
'function-named-fn' => [
'testMarker' => '/* testFunctionFn */',
'expected' => 'fn',
],
'enum-pure' => [
'testMarker' => '/* testPureEnum */',
'expected' => 'Foo',
],
'enum-backed-space-between-name-and-colon' => [
'testMarker' => '/* testBackedEnumSpaceBetweenNameAndColon */',
'expected' => 'Hoo',
],
'enum-backed-no-space-between-name-and-colon' => [
'testMarker' => '/* testBackedEnumNoSpaceBetweenNameAndColon */',
'expected' => 'Suit',
],
'function-return-by-reference-with-reserved-keyword-each' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordEach */',
'expected' => 'each',
],
'function-return-by-reference-with-reserved-keyword-parent' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordParent */',
'expected' => 'parent',
],
'function-return-by-reference-with-reserved-keyword-self' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordSelf */',
'expected' => 'self',
],
'function-return-by-reference-with-reserved-keyword-static' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordStatic */',
'expected' => 'static',
],
];
}//end dataGetDeclarationName()
}//end class
|
