addFileToBlacklist(__FILE__, 'DEFAULT'); App::uses('BaseCoverageReport', 'TestSuite/Coverage'); class HtmlCoverageReport extends BaseCoverageReport { /** * Generates report html to display. * * @return string compiled html report. */ public function report() { $pathFilter = $this->getPathFilter(); $coverageData = $this->filterCoverageDataByPath($pathFilter); if (empty($coverageData)) { return '

No files to generate coverage for

'; } $output = $this->coverageScript(); $output .= <<Code coverage results Toggle all files HTML; foreach ($coverageData as $file => $coverageData) { $fileData = file($file); $output .= $this->generateDiff($file, $fileData, $coverageData); } return $output; } /** * Generates an HTML diff for $file based on $coverageData. * * @param string $filename Name of the file having coverage generated * @param array $fileLines File data as an array. See file() for how to get one of these. * @param array $coverageData Array of coverage data to use to generate HTML diffs with * @return string HTML diff. */ public function generateDiff($filename, $fileLines, $coverageData) { $output = ''; $diff = array(); list($covered, $total) = $this->_calculateCoveredLines($fileLines, $coverageData); //shift line numbers forward one; array_unshift($fileLines, ' '); unset($fileLines[0]); foreach ($fileLines as $lineno => $line) { $class = 'ignored'; $coveringTests = array(); if (isset($coverageData[$lineno]) && is_array($coverageData[$lineno])) { $coveringTests = array(); foreach ($coverageData[$lineno] as $test) { $testReflection = new ReflectionClass(current(explode('::', $test['id']))); $this->_testNames[] = $this->_guessSubjectName($testReflection); $coveringTests[] = $test['id']; } $class = 'covered'; } elseif (isset($coverageData[$lineno]) && $coverageData[$lineno] === -1) { $class = 'uncovered'; } elseif (isset($coverageData[$lineno]) && $coverageData[$lineno] === -2) { $class .= ' dead'; } $diff[] = $this->_paintLine($line, $lineno, $class, $coveringTests); } $percentCovered = round(100 * $covered / $total, 2); $output .= $this->coverageHeader($filename, $percentCovered); $output .= implode("", $diff); $output .= $this->coverageFooter(); return $output; } /** * Guess the classname the test was for based on the test case filename. * * @param ReflectionClass $testReflection. * @return string Possible test subject name. */ protected function _guessSubjectName($testReflection) { $basename = basename($testReflection->getFilename()); if (strpos($basename, '.test') !== false) { list($subject, ) = explode('.', $basename, 2); return $subject; } $subject = str_replace('Test.php', '', $basename); return $subject; } /** * Renders the html for a single line in the html diff. * * @return void */ protected function _paintLine($line, $linenumber, $class, $coveringTests) { $coveredBy = ''; if (!empty($coveringTests)) { $coveredBy = "Covered by:\n"; foreach ($coveringTests as $test) { $coveredBy .= $test . "\n"; } } return sprintf( '
%s%s
', $class, $coveredBy, $linenumber, htmlspecialchars($line) ); } /** * generate some javascript for the coverage report. * * @return void */ public function coverageScript() { return << function coverage_show_hide(selector) { var element = document.getElementById(selector); element.style.display = (element.style.display == 'none') ? '' : 'none'; } function coverage_toggle_all () { var divs = document.querySelectorAll('div.coverage-container'); var i = divs.length; while (i--) { if (divs[i] && divs[i].className.indexOf('primary') == -1) { divs[i].style.display = (divs[i].style.display == 'none') ? '' : 'none'; } } } HTML; } /** * Generate an HTML snippet for coverage headers * * @return void */ public function coverageHeader($filename, $percent) { $filename = basename($filename); list($file, $ext) = explode('.', $filename); $display = in_array($file, $this->_testNames) ? 'block' : 'none'; $primary = $display == 'block' ? 'primary' : ''; return <<

$filename Code coverage: $percent%

"; } }