/usr/share/php/PHP/Depend/Metrics/Coupling/Analyzer.php is in pdepend 1.1.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 | <?php
/**
* This file is part of PHP_Depend.
*
* PHP Version 5
*
* Copyright (c) 2008-2012, Manuel Pichler <mapi@pdepend.org>.
* 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 Manuel Pichler 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 QualityAssurance
* @package PHP_Depend
* @subpackage Metrics
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://pdepend.org/
*/
/**
* This analyzer collects coupling values for the hole project. It calculates
* all function and method <b>calls</b> and the <b>fanout</b>, that means the
* number of referenced types.
*
* The FANOUT calculation is based on the definition used by the apache maven
* project.
*
* <ul>
* <li>field declarations (Uses doc comment annotations)</li>
* <li>formal parameters and return types (The return type uses doc comment
* annotations)</li>
* <li>throws declarations (Uses doc comment annotations)</li>
* <li>local variables</li>
* </ul>
*
* http://www.jajakarta.org/turbine/en/turbine/maven/reference/metrics.html
*
* The implemented algorithm counts each type only once for a method and function.
* Any type that is either a supertype or a subtype of the class is not counted.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Metrics
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.1.4
* @link http://pdepend.org/
*/
class PHP_Depend_Metrics_Coupling_Analyzer
extends PHP_Depend_Metrics_AbstractAnalyzer
implements PHP_Depend_Metrics_NodeAwareI,
PHP_Depend_Metrics_ProjectAwareI
{
/**
* Type of this analyzer class.
*/
const CLAZZ = __CLASS__;
/**
* Metrics provided by the analyzer implementation.
*/
const M_CALLS = 'calls',
M_FANOUT = 'fanout',
M_CA = 'ca',
M_CBO = 'cbo',
M_CE = 'ce';
/**
* Has this analyzer already processed the source under test?
*
* @var boolean
* @since 0.10.2
*/
private $uninitialized = true;
/**
* The number of method or function calls.
*
* @var integer
*/
private $calls = 0;
/**
* Number of fanouts.
*
* @var integer
*/
private $fanout = 0;
/**
* Temporary map that is used to hold the uuid combinations of dependee and
* depender.
*
* @var array(string=>array)
* @since 0.10.2
*/
private $dependencyMap = array();
/**
* This array holds a mapping between node identifiers and an array with
* the node's metrics.
*
* @var array(string=>array)
* @since 0.10.2
*/
private $nodeMetrics = array();
/**
* Provides the project summary as an <b>array</b>.
*
* <code>
* array(
* 'calls' => 23,
* 'fanout' => 42
* )
* </code>
*
* @return array(string=>mixed)
*/
public function getProjectMetrics()
{
return array(
self::M_CALLS => $this->calls,
self::M_FANOUT => $this->fanout
);
}
/**
* This method will return an <b>array</b> with all generated metric values
* for the given node instance. If there are no metrics for the given node
* this method will return an empty <b>array</b>.
*
* <code>
* array(
* 'loc' => 42,
* 'ncloc' => 17,
* 'cc' => 12
* )
* </code>
*
* @param PHP_Depend_Code_NodeI $node The context node instance.
*
* @return array(string=>mixed)
*/
public function getNodeMetrics(PHP_Depend_Code_NodeI $node)
{
if (isset($this->nodeMetrics[$node->getUuid()])) {
return $this->nodeMetrics[$node->getUuid()];
}
return array();
}
/**
* Processes all {@link PHP_Depend_Code_Package} code nodes.
*
* @param PHP_Depend_Code_NodeIterator $packages All code packages.
*
* @return void
*/
public function analyze(PHP_Depend_Code_NodeIterator $packages)
{
if ($this->uninitialized) {
$this->doAnalyze($packages);
$this->uninitialized = false;
}
}
/**
* This method traverses all packages in the given iterator and calculates
* the coupling metrics for them.
*
* @param PHP_Depend_Code_NodeIterator $packages All parsed code packages.
*
* @return void
* @since 0.10.2
*/
private function doAnalyze(PHP_Depend_Code_NodeIterator $packages)
{
$this->fireStartAnalyzer();
$this->reset();
foreach ($packages as $package) {
$package->accept($this);
}
$this->postProcessTemporaryCouplingMap();
$this->fireEndAnalyzer();
}
/**
* This method resets all internal state variables before the analyzer can
* start the object tree traversal.
*
* @return void
* @since 0.10.2
*/
private function reset()
{
$this->calls = 0;
$this->fanout = 0;
$this->nodeMetrics = array();
$this->dependencyMap = array();
}
/**
* This method takes the temporary coupling map with node UUIDs and calculates
* the concrete node metrics.
*
* @return void
* @since 0.10.2
*/
private function postProcessTemporaryCouplingMap()
{
foreach ($this->dependencyMap as $uuid => $metrics) {
$afferentCoupling = count($metrics['ca']);
$efferentCoupling = count($metrics['ce']);
$this->nodeMetrics[$uuid] = array(
self::M_CA => $afferentCoupling,
self::M_CBO => $efferentCoupling,
self::M_CE => $efferentCoupling
);
$this->fanout += $efferentCoupling;
}
$this->dependencyMap = array();
}
/**
* Visits a function node.
*
* @param PHP_Depend_Code_Function $function The current function node.
*
* @return void
*/
public function visitFunction(PHP_Depend_Code_Function $function)
{
$this->fireStartFunction($function);
$fanouts = array();
if (($type = $function->getReturnClass()) !== null) {
$fanouts[] = $type;
++$this->fanout;
}
foreach ($function->getExceptionClasses() as $type) {
if (in_array($type, $fanouts, true) === false) {
$fanouts[] = $type;
++$this->fanout;
}
}
foreach ($function->getDependencies() as $type) {
if (in_array($type, $fanouts, true) === false) {
$fanouts[] = $type;
++$this->fanout;
}
}
foreach ($fanouts as $fanout) {
$this->initDependencyMap($fanout);
$this->dependencyMap[
$fanout->getUuid()
]['ca'][
$function->getUuid()
] = true;
}
$this->countCalls($function);
$this->fireEndFunction($function);
}
/**
* Visit method for classes that will be called by PHP_Depend during the
* analysis phase with the current context class.
*
* @param PHP_Depend_Code_Class $class The currently analyzed class.
*
* @return void
* @since 0.10.2
*/
public function visitClass(PHP_Depend_Code_Class $class)
{
$this->initDependencyMap($class);
return parent::visitClass($class);
}
/**
* Visit method for interfaces that will be called by PHP_Depend during the
* analysis phase with the current context interface.
*
* @param PHP_Depend_Code_Interface $interface The currently analyzed interface.
*
* @return void
* @since 0.10.2
*/
public function visitInterface(PHP_Depend_Code_Interface $interface)
{
$this->initDependencyMap($interface);
return parent::visitInterface($interface);
}
/**
* Visits a method node.
*
* @param PHP_Depend_Code_Method $method The method class node.
*
* @return void
*/
public function visitMethod(PHP_Depend_Code_Method $method)
{
$this->fireStartMethod($method);
$declaringClass = $method->getParent();
$this->calculateCoupling(
$declaringClass,
$method->getReturnClass()
);
foreach ($method->getExceptionClasses() as $type) {
$this->calculateCoupling($declaringClass, $type);
}
foreach ($method->getDependencies() as $type) {
$this->calculateCoupling($declaringClass, $type);
}
$this->countCalls($method);
$this->fireEndMethod($method);
}
/**
* Visits a property node.
*
* @param PHP_Depend_Code_Property $property The property class node.
*
* @return void
*/
public function visitProperty(PHP_Depend_Code_Property $property)
{
$this->fireStartProperty($property);
$this->calculateCoupling(
$property->getDeclaringClass(),
$property->getClass()
);
$this->fireEndProperty($property);
}
/**
* Calculates the coupling between the given types.
*
* @param PHP_Depend_Code_AbstractType $declaringType The declaring type
* or the context type.
* @param PHP_Depend_Code_AbstractType $coupledType The type that is used
* by the declaring type or <b>null</b> when no type is defined.
*
* @return void
* @since 0.10.2
*/
private function calculateCoupling(
PHP_Depend_Code_AbstractType $declaringType,
PHP_Depend_Code_AbstractType $coupledType = null
) {
$this->initDependencyMap($declaringType);
if (null === $coupledType) {
return;
}
if ($coupledType->isSubtypeOf($declaringType)
|| $declaringType->isSubtypeOf($coupledType)
) {
return;
}
$this->initDependencyMap($coupledType);
$this->dependencyMap[
$declaringType->getUuid()
]['ce'][
$coupledType->getUuid()
] = true;
$this->dependencyMap[
$coupledType->getUuid()
]['ca'][
$declaringType->getUuid()
] = true;
}
/**
* This method will initialize a temporary coupling container for the given
* given class or interface instance.
*
* @param PHP_Depend_Code_AbstractType $type The currently
* visited/traversed class or interface instance.
*
* @return void
* @since 0.10.2
*/
private function initDependencyMap(PHP_Depend_Code_AbstractType $type)
{
if (isset($this->dependencyMap[$type->getUuid()])) {
return;
}
$this->dependencyMap[$type->getUuid()] = array(
'ce' => array(),
'ca' => array()
);
}
/**
* Counts all calls within the given <b>$callable</b>
*
* @param PHP_Depend_Code_AbstractCallable $callable Context callable.
*
* @return void
*/
private function countCalls(PHP_Depend_Code_AbstractCallable $callable)
{
$invocations = $callable->findChildrenOfType(
PHP_Depend_Code_ASTInvocation::CLAZZ
);
$invoked = array();
foreach ($invocations as $invocation) {
$parents = $invocation->getParentsOfType(
PHP_Depend_Code_ASTMemberPrimaryPrefix::CLAZZ
);
$image = '';
foreach ($parents as $parent) {
$child = $parent->getChild(0);
if ($child !== $invocation) {
$image .= $child->getImage() . '.';
}
}
$image .= $invocation->getImage() . '()';
$invoked[$image] = $image;
}
$this->calls += count($invoked);
}
}
|