| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283 |
- <?php
- /*
- * This file is part of the php-code-coverage package.
- *
- * (c) Sebastian Bergmann <sebastian@phpunit.de>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace SebastianBergmann\CodeCoverage\Report;
- use SebastianBergmann\CodeCoverage\CodeCoverage;
- use SebastianBergmann\CodeCoverage\Node\File;
- use SebastianBergmann\CodeCoverage\Util;
- /**
- * Generates human readable output from a code coverage object.
- *
- * The output gets put into a text file our written to the CLI.
- */
- final class Text
- {
- /**
- * @var string
- */
- private const COLOR_GREEN = "\x1b[30;42m";
- /**
- * @var string
- */
- private const COLOR_YELLOW = "\x1b[30;43m";
- /**
- * @var string
- */
- private const COLOR_RED = "\x1b[37;41m";
- /**
- * @var string
- */
- private const COLOR_HEADER = "\x1b[1;37;40m";
- /**
- * @var string
- */
- private const COLOR_RESET = "\x1b[0m";
- /**
- * @var string
- */
- private const COLOR_EOL = "\x1b[2K";
- /**
- * @var int
- */
- private $lowUpperBound;
- /**
- * @var int
- */
- private $highLowerBound;
- /**
- * @var bool
- */
- private $showUncoveredFiles;
- /**
- * @var bool
- */
- private $showOnlySummary;
- public function __construct(int $lowUpperBound = 50, int $highLowerBound = 90, bool $showUncoveredFiles = false, bool $showOnlySummary = false)
- {
- $this->lowUpperBound = $lowUpperBound;
- $this->highLowerBound = $highLowerBound;
- $this->showUncoveredFiles = $showUncoveredFiles;
- $this->showOnlySummary = $showOnlySummary;
- }
- public function process(CodeCoverage $coverage, bool $showColors = false): string
- {
- $output = \PHP_EOL . \PHP_EOL;
- $report = $coverage->getReport();
- $colors = [
- 'header' => '',
- 'classes' => '',
- 'methods' => '',
- 'lines' => '',
- 'reset' => '',
- 'eol' => '',
- ];
- if ($showColors) {
- $colors['classes'] = $this->getCoverageColor(
- $report->getNumTestedClassesAndTraits(),
- $report->getNumClassesAndTraits()
- );
- $colors['methods'] = $this->getCoverageColor(
- $report->getNumTestedMethods(),
- $report->getNumMethods()
- );
- $colors['lines'] = $this->getCoverageColor(
- $report->getNumExecutedLines(),
- $report->getNumExecutableLines()
- );
- $colors['reset'] = self::COLOR_RESET;
- $colors['header'] = self::COLOR_HEADER;
- $colors['eol'] = self::COLOR_EOL;
- }
- $classes = \sprintf(
- ' Classes: %6s (%d/%d)',
- Util::percent(
- $report->getNumTestedClassesAndTraits(),
- $report->getNumClassesAndTraits(),
- true
- ),
- $report->getNumTestedClassesAndTraits(),
- $report->getNumClassesAndTraits()
- );
- $methods = \sprintf(
- ' Methods: %6s (%d/%d)',
- Util::percent(
- $report->getNumTestedMethods(),
- $report->getNumMethods(),
- true
- ),
- $report->getNumTestedMethods(),
- $report->getNumMethods()
- );
- $lines = \sprintf(
- ' Lines: %6s (%d/%d)',
- Util::percent(
- $report->getNumExecutedLines(),
- $report->getNumExecutableLines(),
- true
- ),
- $report->getNumExecutedLines(),
- $report->getNumExecutableLines()
- );
- $padding = \max(\array_map('strlen', [$classes, $methods, $lines]));
- if ($this->showOnlySummary) {
- $title = 'Code Coverage Report Summary:';
- $padding = \max($padding, \strlen($title));
- $output .= $this->format($colors['header'], $padding, $title);
- } else {
- $date = \date(' Y-m-d H:i:s', $_SERVER['REQUEST_TIME']);
- $title = 'Code Coverage Report:';
- $output .= $this->format($colors['header'], $padding, $title);
- $output .= $this->format($colors['header'], $padding, $date);
- $output .= $this->format($colors['header'], $padding, '');
- $output .= $this->format($colors['header'], $padding, ' Summary:');
- }
- $output .= $this->format($colors['classes'], $padding, $classes);
- $output .= $this->format($colors['methods'], $padding, $methods);
- $output .= $this->format($colors['lines'], $padding, $lines);
- if ($this->showOnlySummary) {
- return $output . \PHP_EOL;
- }
- $classCoverage = [];
- foreach ($report as $item) {
- if (!$item instanceof File) {
- continue;
- }
- $classes = $item->getClassesAndTraits();
- foreach ($classes as $className => $class) {
- $classStatements = 0;
- $coveredClassStatements = 0;
- $coveredMethods = 0;
- $classMethods = 0;
- foreach ($class['methods'] as $method) {
- if ($method['executableLines'] == 0) {
- continue;
- }
- $classMethods++;
- $classStatements += $method['executableLines'];
- $coveredClassStatements += $method['executedLines'];
- if ($method['coverage'] == 100) {
- $coveredMethods++;
- }
- }
- $namespace = '';
- if (!empty($class['package']['namespace'])) {
- $namespace = '\\' . $class['package']['namespace'] . '::';
- } elseif (!empty($class['package']['fullPackage'])) {
- $namespace = '@' . $class['package']['fullPackage'] . '::';
- }
- $classCoverage[$namespace . $className] = [
- 'namespace' => $namespace,
- 'className ' => $className,
- 'methodsCovered' => $coveredMethods,
- 'methodCount' => $classMethods,
- 'statementsCovered' => $coveredClassStatements,
- 'statementCount' => $classStatements,
- ];
- }
- }
- \ksort($classCoverage);
- $methodColor = '';
- $linesColor = '';
- $resetColor = '';
- foreach ($classCoverage as $fullQualifiedPath => $classInfo) {
- if ($this->showUncoveredFiles || $classInfo['statementsCovered'] != 0) {
- if ($showColors) {
- $methodColor = $this->getCoverageColor($classInfo['methodsCovered'], $classInfo['methodCount']);
- $linesColor = $this->getCoverageColor($classInfo['statementsCovered'], $classInfo['statementCount']);
- $resetColor = $colors['reset'];
- }
- $output .= \PHP_EOL . $fullQualifiedPath . \PHP_EOL
- . ' ' . $methodColor . 'Methods: ' . $this->printCoverageCounts($classInfo['methodsCovered'], $classInfo['methodCount'], 2) . $resetColor . ' '
- . ' ' . $linesColor . 'Lines: ' . $this->printCoverageCounts($classInfo['statementsCovered'], $classInfo['statementCount'], 3) . $resetColor;
- }
- }
- return $output . \PHP_EOL;
- }
- private function getCoverageColor(int $numberOfCoveredElements, int $totalNumberOfElements): string
- {
- $coverage = Util::percent(
- $numberOfCoveredElements,
- $totalNumberOfElements
- );
- if ($coverage >= $this->highLowerBound) {
- return self::COLOR_GREEN;
- }
- if ($coverage > $this->lowUpperBound) {
- return self::COLOR_YELLOW;
- }
- return self::COLOR_RED;
- }
- private function printCoverageCounts(int $numberOfCoveredElements, int $totalNumberOfElements, int $precision): string
- {
- $format = '%' . $precision . 's';
- return Util::percent(
- $numberOfCoveredElements,
- $totalNumberOfElements,
- true,
- true
- ) .
- ' (' . \sprintf($format, $numberOfCoveredElements) . '/' .
- \sprintf($format, $totalNumberOfElements) . ')';
- }
- private function format($color, $padding, $string): string
- {
- $reset = $color ? self::COLOR_RESET : '';
- return $color . \str_pad($string, $padding) . $reset . \PHP_EOL;
- }
- }
|