-
Notifications
You must be signed in to change notification settings - Fork 46
/
CoversHelper.php
123 lines (101 loc) · 2.81 KB
/
CoversHelper.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
<?php declare(strict_types = 1);
namespace PHPStan\Rules\PHPUnit;
use PhpParser\Node;
use PhpParser\Node\Name;
use PHPStan\PhpDoc\ResolvedPhpDocBlock;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Rules\RuleError;
use PHPStan\Rules\RuleErrorBuilder;
use function array_merge;
use function explode;
use function sprintf;
use function strpos;
class CoversHelper
{
/**
* Reflection provider.
*
* @var ReflectionProvider
*/
private $reflectionProvider;
public function __construct(ReflectionProvider $reflectionProvider)
{
$this->reflectionProvider = $reflectionProvider;
}
/**
* Gathers @covers and @coversDefaultClass annotations from phpdocs.
*
* @return array{PhpDocTagNode[], PhpDocTagNode[]}
*/
public function getCoverAnnotations(?ResolvedPhpDocBlock $phpDoc): array
{
if ($phpDoc === null) {
return [[], []];
}
$phpDocNodes = $phpDoc->getPhpDocNodes();
$covers = [];
$coversDefaultClasses = [];
foreach ($phpDocNodes as $docNode) {
$covers = array_merge(
$covers,
$docNode->getTagsByName('@covers')
);
$coversDefaultClasses = array_merge(
$coversDefaultClasses,
$docNode->getTagsByName('@coversDefaultClass')
);
}
return [$covers, $coversDefaultClasses];
}
/**
* @return RuleError[] errors
*/
public function processCovers(
Node $node,
PhpDocTagNode $phpDocTag,
?PhpDocTagNode $coversDefaultClass
): array
{
$errors = [];
$covers = (string) $phpDocTag->value;
$isMethod = strpos($covers, '::') !== false;
$fullName = $covers;
if ($isMethod) {
[$className, $method] = explode('::', $covers);
} else {
$className = $covers;
}
if ($className === '' && $node instanceof Node\Stmt\ClassMethod && $coversDefaultClass !== null) {
$className = (string) $coversDefaultClass->value;
$fullName = $className . $covers;
}
if ($this->reflectionProvider->hasClass($className)) {
$class = $this->reflectionProvider->getClass($className);
if (isset($method) && $method !== '' && !$class->hasMethod($method)) {
$errors[] = RuleErrorBuilder::message(sprintf(
'@covers value %s references an invalid method.',
$fullName
))->build();
}
} else {
if ($covers === '') {
$errors[] = RuleErrorBuilder::message('@covers value does not specify anything.')->build();
return $errors;
}
if (!isset($method) && $this->reflectionProvider->hasFunction(new Name($covers, []), null)) {
return $errors;
}
$error = RuleErrorBuilder::message(sprintf(
'@covers value %s references an invalid %s.',
$fullName,
$isMethod ? 'method' : 'class or function'
));
if (strpos($className, '\\') === false) {
$error->tip('The @covers annotation requires a fully qualified name.');
}
$errors[] = $error->build();
}
return $errors;
}
}