Newer
Older
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
<?php
/*
* 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\PhpUnit;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\DocBlock\DocBlock;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\Preg;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Filippo Tessarotto <zoeslam@gmail.com>
*/
final class PhpUnitOrderedCoversFixer extends AbstractFixer
{
/**
* {@inheritdoc}
*/
public function getDefinition()
{
return new FixerDefinition(
'Order `@covers` annotation of PHPUnit tests.',
[
new CodeSample(
'<?php
/**
* @covers Foo
* @covers Bar
*/
final class MyTest extends \PHPUnit_Framework_TestCase
{}
'
),
]
);
}
/**
* {@inheritdoc}
*/
public function getPriority()
{
// should be run after PhpUnitFqcnAnnotationFixer
return -10;
}
/**
* {@inheritdoc}
*/
public function isCandidate(Tokens $tokens)
{
return $tokens->isAllTokenKindsFound([T_CLASS, T_DOC_COMMENT]);
}
/**
* {@inheritdoc}
*/
protected function applyFix(\SplFileInfo $file, Tokens $tokens)
{
for ($index = $tokens->count() - 1; $index > 0; --$index) {
if (!$tokens[$index]->isGivenKind(T_DOC_COMMENT) || 0 === Preg::match('/@covers\s.+@covers\s/s', $tokens[$index]->getContent())) {
continue;
}
$docBlock = new DocBlock($tokens[$index]->getContent());
$covers = $docBlock->getAnnotationsOfType('covers');
$coversMap = [];
foreach ($covers as $annotation) {
$rawContent = $annotation->getContent();
$comparableContent = Preg::replace('/\*\s*@covers\s+(.+)/', '\1', strtolower(trim($rawContent)));
$coversMap[$comparableContent] = $rawContent;
}
$orderedCoversMap = $coversMap;
ksort($orderedCoversMap, SORT_STRING);
if ($orderedCoversMap === $coversMap) {
continue;
}
$lines = $docBlock->getLines();
foreach (array_reverse($covers) as $annotation) {
array_splice(
$lines,
$annotation->getStart(),
$annotation->getEnd() - $annotation->getStart() + 1,
array_pop($orderedCoversMap)
);
}
$tokens[$index] = new Token([T_DOC_COMMENT, implode($lines)]);
}
}
}