-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPhpDocblockChecker.php
More file actions
200 lines (159 loc) · 5.91 KB
/
Copy pathPhpDocblockChecker.php
File metadata and controls
200 lines (159 loc) · 5.91 KB
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
<?php
declare(strict_types=1);
namespace PHPCensor\Plugins\CodeQuality;
use PHPCensor\Common\Build\BuildErrorInterface;
use PHPCensor\Common\Build\BuildInterface;
use PHPCensor\Common\Build\BuildMetaInterface;
use PHPCensor\Common\Plugin\Plugin;
use PHPCensor\Common\Plugin\ZeroConfigPluginInterface;
/**
* PHP Docblock Checker Plugin - Checks your PHP files for appropriate uses of Docblocks
*
* @package PHP Censor
* @subpackage Plugins
*
* @author Dmitry Khomutov <poisoncorpsee@gmail.com>
* @author Dan Cryer <dan@block8.co.uk>
*/
class PhpDocblockChecker extends Plugin implements ZeroConfigPluginInterface
{
private bool $skipClasses = false;
private bool $skipMethods = false;
private bool $skipSignatures = false;
private int $allowedWarnings = 0;
/**
* {@inheritDoc}
*/
public static function getName(): string
{
return 'php_docblock_checker';
}
/**
* {@inheritDoc}
*/
public function execute(): bool
{
$executable = $this->commandExecutor->findBinary($this->binaryNames, $this->binaryPath);
$ignore = '';
if (0 < \count($this->ignores)) {
$ignore = \sprintf(' --exclude="%s"', \implode(',', $this->ignores));
}
$add = '';
if ($this->skipClasses) {
$add .= ' --skip-classes';
}
if ($this->skipMethods) {
$add .= ' --skip-methods';
}
if ($this->skipSignatures) {
$add .= ' --skip-signatures';
}
// Build command string:
$cmd = $executable . ' --json --directory="%s"%s%s';
if (!$this->build->isDebug()) {
$this->commandExecutor->disableCommandOutput();
}
// Run checker:
$this->commandExecutor->executeCommand(
$cmd,
$this->directory,
$ignore,
$add
);
$this->commandExecutor->enableCommandOutput();
$output = \json_decode($this->commandExecutor->getLastCommandOutput(), true);
$errors = 0;
if ($output && \is_array($output)) {
$errors = \count($output);
$this->buildLogger->logWarning("Number of error : " . $errors);
$this->reportErrors($output);
}
$this->buildMetaWriter->write($this->build->getId(), self::getName(), BuildMetaInterface::KEY_WARNINGS, $errors);
$success = true;
if (-1 !== $this->allowedWarnings && $errors > $this->allowedWarnings) {
$success = false;
}
return $success;
}
/**
* {@inheritDoc}
*/
public static function canExecute(string $stage, BuildInterface $build): bool
{
if (BuildInterface::STAGE_TEST === $stage) {
return true;
}
return false;
}
/**
* {@inheritDoc}
*/
protected function initPluginSettings(): void
{
if ($this->options->has('zero_config') && $this->options->get('zero_config', false)) {
$this->allowedWarnings = -1;
}
$this->allowedWarnings = (int)$this->options->get('allowed_warnings', $this->allowedWarnings);
$this->skipClasses = (bool)$this->options->get('skip_classes', $this->skipClasses);
$this->skipMethods = (bool)$this->options->get('skip_methods', $this->skipMethods);
$this->skipSignatures = (bool)$this->options->get('skip_signatures', $this->skipSignatures);
}
/**
* {@inheritDoc}
*/
protected function getPluginDefaultBinaryNames(): array
{
return [
'phpdoc-checker',
'phpdoc-checker.phar',
];
}
/**
* Report all of the errors we've encountered line-by-line.
*/
private function reportErrors(array $output): void
{
foreach ($output as $error) {
switch ($error['type']) {
case 'class':
$message = 'Class ' . $error['class'] . ' is missing a docblock.';
$severity = BuildErrorInterface::SEVERITY_NORMAL;
break;
case 'method':
$message = 'Method ' . $error['class'] . '::' . $error['method'] . ' is missing a docblock.';
$severity = BuildErrorInterface::SEVERITY_NORMAL;
break;
case 'param-missing':
$message = $error['class'] . '::' . $error['method'] . ' @param ' . $error['param'] . ' missing.';
$severity = BuildErrorInterface::SEVERITY_LOW;
break;
case 'param-mismatch':
$message = $error['class'] . '::' . $error['method'] . ' @param ' . $error['param'] .
'(' . $error['doc-type'] . ') does not match method signature (' . $error['param-type'] . ')';
$severity = BuildErrorInterface::SEVERITY_LOW;
break;
case 'return-missing':
$message = $error['class'] . '::' . $error['method'] . ' @return missing.';
$severity = BuildErrorInterface::SEVERITY_LOW;
break;
case 'return-mismatch':
$message = $error['class'] . '::' . $error['method'] . ' @return ' . $error['doc-type'] .
' does not match method signature (' . $error['return-type'] . ')';
$severity = BuildErrorInterface::SEVERITY_LOW;
break;
default:
$message = 'Class ' . $error['class'] . ' invalid/missing a docblock.';
$severity = BuildErrorInterface::SEVERITY_LOW;
break;
}
$this->buildErrorWriter->write(
$this->build->getId(),
self::getName(),
$message,
$severity,
(string)$error['file'],
(int)$error['line']
);
}
}
}