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