function VersionControl::generate

Prints the author of all errors and warnings, as given by "version control blame".

Parameters

string $cachedData Any partial report data that was returned from: generateFileReport during the run.

int $totalFiles Total number of files processed during the run.:

int $totalErrors Total number of errors found during the run.:

int $totalWarnings Total number of warnings found during the run.:

int $totalFixable Total number of problems that can be fixed.:

bool $showSources Show sources?:

int $width Maximum allowed line width.:

bool $interactive Are we running in interactive mode?:

bool $toScreen Is the report being printed to screen?:

Return value

void

Overrides Report::generate

File

vendor/squizlabs/php_codesniffer/src/Reports/VersionControl.php, line 151

Class

VersionControl

Namespace

PHP_CodeSniffer\Reports

Code

public function generate($cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources = false, $width = 80, $interactive = false, $toScreen = true) {
    $errorsShown = $totalErrors + $totalWarnings;
    if ($errorsShown === 0) {
        // Nothing to show.
        return;
    }
    $lines = explode(PHP_EOL, $cachedData);
    array_pop($lines);
    if (empty($lines) === true) {
        return;
    }
    $authorCache = [];
    $praiseCache = [];
    $sourceCache = [];
    foreach ($lines as $line) {
        $parts = explode('>>', $line);
        switch ($parts[0]) {
            case 'AUTHOR':
                if (isset($authorCache[$parts[1]]) === false) {
                    $authorCache[$parts[1]] = $parts[2];
                }
                else {
                    $authorCache[$parts[1]] += $parts[2];
                }
                break;
            case 'PRAISE':
                if (isset($praiseCache[$parts[1]]) === false) {
                    $praiseCache[$parts[1]] = [
                        'good' => $parts[2],
                        'bad' => $parts[3],
                    ];
                }
                else {
                    $praiseCache[$parts[1]]['good'] += $parts[2];
                    $praiseCache[$parts[1]]['bad'] += $parts[3];
                }
                break;
            case 'SOURCE':
                if (isset($praiseCache[$parts[1]]) === false) {
                    $praiseCache[$parts[1]] = [];
                }
                if (isset($sourceCache[$parts[1]][$parts[2]]) === false) {
                    $sourceCache[$parts[1]][$parts[2]] = [
                        'count' => $parts[3],
                        'fixable' => (bool) $parts[4],
                    ];
                }
                else {
                    $sourceCache[$parts[1]][$parts[2]]['count'] += $parts[3];
                }
                break;
            default:
                break;
        }
        
        //end switch
    }
    
    //end foreach
    // Make sure the report width isn't too big.
    $maxLength = 0;
    foreach ($authorCache as $author => $count) {
        $maxLength = max($maxLength, strlen($author));
        if ($showSources === true && isset($sourceCache[$author]) === true) {
            foreach ($sourceCache[$author] as $source => $sourceData) {
                if ($source === 'count') {
                    continue;
                }
                $maxLength = max($maxLength, strlen($source) + 9);
            }
        }
    }
    $width = min($width, $maxLength + 30);
    $width = max($width, 70);
    arsort($authorCache);
    echo PHP_EOL . "\x1b[1m" . 'PHP CODE SNIFFER ' . $this->reportName . ' BLAME SUMMARY' . "\x1b[0m" . PHP_EOL;
    echo str_repeat('-', $width) . PHP_EOL . "\x1b[1m";
    if ($showSources === true) {
        echo 'AUTHOR   SOURCE' . str_repeat(' ', $width - 43) . '(Author %) (Overall %) COUNT' . PHP_EOL;
        echo str_repeat('-', $width) . PHP_EOL;
    }
    else {
        echo 'AUTHOR' . str_repeat(' ', $width - 34) . '(Author %) (Overall %) COUNT' . PHP_EOL;
        echo str_repeat('-', $width) . PHP_EOL;
    }
    echo "\x1b[0m";
    if ($showSources === true) {
        $maxSniffWidth = $width - 15;
        if ($totalFixable > 0) {
            $maxSniffWidth -= 4;
        }
    }
    $fixableSources = 0;
    foreach ($authorCache as $author => $count) {
        if ($praiseCache[$author]['good'] === 0) {
            $percent = 0;
        }
        else {
            $total = $praiseCache[$author]['bad'] + $praiseCache[$author]['good'];
            $percent = round($praiseCache[$author]['bad'] / $total * 100, 2);
        }
        $overallPercent = '(' . round($count / $errorsShown * 100, 2) . ')';
        $authorPercent = '(' . $percent . ')';
        $line = str_repeat(' ', 6 - strlen($count)) . $count;
        $line = str_repeat(' ', 12 - strlen($overallPercent)) . $overallPercent . $line;
        $line = str_repeat(' ', 11 - strlen($authorPercent)) . $authorPercent . $line;
        $line = $author . str_repeat(' ', $width - strlen($author) - strlen($line)) . $line;
        if ($showSources === true) {
            $line = "\x1b[1m{$line}\x1b[0m";
        }
        echo $line . PHP_EOL;
        if ($showSources === true && isset($sourceCache[$author]) === true) {
            $errors = $sourceCache[$author];
            asort($errors);
            $errors = array_reverse($errors);
            foreach ($errors as $source => $sourceData) {
                if ($source === 'count') {
                    continue;
                }
                $count = $sourceData['count'];
                $srcLength = strlen($source);
                if ($srcLength > $maxSniffWidth) {
                    $source = substr($source, 0, $maxSniffWidth);
                }
                $line = str_repeat(' ', 5 - strlen($count)) . $count;
                echo '         ';
                if ($totalFixable > 0) {
                    echo '[';
                    if ($sourceData['fixable'] === true) {
                        echo 'x';
                        $fixableSources++;
                    }
                    else {
                        echo ' ';
                    }
                    echo '] ';
                }
                echo $source;
                if ($totalFixable > 0) {
                    echo str_repeat(' ', $width - 18 - strlen($source));
                }
                else {
                    echo str_repeat(' ', $width - 14 - strlen($source));
                }
                echo $line . PHP_EOL;
            }
            
            //end foreach
        }
        
        //end if
    }
    
    //end foreach
    echo str_repeat('-', $width) . PHP_EOL;
    echo "\x1b[1m" . 'A TOTAL OF ' . $errorsShown . ' SNIFF VIOLATION';
    if ($errorsShown !== 1) {
        echo 'S';
    }
    echo ' WERE COMMITTED BY ' . count($authorCache) . ' AUTHOR';
    if (count($authorCache) !== 1) {
        echo 'S';
    }
    echo "\x1b[0m";
    if ($totalFixable > 0) {
        if ($showSources === true) {
            echo PHP_EOL . str_repeat('-', $width) . PHP_EOL;
            echo "\x1b[1mPHPCBF CAN FIX THE {$fixableSources} MARKED SOURCES AUTOMATICALLY ({$totalFixable} VIOLATIONS IN TOTAL)\x1b[0m";
        }
        else {
            echo PHP_EOL . str_repeat('-', $width) . PHP_EOL;
            echo "\x1b[1mPHPCBF CAN FIX {$totalFixable} OF THESE SNIFF VIOLATIONS AUTOMATICALLY\x1b[0m";
        }
    }
    echo PHP_EOL . str_repeat('-', $width) . PHP_EOL . PHP_EOL;
    if ($toScreen === true && $interactive === false) {
        Timing::printRunTime();
    }
}