Chris@17
|
1 <?php
|
Chris@17
|
2 /**
|
Chris@17
|
3 * Source report for PHP_CodeSniffer.
|
Chris@17
|
4 *
|
Chris@17
|
5 * @author Greg Sherwood <gsherwood@squiz.net>
|
Chris@17
|
6 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
|
Chris@17
|
7 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
|
Chris@17
|
8 */
|
Chris@17
|
9
|
Chris@17
|
10 namespace PHP_CodeSniffer\Reports;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Util\Timing;
|
Chris@17
|
14
|
Chris@17
|
15 class Source implements Report
|
Chris@17
|
16 {
|
Chris@17
|
17
|
Chris@17
|
18
|
Chris@17
|
19 /**
|
Chris@17
|
20 * Generate a partial report for a single processed file.
|
Chris@17
|
21 *
|
Chris@17
|
22 * Function should return TRUE if it printed or stored data about the file
|
Chris@17
|
23 * and FALSE if it ignored the file. Returning TRUE indicates that the file and
|
Chris@17
|
24 * its data should be counted in the grand totals.
|
Chris@17
|
25 *
|
Chris@17
|
26 * @param array $report Prepared report data.
|
Chris@17
|
27 * @param \PHP_CodeSniffer\File $phpcsFile The file being reported on.
|
Chris@17
|
28 * @param bool $showSources Show sources?
|
Chris@17
|
29 * @param int $width Maximum allowed line width.
|
Chris@17
|
30 *
|
Chris@17
|
31 * @return bool
|
Chris@17
|
32 */
|
Chris@17
|
33 public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
|
Chris@17
|
34 {
|
Chris@17
|
35 if ($report['errors'] === 0 && $report['warnings'] === 0) {
|
Chris@17
|
36 // Nothing to print.
|
Chris@17
|
37 return false;
|
Chris@17
|
38 }
|
Chris@17
|
39
|
Chris@17
|
40 $sources = [];
|
Chris@17
|
41
|
Chris@17
|
42 foreach ($report['messages'] as $line => $lineErrors) {
|
Chris@17
|
43 foreach ($lineErrors as $column => $colErrors) {
|
Chris@17
|
44 foreach ($colErrors as $error) {
|
Chris@17
|
45 $src = $error['source'];
|
Chris@17
|
46 if (isset($sources[$src]) === false) {
|
Chris@17
|
47 $sources[$src] = [
|
Chris@17
|
48 'fixable' => (int) $error['fixable'],
|
Chris@17
|
49 'count' => 1,
|
Chris@17
|
50 ];
|
Chris@17
|
51 } else {
|
Chris@17
|
52 $sources[$src]['count']++;
|
Chris@17
|
53 }
|
Chris@17
|
54 }
|
Chris@17
|
55 }
|
Chris@17
|
56 }
|
Chris@17
|
57
|
Chris@17
|
58 foreach ($sources as $source => $data) {
|
Chris@17
|
59 echo $source.'>>'.$data['fixable'].'>>'.$data['count'].PHP_EOL;
|
Chris@17
|
60 }
|
Chris@17
|
61
|
Chris@17
|
62 return true;
|
Chris@17
|
63
|
Chris@17
|
64 }//end generateFileReport()
|
Chris@17
|
65
|
Chris@17
|
66
|
Chris@17
|
67 /**
|
Chris@17
|
68 * Prints the source of all errors and warnings.
|
Chris@17
|
69 *
|
Chris@17
|
70 * @param string $cachedData Any partial report data that was returned from
|
Chris@17
|
71 * generateFileReport during the run.
|
Chris@17
|
72 * @param int $totalFiles Total number of files processed during the run.
|
Chris@17
|
73 * @param int $totalErrors Total number of errors found during the run.
|
Chris@17
|
74 * @param int $totalWarnings Total number of warnings found during the run.
|
Chris@17
|
75 * @param int $totalFixable Total number of problems that can be fixed.
|
Chris@17
|
76 * @param bool $showSources Show sources?
|
Chris@17
|
77 * @param int $width Maximum allowed line width.
|
Chris@17
|
78 * @param bool $interactive Are we running in interactive mode?
|
Chris@17
|
79 * @param bool $toScreen Is the report being printed to screen?
|
Chris@17
|
80 *
|
Chris@17
|
81 * @return void
|
Chris@17
|
82 */
|
Chris@17
|
83 public function generate(
|
Chris@17
|
84 $cachedData,
|
Chris@17
|
85 $totalFiles,
|
Chris@17
|
86 $totalErrors,
|
Chris@17
|
87 $totalWarnings,
|
Chris@17
|
88 $totalFixable,
|
Chris@17
|
89 $showSources=false,
|
Chris@17
|
90 $width=80,
|
Chris@17
|
91 $interactive=false,
|
Chris@17
|
92 $toScreen=true
|
Chris@17
|
93 ) {
|
Chris@17
|
94 $lines = explode(PHP_EOL, $cachedData);
|
Chris@17
|
95 array_pop($lines);
|
Chris@17
|
96
|
Chris@17
|
97 if (empty($lines) === true) {
|
Chris@17
|
98 return;
|
Chris@17
|
99 }
|
Chris@17
|
100
|
Chris@17
|
101 $sources = [];
|
Chris@17
|
102 $maxLength = 0;
|
Chris@17
|
103
|
Chris@17
|
104 foreach ($lines as $line) {
|
Chris@17
|
105 $parts = explode('>>', $line);
|
Chris@17
|
106 $source = $parts[0];
|
Chris@17
|
107 $fixable = (bool) $parts[1];
|
Chris@17
|
108 $count = $parts[2];
|
Chris@17
|
109
|
Chris@17
|
110 if (isset($sources[$source]) === false) {
|
Chris@17
|
111 if ($showSources === true) {
|
Chris@17
|
112 $parts = null;
|
Chris@17
|
113 $sniff = $source;
|
Chris@17
|
114 } else {
|
Chris@17
|
115 $parts = explode('.', $source);
|
Chris@17
|
116 if ($parts[0] === 'Internal') {
|
Chris@17
|
117 $parts[2] = $parts[1];
|
Chris@17
|
118 $parts[1] = '';
|
Chris@17
|
119 }
|
Chris@17
|
120
|
Chris@17
|
121 $parts[1] = $this->makeFriendlyName($parts[1]);
|
Chris@17
|
122
|
Chris@17
|
123 $sniff = $this->makeFriendlyName($parts[2]);
|
Chris@17
|
124 if (isset($parts[3]) === true) {
|
Chris@17
|
125 $name = $this->makeFriendlyName($parts[3]);
|
Chris@17
|
126 $name[0] = strtolower($name[0]);
|
Chris@17
|
127 $sniff .= ' '.$name;
|
Chris@17
|
128 unset($parts[3]);
|
Chris@17
|
129 }
|
Chris@17
|
130
|
Chris@17
|
131 $parts[2] = $sniff;
|
Chris@17
|
132 }//end if
|
Chris@17
|
133
|
Chris@17
|
134 $maxLength = max($maxLength, strlen($sniff));
|
Chris@17
|
135
|
Chris@17
|
136 $sources[$source] = [
|
Chris@17
|
137 'count' => $count,
|
Chris@17
|
138 'fixable' => $fixable,
|
Chris@17
|
139 'parts' => $parts,
|
Chris@17
|
140 ];
|
Chris@17
|
141 } else {
|
Chris@17
|
142 $sources[$source]['count'] += $count;
|
Chris@17
|
143 }//end if
|
Chris@17
|
144 }//end foreach
|
Chris@17
|
145
|
Chris@17
|
146 if ($showSources === true) {
|
Chris@17
|
147 $width = min($width, ($maxLength + 11));
|
Chris@17
|
148 } else {
|
Chris@17
|
149 $width = min($width, ($maxLength + 41));
|
Chris@17
|
150 }
|
Chris@17
|
151
|
Chris@17
|
152 $width = max($width, 70);
|
Chris@17
|
153
|
Chris@17
|
154 // Sort the data based on counts and source code.
|
Chris@17
|
155 $sourceCodes = array_keys($sources);
|
Chris@17
|
156 $counts = [];
|
Chris@17
|
157 foreach ($sources as $source => $data) {
|
Chris@17
|
158 $counts[$source] = $data['count'];
|
Chris@17
|
159 }
|
Chris@17
|
160
|
Chris@17
|
161 array_multisort($counts, SORT_DESC, $sourceCodes, SORT_ASC, SORT_NATURAL, $sources);
|
Chris@17
|
162
|
Chris@17
|
163 echo PHP_EOL."\033[1mPHP CODE SNIFFER VIOLATION SOURCE SUMMARY\033[0m".PHP_EOL;
|
Chris@17
|
164 echo str_repeat('-', $width).PHP_EOL."\033[1m";
|
Chris@17
|
165 if ($showSources === true) {
|
Chris@17
|
166 if ($totalFixable > 0) {
|
Chris@17
|
167 echo ' SOURCE'.str_repeat(' ', ($width - 15)).'COUNT'.PHP_EOL;
|
Chris@17
|
168 } else {
|
Chris@17
|
169 echo 'SOURCE'.str_repeat(' ', ($width - 11)).'COUNT'.PHP_EOL;
|
Chris@17
|
170 }
|
Chris@17
|
171 } else {
|
Chris@17
|
172 if ($totalFixable > 0) {
|
Chris@17
|
173 echo ' STANDARD CATEGORY SNIFF'.str_repeat(' ', ($width - 44)).'COUNT'.PHP_EOL;
|
Chris@17
|
174 } else {
|
Chris@17
|
175 echo 'STANDARD CATEGORY SNIFF'.str_repeat(' ', ($width - 40)).'COUNT'.PHP_EOL;
|
Chris@17
|
176 }
|
Chris@17
|
177 }
|
Chris@17
|
178
|
Chris@17
|
179 echo "\033[0m".str_repeat('-', $width).PHP_EOL;
|
Chris@17
|
180
|
Chris@17
|
181 $fixableSources = 0;
|
Chris@17
|
182
|
Chris@17
|
183 if ($showSources === true) {
|
Chris@17
|
184 $maxSniffWidth = ($width - 7);
|
Chris@17
|
185 } else {
|
Chris@17
|
186 $maxSniffWidth = ($width - 37);
|
Chris@17
|
187 }
|
Chris@17
|
188
|
Chris@17
|
189 if ($totalFixable > 0) {
|
Chris@17
|
190 $maxSniffWidth -= 4;
|
Chris@17
|
191 }
|
Chris@17
|
192
|
Chris@17
|
193 foreach ($sources as $source => $sourceData) {
|
Chris@17
|
194 if ($totalFixable > 0) {
|
Chris@17
|
195 echo '[';
|
Chris@17
|
196 if ($sourceData['fixable'] === true) {
|
Chris@17
|
197 echo 'x';
|
Chris@17
|
198 $fixableSources++;
|
Chris@17
|
199 } else {
|
Chris@17
|
200 echo ' ';
|
Chris@17
|
201 }
|
Chris@17
|
202
|
Chris@17
|
203 echo '] ';
|
Chris@17
|
204 }
|
Chris@17
|
205
|
Chris@17
|
206 if ($showSources === true) {
|
Chris@17
|
207 if (strlen($source) > $maxSniffWidth) {
|
Chris@17
|
208 $source = substr($source, 0, $maxSniffWidth);
|
Chris@17
|
209 }
|
Chris@17
|
210
|
Chris@17
|
211 echo $source;
|
Chris@17
|
212 if ($totalFixable > 0) {
|
Chris@17
|
213 echo str_repeat(' ', ($width - 9 - strlen($source)));
|
Chris@17
|
214 } else {
|
Chris@17
|
215 echo str_repeat(' ', ($width - 5 - strlen($source)));
|
Chris@17
|
216 }
|
Chris@17
|
217 } else {
|
Chris@17
|
218 $parts = $sourceData['parts'];
|
Chris@17
|
219
|
Chris@17
|
220 if (strlen($parts[0]) > 8) {
|
Chris@17
|
221 $parts[0] = substr($parts[0], 0, ((strlen($parts[0]) - 8) * -1));
|
Chris@17
|
222 }
|
Chris@17
|
223
|
Chris@17
|
224 echo $parts[0].str_repeat(' ', (10 - strlen($parts[0])));
|
Chris@17
|
225
|
Chris@17
|
226 $category = $parts[1];
|
Chris@17
|
227 if (strlen($category) > 18) {
|
Chris@17
|
228 $category = substr($category, 0, ((strlen($category) - 18) * -1));
|
Chris@17
|
229 }
|
Chris@17
|
230
|
Chris@17
|
231 echo $category.str_repeat(' ', (20 - strlen($category)));
|
Chris@17
|
232
|
Chris@17
|
233 $sniff = $parts[2];
|
Chris@17
|
234 if (strlen($sniff) > $maxSniffWidth) {
|
Chris@17
|
235 $sniff = substr($sniff, 0, $maxSniffWidth);
|
Chris@17
|
236 }
|
Chris@17
|
237
|
Chris@17
|
238 if ($totalFixable > 0) {
|
Chris@17
|
239 echo $sniff.str_repeat(' ', ($width - 39 - strlen($sniff)));
|
Chris@17
|
240 } else {
|
Chris@17
|
241 echo $sniff.str_repeat(' ', ($width - 35 - strlen($sniff)));
|
Chris@17
|
242 }
|
Chris@17
|
243 }//end if
|
Chris@17
|
244
|
Chris@17
|
245 echo $sourceData['count'].PHP_EOL;
|
Chris@17
|
246 }//end foreach
|
Chris@17
|
247
|
Chris@17
|
248 echo str_repeat('-', $width).PHP_EOL;
|
Chris@17
|
249 echo "\033[1m".'A TOTAL OF '.($totalErrors + $totalWarnings).' SNIFF VIOLATION';
|
Chris@17
|
250 if (($totalErrors + $totalWarnings) > 1) {
|
Chris@17
|
251 echo 'S';
|
Chris@17
|
252 }
|
Chris@17
|
253
|
Chris@17
|
254 echo ' WERE FOUND IN '.count($sources).' SOURCE';
|
Chris@17
|
255 if (count($sources) !== 1) {
|
Chris@17
|
256 echo 'S';
|
Chris@17
|
257 }
|
Chris@17
|
258
|
Chris@17
|
259 echo "\033[0m";
|
Chris@17
|
260
|
Chris@17
|
261 if ($totalFixable > 0) {
|
Chris@17
|
262 echo PHP_EOL.str_repeat('-', $width).PHP_EOL;
|
Chris@17
|
263 echo "\033[1mPHPCBF CAN FIX THE $fixableSources MARKED SOURCES AUTOMATICALLY ($totalFixable VIOLATIONS IN TOTAL)\033[0m";
|
Chris@17
|
264 }
|
Chris@17
|
265
|
Chris@17
|
266 echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL;
|
Chris@17
|
267
|
Chris@17
|
268 if ($toScreen === true && $interactive === false) {
|
Chris@17
|
269 Timing::printRunTime();
|
Chris@17
|
270 }
|
Chris@17
|
271
|
Chris@17
|
272 }//end generate()
|
Chris@17
|
273
|
Chris@17
|
274
|
Chris@17
|
275 /**
|
Chris@17
|
276 * Converts a camel caps name into a readable string.
|
Chris@17
|
277 *
|
Chris@17
|
278 * @param string $name The camel caps name to convert.
|
Chris@17
|
279 *
|
Chris@17
|
280 * @return string
|
Chris@17
|
281 */
|
Chris@17
|
282 public function makeFriendlyName($name)
|
Chris@17
|
283 {
|
Chris@17
|
284 if (trim($name) === '') {
|
Chris@17
|
285 return '';
|
Chris@17
|
286 }
|
Chris@17
|
287
|
Chris@17
|
288 $friendlyName = '';
|
Chris@17
|
289 $length = strlen($name);
|
Chris@17
|
290
|
Chris@17
|
291 $lastWasUpper = false;
|
Chris@17
|
292 $lastWasNumeric = false;
|
Chris@17
|
293 for ($i = 0; $i < $length; $i++) {
|
Chris@17
|
294 if (is_numeric($name[$i]) === true) {
|
Chris@17
|
295 if ($lastWasNumeric === false) {
|
Chris@17
|
296 $friendlyName .= ' ';
|
Chris@17
|
297 }
|
Chris@17
|
298
|
Chris@17
|
299 $lastWasUpper = false;
|
Chris@17
|
300 $lastWasNumeric = true;
|
Chris@17
|
301 } else {
|
Chris@17
|
302 $lastWasNumeric = false;
|
Chris@17
|
303
|
Chris@17
|
304 $char = strtolower($name[$i]);
|
Chris@17
|
305 if ($char === $name[$i]) {
|
Chris@17
|
306 // Lowercase.
|
Chris@17
|
307 $lastWasUpper = false;
|
Chris@17
|
308 } else {
|
Chris@17
|
309 // Uppercase.
|
Chris@17
|
310 if ($lastWasUpper === false) {
|
Chris@17
|
311 $friendlyName .= ' ';
|
Chris@17
|
312 if ($i < ($length - 1)) {
|
Chris@17
|
313 $next = $name[($i + 1)];
|
Chris@17
|
314 if (strtolower($next) === $next) {
|
Chris@17
|
315 // Next char is lowercase so it is a word boundary.
|
Chris@17
|
316 $name[$i] = strtolower($name[$i]);
|
Chris@17
|
317 }
|
Chris@17
|
318 }
|
Chris@17
|
319 }
|
Chris@17
|
320
|
Chris@17
|
321 $lastWasUpper = true;
|
Chris@17
|
322 }
|
Chris@17
|
323 }//end if
|
Chris@17
|
324
|
Chris@17
|
325 $friendlyName .= $name[$i];
|
Chris@17
|
326 }//end for
|
Chris@17
|
327
|
Chris@17
|
328 $friendlyName = trim($friendlyName);
|
Chris@17
|
329 $friendlyName[0] = strtoupper($friendlyName[0]);
|
Chris@17
|
330
|
Chris@17
|
331 return $friendlyName;
|
Chris@17
|
332
|
Chris@17
|
333 }//end makeFriendlyName()
|
Chris@17
|
334
|
Chris@17
|
335
|
Chris@17
|
336 }//end class
|