/usr/share/php/PHP/Depend/Log/Phpunit/Xml.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 | <?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 Log
* @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/
* @deprecated Since release 0.10.5, please use the summary logger
*/
// @codeCoverageIgnoreStart
/**
* This logger provides a xml log file, that is compatible with the files
* generated by the <a href="http://www.Phpunit.de">PHPUnit</a> --log-metrics
* option.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Log
* @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/
* @deprecated Since release 0.10.5, please use the summary logger
*/
class PHP_Depend_Log_Phpunit_Xml
extends PHP_Depend_Visitor_AbstractVisitor
implements PHP_Depend_Log_CodeAwareI,
PHP_Depend_Log_FileAwareI
{
/**
* The log output file.
*
* @var string
*/
private $logFile = null;
/**
* The raw {@link PHP_Depend_Code_Package} instances.
*
* @var PHP_Depend_Code_NodeIterator
*/
protected $code = null;
/**
* List of all generated project metrics.
*
* @var array(string=>mixed)
*/
protected $projectMetrics = array();
/**
* List of all analyzers that implement the node aware interface
* {@link PHP_Depend_Metrics_NodeAwareI}.
*
* @var PHP_Depend_Metrics_AnalyzerI[]
*/
private $nodeAwareAnalyzers = array();
/**
* The internal used xml stack.
*
* @var DOMElement[]
*/
private $xmlStack = array();
/**
* Number of visited files.
*
* @var integer
*/
private $files = 0;
/**
* This property contains some additional metrics for the file-DOMElement.
*
* @var array(string=>integer)
*/
private $additionalFileMetrics = array(
'classes' => 0,
'functions' => 0
);
/**
* This translation table maps some PHP_Depend identifiers with the
* corresponding PHPUnit identifiers.
*
* @var array(string=>string)
*/
private $phpunitTranslationTable = array(
'ccn2' => 'ccn',
'noc' => 'classes',
'noi' => 'interfs',
'nof' => 'functions',
'eloc' => 'locExecutable',
'maxDIT' => 'maxdit',
);
/**
* Returns an <b>array</b> with accepted analyzer types. These types can be
* concrete analyzer classes or one of the descriptive analyzer interfaces.
*
* @return array(string)
*/
public function getAcceptedAnalyzers()
{
return array(
'PHP_Depend_Metrics_NodeAwareI',
'PHP_Depend_Metrics_ProjectAwareI'
);
}
/**
* Sets the output log file.
*
* @param string $logFile The output log file.
*
* @return void
*/
public function setLogFile($logFile)
{
$this->logFile = $logFile;
}
/**
* Sets the context code nodes.
*
* @param PHP_Depend_Code_NodeIterator $code The code nodes.
*
* @return void
*/
public function setCode(PHP_Depend_Code_NodeIterator $code)
{
$this->code = $code;
}
/**
* Adds an analyzer to log. If this logger accepts the given analyzer it
* with return <b>true</b>, otherwise the return value is <b>false</b>.
*
* @param PHP_Depend_Metrics_AnalyzerI $analyzer The analyzer to log.
*
* @return boolean
*/
public function log(PHP_Depend_Metrics_AnalyzerI $analyzer)
{
$accept = false;
if ($analyzer instanceof PHP_Depend_Metrics_ProjectAwareI) {
// Get project metrics
$metrics = $analyzer->getProjectMetrics();
// Merge with existing metrics.
$this->projectMetrics = array_merge($this->projectMetrics, $metrics);
$accept = true;
}
if ($analyzer instanceof PHP_Depend_Metrics_NodeAwareI) {
$this->nodeAwareAnalyzers[] = $analyzer;
$accept = true;
}
return $accept;
}
/**
* Closes the logger process and writes the output file.
*
* @return void
* @throws PHP_Depend_Log_NoLogOutputException If the no log target exists.
*/
public function close()
{
trigger_error(
'The --phpunit-xml log option is deprecated.',
E_USER_DEPRECATED
);
if ($this->logFile === null) {
throw new PHP_Depend_Log_NoLogOutputException($this);
}
$dom = new DOMDocument('1.0', 'UTF-8');
$dom->formatOutput = true;
// Using XPath is only possible, when we add it to the document!?!?
// Is this this correct?
$metricsXml = $dom->appendChild($dom->createElement('metrics'));
array_push($this->xmlStack, $metricsXml);
foreach ($this->code as $node) {
$node->accept($this);
}
// Create project metrics and apply Phpunit translation table
$metrics = array_merge(
$this->projectMetrics,
array('files' => $this->files)
);
$metrics = $this->applyPhpUnitTranslationTable($metrics);
// Sort metrics
ksort($metrics);
// Append project metrics
foreach ($metrics as $name => $value) {
$metricsXml->setAttribute($name, $value);
}
$dom->save($this->logFile);
}
/**
* Visits a class node.
*
* @param PHP_Depend_Code_Class $class The current class node.
*
* @return void
* @see PHP_Depend_VisitorI::visitClass()
*/
public function visitClass(PHP_Depend_Code_Class $class)
{
$this->visitType($class);
}
/**
* Visits a file node.
*
* @param PHP_Depend_Code_File $file The current file node.
*
* @return void
* @see PHP_Depend_VisitorI::visitFile()
*/
public function visitFile(PHP_Depend_Code_File $file)
{
$metricsXml = end($this->xmlStack);
$document = $metricsXml->ownerDocument;
$xpath = new DOMXPath($document);
$result = $xpath->query("/metrics/file[@name='{$file->getFileName()}']");
// Only add a new file
if ($result->length === 0) {
// Create a new file element
$fileXml = $document->createElement('file');
// Set source file name
$fileXml->setAttribute('name', $file->getFileName());
// Append all metrics
$this->appendMetrics($fileXml, $file, $this->additionalFileMetrics);
// Append file to metrics xml
$metricsXml->appendChild($fileXml);
// Update project file counter
++$this->files;
} else {
$fileXml = $result->item(0);
}
// Add file to stack
array_push($this->xmlStack, $fileXml);
}
/**
* Visits a function node.
*
* @param PHP_Depend_Code_Function $function The current function node.
*
* @return void
* @see PHP_Depend_VisitorI::visitFunction()
*/
public function visitFunction(PHP_Depend_Code_Function $function)
{
// First visit function file
$function->getSourceFile()->accept($this);
$fileXml = end($this->xmlStack);
$document = $fileXml->ownerDocument;
$functionXml = $document->createElement('function');
$functionXml->setAttribute('name', $function->getName());
$this->appendMetrics($functionXml, $function);
$fileXml->appendChild($functionXml);
// Update file element @functions count
$fileXml->setAttribute('functions', 1 + $fileXml->getAttribute('functions'));
// Remove xml file element
array_pop($this->xmlStack);
}
/**
* Visits a code interface object.
*
* @param PHP_Depend_Code_Interface $interface The context code interface.
*
* @return void
* @see PHP_Depend_VisitorI::visitInterface()
*/
public function visitInterface(PHP_Depend_Code_Interface $interface)
{
$this->visitType($interface);
}
/**
* Visits a method node.
*
* @param PHP_Depend_Code_Class $method The method class node.
*
* @return void
* @see PHP_Depend_VisitorI::visitMethod()
*/
public function visitMethod(PHP_Depend_Code_Method $method)
{
$classXml = end($this->xmlStack);
$document = $classXml->ownerDocument;
$methodXml = $document->createElement('method');
$methodXml->setAttribute('name', $method->getName());
$this->appendMetrics($methodXml, $method);
$classXml->appendChild($methodXml);
}
/**
* Generic visit method for classes and interfaces.
*
* @param PHP_Depend_Code_AbstractClassOrInterface $type The context type.
*
* @return void
*/
private function visitType(PHP_Depend_Code_AbstractClassOrInterface $type)
{
$type->getSourceFile()->accept($this);
$fileXml = end($this->xmlStack);
$document = $fileXml->ownerDocument;
$classXml = $document->createElement('class');
$classXml->setAttribute('name', $type->getName());
$this->appendMetrics($classXml, $type);
$fileXml->appendChild($classXml);
array_push($this->xmlStack, $classXml);
foreach ($type->getMethods() as $method) {
$method->accept($this);
}
$fileXml->setAttribute('classes', 1 + $fileXml->getAttribute('classes'));
// Remove xml class element
array_pop($this->xmlStack);
// Remove xml file element
array_pop($this->xmlStack);
}
/**
* Aggregates all metrics for the given <b>$node</b> instance and adds them
* to the <b>DOMElement</b>
*
* @param DOMElement $xml DOM Element that represents $node.
* @param PHP_Depend_Code_NodeI $node The context code node instance.
* @param array(string=>mixed) $metrics Set of additional node metrics
*
* @return void
*/
private function appendMetrics(
DOMElement $xml,
PHP_Depend_Code_NodeI $node,
array $metrics = array()
) {
foreach ($this->nodeAwareAnalyzers as $analyzer) {
$metrics = array_merge($metrics, $analyzer->getNodeMetrics($node));
}
$metrics = $this->applyPhpUnitTranslationTable($metrics);
ksort($metrics);
foreach ($metrics as $name => $value) {
$xml->setAttribute($name, $value);
}
}
/**
* Translates PHP_Depend metric names into PHPUnit names.
*
* @param array(string=>mixed) $metrics Set of collected metric values.
*
* @return array(string=>mixed)
*/
private function applyPhpUnitTranslationTable(array $metrics)
{
foreach ($this->phpunitTranslationTable as $pdepend => $phpunit) {
if (!isset($metrics[$pdepend])) {
continue;
}
$metrics[$phpunit] = $metrics[$pdepend];
unset($metrics[$pdepend]);
}
return $metrics;
}
}
// @codeCoverageIgnoreEnd
|