tests/PHPUnit/Util/Log/PMD/Rule/Project/CRAP.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Util/Log/PMD/Rule/Project.php';
  48 require_once 'PHPUnit/Util/Log/PMD/Rule/Function.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  *
  55  *
  56  * @category   Testing
  57  * @package    PHPUnit
  58  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  59  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  60  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  61  * @version    Release: 3.3.17
  62  * @link       http://www.phpunit.de/
  63  * @since      Class available since Release 3.2.0
  64  */
  65 class PHPUnit_Util_Log_PMD_Rule_Project_CRAP extends PHPUnit_Util_Log_PMD_Rule_Project
  66 {
  67     public function __construct($threshold = array(5, 30), $priority = 1)
  68     {
  69         parent::__construct($threshold, $priority);
  70     }
  71
  72     public function apply(PHPUnit_Util_Metrics $metrics)
  73     {
  74         $numCrappyMethods = 0;
  75         $numMethods       = 0;
  76
  77         foreach ($metrics->getClasses() as $class) {
  78             $methods = $class->getMethods();
  79
  80             foreach ($methods as $method) {
  81                 if ($method->getCrapIndex() > $this->threshold[1]) {
  82                     $numCrappyMethods++;
  83                 }
  84             }
  85
  86             $numMethods += count($methods);
  87         }
  88
  89         if ($numMethods > 0) {
  90             $percent = ($numCrappyMethods / $numMethods) * 100;
  91         } else {
  92             $percent = 0;
  93         }
  94
  95         if ($percent > $this->threshold[0]) {
  96             return sprintf(
  97               "More than %01.2f%% of the project's methods have a Change Risk " .
  98               'Analysis and Predictions (CRAP) index that is above the threshold ' .
  99               "of %d.\n" .
 100               'The CRAP index of a function or method uses cyclomatic complexity ' .
 101               'and code coverage from automated tests to help estimate the ' .
 102               'effort and risk associated with maintaining legacy code. A CRAP ' .
 103               'index over 30 is a good indicator of crappy code.',
 104               $this->threshold[0],
 105               $this->threshold[1]
 106             );
 107         }
 108     }
 109 }
 110 ?>