_rawCoverage = $coverage;
$this->setParams($reporter);
}
/**
* Pulls params out of the reporter.
*
* @return void
*/
protected function setParams(CakeBaseReporter $reporter) {
if ($reporter->params['app']) {
$this->appTest = true;
}
if ($reporter->params['group']) {
$this->groupTest = true;
}
if ($reporter->params['plugin']) {
$this->pluginTest = Inflector::underscore($reporter->params['plugin']);
}
}
/**
* Set the coverage data array
*
* @return void
*/
public function setCoverage($coverage) {
$this->_rawCoverage = $coverage;
}
/**
* 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 = '';
foreach ($coverageData as $file => $coverageData) {
$fileData = file($file);
$output .= $this->generateDiff($file, $fileData, $coverageData);
}
return $output;
}
/**
* Gets the base path that the files we are interested in live in.
* If appTest ist
*
* @return void
*/
public function getPathFilter() {
$path = ROOT . DS;
if ($this->appTest) {
$path .= APP_DIR . DS;
} elseif ($this->pluginTest) {
$path = App::pluginPath($this->pluginTest);
} else {
$path = TEST_CAKE_CORE_INCLUDE_PATH;
}
return $path;
}
/**
* Filters the coverage data by path. Files not in the provided path will be removed.
* This method will merge all the various test run reports as well into a single report per file.
*
* @param string $path Path to filter files by.
* @return array Array of coverage data for files that match the given path.
*/
public function filterCoverageDataByPath($path) {
$files = array();
foreach ($this->_rawCoverage as $testRun) {
foreach ($testRun['data'] as $filename => $fileCoverage) {
if (strpos($filename, $path) !== 0) {
continue;
}
if (!isset($files[$filename])) {
$files[$filename] = array();
}
foreach ($fileCoverage as $line => $value) {
if (!isset($files[$filename][$line])) {
$files[$filename][$line] = $value;
} elseif ($files[$filename][$line] < $value) {
$files[$filename][$line] = $value;
}
}
}
}
ksort($files);
return $files;
}
/**
* Removes non executable lines of code from a file contents string.
*
* @param array $lines in the file.
* @return array Array for the file with lines marked as not runnable.
*/
public function getExecutableLines($lines) {
$output = array();
$phpTagPattern = '/^[ |\t]*[<\?php|\?>]+[ |\t]*/';
$basicallyEmptyPattern = '/^[ |\t]*[{|}|\(|\)]+[ |\t]*/';
$commentStart = '/\/\*\*/';
$commentEnd = '/\*\//';
$ignoreStart = '/@codeCoverageIgnoreStart/';
$ignoreStop = '/@codeCoverageIgnoreEnd/';
$inComment = false;
foreach ($lines as $lineno => $line) {
$runnable = true;
if (preg_match($phpTagPattern, $line) || preg_match($basicallyEmptyPattern, $line)) {
$runnable = false;
}
if ($runnable && preg_match($commentStart, $line)) {
$runnable = false;
$inComment = true;
}
if ($inComment == true) {
$runnable = false;
}
if (!$runnable && preg_match($commentEnd, $line)) {
$inComment = false;
}
$output[$lineno] = $runnable;
}
return $output;
}
/**
* Generates an HTML diff for $file based on $coverageData.
*
* @param array $fileData 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.
*/
function generateDiff($filename, $fileLines, $coverageData) {
$output = '';
$diff = array();
$covered = 0;
$total = 0;
//shift line numbers forward one;
array_unshift($fileLines, ' ');
unset($fileLines[0]);
$executableLines = $this->getExecutableLines($fileLines);
foreach ($fileLines as $lineno => $line) {
$manualFind = (
isset($executableLines[$lineno]) &&
$executableLines[$lineno] == true &&
trim($line) != ''
);
$class = 'ignored';
if ($manualFind) {
$class = 'uncovered';
$total++;
if (isset($coverageData[$lineno]) && $coverageData[$lineno] > 0) {
$class = 'covered';
$covered++;
}
}
$diff[] = $this->_paintLine($line, $lineno, $class);
}
$percentCovered = round(100 * $covered / $total, 2);
$output .= $this->coverageHeader($filename, $percentCovered);
$output .= implode("", $diff);
$output .= $this->coverageFooter();
return $output;
}
/**
* Renders the html for a single line in the html diff.
*
* @return void
*/
protected function _paintLine($line, $linenumber, $class) {
return sprintf(
'
%s%s
',
$class,
$linenumber,
htmlspecialchars($line)
);
}
/**
* Generate an HTML snippet for coverage headers
*
* @return void
*/
public function coverageHeader($filename, $percent) {
$filename = basename($filename);
return <<$filename Code coverage: $percent%
HTML;
}
/**
* Generate an HTML snippet for coverage footers
*
* @return void
*/
public function coverageFooter() {
return "