Chris@4: Chris@4: * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) Chris@4: * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence Chris@4: */ Chris@4: Chris@4: namespace PHP_CodeSniffer\Reports; Chris@4: Chris@4: use PHP_CodeSniffer\Files\File; Chris@4: use PHP_CodeSniffer\Util; Chris@4: Chris@4: class Summary implements Report Chris@4: { Chris@4: Chris@4: Chris@4: /** Chris@4: * Generate a partial report for a single processed file. Chris@4: * Chris@4: * Function should return TRUE if it printed or stored data about the file Chris@4: * and FALSE if it ignored the file. Returning TRUE indicates that the file and Chris@4: * its data should be counted in the grand totals. Chris@4: * Chris@4: * @param array $report Prepared report data. Chris@4: * @param \PHP_CodeSniffer\File $phpcsFile The file being reported on. Chris@4: * @param bool $showSources Show sources? Chris@4: * @param int $width Maximum allowed line width. Chris@4: * Chris@4: * @return bool Chris@4: */ Chris@4: public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80) Chris@4: { Chris@4: if (PHP_CODESNIFFER_VERBOSITY === 0 Chris@4: && $report['errors'] === 0 Chris@4: && $report['warnings'] === 0 Chris@4: ) { Chris@4: // Nothing to print. Chris@4: return false; Chris@4: } Chris@4: Chris@4: echo $report['filename'].'>>'.$report['errors'].'>>'.$report['warnings'].PHP_EOL; Chris@4: return true; Chris@4: Chris@4: }//end generateFileReport() Chris@4: Chris@4: Chris@4: /** Chris@4: * Generates a summary of errors and warnings for each file processed. Chris@4: * Chris@4: * @param string $cachedData Any partial report data that was returned from Chris@4: * generateFileReport during the run. Chris@4: * @param int $totalFiles Total number of files processed during the run. Chris@4: * @param int $totalErrors Total number of errors found during the run. Chris@4: * @param int $totalWarnings Total number of warnings found during the run. Chris@4: * @param int $totalFixable Total number of problems that can be fixed. Chris@4: * @param bool $showSources Show sources? Chris@4: * @param int $width Maximum allowed line width. Chris@4: * @param bool $interactive Are we running in interactive mode? Chris@4: * @param bool $toScreen Is the report being printed to screen? Chris@4: * Chris@4: * @return void Chris@4: */ Chris@4: public function generate( Chris@4: $cachedData, Chris@4: $totalFiles, Chris@4: $totalErrors, Chris@4: $totalWarnings, Chris@4: $totalFixable, Chris@4: $showSources=false, Chris@4: $width=80, Chris@4: $interactive=false, Chris@4: $toScreen=true Chris@4: ) { Chris@4: $lines = explode(PHP_EOL, $cachedData); Chris@4: array_pop($lines); Chris@4: Chris@4: if (empty($lines) === true) { Chris@4: return; Chris@4: } Chris@4: Chris@4: $reportFiles = []; Chris@4: $maxLength = 0; Chris@4: Chris@4: foreach ($lines as $line) { Chris@4: $parts = explode('>>', $line); Chris@4: $fileLen = strlen($parts[0]); Chris@4: $reportFiles[$parts[0]] = [ Chris@4: 'errors' => $parts[1], Chris@4: 'warnings' => $parts[2], Chris@4: 'strlen' => $fileLen, Chris@4: ]; Chris@4: Chris@4: $maxLength = max($maxLength, $fileLen); Chris@4: } Chris@4: Chris@4: uksort( Chris@4: $reportFiles, Chris@4: function ($keyA, $keyB) { Chris@4: $pathPartsA = explode(DIRECTORY_SEPARATOR, $keyA); Chris@4: $pathPartsB = explode(DIRECTORY_SEPARATOR, $keyB); Chris@4: Chris@4: do { Chris@4: $partA = array_shift($pathPartsA); Chris@4: $partB = array_shift($pathPartsB); Chris@4: } while ($partA === $partB && empty($pathPartsA) === false && empty($pathPartsB) === false); Chris@4: Chris@4: if (empty($pathPartsA) === false && empty($pathPartsB) === true) { Chris@4: return 1; Chris@4: } else if (empty($pathPartsA) === true && empty($pathPartsB) === false) { Chris@4: return -1; Chris@4: } else { Chris@4: return strcasecmp($partA, $partB); Chris@4: } Chris@4: } Chris@4: ); Chris@4: Chris@4: $width = min($width, ($maxLength + 21)); Chris@4: $width = max($width, 70); Chris@4: Chris@4: echo PHP_EOL."\033[1m".'PHP CODE SNIFFER REPORT SUMMARY'."\033[0m".PHP_EOL; Chris@4: echo str_repeat('-', $width).PHP_EOL; Chris@4: echo "\033[1m".'FILE'.str_repeat(' ', ($width - 20)).'ERRORS WARNINGS'."\033[0m".PHP_EOL; Chris@4: echo str_repeat('-', $width).PHP_EOL; Chris@4: Chris@4: foreach ($reportFiles as $file => $data) { Chris@4: $padding = ($width - 18 - $data['strlen']); Chris@4: if ($padding < 0) { Chris@4: $file = '...'.substr($file, (($padding * -1) + 3)); Chris@4: $padding = 0; Chris@4: } Chris@4: Chris@4: echo $file.str_repeat(' ', $padding).' '; Chris@4: if ($data['errors'] !== 0) { Chris@4: echo "\033[31m".$data['errors']."\033[0m"; Chris@4: echo str_repeat(' ', (8 - strlen((string) $data['errors']))); Chris@4: } else { Chris@4: echo '0 '; Chris@4: } Chris@4: Chris@4: if ($data['warnings'] !== 0) { Chris@4: echo "\033[33m".$data['warnings']."\033[0m"; Chris@4: } else { Chris@4: echo '0'; Chris@4: } Chris@4: Chris@4: echo PHP_EOL; Chris@4: }//end foreach Chris@4: Chris@4: echo str_repeat('-', $width).PHP_EOL; Chris@4: echo "\033[1mA TOTAL OF $totalErrors ERROR"; Chris@4: if ($totalErrors !== 1) { Chris@4: echo 'S'; Chris@4: } Chris@4: Chris@4: echo ' AND '.$totalWarnings.' WARNING'; Chris@4: if ($totalWarnings !== 1) { Chris@4: echo 'S'; Chris@4: } Chris@4: Chris@4: echo ' WERE FOUND IN '.$totalFiles.' FILE'; Chris@4: if ($totalFiles !== 1) { Chris@4: echo 'S'; Chris@4: } Chris@4: Chris@4: echo "\033[0m"; Chris@4: Chris@4: if ($totalFixable > 0) { Chris@4: echo PHP_EOL.str_repeat('-', $width).PHP_EOL; Chris@4: echo "\033[1mPHPCBF CAN FIX $totalFixable OF THESE SNIFF VIOLATIONS AUTOMATICALLY\033[0m"; Chris@4: } Chris@4: Chris@4: echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL; Chris@4: Chris@4: if ($toScreen === true && $interactive === false) { Chris@4: Util\Timing::printRunTime(); Chris@4: } Chris@4: Chris@4: }//end generate() Chris@4: Chris@4: Chris@4: }//end class