TextCoverageReport.php 2.1 KB

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