TextCoverageReport.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?php
  2. /**
  3. * Generates code coverage reports in Simple plain text from data obtained from PHPUnit
  4. *
  5. * PHP5
  6. *
  7. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8. * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
  9. *
  10. * Licensed under The MIT License
  11. * Redistributions of files must retain the above copyright notice.
  12. *
  13. * @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
  14. * @link http://cakephp.org CakePHP(tm) Project
  15. * @package Cake.TestSuite.Coverage
  16. * @since CakePHP(tm) v 2.0
  17. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  18. */
  19. App::uses('BaseCoverageReport', 'TestSuite/Coverage');
  20. PHP_CodeCoverage_Filter::getInstance()->addFileToBlacklist(__FILE__, 'DEFAULT');
  21. class TextCoverageReport extends BaseCoverageReport {
  22. /**
  23. * Generates report text to display.
  24. *
  25. * @return string compiled plain text report.
  26. */
  27. public function report() {
  28. $pathFilter = $this->getPathFilter();
  29. $coverageData = $this->filterCoverageDataByPath($pathFilter);
  30. if (empty($coverageData)) {
  31. return 'No files to generate coverage for';
  32. }
  33. $output = "\nCoverage Report:\n\n";
  34. foreach ($coverageData as $file => $coverageData) {
  35. $fileData = file($file);
  36. $output .= $this->generateDiff($file, $fileData, $coverageData);
  37. }
  38. return $output;
  39. }
  40. /**
  41. * Generates a 'diff' report for a file.
  42. * Since diffs are too big for plain text reports a simple file => % covered is done.
  43. *
  44. * @param string $filename Name of the file having coverage generated
  45. * @param array $fileLines File data as an array. See file() for how to get one of these.
  46. * @param array $coverageData Array of coverage data to use to generate HTML diffs with
  47. * @return string
  48. */
  49. public function generateDiff($filename, $fileLines, $coverageData) {
  50. list($covered, $total) = $this->_calculateCoveredLines($fileLines, $coverageData);
  51. $percentCovered = round(100 * $covered / $total, 2);
  52. return "$filename : $percentCovered%\n";
  53. }
  54. }