/
PhpdocParamOrderFixer.php
272 lines (229 loc) · 8.16 KB
/
PhpdocParamOrderFixer.php
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
272
<?php
declare(strict_types=1);
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer\Fixer\Phpdoc;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\DocBlock\Annotation;
use PhpCsFixer\DocBlock\DocBlock;
use PhpCsFixer\DocBlock\TypeExpression;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Preg;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Jonathan Gruber <gruberjonathan@gmail.com>
*/
final class PhpdocParamOrderFixer extends AbstractFixer
{
private const PARAM_TAG = 'param';
public function isCandidate(Tokens $tokens): bool
{
return $tokens->isTokenKindFound(T_DOC_COMMENT);
}
/**
* {@inheritdoc}
*
* Must run before PhpdocAlignFixer.
* Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
*/
public function getPriority(): int
{
return parent::getPriority();
}
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Orders all `@param` annotations in DocBlocks according to method signature.',
[
new CodeSample(
'<?php
/**
* Annotations in wrong order
*
* @param int $a
* @param Foo $c
* @param array $b
*/
function m($a, array $b, Foo $c) {}
'
),
]
);
}
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
foreach ($tokens as $index => $token) {
if (!$token->isGivenKind(T_DOC_COMMENT)) {
continue;
}
// Check for function / closure token
$nextFunctionToken = $tokens->getNextTokenOfKind($index, [[T_FUNCTION], [T_FN]]);
if (null === $nextFunctionToken) {
return;
}
// Find start index of param block (opening parenthesis)
$paramBlockStart = $tokens->getNextTokenOfKind($index, ['(']);
if (null === $paramBlockStart) {
return;
}
$doc = new DocBlock($tokens[$index]->getContent());
$paramAnnotations = $doc->getAnnotationsOfType(self::PARAM_TAG);
if ([] === $paramAnnotations) {
continue;
}
$paramNames = $this->getFunctionParamNames($tokens, $paramBlockStart);
$doc = $this->rewriteDocBlock($doc, $paramNames, $paramAnnotations);
$tokens[$index] = new Token([T_DOC_COMMENT, $doc->getContent()]);
}
}
/**
* @return Token[]
*/
private function getFunctionParamNames(Tokens $tokens, int $paramBlockStart): array
{
$paramBlockEnd = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $paramBlockStart);
$paramNames = [];
for (
$i = $tokens->getNextTokenOfKind($paramBlockStart, [[T_VARIABLE]]);
null !== $i && $i < $paramBlockEnd;
$i = $tokens->getNextTokenOfKind($i, [[T_VARIABLE]])
) {
$paramNames[] = $tokens[$i];
}
return $paramNames;
}
/**
* Overwrite the param annotations in order.
*
* @param Token[] $paramNames
* @param Annotation[] $paramAnnotations
*/
private function rewriteDocBlock(DocBlock $doc, array $paramNames, array $paramAnnotations): DocBlock
{
$orderedAnnotations = $this->sortParamAnnotations($paramNames, $paramAnnotations);
$otherAnnotations = $this->getOtherAnnotationsBetweenParams($doc, $paramAnnotations);
// Append annotations found between param ones
if ([] !== $otherAnnotations) {
array_push($orderedAnnotations, ...$otherAnnotations);
}
// Overwrite all annotations between first and last @param tag in order
$paramsStart = reset($paramAnnotations)->getStart();
$paramsEnd = end($paramAnnotations)->getEnd();
foreach ($doc->getAnnotations() as $annotation) {
if ($annotation->getStart() < $paramsStart || $annotation->getEnd() > $paramsEnd) {
continue;
}
$annotation->remove();
$doc
->getLine($annotation->getStart())
->setContent(current($orderedAnnotations))
;
next($orderedAnnotations);
}
return $doc;
}
/**
* Sort the param annotations according to the function parameters.
*
* @param Token[] $funcParamNames
* @param Annotation[] $paramAnnotations
*
* @return list<string>
*/
private function sortParamAnnotations(array $funcParamNames, array $paramAnnotations): array
{
$validParams = [];
foreach ($funcParamNames as $paramName) {
$indices = $this->findParamAnnotationByIdentifier($paramAnnotations, $paramName->getContent());
// Found an exactly matching @param annotation
if (\is_array($indices)) {
foreach ($indices as $index) {
$validParams[$index] = $paramAnnotations[$index]->getContent();
}
}
}
// Detect superfluous annotations
/** @var Annotation[] $invalidParams */
$invalidParams = array_diff_key($paramAnnotations, $validParams);
$invalidParams = array_values($invalidParams);
// Append invalid parameters to the (ordered) valid ones
$orderedParams = array_values($validParams);
foreach ($invalidParams as $params) {
$orderedParams[] = $params->getContent();
}
return $orderedParams;
}
/**
* Fetch all annotations except the param ones.
*
* @param Annotation[] $paramAnnotations
*
* @return list<string>
*/
private function getOtherAnnotationsBetweenParams(DocBlock $doc, array $paramAnnotations): array
{
if (0 === \count($paramAnnotations)) {
return [];
}
$paramsStart = reset($paramAnnotations)->getStart();
$paramsEnd = end($paramAnnotations)->getEnd();
$otherAnnotations = [];
foreach ($doc->getAnnotations() as $annotation) {
if ($annotation->getStart() < $paramsStart || $annotation->getEnd() > $paramsEnd) {
continue;
}
if (self::PARAM_TAG !== $annotation->getTag()->getName()) {
$otherAnnotations[] = $annotation->getContent();
}
}
return $otherAnnotations;
}
/**
* Return the indices of the lines of a specific parameter annotation.
*
* @param Annotation[] $paramAnnotations
*
* @return ?list<int>
*/
private function findParamAnnotationByIdentifier(array $paramAnnotations, string $identifier): ?array
{
$blockLevel = 0;
$blockMatch = false;
$blockIndices = [];
$paramRegex = '/\*\h*@param\h*(?:|'.TypeExpression::REGEX_TYPES.'\h*)&?(?=\$\b)'.preg_quote($identifier).'\b/';
foreach ($paramAnnotations as $i => $param) {
$blockStart = Preg::match('/\s*{\s*/', $param->getContent());
$blockEndMatches = Preg::matchAll('/}[\*\s\n]*/', $param->getContent());
if (0 === $blockLevel && Preg::match($paramRegex, $param->getContent())) {
if ($blockStart) {
$blockMatch = true; // Start of a nested block
} else {
return [$i]; // Top level match
}
}
if ($blockStart) {
++$blockLevel;
}
if (0 !== $blockEndMatches) {
$blockLevel -= $blockEndMatches;
}
if ($blockMatch) {
$blockIndices[] = $i;
if (0 === $blockLevel) {
return $blockIndices;
}
}
}
return null;
}
}