*/
- private $unintentionallyCoveredSubclassesWhitelist = [];
+ private $parentClassesExcludedFromUnintentionallyCoveredCodeCheck = [];
/**
- * Determine if the data has been initialized or not
- *
- * @var bool
+ * @var ?FileAnalyser
*/
- private $isInitialized = false;
+ private $analyser;
/**
- * Determine whether we need to check for dead and unused code on each test
- *
- * @var bool
+ * @var ?string
*/
- private $shouldCheckForDeadAndUnused = true;
+ private $cacheDirectory;
- /**
- * @var Directory
- */
- private $report;
-
- /**
- * @throws RuntimeException
- */
- public function __construct(Driver $driver = null, Filter $filter = null)
+ public function __construct(Driver $driver, Filter $filter)
{
- if ($filter === null) {
- $filter = new Filter;
- }
-
- if ($driver === null) {
- $driver = $this->selectDriver($filter);
- }
-
$this->driver = $driver;
$this->filter = $filter;
-
+ $this->data = new ProcessedCodeCoverageData;
$this->wizard = new Wizard;
}
@@ -4551,11 +26643,7 @@ final class CodeCoverage
*/
public function getReport(): Directory
{
- if ($this->report === null) {
- $this->report = (new Builder)->build($this);
- }
-
- return $this->report;
+ return (new Builder($this->analyser()))->build($this);
}
/**
@@ -4563,11 +26651,9 @@ final class CodeCoverage
*/
public function clear(): void
{
- $this->isInitialized = false;
- $this->currentId = null;
- $this->data = [];
- $this->tests = [];
- $this->report = null;
+ $this->currentId = null;
+ $this->data = new ProcessedCodeCoverageData;
+ $this->tests = [];
}
/**
@@ -4581,10 +26667,14 @@ final class CodeCoverage
/**
* Returns the collected code coverage data.
*/
- public function getData(bool $raw = false): array
+ public function getData(bool $raw = false): ProcessedCodeCoverageData
{
- if (!$raw && $this->addUncoveredFilesFromWhitelist) {
- $this->addUncoveredFilesFromWhitelist();
+ if (!$raw) {
+ if ($this->processUncoveredFiles) {
+ $this->processUncoveredFilesFromFilter();
+ } elseif ($this->includeUncoveredFiles) {
+ $this->addUncoveredFilesFromFilter();
+ }
}
return $this->data;
@@ -4593,10 +26683,9 @@ final class CodeCoverage
/**
* Sets the coverage data.
*/
- public function setData(array $data): void
+ public function setData(ProcessedCodeCoverageData $data): void
{
- $this->data = $data;
- $this->report = null;
+ $this->data = $data;
}
/**
@@ -4619,8 +26708,6 @@ final class CodeCoverage
* Start collection of code coverage information.
*
* @param PhptTestCase|string|TestCase $id
- *
- * @throws RuntimeException
*/
public function start($id, bool $clear = false): void
{
@@ -4628,37 +26715,26 @@ final class CodeCoverage
$this->clear();
}
- if ($this->isInitialized === false) {
- $this->initializeData();
- }
-
$this->currentId = $id;
- $this->driver->start($this->shouldCheckForDeadAndUnused);
+ $this->driver->start();
}
/**
* Stop collection of code coverage information.
*
* @param array|false $linesToBeCovered
- *
- * @throws MissingCoversAnnotationException
- * @throws CoveredCodeNotExecutedException
- * @throws RuntimeException
- * @throws InvalidArgumentException
- * @throws \ReflectionException
*/
- public function stop(bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = [], bool $ignoreForceCoversAnnotation = false): array
+ public function stop(bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = []): RawCodeCoverageData
{
- if (!\is_array($linesToBeCovered) && $linesToBeCovered !== false) {
- throw InvalidArgumentException::create(
- 2,
- 'array or false'
+ if (!is_array($linesToBeCovered) && $linesToBeCovered !== false) {
+ throw new InvalidArgumentException(
+ '$linesToBeCovered must be an array or false'
);
}
$data = $this->driver->stop();
- $this->append($data, null, $append, $linesToBeCovered, $linesToBeUsed, $ignoreForceCoversAnnotation);
+ $this->append($data, null, $append, $linesToBeCovered, $linesToBeUsed);
$this->currentId = null;
@@ -4671,215 +26747,197 @@ final class CodeCoverage
* @param PhptTestCase|string|TestCase $id
* @param array|false $linesToBeCovered
*
- * @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
- * @throws \SebastianBergmann\CodeCoverage\MissingCoversAnnotationException
- * @throws \SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException
- * @throws \ReflectionException
- * @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
- * @throws RuntimeException
+ * @throws ReflectionException
+ * @throws TestIdMissingException
+ * @throws UnintentionallyCoveredCodeException
*/
- public function append(array $data, $id = null, bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = [], bool $ignoreForceCoversAnnotation = false): void
+ public function append(RawCodeCoverageData $rawData, $id = null, bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = []): void
{
if ($id === null) {
$id = $this->currentId;
}
if ($id === null) {
- throw new RuntimeException;
+ throw new TestIdMissingException;
}
- $this->applyWhitelistFilter($data);
- $this->applyIgnoredLinesFilter($data);
- $this->initializeFilesThatAreSeenTheFirstTime($data);
+ $this->applyFilter($rawData);
+
+ $this->applyExecutableLinesFilter($rawData);
+
+ if ($this->useAnnotationsForIgnoringCode) {
+ $this->applyIgnoredLinesFilter($rawData);
+ }
+
+ $this->data->initializeUnseenData($rawData);
if (!$append) {
return;
}
- if ($id !== 'UNCOVERED_FILES_FROM_WHITELIST') {
+ if ($id !== self::UNCOVERED_FILES) {
$this->applyCoversAnnotationFilter(
- $data,
+ $rawData,
$linesToBeCovered,
- $linesToBeUsed,
- $ignoreForceCoversAnnotation
+ $linesToBeUsed
);
- }
- if (empty($data)) {
- return;
- }
-
- $size = 'unknown';
- $status = -1;
-
- if ($id instanceof TestCase) {
- $_size = $id->getSize();
-
- if ($_size === Test::SMALL) {
- $size = 'small';
- } elseif ($_size === Test::MEDIUM) {
- $size = 'medium';
- } elseif ($_size === Test::LARGE) {
- $size = 'large';
+ if (empty($rawData->lineCoverage())) {
+ return;
}
- $status = $id->getStatus();
- $id = \get_class($id) . '::' . $id->getName();
- } elseif ($id instanceof PhptTestCase) {
- $size = 'large';
- $id = $id->getName();
- }
+ $size = 'unknown';
+ $status = -1;
+ $fromTestcase = false;
- $this->tests[$id] = ['size' => $size, 'status' => $status];
+ if ($id instanceof TestCase) {
+ $fromTestcase = true;
+ $_size = $id->getSize();
- foreach ($data as $file => $lines) {
- if (!$this->filter->isFile($file)) {
- continue;
- }
-
- foreach ($lines as $k => $v) {
- if ($v === Driver::LINE_EXECUTED) {
- if (empty($this->data[$file][$k]) || !\in_array($id, $this->data[$file][$k])) {
- $this->data[$file][$k][] = $id;
- }
+ if ($_size === Test::SMALL) {
+ $size = 'small';
+ } elseif ($_size === Test::MEDIUM) {
+ $size = 'medium';
+ } elseif ($_size === Test::LARGE) {
+ $size = 'large';
}
- }
- }
- $this->report = null;
+ $status = $id->getStatus();
+ $id = get_class($id) . '::' . $id->getName();
+ } elseif ($id instanceof PhptTestCase) {
+ $fromTestcase = true;
+ $size = 'large';
+ $id = $id->getName();
+ }
+
+ $this->tests[$id] = ['size' => $size, 'status' => $status, 'fromTestcase' => $fromTestcase];
+
+ $this->data->markCodeAsExecutedByTestCase($id, $rawData);
+ }
}
/**
* Merges the data from another instance.
- *
- * @param CodeCoverage $that
*/
public function merge(self $that): void
{
- $this->filter->setWhitelistedFiles(
- \array_merge($this->filter->getWhitelistedFiles(), $that->filter()->getWhitelistedFiles())
+ $this->filter->includeFiles(
+ $that->filter()->files()
);
- foreach ($that->data as $file => $lines) {
- if (!isset($this->data[$file])) {
- if (!$this->filter->isFiltered($file)) {
- $this->data[$file] = $lines;
- }
+ $this->data->merge($that->data);
- continue;
- }
-
- // we should compare the lines if any of two contains data
- $compareLineNumbers = \array_unique(
- \array_merge(
- \array_keys($this->data[$file]),
- \array_keys($that->data[$file])
- )
- );
-
- foreach ($compareLineNumbers as $line) {
- $thatPriority = $this->getLinePriority($that->data[$file], $line);
- $thisPriority = $this->getLinePriority($this->data[$file], $line);
-
- if ($thatPriority > $thisPriority) {
- $this->data[$file][$line] = $that->data[$file][$line];
- } elseif ($thatPriority === $thisPriority && \is_array($this->data[$file][$line])) {
- $this->data[$file][$line] = \array_unique(
- \array_merge($this->data[$file][$line], $that->data[$file][$line])
- );
- }
- }
- }
-
- $this->tests = \array_merge($this->tests, $that->getTests());
- $this->report = null;
+ $this->tests = array_merge($this->tests, $that->getTests());
}
- public function setCacheTokens(bool $flag): void
+ public function enableCheckForUnintentionallyCoveredCode(): void
{
- $this->cacheTokens = $flag;
+ $this->checkForUnintentionallyCoveredCode = true;
}
- public function getCacheTokens(): bool
+ public function disableCheckForUnintentionallyCoveredCode(): void
{
- return $this->cacheTokens;
+ $this->checkForUnintentionallyCoveredCode = false;
}
- public function setCheckForUnintentionallyCoveredCode(bool $flag): void
+ public function includeUncoveredFiles(): void
{
- $this->checkForUnintentionallyCoveredCode = $flag;
+ $this->includeUncoveredFiles = true;
}
- public function setForceCoversAnnotation(bool $flag): void
+ public function excludeUncoveredFiles(): void
{
- $this->forceCoversAnnotation = $flag;
+ $this->includeUncoveredFiles = false;
}
- public function setCheckForMissingCoversAnnotation(bool $flag): void
+ public function processUncoveredFiles(): void
{
- $this->checkForMissingCoversAnnotation = $flag;
+ $this->processUncoveredFiles = true;
}
- public function setCheckForUnexecutedCoveredCode(bool $flag): void
+ public function doNotProcessUncoveredFiles(): void
{
- $this->checkForUnexecutedCoveredCode = $flag;
+ $this->processUncoveredFiles = false;
}
- public function setAddUncoveredFilesFromWhitelist(bool $flag): void
+ public function enableAnnotationsForIgnoringCode(): void
{
- $this->addUncoveredFilesFromWhitelist = $flag;
+ $this->useAnnotationsForIgnoringCode = true;
}
- public function setProcessUncoveredFilesFromWhitelist(bool $flag): void
+ public function disableAnnotationsForIgnoringCode(): void
{
- $this->processUncoveredFilesFromWhitelist = $flag;
+ $this->useAnnotationsForIgnoringCode = false;
}
- public function setDisableIgnoredLines(bool $flag): void
+ public function ignoreDeprecatedCode(): void
{
- $this->disableIgnoredLines = $flag;
+ $this->ignoreDeprecatedCode = true;
}
- public function setIgnoreDeprecatedCode(bool $flag): void
+ public function doNotIgnoreDeprecatedCode(): void
{
- $this->ignoreDeprecatedCode = $flag;
- }
-
- public function setUnintentionallyCoveredSubclassesWhitelist(array $whitelist): void
- {
- $this->unintentionallyCoveredSubclassesWhitelist = $whitelist;
+ $this->ignoreDeprecatedCode = false;
}
/**
- * Determine the priority for a line
- *
- * 1 = the line is not set
- * 2 = the line has not been tested
- * 3 = the line is dead code
- * 4 = the line has been tested
- *
- * During a merge, a higher number is better.
- *
- * @param array $data
- * @param int $line
- *
- * @return int
+ * @psalm-assert-if-true !null $this->cacheDirectory
*/
- private function getLinePriority($data, $line)
+ public function cachesStaticAnalysis(): bool
{
- if (!\array_key_exists($line, $data)) {
- return 1;
+ return $this->cacheDirectory !== null;
+ }
+
+ public function cacheStaticAnalysis(string $directory): void
+ {
+ $this->cacheDirectory = $directory;
+ }
+
+ public function doNotCacheStaticAnalysis(): void
+ {
+ $this->cacheDirectory = null;
+ }
+
+ /**
+ * @throws StaticAnalysisCacheNotConfiguredException
+ */
+ public function cacheDirectory(): string
+ {
+ if (!$this->cachesStaticAnalysis()) {
+ throw new StaticAnalysisCacheNotConfiguredException(
+ 'The static analysis cache is not configured'
+ );
}
- if (\is_array($data[$line]) && \count($data[$line]) === 0) {
- return 2;
- }
+ return $this->cacheDirectory;
+ }
- if ($data[$line] === null) {
- return 3;
- }
+ /**
+ * @psalm-param class-string $className
+ */
+ public function excludeSubclassesOfThisClassFromUnintentionallyCoveredCodeCheck(string $className): void
+ {
+ $this->parentClassesExcludedFromUnintentionallyCoveredCodeCheck[] = $className;
+ }
- return 4;
+ public function enableBranchAndPathCoverage(): void
+ {
+ $this->driver->enableBranchAndPathCoverage();
+ }
+
+ public function disableBranchAndPathCoverage(): void
+ {
+ $this->driver->disableBranchAndPathCoverage();
+ }
+
+ public function collectsBranchAndPathCoverage(): bool
+ {
+ return $this->driver->collectsBranchAndPathCoverage();
+ }
+
+ public function detectsDeadCode(): bool
+ {
+ return $this->driver->detectsDeadCode();
}
/**
@@ -4887,20 +26945,13 @@ final class CodeCoverage
*
* @param array|false $linesToBeCovered
*
- * @throws \SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException
- * @throws \ReflectionException
- * @throws MissingCoversAnnotationException
+ * @throws ReflectionException
* @throws UnintentionallyCoveredCodeException
*/
- private function applyCoversAnnotationFilter(array &$data, $linesToBeCovered, array $linesToBeUsed, bool $ignoreForceCoversAnnotation): void
+ private function applyCoversAnnotationFilter(RawCodeCoverageData $rawData, $linesToBeCovered, array $linesToBeUsed): void
{
- if ($linesToBeCovered === false ||
- ($this->forceCoversAnnotation && empty($linesToBeCovered) && !$ignoreForceCoversAnnotation)) {
- if ($this->checkForMissingCoversAnnotation) {
- throw new MissingCoversAnnotationException;
- }
-
- $data = [];
+ if ($linesToBeCovered === false) {
+ $rawData->clear();
return;
}
@@ -4912,281 +26963,114 @@ final class CodeCoverage
if ($this->checkForUnintentionallyCoveredCode &&
(!$this->currentId instanceof TestCase ||
(!$this->currentId->isMedium() && !$this->currentId->isLarge()))) {
- $this->performUnintentionallyCoveredCodeCheck($data, $linesToBeCovered, $linesToBeUsed);
+ $this->performUnintentionallyCoveredCodeCheck($rawData, $linesToBeCovered, $linesToBeUsed);
}
- if ($this->checkForUnexecutedCoveredCode) {
- $this->performUnexecutedCoveredCodeCheck($data, $linesToBeCovered, $linesToBeUsed);
+ $rawLineData = $rawData->lineCoverage();
+ $filesWithNoCoverage = array_diff_key($rawLineData, $linesToBeCovered);
+
+ foreach (array_keys($filesWithNoCoverage) as $fileWithNoCoverage) {
+ $rawData->removeCoverageDataForFile($fileWithNoCoverage);
}
- $data = \array_intersect_key($data, $linesToBeCovered);
-
- foreach (\array_keys($data) as $filename) {
- $_linesToBeCovered = \array_flip($linesToBeCovered[$filename]);
- $data[$filename] = \array_intersect_key($data[$filename], $_linesToBeCovered);
- }
- }
-
- private function applyWhitelistFilter(array &$data): void
- {
- foreach (\array_keys($data) as $filename) {
- if ($this->filter->isFiltered($filename)) {
- unset($data[$filename]);
+ if (is_array($linesToBeCovered)) {
+ foreach ($linesToBeCovered as $fileToBeCovered => $includedLines) {
+ $rawData->keepLineCoverageDataOnlyForLines($fileToBeCovered, $includedLines);
+ $rawData->keepFunctionCoverageDataOnlyForLines($fileToBeCovered, $includedLines);
}
}
}
- /**
- * @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
- */
- private function applyIgnoredLinesFilter(array &$data): void
+ private function applyFilter(RawCodeCoverageData $data): void
{
- foreach (\array_keys($data) as $filename) {
+ if ($this->filter->isEmpty()) {
+ return;
+ }
+
+ foreach (array_keys($data->lineCoverage()) as $filename) {
+ if ($this->filter->isExcluded($filename)) {
+ $data->removeCoverageDataForFile($filename);
+ }
+ }
+ }
+
+ private function applyExecutableLinesFilter(RawCodeCoverageData $data): void
+ {
+ foreach (array_keys($data->lineCoverage()) as $filename) {
if (!$this->filter->isFile($filename)) {
continue;
}
- foreach ($this->getLinesToBeIgnored($filename) as $line) {
- unset($data[$filename][$line]);
- }
+ $data->keepLineCoverageDataOnlyForLines(
+ $filename,
+ $this->analyser()->executableLinesIn($filename)
+ );
}
}
- private function initializeFilesThatAreSeenTheFirstTime(array $data): void
+ private function applyIgnoredLinesFilter(RawCodeCoverageData $data): void
{
- foreach ($data as $file => $lines) {
- if (!isset($this->data[$file]) && $this->filter->isFile($file)) {
- $this->data[$file] = [];
-
- foreach ($lines as $k => $v) {
- $this->data[$file][$k] = $v === -2 ? null : [];
- }
+ foreach (array_keys($data->lineCoverage()) as $filename) {
+ if (!$this->filter->isFile($filename)) {
+ continue;
}
+
+ $data->removeCoverageDataForLines(
+ $filename,
+ $this->analyser()->ignoredLinesFor($filename)
+ );
}
}
/**
- * @throws CoveredCodeNotExecutedException
- * @throws InvalidArgumentException
- * @throws MissingCoversAnnotationException
- * @throws RuntimeException
* @throws UnintentionallyCoveredCodeException
- * @throws \ReflectionException
*/
- private function addUncoveredFilesFromWhitelist(): void
+ private function addUncoveredFilesFromFilter(): void
{
- $data = [];
- $uncoveredFiles = \array_diff(
- $this->filter->getWhitelist(),
- \array_keys($this->data)
+ $uncoveredFiles = array_diff(
+ $this->filter->files(),
+ $this->data->coveredFiles()
);
foreach ($uncoveredFiles as $uncoveredFile) {
- if (!\file_exists($uncoveredFile)) {
- continue;
- }
-
- $data[$uncoveredFile] = [];
-
- $lines = \count(\file($uncoveredFile));
-
- for ($i = 1; $i <= $lines; $i++) {
- $data[$uncoveredFile][$i] = Driver::LINE_NOT_EXECUTED;
+ if (is_file($uncoveredFile)) {
+ $this->append(
+ RawCodeCoverageData::fromUncoveredFile(
+ $uncoveredFile,
+ $this->analyser()
+ ),
+ self::UNCOVERED_FILES
+ );
}
}
-
- $this->append($data, 'UNCOVERED_FILES_FROM_WHITELIST');
- }
-
- private function getLinesToBeIgnored(string $fileName): array
- {
- if (isset($this->ignoredLines[$fileName])) {
- return $this->ignoredLines[$fileName];
- }
-
- try {
- return $this->getLinesToBeIgnoredInner($fileName);
- } catch (\OutOfBoundsException $e) {
- // This can happen with PHP_Token_Stream if the file is syntactically invalid,
- // and probably affects a file that wasn't executed.
- return [];
- }
- }
-
- private function getLinesToBeIgnoredInner(string $fileName): array
- {
- $this->ignoredLines[$fileName] = [];
-
- $lines = \file($fileName);
-
- foreach ($lines as $index => $line) {
- if (!\trim($line)) {
- $this->ignoredLines[$fileName][] = $index + 1;
- }
- }
-
- if ($this->cacheTokens) {
- $tokens = \PHP_Token_Stream_CachingFactory::get($fileName);
- } else {
- $tokens = new \PHP_Token_Stream($fileName);
- }
-
- foreach ($tokens->getInterfaces() as $interface) {
- $interfaceStartLine = $interface['startLine'];
- $interfaceEndLine = $interface['endLine'];
-
- foreach (\range($interfaceStartLine, $interfaceEndLine) as $line) {
- $this->ignoredLines[$fileName][] = $line;
- }
- }
-
- foreach (\array_merge($tokens->getClasses(), $tokens->getTraits()) as $classOrTrait) {
- $classOrTraitStartLine = $classOrTrait['startLine'];
- $classOrTraitEndLine = $classOrTrait['endLine'];
-
- if (empty($classOrTrait['methods'])) {
- foreach (\range($classOrTraitStartLine, $classOrTraitEndLine) as $line) {
- $this->ignoredLines[$fileName][] = $line;
- }
-
- continue;
- }
-
- $firstMethod = \array_shift($classOrTrait['methods']);
- $firstMethodStartLine = $firstMethod['startLine'];
- $lastMethodEndLine = $firstMethod['endLine'];
-
- do {
- $lastMethod = \array_pop($classOrTrait['methods']);
- } while ($lastMethod !== null && 0 === \strpos($lastMethod['signature'], 'anonymousFunction'));
-
- if ($lastMethod !== null) {
- $lastMethodEndLine = $lastMethod['endLine'];
- }
-
- foreach (\range($classOrTraitStartLine, $firstMethodStartLine) as $line) {
- $this->ignoredLines[$fileName][] = $line;
- }
-
- foreach (\range($lastMethodEndLine + 1, $classOrTraitEndLine) as $line) {
- $this->ignoredLines[$fileName][] = $line;
- }
- }
-
- if ($this->disableIgnoredLines) {
- $this->ignoredLines[$fileName] = \array_unique($this->ignoredLines[$fileName]);
- \sort($this->ignoredLines[$fileName]);
-
- return $this->ignoredLines[$fileName];
- }
-
- $ignore = false;
- $stop = false;
-
- foreach ($tokens->tokens() as $token) {
- switch (\get_class($token)) {
- case \PHP_Token_COMMENT::class:
- case \PHP_Token_DOC_COMMENT::class:
- $_token = \trim((string) $token);
- $_line = \trim($lines[$token->getLine() - 1]);
-
- if ($_token === '// @codeCoverageIgnore' ||
- $_token === '//@codeCoverageIgnore') {
- $ignore = true;
- $stop = true;
- } elseif ($_token === '// @codeCoverageIgnoreStart' ||
- $_token === '//@codeCoverageIgnoreStart') {
- $ignore = true;
- } elseif ($_token === '// @codeCoverageIgnoreEnd' ||
- $_token === '//@codeCoverageIgnoreEnd') {
- $stop = true;
- }
-
- if (!$ignore) {
- $start = $token->getLine();
- $end = $start + \substr_count((string) $token, "\n");
-
- // Do not ignore the first line when there is a token
- // before the comment
- if (0 !== \strpos($_token, $_line)) {
- $start++;
- }
-
- for ($i = $start; $i < $end; $i++) {
- $this->ignoredLines[$fileName][] = $i;
- }
-
- // A DOC_COMMENT token or a COMMENT token starting with "/*"
- // does not contain the final \n character in its text
- if (isset($lines[$i - 1]) && 0 === \strpos($_token, '/*') && '*/' === \substr(\trim($lines[$i - 1]), -2)) {
- $this->ignoredLines[$fileName][] = $i;
- }
- }
-
- break;
-
- case \PHP_Token_INTERFACE::class:
- case \PHP_Token_TRAIT::class:
- case \PHP_Token_CLASS::class:
- case \PHP_Token_FUNCTION::class:
- /* @var \PHP_Token_Interface $token */
-
- $docblock = (string) $token->getDocblock();
-
- $this->ignoredLines[$fileName][] = $token->getLine();
-
- if (\strpos($docblock, '@codeCoverageIgnore') || ($this->ignoreDeprecatedCode && \strpos($docblock, '@deprecated'))) {
- $endLine = $token->getEndLine();
-
- for ($i = $token->getLine(); $i <= $endLine; $i++) {
- $this->ignoredLines[$fileName][] = $i;
- }
- }
-
- break;
-
- /* @noinspection PhpMissingBreakStatementInspection */
- case \PHP_Token_NAMESPACE::class:
- $this->ignoredLines[$fileName][] = $token->getEndLine();
-
- // Intentional fallthrough
- case \PHP_Token_DECLARE::class:
- case \PHP_Token_OPEN_TAG::class:
- case \PHP_Token_CLOSE_TAG::class:
- case \PHP_Token_USE::class:
- case \PHP_Token_USE_FUNCTION::class:
- $this->ignoredLines[$fileName][] = $token->getLine();
-
- break;
- }
-
- if ($ignore) {
- $this->ignoredLines[$fileName][] = $token->getLine();
-
- if ($stop) {
- $ignore = false;
- $stop = false;
- }
- }
- }
-
- $this->ignoredLines[$fileName][] = \count($lines) + 1;
-
- $this->ignoredLines[$fileName] = \array_unique(
- $this->ignoredLines[$fileName]
- );
-
- $this->ignoredLines[$fileName] = \array_unique($this->ignoredLines[$fileName]);
- \sort($this->ignoredLines[$fileName]);
-
- return $this->ignoredLines[$fileName];
}
/**
- * @throws \ReflectionException
* @throws UnintentionallyCoveredCodeException
*/
- private function performUnintentionallyCoveredCodeCheck(array &$data, array $linesToBeCovered, array $linesToBeUsed): void
+ private function processUncoveredFilesFromFilter(): void
+ {
+ $uncoveredFiles = array_diff(
+ $this->filter->files(),
+ $this->data->coveredFiles()
+ );
+
+ $this->driver->start();
+
+ foreach ($uncoveredFiles as $uncoveredFile) {
+ if (is_file($uncoveredFile)) {
+ include_once $uncoveredFile;
+ }
+ }
+
+ $this->append($this->driver->stop(), self::UNCOVERED_FILES);
+ }
+
+ /**
+ * @throws ReflectionException
+ * @throws UnintentionallyCoveredCodeException
+ */
+ private function performUnintentionallyCoveredCodeCheck(RawCodeCoverageData $data, array $linesToBeCovered, array $linesToBeUsed): void
{
$allowedLines = $this->getAllowedLines(
$linesToBeCovered,
@@ -5195,7 +27079,7 @@ final class CodeCoverage
$unintentionallyCoveredUnits = [];
- foreach ($data as $file => $_data) {
+ foreach ($data->lineCoverage() as $file => $_data) {
foreach ($_data as $line => $flag) {
if ($flag === 1 && !isset($allowedLines[$file][$line])) {
$unintentionallyCoveredUnits[] = $this->wizard->lookup($file, $line);
@@ -5212,66 +27096,35 @@ final class CodeCoverage
}
}
- /**
- * @throws CoveredCodeNotExecutedException
- */
- private function performUnexecutedCoveredCodeCheck(array &$data, array $linesToBeCovered, array $linesToBeUsed): void
- {
- $executedCodeUnits = $this->coverageToCodeUnits($data);
- $message = '';
-
- foreach ($this->linesToCodeUnits($linesToBeCovered) as $codeUnit) {
- if (!\in_array($codeUnit, $executedCodeUnits)) {
- $message .= \sprintf(
- '- %s is expected to be executed (@covers) but was not executed' . "\n",
- $codeUnit
- );
- }
- }
-
- foreach ($this->linesToCodeUnits($linesToBeUsed) as $codeUnit) {
- if (!\in_array($codeUnit, $executedCodeUnits)) {
- $message .= \sprintf(
- '- %s is expected to be executed (@uses) but was not executed' . "\n",
- $codeUnit
- );
- }
- }
-
- if (!empty($message)) {
- throw new CoveredCodeNotExecutedException($message);
- }
- }
-
private function getAllowedLines(array $linesToBeCovered, array $linesToBeUsed): array
{
$allowedLines = [];
- foreach (\array_keys($linesToBeCovered) as $file) {
+ foreach (array_keys($linesToBeCovered) as $file) {
if (!isset($allowedLines[$file])) {
$allowedLines[$file] = [];
}
- $allowedLines[$file] = \array_merge(
+ $allowedLines[$file] = array_merge(
$allowedLines[$file],
$linesToBeCovered[$file]
);
}
- foreach (\array_keys($linesToBeUsed) as $file) {
+ foreach (array_keys($linesToBeUsed) as $file) {
if (!isset($allowedLines[$file])) {
$allowedLines[$file] = [];
}
- $allowedLines[$file] = \array_merge(
+ $allowedLines[$file] = array_merge(
$allowedLines[$file],
$linesToBeUsed[$file]
);
}
- foreach (\array_keys($allowedLines) as $file) {
- $allowedLines[$file] = \array_flip(
- \array_unique($allowedLines[$file])
+ foreach (array_keys($allowedLines) as $file) {
+ $allowedLines[$file] = array_flip(
+ array_unique($allowedLines[$file])
);
}
@@ -5279,131 +27132,66 @@ final class CodeCoverage
}
/**
- * @throws RuntimeException
+ * @throws ReflectionException
*/
- private function selectDriver(Filter $filter): Driver
- {
- $runtime = new Runtime;
-
- if (!$runtime->canCollectCodeCoverage()) {
- throw new RuntimeException('No code coverage driver available');
- }
-
- if ($runtime->isPHPDBG()) {
- return new PHPDBG;
- }
-
- if ($runtime->hasXdebug()) {
- return new Xdebug($filter);
- }
-
- if ($runtime->hasPCOV()) {
- return new PCOV;
- }
-
- throw new RuntimeException('No code coverage driver available');
- }
-
private function processUnintentionallyCoveredUnits(array $unintentionallyCoveredUnits): array
{
- $unintentionallyCoveredUnits = \array_unique($unintentionallyCoveredUnits);
- \sort($unintentionallyCoveredUnits);
+ $unintentionallyCoveredUnits = array_unique($unintentionallyCoveredUnits);
+ sort($unintentionallyCoveredUnits);
- foreach (\array_keys($unintentionallyCoveredUnits) as $k => $v) {
- $unit = \explode('::', $unintentionallyCoveredUnits[$k]);
+ foreach (array_keys($unintentionallyCoveredUnits) as $k => $v) {
+ $unit = explode('::', $unintentionallyCoveredUnits[$k]);
- if (\count($unit) !== 2) {
+ if (count($unit) !== 2) {
continue;
}
- $class = new \ReflectionClass($unit[0]);
+ try {
+ $class = new ReflectionClass($unit[0]);
- foreach ($this->unintentionallyCoveredSubclassesWhitelist as $whitelisted) {
- if ($class->isSubclassOf($whitelisted)) {
- unset($unintentionallyCoveredUnits[$k]);
+ foreach ($this->parentClassesExcludedFromUnintentionallyCoveredCodeCheck as $parentClass) {
+ if ($class->isSubclassOf($parentClass)) {
+ unset($unintentionallyCoveredUnits[$k]);
- break;
- }
- }
- }
-
- return \array_values($unintentionallyCoveredUnits);
- }
-
- /**
- * @throws CoveredCodeNotExecutedException
- * @throws InvalidArgumentException
- * @throws MissingCoversAnnotationException
- * @throws RuntimeException
- * @throws UnintentionallyCoveredCodeException
- * @throws \ReflectionException
- */
- private function initializeData(): void
- {
- $this->isInitialized = true;
-
- if ($this->processUncoveredFilesFromWhitelist) {
- $this->shouldCheckForDeadAndUnused = false;
-
- $this->driver->start();
-
- foreach ($this->filter->getWhitelist() as $file) {
- if ($this->filter->isFile($file)) {
- include_once $file;
- }
- }
-
- $data = [];
-
- foreach ($this->driver->stop() as $file => $fileCoverage) {
- if ($this->filter->isFiltered($file)) {
- continue;
- }
-
- foreach (\array_keys($fileCoverage) as $key) {
- if ($fileCoverage[$key] === Driver::LINE_EXECUTED) {
- $fileCoverage[$key] = Driver::LINE_NOT_EXECUTED;
+ break;
}
}
-
- $data[$file] = $fileCoverage;
+ } catch (\ReflectionException $e) {
+ throw new ReflectionException(
+ $e->getMessage(),
+ (int) $e->getCode(),
+ $e
+ );
}
-
- $this->append($data, 'UNCOVERED_FILES_FROM_WHITELIST');
}
+
+ return array_values($unintentionallyCoveredUnits);
}
- private function coverageToCodeUnits(array $data): array
+ private function analyser(): FileAnalyser
{
- $codeUnits = [];
-
- foreach ($data as $filename => $lines) {
- foreach ($lines as $line => $flag) {
- if ($flag === 1) {
- $codeUnits[] = $this->wizard->lookup($filename, $line);
- }
- }
+ if ($this->analyser !== null) {
+ return $this->analyser;
}
- return \array_unique($codeUnits);
- }
+ $this->analyser = new ParsingFileAnalyser(
+ $this->useAnnotationsForIgnoringCode,
+ $this->ignoreDeprecatedCode
+ );
- private function linesToCodeUnits(array $data): array
- {
- $codeUnits = [];
-
- foreach ($data as $filename => $lines) {
- foreach ($lines as $line) {
- $codeUnits[] = $this->wizard->lookup($filename, $line);
- }
+ if ($this->cachesStaticAnalysis()) {
+ $this->analyser = new CachingFileAnalyser(
+ $this->cacheDirectory,
+ $this->analyser
+ );
}
- return \array_unique($codeUnits);
+ return $this->analyser;
}
}
*
@@ -5412,2921 +27200,747 @@ final class CodeCoverage
*/
namespace SebastianBergmann\CodeCoverage;
-use SebastianBergmann\Version as VersionId;
-
-final class Version
-{
- /**
- * @var string
- */
- private static $version;
-
- public static function id(): string
- {
- if (self::$version === null) {
- $version = new VersionId('7.0.8', \dirname(__DIR__));
- self::$version = $version->getVersion();
- }
-
- return self::$version;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage;
+use function array_key_exists;
+use function array_keys;
+use function array_merge;
+use function array_unique;
+use function count;
+use function is_array;
+use function ksort;
+use SebastianBergmann\CodeCoverage\Driver\Driver;
/**
- * Utility methods.
+ * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
*/
-final class Util
+final class ProcessedCodeCoverageData
{
/**
- * @return float|int|string
- */
- public static function percent(float $a, float $b, bool $asString = false, bool $fixedWidth = false)
- {
- if ($asString && $b == 0) {
- return '';
- }
-
- $percent = 100;
-
- if ($b > 0) {
- $percent = ($a / $b) * 100;
- }
-
- if ($asString) {
- $format = $fixedWidth ? '%6.2F%%' : '%01.2F%%';
-
- return \sprintf($format, $percent);
- }
-
- return $percent;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Node;
-
-use SebastianBergmann\CodeCoverage\Util;
-
-/**
- * Base class for nodes in the code coverage information tree.
- */
-abstract class AbstractNode implements \Countable
-{
- /**
- * @var string
- */
- private $name;
-
- /**
- * @var string
- */
- private $path;
-
- /**
+ * Line coverage data.
+ * An array of filenames, each having an array of linenumbers, each executable line having an array of testcase ids.
+ *
* @var array
*/
- private $pathArray;
+ private $lineCoverage = [];
/**
- * @var AbstractNode
+ * Function coverage data.
+ * Maintains base format of raw data (@see https://xdebug.org/docs/code_coverage), but each 'hit' entry is an array
+ * of testcase ids.
+ *
+ * @var array
*/
- private $parent;
+ private $functionCoverage = [];
- /**
- * @var string
- */
- private $id;
-
- public function __construct(string $name, self $parent = null)
+ public function initializeUnseenData(RawCodeCoverageData $rawData): void
{
- if (\substr($name, -1) == \DIRECTORY_SEPARATOR) {
- $name = \substr($name, 0, -1);
+ foreach ($rawData->lineCoverage() as $file => $lines) {
+ if (!isset($this->lineCoverage[$file])) {
+ $this->lineCoverage[$file] = [];
+
+ foreach ($lines as $k => $v) {
+ $this->lineCoverage[$file][$k] = $v === Driver::LINE_NOT_EXECUTABLE ? null : [];
+ }
+ }
}
- $this->name = $name;
- $this->parent = $parent;
- }
-
- public function getName(): string
- {
- return $this->name;
- }
-
- public function getId(): string
- {
- if ($this->id === null) {
- $parent = $this->getParent();
-
- if ($parent === null) {
- $this->id = 'index';
- } else {
- $parentId = $parent->getId();
-
- if ($parentId === 'index') {
- $this->id = \str_replace(':', '_', $this->name);
+ foreach ($rawData->functionCoverage() as $file => $functions) {
+ foreach ($functions as $functionName => $functionData) {
+ if (isset($this->functionCoverage[$file][$functionName])) {
+ $this->initPreviouslySeenFunction($file, $functionName, $functionData);
} else {
- $this->id = $parentId . '/' . $this->name;
+ $this->initPreviouslyUnseenFunction($file, $functionName, $functionData);
+ }
+ }
+ }
+ }
+
+ public function markCodeAsExecutedByTestCase(string $testCaseId, RawCodeCoverageData $executedCode): void
+ {
+ foreach ($executedCode->lineCoverage() as $file => $lines) {
+ foreach ($lines as $k => $v) {
+ if ($v === Driver::LINE_EXECUTED) {
+ $this->lineCoverage[$file][$k][] = $testCaseId;
}
}
}
- return $this->id;
- }
-
- public function getPath(): string
- {
- if ($this->path === null) {
- if ($this->parent === null || $this->parent->getPath() === null || $this->parent->getPath() === false) {
- $this->path = $this->name;
- } else {
- $this->path = $this->parent->getPath() . \DIRECTORY_SEPARATOR . $this->name;
- }
- }
-
- return $this->path;
- }
-
- public function getPathAsArray(): array
- {
- if ($this->pathArray === null) {
- if ($this->parent === null) {
- $this->pathArray = [];
- } else {
- $this->pathArray = $this->parent->getPathAsArray();
- }
-
- $this->pathArray[] = $this;
- }
-
- return $this->pathArray;
- }
-
- public function getParent(): ?self
- {
- return $this->parent;
- }
-
- /**
- * Returns the percentage of classes that has been tested.
- *
- * @return int|string
- */
- public function getTestedClassesPercent(bool $asString = true)
- {
- return Util::percent(
- $this->getNumTestedClasses(),
- $this->getNumClasses(),
- $asString
- );
- }
-
- /**
- * Returns the percentage of traits that has been tested.
- *
- * @return int|string
- */
- public function getTestedTraitsPercent(bool $asString = true)
- {
- return Util::percent(
- $this->getNumTestedTraits(),
- $this->getNumTraits(),
- $asString
- );
- }
-
- /**
- * Returns the percentage of classes and traits that has been tested.
- *
- * @return int|string
- */
- public function getTestedClassesAndTraitsPercent(bool $asString = true)
- {
- return Util::percent(
- $this->getNumTestedClassesAndTraits(),
- $this->getNumClassesAndTraits(),
- $asString
- );
- }
-
- /**
- * Returns the percentage of functions that has been tested.
- *
- * @return int|string
- */
- public function getTestedFunctionsPercent(bool $asString = true)
- {
- return Util::percent(
- $this->getNumTestedFunctions(),
- $this->getNumFunctions(),
- $asString
- );
- }
-
- /**
- * Returns the percentage of methods that has been tested.
- *
- * @return int|string
- */
- public function getTestedMethodsPercent(bool $asString = true)
- {
- return Util::percent(
- $this->getNumTestedMethods(),
- $this->getNumMethods(),
- $asString
- );
- }
-
- /**
- * Returns the percentage of functions and methods that has been tested.
- *
- * @return int|string
- */
- public function getTestedFunctionsAndMethodsPercent(bool $asString = true)
- {
- return Util::percent(
- $this->getNumTestedFunctionsAndMethods(),
- $this->getNumFunctionsAndMethods(),
- $asString
- );
- }
-
- /**
- * Returns the percentage of executed lines.
- *
- * @return int|string
- */
- public function getLineExecutedPercent(bool $asString = true)
- {
- return Util::percent(
- $this->getNumExecutedLines(),
- $this->getNumExecutableLines(),
- $asString
- );
- }
-
- /**
- * Returns the number of classes and traits.
- */
- public function getNumClassesAndTraits(): int
- {
- return $this->getNumClasses() + $this->getNumTraits();
- }
-
- /**
- * Returns the number of tested classes and traits.
- */
- public function getNumTestedClassesAndTraits(): int
- {
- return $this->getNumTestedClasses() + $this->getNumTestedTraits();
- }
-
- /**
- * Returns the classes and traits of this node.
- */
- public function getClassesAndTraits(): array
- {
- return \array_merge($this->getClasses(), $this->getTraits());
- }
-
- /**
- * Returns the number of functions and methods.
- */
- public function getNumFunctionsAndMethods(): int
- {
- return $this->getNumFunctions() + $this->getNumMethods();
- }
-
- /**
- * Returns the number of tested functions and methods.
- */
- public function getNumTestedFunctionsAndMethods(): int
- {
- return $this->getNumTestedFunctions() + $this->getNumTestedMethods();
- }
-
- /**
- * Returns the functions and methods of this node.
- */
- public function getFunctionsAndMethods(): array
- {
- return \array_merge($this->getFunctions(), $this->getMethods());
- }
-
- /**
- * Returns the classes of this node.
- */
- abstract public function getClasses(): array;
-
- /**
- * Returns the traits of this node.
- */
- abstract public function getTraits(): array;
-
- /**
- * Returns the functions of this node.
- */
- abstract public function getFunctions(): array;
-
- /**
- * Returns the LOC/CLOC/NCLOC of this node.
- */
- abstract public function getLinesOfCode(): array;
-
- /**
- * Returns the number of executable lines.
- */
- abstract public function getNumExecutableLines(): int;
-
- /**
- * Returns the number of executed lines.
- */
- abstract public function getNumExecutedLines(): int;
-
- /**
- * Returns the number of classes.
- */
- abstract public function getNumClasses(): int;
-
- /**
- * Returns the number of tested classes.
- */
- abstract public function getNumTestedClasses(): int;
-
- /**
- * Returns the number of traits.
- */
- abstract public function getNumTraits(): int;
-
- /**
- * Returns the number of tested traits.
- */
- abstract public function getNumTestedTraits(): int;
-
- /**
- * Returns the number of methods.
- */
- abstract public function getNumMethods(): int;
-
- /**
- * Returns the number of tested methods.
- */
- abstract public function getNumTestedMethods(): int;
-
- /**
- * Returns the number of functions.
- */
- abstract public function getNumFunctions(): int;
-
- /**
- * Returns the number of tested functions.
- */
- abstract public function getNumTestedFunctions(): int;
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Node;
-
-/**
- * Recursive iterator for node object graphs.
- */
-final class Iterator implements \RecursiveIterator
-{
- /**
- * @var int
- */
- private $position;
-
- /**
- * @var AbstractNode[]
- */
- private $nodes;
-
- public function __construct(Directory $node)
- {
- $this->nodes = $node->getChildNodes();
- }
-
- /**
- * Rewinds the Iterator to the first element.
- */
- public function rewind(): void
- {
- $this->position = 0;
- }
-
- /**
- * Checks if there is a current element after calls to rewind() or next().
- */
- public function valid(): bool
- {
- return $this->position < \count($this->nodes);
- }
-
- /**
- * Returns the key of the current element.
- */
- public function key(): int
- {
- return $this->position;
- }
-
- /**
- * Returns the current element.
- */
- public function current(): AbstractNode
- {
- return $this->valid() ? $this->nodes[$this->position] : null;
- }
-
- /**
- * Moves forward to next element.
- */
- public function next(): void
- {
- $this->position++;
- }
-
- /**
- * Returns the sub iterator for the current element.
- *
- * @return Iterator
- */
- public function getChildren(): self
- {
- return new self($this->nodes[$this->position]);
- }
-
- /**
- * Checks whether the current element has children.
- */
- public function hasChildren(): bool
- {
- return $this->nodes[$this->position] instanceof Directory;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Node;
-
-use SebastianBergmann\CodeCoverage\CodeCoverage;
-
-final class Builder
-{
- public function build(CodeCoverage $coverage): Directory
- {
- $files = $coverage->getData();
- $commonPath = $this->reducePaths($files);
- $root = new Directory(
- $commonPath,
- null
- );
-
- $this->addItems(
- $root,
- $this->buildDirectoryStructure($files),
- $coverage->getTests(),
- $coverage->getCacheTokens()
- );
-
- return $root;
- }
-
- private function addItems(Directory $root, array $items, array $tests, bool $cacheTokens): void
- {
- foreach ($items as $key => $value) {
- $key = (string) $key;
-
- if (\substr($key, -2) === '/f') {
- $key = \substr($key, 0, -2);
-
- if (\file_exists($root->getPath() . \DIRECTORY_SEPARATOR . $key)) {
- $root->addFile($key, $value, $tests, $cacheTokens);
- }
- } else {
- $child = $root->addDirectory($key);
- $this->addItems($child, $value, $tests, $cacheTokens);
- }
- }
- }
-
- /**
- * Builds an array representation of the directory structure.
- *
- * For instance,
- *
- *
- * Array
- * (
- * [Money.php] => Array
- * (
- * ...
- * )
- *
- * [MoneyBag.php] => Array
- * (
- * ...
- * )
- * )
- *
- *
- * is transformed into
- *
- *
- * Array
- * (
- * [.] => Array
- * (
- * [Money.php] => Array
- * (
- * ...
- * )
- *
- * [MoneyBag.php] => Array
- * (
- * ...
- * )
- * )
- * )
- *
- */
- private function buildDirectoryStructure(array $files): array
- {
- $result = [];
-
- foreach ($files as $path => $file) {
- $path = \explode(\DIRECTORY_SEPARATOR, $path);
- $pointer = &$result;
- $max = \count($path);
-
- for ($i = 0; $i < $max; $i++) {
- $type = '';
-
- if ($i === ($max - 1)) {
- $type = '/f';
+ foreach ($executedCode->functionCoverage() as $file => $functions) {
+ foreach ($functions as $functionName => $functionData) {
+ foreach ($functionData['branches'] as $branchId => $branchData) {
+ if ($branchData['hit'] === Driver::BRANCH_HIT) {
+ $this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'][] = $testCaseId;
+ }
}
- $pointer = &$pointer[$path[$i] . $type];
- }
-
- $pointer = $file;
- }
-
- return $result;
- }
-
- /**
- * Reduces the paths by cutting the longest common start path.
- *
- * For instance,
- *
- *
- * Array
- * (
- * [/home/sb/Money/Money.php] => Array
- * (
- * ...
- * )
- *
- * [/home/sb/Money/MoneyBag.php] => Array
- * (
- * ...
- * )
- * )
- *
- *
- * is reduced to
- *
- *
- * Array
- * (
- * [Money.php] => Array
- * (
- * ...
- * )
- *
- * [MoneyBag.php] => Array
- * (
- * ...
- * )
- * )
- *
- */
- private function reducePaths(array &$files): string
- {
- if (empty($files)) {
- return '.';
- }
-
- $commonPath = '';
- $paths = \array_keys($files);
-
- if (\count($files) === 1) {
- $commonPath = \dirname($paths[0]) . \DIRECTORY_SEPARATOR;
- $files[\basename($paths[0])] = $files[$paths[0]];
-
- unset($files[$paths[0]]);
-
- return $commonPath;
- }
-
- $max = \count($paths);
-
- for ($i = 0; $i < $max; $i++) {
- // strip phar:// prefixes
- if (\strpos($paths[$i], 'phar://') === 0) {
- $paths[$i] = \substr($paths[$i], 7);
- $paths[$i] = \str_replace('/', \DIRECTORY_SEPARATOR, $paths[$i]);
- }
- $paths[$i] = \explode(\DIRECTORY_SEPARATOR, $paths[$i]);
-
- if (empty($paths[$i][0])) {
- $paths[$i][0] = \DIRECTORY_SEPARATOR;
- }
- }
-
- $done = false;
- $max = \count($paths);
-
- while (!$done) {
- for ($i = 0; $i < $max - 1; $i++) {
- if (!isset($paths[$i][0]) ||
- !isset($paths[$i + 1][0]) ||
- $paths[$i][0] !== $paths[$i + 1][0]) {
- $done = true;
-
- break;
- }
- }
-
- if (!$done) {
- $commonPath .= $paths[0][0];
-
- if ($paths[0][0] !== \DIRECTORY_SEPARATOR) {
- $commonPath .= \DIRECTORY_SEPARATOR;
- }
-
- for ($i = 0; $i < $max; $i++) {
- \array_shift($paths[$i]);
- }
- }
- }
-
- $original = \array_keys($files);
- $max = \count($original);
-
- for ($i = 0; $i < $max; $i++) {
- $files[\implode(\DIRECTORY_SEPARATOR, $paths[$i])] = $files[$original[$i]];
- unset($files[$original[$i]]);
- }
-
- \ksort($files);
-
- return \substr($commonPath, 0, -1);
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Node;
-
-use SebastianBergmann\CodeCoverage\InvalidArgumentException;
-
-/**
- * Represents a directory in the code coverage information tree.
- */
-final class Directory extends AbstractNode implements \IteratorAggregate
-{
- /**
- * @var AbstractNode[]
- */
- private $children = [];
-
- /**
- * @var Directory[]
- */
- private $directories = [];
-
- /**
- * @var File[]
- */
- private $files = [];
-
- /**
- * @var array
- */
- private $classes;
-
- /**
- * @var array
- */
- private $traits;
-
- /**
- * @var array
- */
- private $functions;
-
- /**
- * @var array
- */
- private $linesOfCode;
-
- /**
- * @var int
- */
- private $numFiles = -1;
-
- /**
- * @var int
- */
- private $numExecutableLines = -1;
-
- /**
- * @var int
- */
- private $numExecutedLines = -1;
-
- /**
- * @var int
- */
- private $numClasses = -1;
-
- /**
- * @var int
- */
- private $numTestedClasses = -1;
-
- /**
- * @var int
- */
- private $numTraits = -1;
-
- /**
- * @var int
- */
- private $numTestedTraits = -1;
-
- /**
- * @var int
- */
- private $numMethods = -1;
-
- /**
- * @var int
- */
- private $numTestedMethods = -1;
-
- /**
- * @var int
- */
- private $numFunctions = -1;
-
- /**
- * @var int
- */
- private $numTestedFunctions = -1;
-
- /**
- * Returns the number of files in/under this node.
- */
- public function count(): int
- {
- if ($this->numFiles === -1) {
- $this->numFiles = 0;
-
- foreach ($this->children as $child) {
- $this->numFiles += \count($child);
- }
- }
-
- return $this->numFiles;
- }
-
- /**
- * Returns an iterator for this node.
- */
- public function getIterator(): \RecursiveIteratorIterator
- {
- return new \RecursiveIteratorIterator(
- new Iterator($this),
- \RecursiveIteratorIterator::SELF_FIRST
- );
- }
-
- /**
- * Adds a new directory.
- */
- public function addDirectory(string $name): self
- {
- $directory = new self($name, $this);
-
- $this->children[] = $directory;
- $this->directories[] = &$this->children[\count($this->children) - 1];
-
- return $directory;
- }
-
- /**
- * Adds a new file.
- *
- * @throws InvalidArgumentException
- */
- public function addFile(string $name, array $coverageData, array $testData, bool $cacheTokens): File
- {
- $file = new File($name, $this, $coverageData, $testData, $cacheTokens);
-
- $this->children[] = $file;
- $this->files[] = &$this->children[\count($this->children) - 1];
-
- $this->numExecutableLines = -1;
- $this->numExecutedLines = -1;
-
- return $file;
- }
-
- /**
- * Returns the directories in this directory.
- */
- public function getDirectories(): array
- {
- return $this->directories;
- }
-
- /**
- * Returns the files in this directory.
- */
- public function getFiles(): array
- {
- return $this->files;
- }
-
- /**
- * Returns the child nodes of this node.
- */
- public function getChildNodes(): array
- {
- return $this->children;
- }
-
- /**
- * Returns the classes of this node.
- */
- public function getClasses(): array
- {
- if ($this->classes === null) {
- $this->classes = [];
-
- foreach ($this->children as $child) {
- $this->classes = \array_merge(
- $this->classes,
- $child->getClasses()
- );
- }
- }
-
- return $this->classes;
- }
-
- /**
- * Returns the traits of this node.
- */
- public function getTraits(): array
- {
- if ($this->traits === null) {
- $this->traits = [];
-
- foreach ($this->children as $child) {
- $this->traits = \array_merge(
- $this->traits,
- $child->getTraits()
- );
- }
- }
-
- return $this->traits;
- }
-
- /**
- * Returns the functions of this node.
- */
- public function getFunctions(): array
- {
- if ($this->functions === null) {
- $this->functions = [];
-
- foreach ($this->children as $child) {
- $this->functions = \array_merge(
- $this->functions,
- $child->getFunctions()
- );
- }
- }
-
- return $this->functions;
- }
-
- /**
- * Returns the LOC/CLOC/NCLOC of this node.
- */
- public function getLinesOfCode(): array
- {
- if ($this->linesOfCode === null) {
- $this->linesOfCode = ['loc' => 0, 'cloc' => 0, 'ncloc' => 0];
-
- foreach ($this->children as $child) {
- $linesOfCode = $child->getLinesOfCode();
-
- $this->linesOfCode['loc'] += $linesOfCode['loc'];
- $this->linesOfCode['cloc'] += $linesOfCode['cloc'];
- $this->linesOfCode['ncloc'] += $linesOfCode['ncloc'];
- }
- }
-
- return $this->linesOfCode;
- }
-
- /**
- * Returns the number of executable lines.
- */
- public function getNumExecutableLines(): int
- {
- if ($this->numExecutableLines === -1) {
- $this->numExecutableLines = 0;
-
- foreach ($this->children as $child) {
- $this->numExecutableLines += $child->getNumExecutableLines();
- }
- }
-
- return $this->numExecutableLines;
- }
-
- /**
- * Returns the number of executed lines.
- */
- public function getNumExecutedLines(): int
- {
- if ($this->numExecutedLines === -1) {
- $this->numExecutedLines = 0;
-
- foreach ($this->children as $child) {
- $this->numExecutedLines += $child->getNumExecutedLines();
- }
- }
-
- return $this->numExecutedLines;
- }
-
- /**
- * Returns the number of classes.
- */
- public function getNumClasses(): int
- {
- if ($this->numClasses === -1) {
- $this->numClasses = 0;
-
- foreach ($this->children as $child) {
- $this->numClasses += $child->getNumClasses();
- }
- }
-
- return $this->numClasses;
- }
-
- /**
- * Returns the number of tested classes.
- */
- public function getNumTestedClasses(): int
- {
- if ($this->numTestedClasses === -1) {
- $this->numTestedClasses = 0;
-
- foreach ($this->children as $child) {
- $this->numTestedClasses += $child->getNumTestedClasses();
- }
- }
-
- return $this->numTestedClasses;
- }
-
- /**
- * Returns the number of traits.
- */
- public function getNumTraits(): int
- {
- if ($this->numTraits === -1) {
- $this->numTraits = 0;
-
- foreach ($this->children as $child) {
- $this->numTraits += $child->getNumTraits();
- }
- }
-
- return $this->numTraits;
- }
-
- /**
- * Returns the number of tested traits.
- */
- public function getNumTestedTraits(): int
- {
- if ($this->numTestedTraits === -1) {
- $this->numTestedTraits = 0;
-
- foreach ($this->children as $child) {
- $this->numTestedTraits += $child->getNumTestedTraits();
- }
- }
-
- return $this->numTestedTraits;
- }
-
- /**
- * Returns the number of methods.
- */
- public function getNumMethods(): int
- {
- if ($this->numMethods === -1) {
- $this->numMethods = 0;
-
- foreach ($this->children as $child) {
- $this->numMethods += $child->getNumMethods();
- }
- }
-
- return $this->numMethods;
- }
-
- /**
- * Returns the number of tested methods.
- */
- public function getNumTestedMethods(): int
- {
- if ($this->numTestedMethods === -1) {
- $this->numTestedMethods = 0;
-
- foreach ($this->children as $child) {
- $this->numTestedMethods += $child->getNumTestedMethods();
- }
- }
-
- return $this->numTestedMethods;
- }
-
- /**
- * Returns the number of functions.
- */
- public function getNumFunctions(): int
- {
- if ($this->numFunctions === -1) {
- $this->numFunctions = 0;
-
- foreach ($this->children as $child) {
- $this->numFunctions += $child->getNumFunctions();
- }
- }
-
- return $this->numFunctions;
- }
-
- /**
- * Returns the number of tested functions.
- */
- public function getNumTestedFunctions(): int
- {
- if ($this->numTestedFunctions === -1) {
- $this->numTestedFunctions = 0;
-
- foreach ($this->children as $child) {
- $this->numTestedFunctions += $child->getNumTestedFunctions();
- }
- }
-
- return $this->numTestedFunctions;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Node;
-
-/**
- * Represents a file in the code coverage information tree.
- */
-final class File extends AbstractNode
-{
- /**
- * @var array
- */
- private $coverageData;
-
- /**
- * @var array
- */
- private $testData;
-
- /**
- * @var int
- */
- private $numExecutableLines = 0;
-
- /**
- * @var int
- */
- private $numExecutedLines = 0;
-
- /**
- * @var array
- */
- private $classes = [];
-
- /**
- * @var array
- */
- private $traits = [];
-
- /**
- * @var array
- */
- private $functions = [];
-
- /**
- * @var array
- */
- private $linesOfCode = [];
-
- /**
- * @var int
- */
- private $numClasses;
-
- /**
- * @var int
- */
- private $numTestedClasses = 0;
-
- /**
- * @var int
- */
- private $numTraits;
-
- /**
- * @var int
- */
- private $numTestedTraits = 0;
-
- /**
- * @var int
- */
- private $numMethods;
-
- /**
- * @var int
- */
- private $numTestedMethods;
-
- /**
- * @var int
- */
- private $numTestedFunctions;
-
- /**
- * @var bool
- */
- private $cacheTokens;
-
- /**
- * @var array
- */
- private $codeUnitsByLine = [];
-
- public function __construct(string $name, AbstractNode $parent, array $coverageData, array $testData, bool $cacheTokens)
- {
- parent::__construct($name, $parent);
-
- $this->coverageData = $coverageData;
- $this->testData = $testData;
- $this->cacheTokens = $cacheTokens;
-
- $this->calculateStatistics();
- }
-
- /**
- * Returns the number of files in/under this node.
- */
- public function count(): int
- {
- return 1;
- }
-
- /**
- * Returns the code coverage data of this node.
- */
- public function getCoverageData(): array
- {
- return $this->coverageData;
- }
-
- /**
- * Returns the test data of this node.
- */
- public function getTestData(): array
- {
- return $this->testData;
- }
-
- /**
- * Returns the classes of this node.
- */
- public function getClasses(): array
- {
- return $this->classes;
- }
-
- /**
- * Returns the traits of this node.
- */
- public function getTraits(): array
- {
- return $this->traits;
- }
-
- /**
- * Returns the functions of this node.
- */
- public function getFunctions(): array
- {
- return $this->functions;
- }
-
- /**
- * Returns the LOC/CLOC/NCLOC of this node.
- */
- public function getLinesOfCode(): array
- {
- return $this->linesOfCode;
- }
-
- /**
- * Returns the number of executable lines.
- */
- public function getNumExecutableLines(): int
- {
- return $this->numExecutableLines;
- }
-
- /**
- * Returns the number of executed lines.
- */
- public function getNumExecutedLines(): int
- {
- return $this->numExecutedLines;
- }
-
- /**
- * Returns the number of classes.
- */
- public function getNumClasses(): int
- {
- if ($this->numClasses === null) {
- $this->numClasses = 0;
-
- foreach ($this->classes as $class) {
- foreach ($class['methods'] as $method) {
- if ($method['executableLines'] > 0) {
- $this->numClasses++;
-
- continue 2;
+ foreach ($functionData['paths'] as $pathId => $pathData) {
+ if ($pathData['hit'] === Driver::BRANCH_HIT) {
+ $this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'][] = $testCaseId;
}
}
}
}
-
- return $this->numClasses;
}
- /**
- * Returns the number of tested classes.
- */
- public function getNumTestedClasses(): int
+ public function setLineCoverage(array $lineCoverage): void
{
- return $this->numTestedClasses;
+ $this->lineCoverage = $lineCoverage;
}
- /**
- * Returns the number of traits.
- */
- public function getNumTraits(): int
+ public function lineCoverage(): array
{
- if ($this->numTraits === null) {
- $this->numTraits = 0;
+ ksort($this->lineCoverage);
- foreach ($this->traits as $trait) {
- foreach ($trait['methods'] as $method) {
- if ($method['executableLines'] > 0) {
- $this->numTraits++;
-
- continue 2;
- }
- }
- }
- }
-
- return $this->numTraits;
+ return $this->lineCoverage;
}
- /**
- * Returns the number of tested traits.
- */
- public function getNumTestedTraits(): int
+ public function setFunctionCoverage(array $functionCoverage): void
{
- return $this->numTestedTraits;
+ $this->functionCoverage = $functionCoverage;
}
- /**
- * Returns the number of methods.
- */
- public function getNumMethods(): int
+ public function functionCoverage(): array
{
- if ($this->numMethods === null) {
- $this->numMethods = 0;
+ ksort($this->functionCoverage);
- foreach ($this->classes as $class) {
- foreach ($class['methods'] as $method) {
- if ($method['executableLines'] > 0) {
- $this->numMethods++;
- }
- }
- }
-
- foreach ($this->traits as $trait) {
- foreach ($trait['methods'] as $method) {
- if ($method['executableLines'] > 0) {
- $this->numMethods++;
- }
- }
- }
- }
-
- return $this->numMethods;
+ return $this->functionCoverage;
}
- /**
- * Returns the number of tested methods.
- */
- public function getNumTestedMethods(): int
+ public function coveredFiles(): array
{
- if ($this->numTestedMethods === null) {
- $this->numTestedMethods = 0;
+ ksort($this->lineCoverage);
- foreach ($this->classes as $class) {
- foreach ($class['methods'] as $method) {
- if ($method['executableLines'] > 0 &&
- $method['coverage'] === 100) {
- $this->numTestedMethods++;
- }
- }
- }
-
- foreach ($this->traits as $trait) {
- foreach ($trait['methods'] as $method) {
- if ($method['executableLines'] > 0 &&
- $method['coverage'] === 100) {
- $this->numTestedMethods++;
- }
- }
- }
- }
-
- return $this->numTestedMethods;
+ return array_keys($this->lineCoverage);
}
- /**
- * Returns the number of functions.
- */
- public function getNumFunctions(): int
+ public function renameFile(string $oldFile, string $newFile): void
{
- return \count($this->functions);
+ $this->lineCoverage[$newFile] = $this->lineCoverage[$oldFile];
+
+ if (isset($this->functionCoverage[$oldFile])) {
+ $this->functionCoverage[$newFile] = $this->functionCoverage[$oldFile];
+ }
+
+ unset($this->lineCoverage[$oldFile], $this->functionCoverage[$oldFile]);
}
- /**
- * Returns the number of tested functions.
- */
- public function getNumTestedFunctions(): int
+ public function merge(self $newData): void
{
- if ($this->numTestedFunctions === null) {
- $this->numTestedFunctions = 0;
+ foreach ($newData->lineCoverage as $file => $lines) {
+ if (!isset($this->lineCoverage[$file])) {
+ $this->lineCoverage[$file] = $lines;
- foreach ($this->functions as $function) {
- if ($function['executableLines'] > 0 &&
- $function['coverage'] === 100) {
- $this->numTestedFunctions++;
- }
- }
- }
-
- return $this->numTestedFunctions;
- }
-
- private function calculateStatistics(): void
- {
- if ($this->cacheTokens) {
- $tokens = \PHP_Token_Stream_CachingFactory::get($this->getPath());
- } else {
- $tokens = new \PHP_Token_Stream($this->getPath());
- }
-
- $this->linesOfCode = $tokens->getLinesOfCode();
-
- foreach (\range(1, $this->linesOfCode['loc']) as $lineNumber) {
- $this->codeUnitsByLine[$lineNumber] = [];
- }
-
- try {
- $this->processClasses($tokens);
- $this->processTraits($tokens);
- $this->processFunctions($tokens);
- } catch (\OutOfBoundsException $e) {
- // This can happen with PHP_Token_Stream if the file is syntactically invalid,
- // and probably affects a file that wasn't executed.
- }
- unset($tokens);
-
- foreach (\range(1, $this->linesOfCode['loc']) as $lineNumber) {
- if (isset($this->coverageData[$lineNumber])) {
- foreach ($this->codeUnitsByLine[$lineNumber] as &$codeUnit) {
- $codeUnit['executableLines']++;
- }
-
- unset($codeUnit);
-
- $this->numExecutableLines++;
-
- if (\count($this->coverageData[$lineNumber]) > 0) {
- foreach ($this->codeUnitsByLine[$lineNumber] as &$codeUnit) {
- $codeUnit['executedLines']++;
- }
-
- unset($codeUnit);
-
- $this->numExecutedLines++;
- }
- }
- }
-
- foreach ($this->traits as &$trait) {
- foreach ($trait['methods'] as &$method) {
- if ($method['executableLines'] > 0) {
- $method['coverage'] = ($method['executedLines'] /
- $method['executableLines']) * 100;
- } else {
- $method['coverage'] = 100;
- }
-
- $method['crap'] = $this->crap(
- $method['ccn'],
- $method['coverage']
- );
-
- $trait['ccn'] += $method['ccn'];
- }
-
- unset($method);
-
- if ($trait['executableLines'] > 0) {
- $trait['coverage'] = ($trait['executedLines'] /
- $trait['executableLines']) * 100;
-
- if ($trait['coverage'] === 100) {
- $this->numTestedClasses++;
- }
- } else {
- $trait['coverage'] = 100;
- }
-
- $trait['crap'] = $this->crap(
- $trait['ccn'],
- $trait['coverage']
- );
- }
-
- unset($trait);
-
- foreach ($this->classes as &$class) {
- foreach ($class['methods'] as &$method) {
- if ($method['executableLines'] > 0) {
- $method['coverage'] = ($method['executedLines'] /
- $method['executableLines']) * 100;
- } else {
- $method['coverage'] = 100;
- }
-
- $method['crap'] = $this->crap(
- $method['ccn'],
- $method['coverage']
- );
-
- $class['ccn'] += $method['ccn'];
- }
-
- unset($method);
-
- if ($class['executableLines'] > 0) {
- $class['coverage'] = ($class['executedLines'] /
- $class['executableLines']) * 100;
-
- if ($class['coverage'] === 100) {
- $this->numTestedClasses++;
- }
- } else {
- $class['coverage'] = 100;
- }
-
- $class['crap'] = $this->crap(
- $class['ccn'],
- $class['coverage']
- );
- }
-
- unset($class);
-
- foreach ($this->functions as &$function) {
- if ($function['executableLines'] > 0) {
- $function['coverage'] = ($function['executedLines'] /
- $function['executableLines']) * 100;
- } else {
- $function['coverage'] = 100;
- }
-
- if ($function['coverage'] === 100) {
- $this->numTestedFunctions++;
- }
-
- $function['crap'] = $this->crap(
- $function['ccn'],
- $function['coverage']
- );
- }
- }
-
- private function processClasses(\PHP_Token_Stream $tokens): void
- {
- $classes = $tokens->getClasses();
- $link = $this->getId() . '.html#';
-
- foreach ($classes as $className => $class) {
- if (\strpos($className, 'anonymous') === 0) {
continue;
}
- if (!empty($class['package']['namespace'])) {
- $className = $class['package']['namespace'] . '\\' . $className;
- }
+ // we should compare the lines if any of two contains data
+ $compareLineNumbers = array_unique(
+ array_merge(
+ array_keys($this->lineCoverage[$file]),
+ array_keys($newData->lineCoverage[$file])
+ )
+ );
- $this->classes[$className] = [
- 'className' => $className,
- 'methods' => [],
- 'startLine' => $class['startLine'],
- 'executableLines' => 0,
- 'executedLines' => 0,
- 'ccn' => 0,
- 'coverage' => 0,
- 'crap' => 0,
- 'package' => $class['package'],
- 'link' => $link . $class['startLine'],
- ];
+ foreach ($compareLineNumbers as $line) {
+ $thatPriority = $this->priorityForLine($newData->lineCoverage[$file], $line);
+ $thisPriority = $this->priorityForLine($this->lineCoverage[$file], $line);
- foreach ($class['methods'] as $methodName => $method) {
- if (\strpos($methodName, 'anonymous') === 0) {
- continue;
- }
-
- $this->classes[$className]['methods'][$methodName] = $this->newMethod($methodName, $method, $link);
-
- foreach (\range($method['startLine'], $method['endLine']) as $lineNumber) {
- $this->codeUnitsByLine[$lineNumber] = [
- &$this->classes[$className],
- &$this->classes[$className]['methods'][$methodName],
- ];
+ if ($thatPriority > $thisPriority) {
+ $this->lineCoverage[$file][$line] = $newData->lineCoverage[$file][$line];
+ } elseif ($thatPriority === $thisPriority && is_array($this->lineCoverage[$file][$line])) {
+ $this->lineCoverage[$file][$line] = array_unique(
+ array_merge($this->lineCoverage[$file][$line], $newData->lineCoverage[$file][$line])
+ );
}
}
}
- }
- private function processTraits(\PHP_Token_Stream $tokens): void
- {
- $traits = $tokens->getTraits();
- $link = $this->getId() . '.html#';
+ foreach ($newData->functionCoverage as $file => $functions) {
+ if (!isset($this->functionCoverage[$file])) {
+ $this->functionCoverage[$file] = $functions;
- foreach ($traits as $traitName => $trait) {
- $this->traits[$traitName] = [
- 'traitName' => $traitName,
- 'methods' => [],
- 'startLine' => $trait['startLine'],
- 'executableLines' => 0,
- 'executedLines' => 0,
- 'ccn' => 0,
- 'coverage' => 0,
- 'crap' => 0,
- 'package' => $trait['package'],
- 'link' => $link . $trait['startLine'],
- ];
-
- foreach ($trait['methods'] as $methodName => $method) {
- if (\strpos($methodName, 'anonymous') === 0) {
- continue;
- }
-
- $this->traits[$traitName]['methods'][$methodName] = $this->newMethod($methodName, $method, $link);
-
- foreach (\range($method['startLine'], $method['endLine']) as $lineNumber) {
- $this->codeUnitsByLine[$lineNumber] = [
- &$this->traits[$traitName],
- &$this->traits[$traitName]['methods'][$methodName],
- ];
- }
- }
- }
- }
-
- private function processFunctions(\PHP_Token_Stream $tokens): void
- {
- $functions = $tokens->getFunctions();
- $link = $this->getId() . '.html#';
-
- foreach ($functions as $functionName => $function) {
- if (\strpos($functionName, 'anonymous') === 0) {
continue;
}
- $this->functions[$functionName] = [
- 'functionName' => $functionName,
- 'signature' => $function['signature'],
- 'startLine' => $function['startLine'],
- 'executableLines' => 0,
- 'executedLines' => 0,
- 'ccn' => $function['ccn'],
- 'coverage' => 0,
- 'crap' => 0,
- 'link' => $link . $function['startLine'],
- ];
+ foreach ($functions as $functionName => $functionData) {
+ if (isset($this->functionCoverage[$file][$functionName])) {
+ $this->initPreviouslySeenFunction($file, $functionName, $functionData);
+ } else {
+ $this->initPreviouslyUnseenFunction($file, $functionName, $functionData);
+ }
- foreach (\range($function['startLine'], $function['endLine']) as $lineNumber) {
- $this->codeUnitsByLine[$lineNumber] = [&$this->functions[$functionName]];
+ foreach ($functionData['branches'] as $branchId => $branchData) {
+ $this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'] = array_unique(array_merge($this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'], $branchData['hit']));
+ }
+
+ foreach ($functionData['paths'] as $pathId => $pathData) {
+ $this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'] = array_unique(array_merge($this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'], $pathData['hit']));
+ }
}
}
}
- private function crap(int $ccn, float $coverage): string
- {
- if ($coverage === 0) {
- return (string) ($ccn ** 2 + $ccn);
- }
-
- if ($coverage >= 95) {
- return (string) $ccn;
- }
-
- return \sprintf(
- '%01.2F',
- $ccn ** 2 * (1 - $coverage / 100) ** 3 + $ccn
- );
- }
-
- private function newMethod(string $methodName, array $method, string $link): array
- {
- return [
- 'methodName' => $methodName,
- 'visibility' => $method['visibility'],
- 'signature' => $method['signature'],
- 'startLine' => $method['startLine'],
- 'endLine' => $method['endLine'],
- 'executableLines' => 0,
- 'executedLines' => 0,
- 'ccn' => $method['ccn'],
- 'coverage' => 0,
- 'crap' => 0,
- 'link' => $link . $method['startLine'],
- ];
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-final class Project extends Node
-{
- public function __construct(string $directory)
- {
- $this->init();
- $this->setProjectSourceDirectory($directory);
- }
-
- public function getProjectSourceDirectory(): string
- {
- return $this->getContextNode()->getAttribute('source');
- }
-
- public function getBuildInformation(): BuildInformation
- {
- $buildNode = $this->getDom()->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'build'
- )->item(0);
-
- if (!$buildNode) {
- $buildNode = $this->getDom()->documentElement->appendChild(
- $this->getDom()->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'build'
- )
- );
- }
-
- return new BuildInformation($buildNode);
- }
-
- public function getTests(): Tests
- {
- $testsNode = $this->getContextNode()->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'tests'
- )->item(0);
-
- if (!$testsNode) {
- $testsNode = $this->getContextNode()->appendChild(
- $this->getDom()->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'tests'
- )
- );
- }
-
- return new Tests($testsNode);
- }
-
- public function asDom(): \DOMDocument
- {
- return $this->getDom();
- }
-
- private function init(): void
- {
- $dom = new \DOMDocument;
- $dom->loadXML('');
-
- $this->setContextNode(
- $dom->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'project'
- )->item(0)
- );
- }
-
- private function setProjectSourceDirectory(string $name): void
- {
- $this->getContextNode()->setAttribute('source', $name);
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-use TheSeer\Tokenizer\NamespaceUri;
-use TheSeer\Tokenizer\Tokenizer;
-use TheSeer\Tokenizer\XMLSerializer;
-
-final class Source
-{
- /** @var \DOMElement */
- private $context;
-
- public function __construct(\DOMElement $context)
- {
- $this->context = $context;
- }
-
- public function setSourceCode(string $source): void
- {
- $context = $this->context;
-
- $tokens = (new Tokenizer())->parse($source);
- $srcDom = (new XMLSerializer(new NamespaceUri($context->namespaceURI)))->toDom($tokens);
-
- $context->parentNode->replaceChild(
- $context->ownerDocument->importNode($srcDom->documentElement, true),
- $context
- );
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-final class Report extends File
-{
- public function __construct(string $name)
- {
- $dom = new \DOMDocument();
- $dom->loadXML('');
-
- $contextNode = $dom->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'file'
- )->item(0);
-
- parent::__construct($contextNode);
-
- $this->setName($name);
- }
-
- public function asDom(): \DOMDocument
- {
- return $this->getDomDocument();
- }
-
- public function getFunctionObject($name): Method
- {
- $node = $this->getContextNode()->appendChild(
- $this->getDomDocument()->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'function'
- )
- );
-
- return new Method($node, $name);
- }
-
- public function getClassObject($name): Unit
- {
- return $this->getUnitObject('class', $name);
- }
-
- public function getTraitObject($name): Unit
- {
- return $this->getUnitObject('trait', $name);
- }
-
- public function getSource(): Source
- {
- $source = $this->getContextNode()->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'source'
- )->item(0);
-
- if (!$source) {
- $source = $this->getContextNode()->appendChild(
- $this->getDomDocument()->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'source'
- )
- );
- }
-
- return new Source($source);
- }
-
- private function setName($name): void
- {
- $this->getContextNode()->setAttribute('name', \basename($name));
- $this->getContextNode()->setAttribute('path', \dirname($name));
- }
-
- private function getUnitObject($tagName, $name): Unit
- {
- $node = $this->getContextNode()->appendChild(
- $this->getDomDocument()->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- $tagName
- )
- );
-
- return new Unit($node, $name);
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-final class Unit
-{
/**
- * @var \DOMElement
+ * Determine the priority for a line.
+ *
+ * 1 = the line is not set
+ * 2 = the line has not been tested
+ * 3 = the line is dead code
+ * 4 = the line has been tested
+ *
+ * During a merge, a higher number is better.
*/
- private $contextNode;
-
- public function __construct(\DOMElement $context, string $name)
+ private function priorityForLine(array $data, int $line): int
{
- $this->contextNode = $context;
-
- $this->setName($name);
- }
-
- public function setLines(int $start, int $executable, int $executed): void
- {
- $this->contextNode->setAttribute('start', (string) $start);
- $this->contextNode->setAttribute('executable', (string) $executable);
- $this->contextNode->setAttribute('executed', (string) $executed);
- }
-
- public function setCrap(float $crap): void
- {
- $this->contextNode->setAttribute('crap', (string) $crap);
- }
-
- public function setPackage(string $full, string $package, string $sub, string $category): void
- {
- $node = $this->contextNode->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'package'
- )->item(0);
-
- if (!$node) {
- $node = $this->contextNode->appendChild(
- $this->contextNode->ownerDocument->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'package'
- )
- );
+ if (!array_key_exists($line, $data)) {
+ return 1;
}
- $node->setAttribute('full', $full);
- $node->setAttribute('name', $package);
- $node->setAttribute('sub', $sub);
- $node->setAttribute('category', $category);
- }
-
- public function setNamespace(string $namespace): void
- {
- $node = $this->contextNode->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'namespace'
- )->item(0);
-
- if (!$node) {
- $node = $this->contextNode->appendChild(
- $this->contextNode->ownerDocument->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'namespace'
- )
- );
+ if (is_array($data[$line]) && count($data[$line]) === 0) {
+ return 2;
}
- $node->setAttribute('name', $namespace);
- }
-
- public function addMethod(string $name): Method
- {
- $node = $this->contextNode->appendChild(
- $this->contextNode->ownerDocument->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'method'
- )
- );
-
- return new Method($node, $name);
- }
-
- private function setName(string $name): void
- {
- $this->contextNode->setAttribute('name', $name);
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-abstract class Node
-{
- /**
- * @var \DOMDocument
- */
- private $dom;
-
- /**
- * @var \DOMElement
- */
- private $contextNode;
-
- public function __construct(\DOMElement $context)
- {
- $this->setContextNode($context);
- }
-
- public function getDom(): \DOMDocument
- {
- return $this->dom;
- }
-
- public function getTotals(): Totals
- {
- $totalsContainer = $this->getContextNode()->firstChild;
-
- if (!$totalsContainer) {
- $totalsContainer = $this->getContextNode()->appendChild(
- $this->dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'totals'
- )
- );
+ if ($data[$line] === null) {
+ return 3;
}
- return new Totals($totalsContainer);
- }
-
- public function addDirectory(string $name): Directory
- {
- $dirNode = $this->getDom()->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'directory'
- );
-
- $dirNode->setAttribute('name', $name);
- $this->getContextNode()->appendChild($dirNode);
-
- return new Directory($dirNode);
- }
-
- public function addFile(string $name, string $href): File
- {
- $fileNode = $this->getDom()->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'file'
- );
-
- $fileNode->setAttribute('name', $name);
- $fileNode->setAttribute('href', $href);
- $this->getContextNode()->appendChild($fileNode);
-
- return new File($fileNode);
- }
-
- protected function setContextNode(\DOMElement $context): void
- {
- $this->dom = $context->ownerDocument;
- $this->contextNode = $context;
- }
-
- protected function getContextNode(): \DOMElement
- {
- return $this->contextNode;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-final class Directory extends Node
-{
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-use SebastianBergmann\CodeCoverage\RuntimeException;
-
-final class Coverage
-{
- /**
- * @var \XMLWriter
- */
- private $writer;
-
- /**
- * @var \DOMElement
- */
- private $contextNode;
-
- /**
- * @var bool
- */
- private $finalized = false;
-
- public function __construct(\DOMElement $context, string $line)
- {
- $this->contextNode = $context;
-
- $this->writer = new \XMLWriter();
- $this->writer->openMemory();
- $this->writer->startElementNS(null, $context->nodeName, 'https://schema.phpunit.de/coverage/1.0');
- $this->writer->writeAttribute('nr', $line);
+ return 4;
}
/**
- * @throws RuntimeException
+ * For a function we have never seen before, copy all data over and simply init the 'hit' array.
*/
- public function addTest(string $test): void
+ private function initPreviouslyUnseenFunction(string $file, string $functionName, array $functionData): void
{
- if ($this->finalized) {
- throw new RuntimeException('Coverage Report already finalized');
+ $this->functionCoverage[$file][$functionName] = $functionData;
+
+ foreach (array_keys($functionData['branches']) as $branchId) {
+ $this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'] = [];
}
- $this->writer->startElement('covered');
- $this->writer->writeAttribute('by', $test);
- $this->writer->endElement();
+ foreach (array_keys($functionData['paths']) as $pathId) {
+ $this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'] = [];
+ }
}
- public function finalize(): void
- {
- $this->writer->endElement();
-
- $fragment = $this->contextNode->ownerDocument->createDocumentFragment();
- $fragment->appendXML($this->writer->outputMemory());
-
- $this->contextNode->parentNode->replaceChild(
- $fragment,
- $this->contextNode
- );
-
- $this->finalized = true;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-final class Method
-{
/**
- * @var \DOMElement
+ * For a function we have seen before, only copy over and init the 'hit' array for any unseen branches and paths.
+ * Techniques such as mocking and where the contents of a file are different vary during tests (e.g. compiling
+ * containers) mean that the functions inside a file cannot be relied upon to be static.
*/
- private $contextNode;
-
- public function __construct(\DOMElement $context, string $name)
+ private function initPreviouslySeenFunction(string $file, string $functionName, array $functionData): void
{
- $this->contextNode = $context;
+ foreach ($functionData['branches'] as $branchId => $branchData) {
+ if (!isset($this->functionCoverage[$file][$functionName]['branches'][$branchId])) {
+ $this->functionCoverage[$file][$functionName]['branches'][$branchId] = $branchData;
+ $this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'] = [];
+ }
+ }
- $this->setName($name);
- }
-
- public function setSignature(string $signature): void
- {
- $this->contextNode->setAttribute('signature', $signature);
- }
-
- public function setLines(string $start, ?string $end = null): void
- {
- $this->contextNode->setAttribute('start', $start);
-
- if ($end !== null) {
- $this->contextNode->setAttribute('end', $end);
+ foreach ($functionData['paths'] as $pathId => $pathData) {
+ if (!isset($this->functionCoverage[$file][$functionName]['paths'][$pathId])) {
+ $this->functionCoverage[$file][$functionName]['paths'][$pathId] = $pathData;
+ $this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'] = [];
+ }
}
}
-
- public function setTotals(string $executable, string $executed, string $coverage): void
- {
- $this->contextNode->setAttribute('executable', $executable);
- $this->contextNode->setAttribute('executed', $executed);
- $this->contextNode->setAttribute('coverage', $coverage);
- }
-
- public function setCrap(string $crap): void
- {
- $this->contextNode->setAttribute('crap', $crap);
- }
-
- private function setName(string $name): void
- {
- $this->contextNode->setAttribute('name', $name);
- }
}
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-final class Tests
-{
- private $contextNode;
-
- private $codeMap = [
- -1 => 'UNKNOWN', // PHPUnit_Runner_BaseTestRunner::STATUS_UNKNOWN
- 0 => 'PASSED', // PHPUnit_Runner_BaseTestRunner::STATUS_PASSED
- 1 => 'SKIPPED', // PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED
- 2 => 'INCOMPLETE', // PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE
- 3 => 'FAILURE', // PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE
- 4 => 'ERROR', // PHPUnit_Runner_BaseTestRunner::STATUS_ERROR
- 5 => 'RISKY', // PHPUnit_Runner_BaseTestRunner::STATUS_RISKY
- 6 => 'WARNING', // PHPUnit_Runner_BaseTestRunner::STATUS_WARNING
- ];
-
- public function __construct(\DOMElement $context)
- {
- $this->contextNode = $context;
- }
-
- public function addTest(string $test, array $result): void
- {
- $node = $this->contextNode->appendChild(
- $this->contextNode->ownerDocument->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'test'
- )
- );
-
- $node->setAttribute('name', $test);
- $node->setAttribute('size', $result['size']);
- $node->setAttribute('result', (string) $result['status']);
- $node->setAttribute('status', $this->codeMap[(int) $result['status']]);
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
+namespace SebastianBergmann\CodeCoverage\Report;
+use function date;
+use function dirname;
+use function file_put_contents;
+use function htmlspecialchars;
+use function is_string;
+use function round;
+use DOMDocument;
use SebastianBergmann\CodeCoverage\CodeCoverage;
-use SebastianBergmann\CodeCoverage\Node\AbstractNode;
-use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode;
-use SebastianBergmann\CodeCoverage\Node\File as FileNode;
-use SebastianBergmann\CodeCoverage\RuntimeException;
-use SebastianBergmann\CodeCoverage\Version;
-use SebastianBergmann\Environment\Runtime;
+use SebastianBergmann\CodeCoverage\Driver\WriteOperationFailedException;
+use SebastianBergmann\CodeCoverage\Node\File;
+use SebastianBergmann\CodeCoverage\Util\Filesystem;
-final class Facade
+final class Crap4j
{
/**
- * @var string
+ * @var int
*/
- private $target;
+ private $threshold;
- /**
- * @var Project
- */
- private $project;
-
- /**
- * @var string
- */
- private $phpUnitVersion;
-
- public function __construct(string $version)
+ public function __construct(int $threshold = 30)
{
- $this->phpUnitVersion = $version;
+ $this->threshold = $threshold;
}
/**
- * @throws RuntimeException
+ * @throws WriteOperationFailedException
*/
- public function process(CodeCoverage $coverage, string $target): void
+ public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string
{
- if (\substr($target, -1, 1) !== \DIRECTORY_SEPARATOR) {
- $target .= \DIRECTORY_SEPARATOR;
- }
+ $document = new DOMDocument('1.0', 'UTF-8');
+ $document->formatOutput = true;
- $this->target = $target;
- $this->initTargetDirectory($target);
+ $root = $document->createElement('crap_result');
+ $document->appendChild($root);
+
+ $project = $document->createElement('project', is_string($name) ? $name : '');
+ $root->appendChild($project);
+ $root->appendChild($document->createElement('timestamp', date('Y-m-d H:i:s')));
+
+ $stats = $document->createElement('stats');
+ $methodsNode = $document->createElement('methods');
$report = $coverage->getReport();
+ unset($coverage);
- $this->project = new Project(
- $coverage->getReport()->getName()
- );
+ $fullMethodCount = 0;
+ $fullCrapMethodCount = 0;
+ $fullCrapLoad = 0;
+ $fullCrap = 0;
- $this->setBuildInformation();
- $this->processTests($coverage->getTests());
- $this->processDirectory($report, $this->project);
+ foreach ($report as $item) {
+ $namespace = 'global';
- $this->saveDocument($this->project->asDom(), 'index');
- }
-
- private function setBuildInformation(): void
- {
- $buildNode = $this->project->getBuildInformation();
- $buildNode->setRuntimeInformation(new Runtime());
- $buildNode->setBuildTime(\DateTime::createFromFormat('U', (string) $_SERVER['REQUEST_TIME']));
- $buildNode->setGeneratorVersions($this->phpUnitVersion, Version::id());
- }
-
- /**
- * @throws RuntimeException
- */
- private function initTargetDirectory(string $directory): void
- {
- if (\file_exists($directory)) {
- if (!\is_dir($directory)) {
- throw new RuntimeException(
- "'$directory' exists but is not a directory."
- );
- }
-
- if (!\is_writable($directory)) {
- throw new RuntimeException(
- "'$directory' exists but is not writable."
- );
- }
- } elseif (!$this->createDirectory($directory)) {
- throw new RuntimeException(
- "'$directory' could not be created."
- );
- }
- }
-
- private function processDirectory(DirectoryNode $directory, Node $context): void
- {
- $directoryName = $directory->getName();
-
- if ($this->project->getProjectSourceDirectory() === $directoryName) {
- $directoryName = '/';
- }
-
- $directoryObject = $context->addDirectory($directoryName);
-
- $this->setTotals($directory, $directoryObject->getTotals());
-
- foreach ($directory->getDirectories() as $node) {
- $this->processDirectory($node, $directoryObject);
- }
-
- foreach ($directory->getFiles() as $node) {
- $this->processFile($node, $directoryObject);
- }
- }
-
- /**
- * @throws RuntimeException
- */
- private function processFile(FileNode $file, Directory $context): void
- {
- $fileObject = $context->addFile(
- $file->getName(),
- $file->getId() . '.xml'
- );
-
- $this->setTotals($file, $fileObject->getTotals());
-
- $path = \substr(
- $file->getPath(),
- \strlen($this->project->getProjectSourceDirectory())
- );
-
- $fileReport = new Report($path);
-
- $this->setTotals($file, $fileReport->getTotals());
-
- foreach ($file->getClassesAndTraits() as $unit) {
- $this->processUnit($unit, $fileReport);
- }
-
- foreach ($file->getFunctions() as $function) {
- $this->processFunction($function, $fileReport);
- }
-
- foreach ($file->getCoverageData() as $line => $tests) {
- if (!\is_array($tests) || \count($tests) === 0) {
+ if (!$item instanceof File) {
continue;
}
- $coverage = $fileReport->getLineCoverage((string) $line);
+ $file = $document->createElement('file');
+ $file->setAttribute('name', $item->pathAsString());
- foreach ($tests as $test) {
- $coverage->addTest($test);
+ $classes = $item->classesAndTraits();
+
+ foreach ($classes as $className => $class) {
+ foreach ($class['methods'] as $methodName => $method) {
+ $crapLoad = $this->crapLoad((float) $method['crap'], $method['ccn'], $method['coverage']);
+
+ $fullCrap += $method['crap'];
+ $fullCrapLoad += $crapLoad;
+ $fullMethodCount++;
+
+ if ($method['crap'] >= $this->threshold) {
+ $fullCrapMethodCount++;
+ }
+
+ $methodNode = $document->createElement('method');
+
+ if (!empty($class['namespace'])) {
+ $namespace = $class['namespace'];
+ }
+
+ $methodNode->appendChild($document->createElement('package', $namespace));
+ $methodNode->appendChild($document->createElement('className', $className));
+ $methodNode->appendChild($document->createElement('methodName', $methodName));
+ $methodNode->appendChild($document->createElement('methodSignature', htmlspecialchars($method['signature'])));
+ $methodNode->appendChild($document->createElement('fullMethod', htmlspecialchars($method['signature'])));
+ $methodNode->appendChild($document->createElement('crap', (string) $this->roundValue((float) $method['crap'])));
+ $methodNode->appendChild($document->createElement('complexity', (string) $method['ccn']));
+ $methodNode->appendChild($document->createElement('coverage', (string) $this->roundValue($method['coverage'])));
+ $methodNode->appendChild($document->createElement('crapLoad', (string) round($crapLoad)));
+
+ $methodsNode->appendChild($methodNode);
+ }
}
-
- $coverage->finalize();
}
- $fileReport->getSource()->setSourceCode(
- \file_get_contents($file->getPath())
- );
+ $stats->appendChild($document->createElement('name', 'Method Crap Stats'));
+ $stats->appendChild($document->createElement('methodCount', (string) $fullMethodCount));
+ $stats->appendChild($document->createElement('crapMethodCount', (string) $fullCrapMethodCount));
+ $stats->appendChild($document->createElement('crapLoad', (string) round($fullCrapLoad)));
+ $stats->appendChild($document->createElement('totalCrap', (string) $fullCrap));
- $this->saveDocument($fileReport->asDom(), $file->getId());
+ $crapMethodPercent = 0;
+
+ if ($fullMethodCount > 0) {
+ $crapMethodPercent = $this->roundValue((100 * $fullCrapMethodCount) / $fullMethodCount);
+ }
+
+ $stats->appendChild($document->createElement('crapMethodPercent', (string) $crapMethodPercent));
+
+ $root->appendChild($stats);
+ $root->appendChild($methodsNode);
+
+ $buffer = $document->saveXML();
+
+ if ($target !== null) {
+ Filesystem::createDirectory(dirname($target));
+
+ if (@file_put_contents($target, $buffer) === false) {
+ throw new WriteOperationFailedException($target);
+ }
+ }
+
+ return $buffer;
}
- private function processUnit(array $unit, Report $report): void
+ private function crapLoad(float $crapValue, int $cyclomaticComplexity, float $coveragePercent): float
{
- if (isset($unit['className'])) {
- $unitObject = $report->getClassObject($unit['className']);
+ $crapLoad = 0;
+
+ if ($crapValue >= $this->threshold) {
+ $crapLoad += $cyclomaticComplexity * (1.0 - $coveragePercent / 100);
+ $crapLoad += $cyclomaticComplexity / $this->threshold;
+ }
+
+ return $crapLoad;
+ }
+
+ private function roundValue(float $value): float
+ {
+ return round($value, 2);
+ }
+}
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\CodeCoverage\Report;
+
+use const PHP_EOL;
+use function array_map;
+use function date;
+use function ksort;
+use function max;
+use function sprintf;
+use function str_pad;
+use function strlen;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\Node\File;
+use SebastianBergmann\CodeCoverage\Util\Percentage;
+
+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
+ {
+ $hasBranchCoverage = !empty($coverage->getData(true)->functionCoverage());
+
+ $output = PHP_EOL . PHP_EOL;
+ $report = $coverage->getReport();
+
+ $colors = [
+ 'header' => '',
+ 'classes' => '',
+ 'methods' => '',
+ 'lines' => '',
+ 'branches' => '',
+ 'paths' => '',
+ 'reset' => '',
+ 'eol' => '',
+ ];
+
+ if ($showColors) {
+ $colors['classes'] = $this->coverageColor(
+ $report->numberOfTestedClassesAndTraits(),
+ $report->numberOfClassesAndTraits()
+ );
+
+ $colors['methods'] = $this->coverageColor(
+ $report->numberOfTestedMethods(),
+ $report->numberOfMethods()
+ );
+
+ $colors['lines'] = $this->coverageColor(
+ $report->numberOfExecutedLines(),
+ $report->numberOfExecutableLines()
+ );
+
+ $colors['branches'] = $this->coverageColor(
+ $report->numberOfExecutedBranches(),
+ $report->numberOfExecutableBranches()
+ );
+
+ $colors['paths'] = $this->coverageColor(
+ $report->numberOfExecutedPaths(),
+ $report->numberOfExecutablePaths()
+ );
+
+ $colors['reset'] = self::COLOR_RESET;
+ $colors['header'] = self::COLOR_HEADER;
+ $colors['eol'] = self::COLOR_EOL;
+ }
+
+ $classes = sprintf(
+ ' Classes: %6s (%d/%d)',
+ Percentage::fromFractionAndTotal(
+ $report->numberOfTestedClassesAndTraits(),
+ $report->numberOfClassesAndTraits()
+ )->asString(),
+ $report->numberOfTestedClassesAndTraits(),
+ $report->numberOfClassesAndTraits()
+ );
+
+ $methods = sprintf(
+ ' Methods: %6s (%d/%d)',
+ Percentage::fromFractionAndTotal(
+ $report->numberOfTestedMethods(),
+ $report->numberOfMethods(),
+ )->asString(),
+ $report->numberOfTestedMethods(),
+ $report->numberOfMethods()
+ );
+
+ $paths = '';
+ $branches = '';
+
+ if ($hasBranchCoverage) {
+ $paths = sprintf(
+ ' Paths: %6s (%d/%d)',
+ Percentage::fromFractionAndTotal(
+ $report->numberOfExecutedPaths(),
+ $report->numberOfExecutablePaths(),
+ )->asString(),
+ $report->numberOfExecutedPaths(),
+ $report->numberOfExecutablePaths()
+ );
+
+ $branches = sprintf(
+ ' Branches: %6s (%d/%d)',
+ Percentage::fromFractionAndTotal(
+ $report->numberOfExecutedBranches(),
+ $report->numberOfExecutableBranches(),
+ )->asString(),
+ $report->numberOfExecutedBranches(),
+ $report->numberOfExecutableBranches()
+ );
+ }
+
+ $lines = sprintf(
+ ' Lines: %6s (%d/%d)',
+ Percentage::fromFractionAndTotal(
+ $report->numberOfExecutedLines(),
+ $report->numberOfExecutableLines(),
+ )->asString(),
+ $report->numberOfExecutedLines(),
+ $report->numberOfExecutableLines()
+ );
+
+ $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 {
- $unitObject = $report->getTraitObject($unit['traitName']);
+ $date = date(' Y-m-d H:i:s');
+ $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:');
}
- $unitObject->setLines(
- $unit['startLine'],
- $unit['executableLines'],
- $unit['executedLines']
- );
+ $output .= $this->format($colors['classes'], $padding, $classes);
+ $output .= $this->format($colors['methods'], $padding, $methods);
- $unitObject->setCrap((float) $unit['crap']);
-
- $unitObject->setPackage(
- $unit['package']['fullPackage'],
- $unit['package']['package'],
- $unit['package']['subpackage'],
- $unit['package']['category']
- );
-
- $unitObject->setNamespace($unit['package']['namespace']);
-
- foreach ($unit['methods'] as $method) {
- $methodObject = $unitObject->addMethod($method['methodName']);
- $methodObject->setSignature($method['signature']);
- $methodObject->setLines((string) $method['startLine'], (string) $method['endLine']);
- $methodObject->setCrap($method['crap']);
- $methodObject->setTotals(
- (string) $method['executableLines'],
- (string) $method['executedLines'],
- (string) $method['coverage']
- );
+ if ($hasBranchCoverage) {
+ $output .= $this->format($colors['paths'], $padding, $paths);
+ $output .= $this->format($colors['branches'], $padding, $branches);
}
- }
+ $output .= $this->format($colors['lines'], $padding, $lines);
- private function processFunction(array $function, Report $report): void
- {
- $functionObject = $report->getFunctionObject($function['functionName']);
+ if ($this->showOnlySummary) {
+ return $output . PHP_EOL;
+ }
- $functionObject->setSignature($function['signature']);
- $functionObject->setLines((string) $function['startLine']);
- $functionObject->setCrap($function['crap']);
- $functionObject->setTotals((string) $function['executableLines'], (string) $function['executedLines'], (string) $function['coverage']);
- }
+ $classCoverage = [];
- private function processTests(array $tests): void
- {
- $testsObject = $this->project->getTests();
-
- foreach ($tests as $test => $result) {
- if ($test === 'UNCOVERED_FILES_FROM_WHITELIST') {
+ foreach ($report as $item) {
+ if (!$item instanceof File) {
continue;
}
- $testsObject->addTest($test, $result);
+ $classes = $item->classesAndTraits();
+
+ foreach ($classes as $className => $class) {
+ $classExecutableLines = 0;
+ $classExecutedLines = 0;
+ $classExecutableBranches = 0;
+ $classExecutedBranches = 0;
+ $classExecutablePaths = 0;
+ $classExecutedPaths = 0;
+ $coveredMethods = 0;
+ $classMethods = 0;
+
+ foreach ($class['methods'] as $method) {
+ if ($method['executableLines'] == 0) {
+ continue;
+ }
+
+ $classMethods++;
+ $classExecutableLines += $method['executableLines'];
+ $classExecutedLines += $method['executedLines'];
+ $classExecutableBranches += $method['executableBranches'];
+ $classExecutedBranches += $method['executedBranches'];
+ $classExecutablePaths += $method['executablePaths'];
+ $classExecutedPaths += $method['executedPaths'];
+
+ if ($method['coverage'] == 100) {
+ $coveredMethods++;
+ }
+ }
+
+ $classCoverage[$className] = [
+ 'namespace' => $class['namespace'],
+ 'className' => $className,
+ 'methodsCovered' => $coveredMethods,
+ 'methodCount' => $classMethods,
+ 'statementsCovered' => $classExecutedLines,
+ 'statementCount' => $classExecutableLines,
+ 'branchesCovered' => $classExecutedBranches,
+ 'branchesCount' => $classExecutableBranches,
+ 'pathsCovered' => $classExecutedPaths,
+ 'pathsCount' => $classExecutablePaths,
+ ];
+ }
}
+
+ ksort($classCoverage);
+
+ $methodColor = '';
+ $pathsColor = '';
+ $branchesColor = '';
+ $linesColor = '';
+ $resetColor = '';
+
+ foreach ($classCoverage as $fullQualifiedPath => $classInfo) {
+ if ($this->showUncoveredFiles || $classInfo['statementsCovered'] != 0) {
+ if ($showColors) {
+ $methodColor = $this->coverageColor($classInfo['methodsCovered'], $classInfo['methodCount']);
+ $pathsColor = $this->coverageColor($classInfo['pathsCovered'], $classInfo['pathsCount']);
+ $branchesColor = $this->coverageColor($classInfo['branchesCovered'], $classInfo['branchesCount']);
+ $linesColor = $this->coverageColor($classInfo['statementsCovered'], $classInfo['statementCount']);
+ $resetColor = $colors['reset'];
+ }
+
+ $output .= PHP_EOL . $fullQualifiedPath . PHP_EOL
+ . ' ' . $methodColor . 'Methods: ' . $this->printCoverageCounts($classInfo['methodsCovered'], $classInfo['methodCount'], 2) . $resetColor . ' ';
+
+ if ($hasBranchCoverage) {
+ $output .= ' ' . $pathsColor . 'Paths: ' . $this->printCoverageCounts($classInfo['pathsCovered'], $classInfo['pathsCount'], 3) . $resetColor . ' '
+ . ' ' . $branchesColor . 'Branches: ' . $this->printCoverageCounts($classInfo['branchesCovered'], $classInfo['branchesCount'], 3) . $resetColor . ' ';
+ }
+ $output .= ' ' . $linesColor . 'Lines: ' . $this->printCoverageCounts($classInfo['statementsCovered'], $classInfo['statementCount'], 3) . $resetColor;
+ }
+ }
+
+ return $output . PHP_EOL;
}
- private function setTotals(AbstractNode $node, Totals $totals): void
+ private function coverageColor(int $numberOfCoveredElements, int $totalNumberOfElements): string
{
- $loc = $node->getLinesOfCode();
-
- $totals->setNumLines(
- $loc['loc'],
- $loc['cloc'],
- $loc['ncloc'],
- $node->getNumExecutableLines(),
- $node->getNumExecutedLines()
+ $coverage = Percentage::fromFractionAndTotal(
+ $numberOfCoveredElements,
+ $totalNumberOfElements
);
- $totals->setNumClasses(
- $node->getNumClasses(),
- $node->getNumTestedClasses()
- );
+ if ($coverage->asFloat() >= $this->highLowerBound) {
+ return self::COLOR_GREEN;
+ }
- $totals->setNumTraits(
- $node->getNumTraits(),
- $node->getNumTestedTraits()
- );
+ if ($coverage->asFloat() > $this->lowUpperBound) {
+ return self::COLOR_YELLOW;
+ }
- $totals->setNumMethods(
- $node->getNumMethods(),
- $node->getNumTestedMethods()
- );
-
- $totals->setNumFunctions(
- $node->getNumFunctions(),
- $node->getNumTestedFunctions()
- );
+ return self::COLOR_RED;
}
- private function getTargetDirectory(): string
+ private function printCoverageCounts(int $numberOfCoveredElements, int $totalNumberOfElements, int $precision): string
{
- return $this->target;
+ $format = '%' . $precision . 's';
+
+ return Percentage::fromFractionAndTotal(
+ $numberOfCoveredElements,
+ $totalNumberOfElements
+ )->asFixedWidthString() .
+ ' (' . sprintf($format, $numberOfCoveredElements) . '/' .
+ sprintf($format, $totalNumberOfElements) . ')';
}
/**
- * @throws RuntimeException
+ * @param false|string $string
*/
- private function saveDocument(\DOMDocument $document, string $name): void
+ private function format(string $color, int $padding, $string): string
{
- $filename = \sprintf('%s/%s.xml', $this->getTargetDirectory(), $name);
+ $reset = $color ? self::COLOR_RESET : '';
- $document->formatOutput = true;
- $document->preserveWhiteSpace = false;
- $this->initTargetDirectory(\dirname($filename));
-
- $document->save($filename);
- }
-
- private function createDirectory(string $directory): bool
- {
- return !(!\is_dir($directory) && !@\mkdir($directory, 0777, true) && !\is_dir($directory));
+ return $color . str_pad((string) $string, $padding) . $reset . PHP_EOL;
}
}
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-use SebastianBergmann\CodeCoverage\Util;
-
-final class Totals
-{
- /**
- * @var \DOMNode
- */
- private $container;
-
- /**
- * @var \DOMElement
- */
- private $linesNode;
-
- /**
- * @var \DOMElement
- */
- private $methodsNode;
-
- /**
- * @var \DOMElement
- */
- private $functionsNode;
-
- /**
- * @var \DOMElement
- */
- private $classesNode;
-
- /**
- * @var \DOMElement
- */
- private $traitsNode;
-
- public function __construct(\DOMElement $container)
- {
- $this->container = $container;
- $dom = $container->ownerDocument;
-
- $this->linesNode = $dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'lines'
- );
-
- $this->methodsNode = $dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'methods'
- );
-
- $this->functionsNode = $dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'functions'
- );
-
- $this->classesNode = $dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'classes'
- );
-
- $this->traitsNode = $dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'traits'
- );
-
- $container->appendChild($this->linesNode);
- $container->appendChild($this->methodsNode);
- $container->appendChild($this->functionsNode);
- $container->appendChild($this->classesNode);
- $container->appendChild($this->traitsNode);
- }
-
- public function getContainer(): \DOMNode
- {
- return $this->container;
- }
-
- public function setNumLines(int $loc, int $cloc, int $ncloc, int $executable, int $executed): void
- {
- $this->linesNode->setAttribute('total', (string) $loc);
- $this->linesNode->setAttribute('comments', (string) $cloc);
- $this->linesNode->setAttribute('code', (string) $ncloc);
- $this->linesNode->setAttribute('executable', (string) $executable);
- $this->linesNode->setAttribute('executed', (string) $executed);
- $this->linesNode->setAttribute(
- 'percent',
- $executable === 0 ? '0' : \sprintf('%01.2F', Util::percent($executed, $executable))
- );
- }
-
- public function setNumClasses(int $count, int $tested): void
- {
- $this->classesNode->setAttribute('count', (string) $count);
- $this->classesNode->setAttribute('tested', (string) $tested);
- $this->classesNode->setAttribute(
- 'percent',
- $count === 0 ? '0' : \sprintf('%01.2F', Util::percent($tested, $count))
- );
- }
-
- public function setNumTraits(int $count, int $tested): void
- {
- $this->traitsNode->setAttribute('count', (string) $count);
- $this->traitsNode->setAttribute('tested', (string) $tested);
- $this->traitsNode->setAttribute(
- 'percent',
- $count === 0 ? '0' : \sprintf('%01.2F', Util::percent($tested, $count))
- );
- }
-
- public function setNumMethods(int $count, int $tested): void
- {
- $this->methodsNode->setAttribute('count', (string) $count);
- $this->methodsNode->setAttribute('tested', (string) $tested);
- $this->methodsNode->setAttribute(
- 'percent',
- $count === 0 ? '0' : \sprintf('%01.2F', Util::percent($tested, $count))
- );
- }
-
- public function setNumFunctions(int $count, int $tested): void
- {
- $this->functionsNode->setAttribute('count', (string) $count);
- $this->functionsNode->setAttribute('tested', (string) $tested);
- $this->functionsNode->setAttribute(
- 'percent',
- $count === 0 ? '0' : \sprintf('%01.2F', Util::percent($tested, $count))
- );
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-use SebastianBergmann\Environment\Runtime;
-
-final class BuildInformation
-{
- /**
- * @var \DOMElement
- */
- private $contextNode;
-
- public function __construct(\DOMElement $contextNode)
- {
- $this->contextNode = $contextNode;
- }
-
- public function setRuntimeInformation(Runtime $runtime): void
- {
- $runtimeNode = $this->getNodeByName('runtime');
-
- $runtimeNode->setAttribute('name', $runtime->getName());
- $runtimeNode->setAttribute('version', $runtime->getVersion());
- $runtimeNode->setAttribute('url', $runtime->getVendorUrl());
-
- $driverNode = $this->getNodeByName('driver');
-
- if ($runtime->hasPHPDBGCodeCoverage()) {
- $driverNode->setAttribute('name', 'phpdbg');
- $driverNode->setAttribute('version', \constant('PHPDBG_VERSION'));
- }
-
- if ($runtime->hasXdebug()) {
- $driverNode->setAttribute('name', 'xdebug');
- $driverNode->setAttribute('version', \phpversion('xdebug'));
- }
-
- if ($runtime->hasPCOV()) {
- $driverNode->setAttribute('name', 'pcov');
- $driverNode->setAttribute('version', \phpversion('pcov'));
- }
- }
-
- public function setBuildTime(\DateTime $date): void
- {
- $this->contextNode->setAttribute('time', $date->format('D M j G:i:s T Y'));
- }
-
- public function setGeneratorVersions(string $phpUnitVersion, string $coverageVersion): void
- {
- $this->contextNode->setAttribute('phpunit', $phpUnitVersion);
- $this->contextNode->setAttribute('coverage', $coverageVersion);
- }
-
- private function getNodeByName(string $name): \DOMElement
- {
- $node = $this->contextNode->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- $name
- )->item(0);
-
- if (!$node) {
- $node = $this->contextNode->appendChild(
- $this->contextNode->ownerDocument->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- $name
- )
- );
- }
-
- return $node;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Xml;
-
-class File
-{
- /**
- * @var \DOMDocument
- */
- private $dom;
-
- /**
- * @var \DOMElement
- */
- private $contextNode;
-
- public function __construct(\DOMElement $context)
- {
- $this->dom = $context->ownerDocument;
- $this->contextNode = $context;
- }
-
- public function getTotals(): Totals
- {
- $totalsContainer = $this->contextNode->firstChild;
-
- if (!$totalsContainer) {
- $totalsContainer = $this->contextNode->appendChild(
- $this->dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'totals'
- )
- );
- }
-
- return new Totals($totalsContainer);
- }
-
- public function getLineCoverage(string $line): Coverage
- {
- $coverage = $this->contextNode->getElementsByTagNameNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'coverage'
- )->item(0);
-
- if (!$coverage) {
- $coverage = $this->contextNode->appendChild(
- $this->dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'coverage'
- )
- );
- }
-
- $lineNode = $coverage->appendChild(
- $this->dom->createElementNS(
- 'https://schema.phpunit.de/coverage/1.0',
- 'line'
- )
- );
-
- return new Coverage($lineNode, $line);
- }
-
- protected function getContextNode(): \DOMElement
- {
- return $this->contextNode;
- }
-
- protected function getDomDocument(): \DOMDocument
- {
- return $this->dom;
- }
-}
-
*
@@ -8335,14 +27949,167 @@ class File
*/
namespace SebastianBergmann\CodeCoverage\Report\Html;
+use const DIRECTORY_SEPARATOR;
+use function copy;
+use function date;
+use function dirname;
+use function substr;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\InvalidArgumentException;
+use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode;
+use SebastianBergmann\CodeCoverage\Util\Filesystem;
+
+final class Facade
+{
+ /**
+ * @var string
+ */
+ private $templatePath;
+
+ /**
+ * @var string
+ */
+ private $generator;
+
+ /**
+ * @var int
+ */
+ private $lowUpperBound;
+
+ /**
+ * @var int
+ */
+ private $highLowerBound;
+
+ public function __construct(int $lowUpperBound = 50, int $highLowerBound = 90, string $generator = '')
+ {
+ if ($lowUpperBound > $highLowerBound) {
+ throw new InvalidArgumentException(
+ '$lowUpperBound must not be larger than $highLowerBound'
+ );
+ }
+
+ $this->generator = $generator;
+ $this->highLowerBound = $highLowerBound;
+ $this->lowUpperBound = $lowUpperBound;
+ $this->templatePath = __DIR__ . '/Renderer/Template/';
+ }
+
+ public function process(CodeCoverage $coverage, string $target): void
+ {
+ $target = $this->directory($target);
+ $report = $coverage->getReport();
+ $date = date('D M j G:i:s T Y');
+
+ $dashboard = new Dashboard(
+ $this->templatePath,
+ $this->generator,
+ $date,
+ $this->lowUpperBound,
+ $this->highLowerBound,
+ $coverage->collectsBranchAndPathCoverage()
+ );
+
+ $directory = new Directory(
+ $this->templatePath,
+ $this->generator,
+ $date,
+ $this->lowUpperBound,
+ $this->highLowerBound,
+ $coverage->collectsBranchAndPathCoverage()
+ );
+
+ $file = new File(
+ $this->templatePath,
+ $this->generator,
+ $date,
+ $this->lowUpperBound,
+ $this->highLowerBound,
+ $coverage->collectsBranchAndPathCoverage()
+ );
+
+ $directory->render($report, $target . 'index.html');
+ $dashboard->render($report, $target . 'dashboard.html');
+
+ foreach ($report as $node) {
+ $id = $node->id();
+
+ if ($node instanceof DirectoryNode) {
+ Filesystem::createDirectory($target . $id);
+
+ $directory->render($node, $target . $id . '/index.html');
+ $dashboard->render($node, $target . $id . '/dashboard.html');
+ } else {
+ $dir = dirname($target . $id);
+
+ Filesystem::createDirectory($dir);
+
+ $file->render($node, $target . $id);
+ }
+ }
+
+ $this->copyFiles($target);
+ }
+
+ private function copyFiles(string $target): void
+ {
+ $dir = $this->directory($target . '_css');
+
+ copy($this->templatePath . 'css/bootstrap.min.css', $dir . 'bootstrap.min.css');
+ copy($this->templatePath . 'css/nv.d3.min.css', $dir . 'nv.d3.min.css');
+ copy($this->templatePath . 'css/style.css', $dir . 'style.css');
+ copy($this->templatePath . 'css/custom.css', $dir . 'custom.css');
+ copy($this->templatePath . 'css/octicons.css', $dir . 'octicons.css');
+
+ $dir = $this->directory($target . '_icons');
+ copy($this->templatePath . 'icons/file-code.svg', $dir . 'file-code.svg');
+ copy($this->templatePath . 'icons/file-directory.svg', $dir . 'file-directory.svg');
+
+ $dir = $this->directory($target . '_js');
+ copy($this->templatePath . 'js/bootstrap.min.js', $dir . 'bootstrap.min.js');
+ copy($this->templatePath . 'js/popper.min.js', $dir . 'popper.min.js');
+ copy($this->templatePath . 'js/d3.min.js', $dir . 'd3.min.js');
+ copy($this->templatePath . 'js/jquery.min.js', $dir . 'jquery.min.js');
+ copy($this->templatePath . 'js/nv.d3.min.js', $dir . 'nv.d3.min.js');
+ copy($this->templatePath . 'js/file.js', $dir . 'file.js');
+ }
+
+ private function directory(string $directory): string
+ {
+ if (substr($directory, -1, 1) != DIRECTORY_SEPARATOR) {
+ $directory .= DIRECTORY_SEPARATOR;
+ }
+
+ Filesystem::createDirectory($directory);
+
+ return $directory;
+ }
+}
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\CodeCoverage\Report\Html;
+
+use function array_pop;
+use function count;
+use function sprintf;
+use function str_repeat;
+use function substr_count;
use SebastianBergmann\CodeCoverage\Node\AbstractNode;
use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode;
use SebastianBergmann\CodeCoverage\Node\File as FileNode;
use SebastianBergmann\CodeCoverage\Version;
use SebastianBergmann\Environment\Runtime;
+use SebastianBergmann\Template\Template;
/**
- * Base class for node renderers.
+ * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
*/
abstract class Renderer
{
@@ -8371,32 +28138,38 @@ abstract class Renderer
*/
protected $highLowerBound;
+ /**
+ * @var bool
+ */
+ protected $hasBranchCoverage;
+
/**
* @var string
*/
protected $version;
- public function __construct(string $templatePath, string $generator, string $date, int $lowUpperBound, int $highLowerBound)
+ public function __construct(string $templatePath, string $generator, string $date, int $lowUpperBound, int $highLowerBound, bool $hasBranchCoverage)
{
- $this->templatePath = $templatePath;
- $this->generator = $generator;
- $this->date = $date;
- $this->lowUpperBound = $lowUpperBound;
- $this->highLowerBound = $highLowerBound;
- $this->version = Version::id();
+ $this->templatePath = $templatePath;
+ $this->generator = $generator;
+ $this->date = $date;
+ $this->lowUpperBound = $lowUpperBound;
+ $this->highLowerBound = $highLowerBound;
+ $this->version = Version::id();
+ $this->hasBranchCoverage = $hasBranchCoverage;
}
- protected function renderItemTemplate(\Text_Template $template, array $data): string
+ protected function renderItemTemplate(Template $template, array $data): string
{
- $numSeparator = ' / ';
+ $numSeparator = ' / ';
if (isset($data['numClasses']) && $data['numClasses'] > 0) {
- $classesLevel = $this->getColorLevel($data['testedClassesPercent']);
+ $classesLevel = $this->colorLevel($data['testedClassesPercent']);
$classesNumber = $data['numTestedClasses'] . $numSeparator .
$data['numClasses'];
- $classesBar = $this->getCoverageBar(
+ $classesBar = $this->coverageBar(
$data['testedClassesPercent']
);
} else {
@@ -8407,12 +28180,12 @@ abstract class Renderer
}
if ($data['numMethods'] > 0) {
- $methodsLevel = $this->getColorLevel($data['testedMethodsPercent']);
+ $methodsLevel = $this->colorLevel($data['testedMethodsPercent']);
$methodsNumber = $data['numTestedMethods'] . $numSeparator .
$data['numMethods'];
- $methodsBar = $this->getCoverageBar(
+ $methodsBar = $this->coverageBar(
$data['testedMethodsPercent']
);
} else {
@@ -8423,12 +28196,12 @@ abstract class Renderer
}
if ($data['numExecutableLines'] > 0) {
- $linesLevel = $this->getColorLevel($data['linesExecutedPercent']);
+ $linesLevel = $this->colorLevel($data['linesExecutedPercent']);
$linesNumber = $data['numExecutedLines'] . $numSeparator .
$data['numExecutableLines'];
- $linesBar = $this->getCoverageBar(
+ $linesBar = $this->coverageBar(
$data['linesExecutedPercent']
);
} else {
@@ -8438,40 +28211,80 @@ abstract class Renderer
$data['linesExecutedPercentAsString'] = 'n/a';
}
+ if ($data['numExecutablePaths'] > 0) {
+ $pathsLevel = $this->colorLevel($data['pathsExecutedPercent']);
+
+ $pathsNumber = $data['numExecutedPaths'] . $numSeparator .
+ $data['numExecutablePaths'];
+
+ $pathsBar = $this->coverageBar(
+ $data['pathsExecutedPercent']
+ );
+ } else {
+ $pathsLevel = '';
+ $pathsNumber = '0' . $numSeparator . '0';
+ $pathsBar = '';
+ $data['pathsExecutedPercentAsString'] = 'n/a';
+ }
+
+ if ($data['numExecutableBranches'] > 0) {
+ $branchesLevel = $this->colorLevel($data['branchesExecutedPercent']);
+
+ $branchesNumber = $data['numExecutedBranches'] . $numSeparator .
+ $data['numExecutableBranches'];
+
+ $branchesBar = $this->coverageBar(
+ $data['branchesExecutedPercent']
+ );
+ } else {
+ $branchesLevel = '';
+ $branchesNumber = '0' . $numSeparator . '0';
+ $branchesBar = '';
+ $data['branchesExecutedPercentAsString'] = 'n/a';
+ }
+
$template->setVar(
[
- 'icon' => $data['icon'] ?? '',
- 'crap' => $data['crap'] ?? '',
- 'name' => $data['name'],
- 'lines_bar' => $linesBar,
- 'lines_executed_percent' => $data['linesExecutedPercentAsString'],
- 'lines_level' => $linesLevel,
- 'lines_number' => $linesNumber,
- 'methods_bar' => $methodsBar,
- 'methods_tested_percent' => $data['testedMethodsPercentAsString'],
- 'methods_level' => $methodsLevel,
- 'methods_number' => $methodsNumber,
- 'classes_bar' => $classesBar,
- 'classes_tested_percent' => $data['testedClassesPercentAsString'] ?? '',
- 'classes_level' => $classesLevel,
- 'classes_number' => $classesNumber,
+ 'icon' => $data['icon'] ?? '',
+ 'crap' => $data['crap'] ?? '',
+ 'name' => $data['name'],
+ 'lines_bar' => $linesBar,
+ 'lines_executed_percent' => $data['linesExecutedPercentAsString'],
+ 'lines_level' => $linesLevel,
+ 'lines_number' => $linesNumber,
+ 'paths_bar' => $pathsBar,
+ 'paths_executed_percent' => $data['pathsExecutedPercentAsString'],
+ 'paths_level' => $pathsLevel,
+ 'paths_number' => $pathsNumber,
+ 'branches_bar' => $branchesBar,
+ 'branches_executed_percent' => $data['branchesExecutedPercentAsString'],
+ 'branches_level' => $branchesLevel,
+ 'branches_number' => $branchesNumber,
+ 'methods_bar' => $methodsBar,
+ 'methods_tested_percent' => $data['testedMethodsPercentAsString'],
+ 'methods_level' => $methodsLevel,
+ 'methods_number' => $methodsNumber,
+ 'classes_bar' => $classesBar,
+ 'classes_tested_percent' => $data['testedClassesPercentAsString'] ?? '',
+ 'classes_level' => $classesLevel,
+ 'classes_number' => $classesNumber,
]
);
return $template->render();
}
- protected function setCommonTemplateVariables(\Text_Template $template, AbstractNode $node): void
+ protected function setCommonTemplateVariables(Template $template, AbstractNode $node): void
{
$template->setVar(
[
- 'id' => $node->getId(),
- 'full_path' => $node->getPath(),
- 'path_to_root' => $this->getPathToRoot($node),
- 'breadcrumbs' => $this->getBreadcrumbs($node),
+ 'id' => $node->id(),
+ 'full_path' => $node->pathAsString(),
+ 'path_to_root' => $this->pathToRoot($node),
+ 'breadcrumbs' => $this->breadcrumbs($node),
'date' => $this->date,
'version' => $this->version,
- 'runtime' => $this->getRuntimeString(),
+ 'runtime' => $this->runtimeString(),
'generator' => $this->generator,
'low_upper_bound' => $this->lowUpperBound,
'high_lower_bound' => $this->highLowerBound,
@@ -8479,40 +28292,40 @@ abstract class Renderer
);
}
- protected function getBreadcrumbs(AbstractNode $node): string
+ protected function breadcrumbs(AbstractNode $node): string
{
$breadcrumbs = '';
- $path = $node->getPathAsArray();
+ $path = $node->pathAsArray();
$pathToRoot = [];
- $max = \count($path);
+ $max = count($path);
if ($node instanceof FileNode) {
$max--;
}
for ($i = 0; $i < $max; $i++) {
- $pathToRoot[] = \str_repeat('../', $i);
+ $pathToRoot[] = str_repeat('../', $i);
}
foreach ($path as $step) {
if ($step !== $node) {
- $breadcrumbs .= $this->getInactiveBreadcrumb(
+ $breadcrumbs .= $this->inactiveBreadcrumb(
$step,
- \array_pop($pathToRoot)
+ array_pop($pathToRoot)
);
} else {
- $breadcrumbs .= $this->getActiveBreadcrumb($step);
+ $breadcrumbs .= $this->activeBreadcrumb($step);
}
}
return $breadcrumbs;
}
- protected function getActiveBreadcrumb(AbstractNode $node): string
+ protected function activeBreadcrumb(AbstractNode $node): string
{
- $buffer = \sprintf(
+ $buffer = sprintf(
' %s' . "\n",
- $node->getName()
+ $node->name()
);
if ($node instanceof DirectoryNode) {
@@ -8522,44 +28335,45 @@ abstract class Renderer
return $buffer;
}
- protected function getInactiveBreadcrumb(AbstractNode $node, string $pathToRoot): string
+ protected function inactiveBreadcrumb(AbstractNode $node, string $pathToRoot): string
{
- return \sprintf(
+ return sprintf(
' %s' . "\n",
$pathToRoot,
- $node->getName()
+ $node->name()
);
}
- protected function getPathToRoot(AbstractNode $node): string
+ protected function pathToRoot(AbstractNode $node): string
{
- $id = $node->getId();
- $depth = \substr_count($id, '/');
+ $id = $node->id();
+ $depth = substr_count($id, '/');
if ($id !== 'index' &&
$node instanceof DirectoryNode) {
$depth++;
}
- return \str_repeat('../', $depth);
+ return str_repeat('../', $depth);
}
- protected function getCoverageBar(float $percent): string
+ protected function coverageBar(float $percent): string
{
- $level = $this->getColorLevel($percent);
+ $level = $this->colorLevel($percent);
- $template = new \Text_Template(
- $this->templatePath . 'coverage_bar.html',
+ $templateName = $this->templatePath . ($this->hasBranchCoverage ? 'coverage_bar_branch.html' : 'coverage_bar.html');
+ $template = new Template(
+ $templateName,
'{{',
'}}'
);
- $template->setVar(['level' => $level, 'percent' => \sprintf('%.2F', $percent)]);
+ $template->setVar(['level' => $level, 'percent' => sprintf('%.2F', $percent)]);
return $template->render();
}
- protected function getColorLevel(float $percent): string
+ protected function colorLevel(float $percent): string
{
if ($percent <= $this->lowUpperBound) {
return 'danger';
@@ -8573,411 +28387,16 @@ abstract class Renderer
return 'success';
}
- private function getRuntimeString(): string
+ private function runtimeString(): string
{
$runtime = new Runtime;
- $buffer = \sprintf(
+ return sprintf(
'%s %s',
$runtime->getVendorUrl(),
$runtime->getName(),
$runtime->getVersion()
);
-
- if ($runtime->hasXdebug() && !$runtime->hasPHPDBGCodeCoverage()) {
- $buffer .= \sprintf(
- ' with Xdebug %s',
- \phpversion('xdebug')
- );
- }
-
- if ($runtime->hasPCOV() && !$runtime->hasPHPDBGCodeCoverage()) {
- $buffer .= \sprintf(
- ' with PCOV %s',
- \phpversion('pcov')
- );
- }
-
- return $buffer;
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Html;
-
-use SebastianBergmann\CodeCoverage\Node\AbstractNode as Node;
-use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode;
-
-/**
- * Renders a directory node.
- */
-final class Directory extends Renderer
-{
- /**
- * @throws \InvalidArgumentException
- * @throws \RuntimeException
- */
- public function render(DirectoryNode $node, string $file): void
- {
- $template = new \Text_Template($this->templatePath . 'directory.html', '{{', '}}');
-
- $this->setCommonTemplateVariables($template, $node);
-
- $items = $this->renderItem($node, true);
-
- foreach ($node->getDirectories() as $item) {
- $items .= $this->renderItem($item);
- }
-
- foreach ($node->getFiles() as $item) {
- $items .= $this->renderItem($item);
- }
-
- $template->setVar(
- [
- 'id' => $node->getId(),
- 'items' => $items,
- ]
- );
-
- $template->renderTo($file);
- }
-
- protected function renderItem(Node $node, bool $total = false): string
- {
- $data = [
- 'numClasses' => $node->getNumClassesAndTraits(),
- 'numTestedClasses' => $node->getNumTestedClassesAndTraits(),
- 'numMethods' => $node->getNumFunctionsAndMethods(),
- 'numTestedMethods' => $node->getNumTestedFunctionsAndMethods(),
- 'linesExecutedPercent' => $node->getLineExecutedPercent(false),
- 'linesExecutedPercentAsString' => $node->getLineExecutedPercent(),
- 'numExecutedLines' => $node->getNumExecutedLines(),
- 'numExecutableLines' => $node->getNumExecutableLines(),
- 'testedMethodsPercent' => $node->getTestedFunctionsAndMethodsPercent(false),
- 'testedMethodsPercentAsString' => $node->getTestedFunctionsAndMethodsPercent(),
- 'testedClassesPercent' => $node->getTestedClassesAndTraitsPercent(false),
- 'testedClassesPercentAsString' => $node->getTestedClassesAndTraitsPercent(),
- ];
-
- if ($total) {
- $data['name'] = 'Total';
- } else {
- if ($node instanceof DirectoryNode) {
- $data['name'] = \sprintf(
- '%s',
- $node->getName(),
- $node->getName()
- );
-
- $up = \str_repeat('../', \count($node->getPathAsArray()) - 2);
-
- $data['icon'] = \sprintf('
', $up);
- } else {
- $data['name'] = \sprintf(
- '%s',
- $node->getName(),
- $node->getName()
- );
-
- $up = \str_repeat('../', \count($node->getPathAsArray()) - 2);
-
- $data['icon'] = \sprintf('
', $up);
- }
- }
-
- return $this->renderItemTemplate(
- new \Text_Template($this->templatePath . 'directory_item.html', '{{', '}}'),
- $data
- );
- }
-}
-
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-namespace SebastianBergmann\CodeCoverage\Report\Html;
-
-use SebastianBergmann\CodeCoverage\Node\AbstractNode;
-use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode;
-
-/**
- * Renders the dashboard for a directory node.
- */
-final class Dashboard extends Renderer
-{
- /**
- * @throws \InvalidArgumentException
- * @throws \RuntimeException
- */
- public function render(DirectoryNode $node, string $file): void
- {
- $classes = $node->getClassesAndTraits();
- $template = new \Text_Template(
- $this->templatePath . 'dashboard.html',
- '{{',
- '}}'
- );
-
- $this->setCommonTemplateVariables($template, $node);
-
- $baseLink = $node->getId() . '/';
- $complexity = $this->complexity($classes, $baseLink);
- $coverageDistribution = $this->coverageDistribution($classes);
- $insufficientCoverage = $this->insufficientCoverage($classes, $baseLink);
- $projectRisks = $this->projectRisks($classes, $baseLink);
-
- $template->setVar(
- [
- 'insufficient_coverage_classes' => $insufficientCoverage['class'],
- 'insufficient_coverage_methods' => $insufficientCoverage['method'],
- 'project_risks_classes' => $projectRisks['class'],
- 'project_risks_methods' => $projectRisks['method'],
- 'complexity_class' => $complexity['class'],
- 'complexity_method' => $complexity['method'],
- 'class_coverage_distribution' => $coverageDistribution['class'],
- 'method_coverage_distribution' => $coverageDistribution['method'],
- ]
- );
-
- $template->renderTo($file);
- }
-
- /**
- * Returns the data for the Class/Method Complexity charts.
- */
- protected function complexity(array $classes, string $baseLink): array
- {
- $result = ['class' => [], 'method' => []];
-
- foreach ($classes as $className => $class) {
- foreach ($class['methods'] as $methodName => $method) {
- if ($className !== '*') {
- $methodName = $className . '::' . $methodName;
- }
-
- $result['method'][] = [
- $method['coverage'],
- $method['ccn'],
- \sprintf(
- '%s',
- \str_replace($baseLink, '', $method['link']),
- $methodName
- ),
- ];
- }
-
- $result['class'][] = [
- $class['coverage'],
- $class['ccn'],
- \sprintf(
- '%s',
- \str_replace($baseLink, '', $class['link']),
- $className
- ),
- ];
- }
-
- return [
- 'class' => \json_encode($result['class']),
- 'method' => \json_encode($result['method']),
- ];
- }
-
- /**
- * Returns the data for the Class / Method Coverage Distribution chart.
- */
- protected function coverageDistribution(array $classes): array
- {
- $result = [
- 'class' => [
- '0%' => 0,
- '0-10%' => 0,
- '10-20%' => 0,
- '20-30%' => 0,
- '30-40%' => 0,
- '40-50%' => 0,
- '50-60%' => 0,
- '60-70%' => 0,
- '70-80%' => 0,
- '80-90%' => 0,
- '90-100%' => 0,
- '100%' => 0,
- ],
- 'method' => [
- '0%' => 0,
- '0-10%' => 0,
- '10-20%' => 0,
- '20-30%' => 0,
- '30-40%' => 0,
- '40-50%' => 0,
- '50-60%' => 0,
- '60-70%' => 0,
- '70-80%' => 0,
- '80-90%' => 0,
- '90-100%' => 0,
- '100%' => 0,
- ],
- ];
-
- foreach ($classes as $class) {
- foreach ($class['methods'] as $methodName => $method) {
- if ($method['coverage'] === 0) {
- $result['method']['0%']++;
- } elseif ($method['coverage'] === 100) {
- $result['method']['100%']++;
- } else {
- $key = \floor($method['coverage'] / 10) * 10;
- $key = $key . '-' . ($key + 10) . '%';
- $result['method'][$key]++;
- }
- }
-
- if ($class['coverage'] === 0) {
- $result['class']['0%']++;
- } elseif ($class['coverage'] === 100) {
- $result['class']['100%']++;
- } else {
- $key = \floor($class['coverage'] / 10) * 10;
- $key = $key . '-' . ($key + 10) . '%';
- $result['class'][$key]++;
- }
- }
-
- return [
- 'class' => \json_encode(\array_values($result['class'])),
- 'method' => \json_encode(\array_values($result['method'])),
- ];
- }
-
- /**
- * Returns the classes / methods with insufficient coverage.
- */
- protected function insufficientCoverage(array $classes, string $baseLink): array
- {
- $leastTestedClasses = [];
- $leastTestedMethods = [];
- $result = ['class' => '', 'method' => ''];
-
- foreach ($classes as $className => $class) {
- foreach ($class['methods'] as $methodName => $method) {
- if ($method['coverage'] < $this->highLowerBound) {
- $key = $methodName;
-
- if ($className !== '*') {
- $key = $className . '::' . $methodName;
- }
-
- $leastTestedMethods[$key] = $method['coverage'];
- }
- }
-
- if ($class['coverage'] < $this->highLowerBound) {
- $leastTestedClasses[$className] = $class['coverage'];
- }
- }
-
- \asort($leastTestedClasses);
- \asort($leastTestedMethods);
-
- foreach ($leastTestedClasses as $className => $coverage) {
- $result['class'] .= \sprintf(
- ' | %s | %d%% |
' . "\n",
- \str_replace($baseLink, '', $classes[$className]['link']),
- $className,
- $coverage
- );
- }
-
- foreach ($leastTestedMethods as $methodName => $coverage) {
- [$class, $method] = \explode('::', $methodName);
-
- $result['method'] .= \sprintf(
- ' | %s | %d%% |
' . "\n",
- \str_replace($baseLink, '', $classes[$class]['methods'][$method]['link']),
- $methodName,
- $method,
- $coverage
- );
- }
-
- return $result;
- }
-
- /**
- * Returns the project risks according to the CRAP index.
- */
- protected function projectRisks(array $classes, string $baseLink): array
- {
- $classRisks = [];
- $methodRisks = [];
- $result = ['class' => '', 'method' => ''];
-
- foreach ($classes as $className => $class) {
- foreach ($class['methods'] as $methodName => $method) {
- if ($method['coverage'] < $this->highLowerBound && $method['ccn'] > 1) {
- $key = $methodName;
-
- if ($className !== '*') {
- $key = $className . '::' . $methodName;
- }
-
- $methodRisks[$key] = $method['crap'];
- }
- }
-
- if ($class['coverage'] < $this->highLowerBound &&
- $class['ccn'] > \count($class['methods'])) {
- $classRisks[$className] = $class['crap'];
- }
- }
-
- \arsort($classRisks);
- \arsort($methodRisks);
-
- foreach ($classRisks as $className => $crap) {
- $result['class'] .= \sprintf(
- ' | %s | %d |
' . "\n",
- \str_replace($baseLink, '', $classes[$className]['link']),
- $className,
- $crap
- );
- }
-
- foreach ($methodRisks as $methodName => $crap) {
- [$class, $method] = \explode('::', $methodName);
-
- $result['method'] .= \sprintf(
- ' | %s | %d |
' . "\n",
- \str_replace($baseLink, '', $classes[$class]['methods'][$method]['link']),
- $methodName,
- $method,
- $crap
- );
- }
-
- return $result;
- }
-
- protected function getActiveBreadcrumb(AbstractNode $node): string
- {
- return \sprintf(
- ' %s' . "\n" .
- ' (Dashboard)' . "\n",
- $node->getName()
- );
}
}
@@ -9015,9 +28434,9 @@ final class Dashboard extends Renderer
| |
- Classes and Traits |
- Functions and Methods |
Lines |
+ Functions and Methods |
+ Classes and Traits |
@@ -9025,19 +28444,12 @@ final class Dashboard extends Renderer
-
+{{structure}}