TextCoverageReport.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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. class TextCoverageReport extends BaseCoverageReport {
  21. /**
  22. * Generates report text to display.
  23. *
  24. * @return string compiled plain text report.
  25. */
  26. public function report() {
  27. $pathFilter = $this->getPathFilter();
  28. $coverageData = $this->filterCoverageDataByPath($pathFilter);
  29. if (empty($coverageData)) {
  30. return 'No files to generate coverage for';
  31. }
  32. $output = "\nCoverage Report:\n\n";
  33. foreach ($coverageData as $file => $coverageData) {
  34. $fileData = file($file);
  35. $output .= $this->generateDiff($file, $fileData, $coverageData);
  36. }
  37. return $output;
  38. }
  39. /**
  40. * Generates a 'diff' report for a file.
  41. * Since diffs are too big for plain text reports a simple file => % covered is done.
  42. *
  43. * @param string $filename Name of the file having coverage generated
  44. * @param array $fileLines File data as an array. See file() for how to get one of these.
  45. * @param array $coverageData Array of coverage data to use to generate HTML diffs with
  46. * @return string
  47. */
  48. public function generateDiff($filename, $fileLines, $coverageData) {
  49. list($covered, $total) = $this->_calculateCoveredLines($fileLines, $coverageData);
  50. $percentCovered = round(100 * $covered / $total, 2);
  51. return "$filename : $percentCovered%\n";
  52. }
  53. }