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
|
<?php
/**
* Tests that single line docblocks are tokenized correctly.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2024 PHPCSStandards and contributors
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment;
/**
* Tests that single line docblocks are tokenized correctly.
*
* @covers PHP_CodeSniffer\Tokenizers\Comment
*/
final class SingleLineDocBlockTest extends CommentTestCase
{
/**
* Data provider.
*
* @see testDocblockOpenerCloser()
*
* @return array<string, array<string, string|int|array<int>>>
*/
public static function dataDocblockOpenerCloser()
{
return [
'Single line docblock: empty, no whitespace' => [
'marker' => '/* testEmptyDocblockNoWhiteSpace */',
'closerOffset' => 1,
'expectedTags' => [],
],
'Single line docblock: only whitespace' => [
'marker' => '/* testEmptyDocblockWithWhiteSpace */',
'closerOffset' => 2,
'expectedTags' => [],
],
'Single line docblock: just text' => [
'marker' => '/* testSingleLineDocblockNoTag */',
'closerOffset' => 3,
'expectedTags' => [],
],
'Single line docblock: @var type before name' => [
'marker' => '/* testSingleLineDocblockWithTag1 */',
'closerOffset' => 5,
'expectedTags' => [2],
],
'Single line docblock: @var name before type' => [
'marker' => '/* testSingleLineDocblockWithTag2 */',
'closerOffset' => 5,
'expectedTags' => [2],
],
'Single line docblock: @see with description' => [
'marker' => '/* testSingleLineDocblockWithTag3 */',
'closerOffset' => 5,
'expectedTags' => [2],
],
];
}//end dataDocblockOpenerCloser()
/**
* Verify an empty block comment is tokenized as T_COMMENT, not as a docblock.
*
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*
* @return void
*/
public function testEmptyBlockCommentNoWhiteSpace()
{
$expectedSequence = [
[T_COMMENT => '/**/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', [T_COMMENT, T_DOC_COMMENT_OPEN_TAG]);
$this->checkTokenSequence($target, $expectedSequence);
}//end testEmptyBlockCommentNoWhiteSpace()
/**
* Verify tokenization of an empty, single line DocBlock without whitespace between the opener and closer.
*
* @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment.
*
* @return void
*/
public function testEmptyDocblockNoWhiteSpace()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testEmptyDocblockNoWhiteSpace()
/**
* Verify tokenization of an empty, single line DocBlock.
*
* @return void
*/
public function testEmptyDocblockWithWhiteSpace()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testEmptyDocblockWithWhiteSpace()
/**
* Verify tokenization of a single line DocBlock.
*
* @return void
*/
public function testSingleLineDocblockNoTag()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Just some text '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocblockNoTag()
/**
* Verify tokenization of a single line DocBlock with a tag.
*
* @return void
*/
public function testSingleLineDocblockWithTag1()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@var'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => '\SomeClass[] $var '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocblockWithTag1()
/**
* Verify tokenization of a single line DocBlock with a tag.
*
* @return void
*/
public function testSingleLineDocblockWithTag2()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@var'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => '$var \SomeClass[] '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocblockWithTag2()
/**
* Verify tokenization of a single line DocBlock with a tag.
*
* @return void
*/
public function testSingleLineDocblockWithTag3()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@see'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Something::Else '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocblockWithTag3()
}//end class
|
