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
|
<?php
/**
* Tests for the \PHP_CodeSniffer\Files\File:getClassProperties method.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2022 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\File;
use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTestCase;
/**
* Tests for the \PHP_CodeSniffer\Files\File:getClassProperties method.
*
* @covers \PHP_CodeSniffer\Files\File::getClassProperties
*/
final class GetClassPropertiesTest extends AbstractMethodUnitTestCase
{
/**
* Test receiving an expected exception when a non class token is passed.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param int|string $tokenType The type of token to look for after the marker.
*
* @dataProvider dataNotAClassException
*
* @return void
*/
public function testNotAClassException($testMarker, $tokenType)
{
$this->expectRunTimeException('$stackPtr must be of type T_CLASS');
$target = $this->getTargetToken($testMarker, $tokenType);
self::$phpcsFile->getClassProperties($target);
}//end testNotAClassException()
/**
* Data provider.
*
* @see testNotAClassException() For the array format.
*
* @return array<string, array<string, string|int>>
*/
public static function dataNotAClassException()
{
return [
'interface' => [
'testMarker' => '/* testNotAClass */',
'tokenType' => T_INTERFACE,
],
'anon-class' => [
'testMarker' => '/* testAnonClass */',
'tokenType' => T_ANON_CLASS,
],
'enum' => [
'testMarker' => '/* testEnum */',
'tokenType' => T_ENUM,
],
];
}//end dataNotAClassException()
/**
* Test retrieving the properties for a class declaration.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param array<string, bool> $expected Expected function output.
*
* @dataProvider dataGetClassProperties
*
* @return void
*/
public function testGetClassProperties($testMarker, $expected)
{
$class = $this->getTargetToken($testMarker, T_CLASS);
$result = self::$phpcsFile->getClassProperties($class);
$this->assertSame($expected, $result);
}//end testGetClassProperties()
/**
* Data provider.
*
* @see testGetClassProperties() For the array format.
*
* @return array<string, array<string, string|array<string, bool|int>>>
*/
public static function dataGetClassProperties()
{
return [
'no-properties' => [
'testMarker' => '/* testClassWithoutProperties */',
'expected' => [
'is_abstract' => false,
'is_final' => false,
'is_readonly' => false,
],
],
'abstract' => [
'testMarker' => '/* testAbstractClass */',
'expected' => [
'is_abstract' => true,
'is_final' => false,
'is_readonly' => false,
],
],
'final' => [
'testMarker' => '/* testFinalClass */',
'expected' => [
'is_abstract' => false,
'is_final' => true,
'is_readonly' => false,
],
],
'readonly' => [
'testMarker' => '/* testReadonlyClass */',
'expected' => [
'is_abstract' => false,
'is_final' => false,
'is_readonly' => true,
],
],
'final-readonly' => [
'testMarker' => '/* testFinalReadonlyClass */',
'expected' => [
'is_abstract' => false,
'is_final' => true,
'is_readonly' => true,
],
],
'readonly-final' => [
'testMarker' => '/* testReadonlyFinalClass */',
'expected' => [
'is_abstract' => false,
'is_final' => true,
'is_readonly' => true,
],
],
'abstract-readonly' => [
'testMarker' => '/* testAbstractReadonlyClass */',
'expected' => [
'is_abstract' => true,
'is_final' => false,
'is_readonly' => true,
],
],
'readonly-abstract' => [
'testMarker' => '/* testReadonlyAbstractClass */',
'expected' => [
'is_abstract' => true,
'is_final' => false,
'is_readonly' => true,
],
],
'comments-and-new-lines' => [
'testMarker' => '/* testWithCommentsAndNewLines */',
'expected' => [
'is_abstract' => true,
'is_final' => false,
'is_readonly' => false,
],
],
'no-properties-with-docblock' => [
'testMarker' => '/* testWithDocblockWithoutProperties */',
'expected' => [
'is_abstract' => false,
'is_final' => false,
'is_readonly' => false,
],
],
'abstract-final-parse-error' => [
'testMarker' => '/* testParseErrorAbstractFinal */',
'expected' => [
'is_abstract' => true,
'is_final' => true,
'is_readonly' => false,
],
],
];
}//end dataGetClassProperties()
}//end class
|
