Viewing file:  File.php (7.86 KB) -rwxr-xr-x
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* PHPUnit
*
* Copyright (c) 2002-2008, Sebastian Bergmann <sb@sebastian-bergmann.de>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Sebastian Bergmann nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category Testing
* @package PHPUnit
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2002-2008 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id: File.php 1985 2007-12-26 18:11:55Z sb $
* @link http://www.phpunit.de/
* @since File available since Release 3.2.0
*/
require_once 'PHPUnit/Util/Class.php';
require_once 'PHPUnit/Util/Metrics.php';
require_once 'PHPUnit/Util/Filter.php';
PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
/**
* File-Level Metrics.
*
* @category Testing
* @package PHPUnit
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2002-2008 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 3.2.9
* @link http://www.phpunit.de/
* @since Class available since Release 3.2.0
*/
class PHPUnit_Util_Metrics_File extends PHPUnit_Util_Metrics {
protected $coverage = 0;
protected $loc = 0;
protected $cloc = 0;
protected $ncloc = 0;
protected $locExecutable = 0;
protected $locExecuted = 0;
protected $filename;
protected $classes = array();
protected $functions = array();
protected $lines = array();
protected $tokens = array();
protected static $cache = array();
/**
* Constructor.
*
* @param string $filename
* @param array $codeCoverage
* @throws RuntimeException
* @access protected
*/
protected function __construct($filename, &$codeCoverage = array()) {
if (! file_exists($filename)) {
throw new RuntimeException(sprintf('File "%s" not found.', $filename));
}
$this->filename = $filename;
$this->lines = file($filename);
$this->tokens = token_get_all(file_get_contents($filename));
$this->countLines();
$this->setCoverage($codeCoverage);
foreach (PHPUnit_Util_Class::getClassesInFile($filename) as $class) {
$this->classes[$class->getName()] = PHPUnit_Util_Metrics_Class::factory($class, $codeCoverage);
}
foreach (PHPUnit_Util_Class::getFunctionsInFile($filename) as $function) {
$this->functions[$function->getName()] = PHPUnit_Util_Metrics_Function::factory($function, $codeCoverage);
}
}
/**
* Factory.
*
* @param string $filename
* @param array $codeCoverage
* @return PHPUnit_Util_Metrics_File
* @access public
* @static
*/
public static function factory($filename, &$codeCoverage = array()) {
if (! isset(self::$cache[$filename])) {
self::$cache[$filename] = new PHPUnit_Util_Metrics_File($filename, $codeCoverage);
}
else if (! empty($codeCoverage) && self::$cache[$filename]->getCoverage() == 0) {
self::$cache[$filename]->setCoverage($codeCoverage);
}
return self::$cache[$filename];
}
/**
* @param array $codeCoverage
* @access public
*/
public function setCoverage(array &$codeCoverage) {
if (! empty($codeCoverage)) {
$this->calculateCodeCoverage($codeCoverage);
foreach ($this->classes as $class) {
$class->setCoverage($codeCoverage);
}
foreach ($this->functions as $function) {
$function->setCoverage($codeCoverage);
}
}
}
/**
* Returns the path to the file.
*
* @return string
* @access public
*/
public function getPath() {
return $this->filename;
}
/**
* Classes.
*
* @return array
* @access public
*/
public function getClasses() {
return $this->classes;
}
/**
* A class.
*
* @param string $className
* @return ReflectionClass
* @access public
*/
public function getClass($className) {
return $this->classes[$className];
}
/**
* Functions.
*
* @return array
* @access public
*/
public function getFunctions() {
return $this->functions;
}
/**
* A function.
*
* @param string $functionName
* @return ReflectionClass
* @access public
*/
public function getFunction($functionName) {
return $this->functions[$functionName];
}
/**
* Lines.
*
* @return array
* @access public
*/
public function getLines() {
return $this->lines;
}
/**
* Tokens.
*
* @return array
* @access public
*/
public function getTokens() {
return $this->tokens;
}
/**
* Returns the Code Coverage for the file.
*
* @return float
* @access public
*/
public function getCoverage() {
return $this->coverage;
}
/**
* Lines of Code (LOC).
*
* @return int
* @access public
*/
public function getLoc() {
return $this->loc;
}
/**
* Executable Lines of Code (ELOC).
*
* @return int
* @access public
*/
public function getLocExecutable() {
return $this->locExecutable;
}
/**
* Executed Lines of Code.
*
* @return int
* @access public
*/
public function getLocExecuted() {
return $this->locExecuted;
}
/**
* Comment Lines of Code (CLOC).
*
* @return int
* @access public
*/
public function getCloc() {
return $this->cloc;
}
/**
* Non-Comment Lines of Code (NCLOC).
*
* @return int
* @access public
*/
public function getNcloc() {
return $this->ncloc;
}
/**
* Calculates the Code Coverage for the class.
*
* @param array $codeCoverage
* @access protected
*/
protected function calculateCodeCoverage(&$codeCoverage) {
$statistics = PHPUnit_Util_CodeCoverage::getStatistics($codeCoverage, $this->filename, 1, count($this->lines));
$this->coverage = $statistics['coverage'];
$this->loc = $statistics['loc'];
$this->locExecutable = $statistics['locExecutable'];
$this->locExecuted = $statistics['locExecuted'];
}
/**
* @access protected
*/
protected function countLines() {
$this->loc = count($this->lines);
$this->cloc = 0;
foreach ($this->tokens as $i => $token) {
if (is_string($token)) {
continue;
}
list($token, $value) = $token;
if ($token == T_COMMENT || $token == T_DOC_COMMENT) {
$this->cloc += count(explode("\n", $value));
}
}
$this->ncloc = $this->loc - $this->cloc;
}
}
?>
|