Cauditor\Analyzers\PDepend\Analyzer

Complexity

Total Complexity

8

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	8
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	execute()	0	24	2
B	pdepend()	0	31	2
A	warningHandler()	0	11	3

<?php

namespace Cauditor\Analyzers\PDepend;

use Cauditor\Analyzers\AnalyzerInterface;
use Cauditor\Config;
use Cauditor\Exception;
use MatthiasMullie\PathConverter\Converter as PathConverter;
use PDepend\Application;
use PDepend\Input\ExcludePathFilter;

/**
 * @author Matthias Mullie <cauditor@mullie.eu>
 * @copyright Copyright (c) 2016, Matthias Mullie. All rights reserved.
 * @license LICENSE MIT
 */
class Analyzer implements AnalyzerInterface
{
    /**
     * cauditor JSON filename.
     *
     * @var string
     */
    protected $json = 'cauditor.json';

    /**
     * PDepend cache directory name.
     *
     * @var string
     */
    protected $pdepend = '.pdepend';

    /**
     * @var Config
     */
    protected $config;

    /**
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        $this->config = $config;
    }

    /**
     * {@inheritdoc}
     */
    public function execute()
    {
        // all paths in build_path are relative to project root, which may not
        // be where this code is run from, so prepend the project root!
        $buildPath = $this->config['path'].DIRECTORY_SEPARATOR.$this->config['build_path'];

        exec('mkdir -p '.$buildPath.DIRECTORY_SEPARATOR.$this->pdepend, $output, $result);
        if ($result !== 0) {
            throw new Exception('Unable to create build directory.');
        }

        // let pdepend generate all metrics we'll need
        set_error_handler(array($this, 'warningHandler'), E_WARNING);
        $path = $buildPath;
        $this->pdepend($path);
        restore_error_handler();

        // if we expect these json files to be loaded client-side to render
        // the charts, might as well assume it'll fit in this machine's
        // memory to submit it to our API ;)
        $json = file_get_contents($path.DIRECTORY_SEPARATOR.$this->json);

        return json_decode($json, true);
    }

    /**
     * Runs pdepend to generate the metrics.
     *
     * @param string $path
     *
     * @throws Exception
     */
    protected function pdepend($path)
    {
        $jsonGenerator = new JsonGenerator();
        $jsonGenerator->setLogFile($path.DIRECTORY_SEPARATOR.$this->json);

        $application = new Application();

        // overwrite default config to ensure that cache files are stored in
        // different folders per build
        $config = $application->getConfiguration();
        $config->cache->driver = 'file';
        $config->cache->location = $path.DIRECTORY_SEPARATOR.$this->pdepend;

        $engine = $application->getEngine();
        $engine->addReportGenerator($jsonGenerator);

        $engine->addDirectory($this->config['path']);

        // exclude directories are evaluated relative to where pdepend is being
        // run from, not what it is running on
        $converter = new PathConverter($this->config['path'], getcwd());
        $exclude = array_map(array($converter, 'convert'), $this->config['exclude_folders']);
        $filter = new ExcludePathFilter($exclude);
        $engine->addFileFilter($filter);

        try {
            $engine->analyze();
        } catch (\Exception $e) {
            throw new Exception('Unable to generate pdepend metrics.');
        }
    }

    /**
     * @param int    $errno
     * @param string $errstr
     * @param string $errfile
     * @param string $errline
     * @param array  $errcontext
     *
     * @throws Exception
     */
    protected function warningHandler($errno, $errstr, $errfile, $errline, array $errcontext)

The parameter $errline is not used and could be removed.

The parameter $errcontext is not used and could be removed.

    {
        if (
            strpos($errstr, 'filesize(): stat failed') !== false &&
            strpos($errfile, 'FileCacheDriver.php') !== false
        ) {
            throw new Exception('Failed to load from cache; risk potentially incomplete metrics.');
        }

        return;
    }
}