class PHP_CodeCoverage_Report_Crap4j in Zircon Profile 8

@since Class available since Release 2.0.0

Hierarchy

• class \PHP_CodeCoverage_Report_Crap4j

File

vendor/phpunit/php-code-coverage/src/CodeCoverage/Report/Crap4j.php, line 14

class PHP_CodeCoverage_Report_Crap4j {

  /**
   * @var int
   */
  private $threshold;

  /**
   * @param int $threshold
   */
  public function __construct($threshold = 30) {
    if (!is_int($threshold)) {
      throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(1, 'integer');
    }
    $this->threshold = $threshold;
  }

  /**
   * @param  PHP_CodeCoverage $coverage
   * @param  string           $target
   * @param  string           $name
   * @return string
   */
  public function process(PHP_CodeCoverage $coverage, $target = null, $name = null) {
    $document = new DOMDocument('1.0', 'UTF-8');
    $document->formatOutput = true;
    $root = $document
      ->createElement('crap_result');
    $document
      ->appendChild($root);
    $project = $document
      ->createElement('project', is_string($name) ? $name : '');
    $root
      ->appendChild($project);
    $root
      ->appendChild($document
      ->createElement('timestamp', date('Y-m-d H:i:s', (int) $_SERVER['REQUEST_TIME'])));
    $stats = $document
      ->createElement('stats');
    $methodsNode = $document
      ->createElement('methods');
    $report = $coverage
      ->getReport();
    unset($coverage);
    $fullMethodCount = 0;
    $fullCrapMethodCount = 0;
    $fullCrapLoad = 0;
    $fullCrap = 0;
    foreach ($report as $item) {
      $namespace = 'global';
      if (!$item instanceof PHP_CodeCoverage_Report_Node_File) {
        continue;
      }
      $file = $document
        ->createElement('file');
      $file
        ->setAttribute('name', $item
        ->getPath());
      $classes = $item
        ->getClassesAndTraits();
      foreach ($classes as $className => $class) {
        foreach ($class['methods'] as $methodName => $method) {
          $crapLoad = $this
            ->getCrapLoad($method['crap'], $method['ccn'], $method['coverage']);
          $fullCrap += $method['crap'];
          $fullCrapLoad += $crapLoad;
          $fullMethodCount++;
          if ($method['crap'] >= $this->threshold) {
            $fullCrapMethodCount++;
          }
          $methodNode = $document
            ->createElement('method');
          if (!empty($class['package']['namespace'])) {
            $namespace = $class['package']['namespace'];
          }
          $methodNode
            ->appendChild($document
            ->createElement('package', $namespace));
          $methodNode
            ->appendChild($document
            ->createElement('className', $className));
          $methodNode
            ->appendChild($document
            ->createElement('methodName', $methodName));
          $methodNode
            ->appendChild($document
            ->createElement('methodSignature', htmlspecialchars($method['signature'])));
          $methodNode
            ->appendChild($document
            ->createElement('fullMethod', htmlspecialchars($method['signature'])));
          $methodNode
            ->appendChild($document
            ->createElement('crap', $this
            ->roundValue($method['crap'])));
          $methodNode
            ->appendChild($document
            ->createElement('complexity', $method['ccn']));
          $methodNode
            ->appendChild($document
            ->createElement('coverage', $this
            ->roundValue($method['coverage'])));
          $methodNode
            ->appendChild($document
            ->createElement('crapLoad', round($crapLoad)));
          $methodsNode
            ->appendChild($methodNode);
        }
      }
    }
    $stats
      ->appendChild($document
      ->createElement('name', 'Method Crap Stats'));
    $stats
      ->appendChild($document
      ->createElement('methodCount', $fullMethodCount));
    $stats
      ->appendChild($document
      ->createElement('crapMethodCount', $fullCrapMethodCount));
    $stats
      ->appendChild($document
      ->createElement('crapLoad', round($fullCrapLoad)));
    $stats
      ->appendChild($document
      ->createElement('totalCrap', $fullCrap));
    if ($fullMethodCount > 0) {
      $crapMethodPercent = $this
        ->roundValue(100 * $fullCrapMethodCount / $fullMethodCount);
    }
    else {
      $crapMethodPercent = 0;
    }
    $stats
      ->appendChild($document
      ->createElement('crapMethodPercent', $crapMethodPercent));
    $root
      ->appendChild($stats);
    $root
      ->appendChild($methodsNode);
    if ($target !== null) {
      if (!is_dir(dirname($target))) {
        mkdir(dirname($target), 0777, true);
      }
      return $document
        ->save($target);
    }
    else {
      return $document
        ->saveXML();
    }
  }

  /**
   * @param  float $crapValue
   * @param  int   $cyclomaticComplexity
   * @param  float $coveragePercent
   * @return float
   */
  private function getCrapLoad($crapValue, $cyclomaticComplexity, $coveragePercent) {
    $crapLoad = 0;
    if ($crapValue >= $this->threshold) {
      $crapLoad += $cyclomaticComplexity * (1.0 - $coveragePercent / 100);
      $crapLoad += $cyclomaticComplexity / $this->threshold;
    }
    return $crapLoad;
  }

  /**
   * @param  float $value
   * @return float
   */
  private function roundValue($value) {
    return round($value, 2);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHP_CodeCoverage_Report_Crap4j::$threshold	private	property
PHP_CodeCoverage_Report_Crap4j::getCrapLoad	private	function
PHP_CodeCoverage_Report_Crap4j::process	public	function
PHP_CodeCoverage_Report_Crap4j::roundValue	private	function
PHP_CodeCoverage_Report_Crap4j::__construct	public	function