Cauditor\Config

Complexity

Total Complexity

17

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	5
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	offsetExists()	0	4	1
A	offsetGet()	0	15	2
A	offsetSet()	0	4	1
A	offsetUnset()	0	4	1
C	readConfig()	0	23	7
A	normalizePath()	0	15	3

<?php

namespace Cauditor;

use MatthiasMullie\PathConverter\Converter as PathConverter;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Parser;

/**
 * @author Matthias Mullie <cauditor@mullie.eu>
 * @copyright Copyright (c) 2016, Matthias Mullie. All rights reserved.
 * @license LICENSE MIT
 */
class Config implements \ArrayAccess
{
    /**
     * @var array
     */
    protected $config = array();

    /**
     * @var array
     */
    protected $defaults = array(
        'build_path' => 'build/cauditor',
        'exclude_folders' => array('tests', 'vendor'),
    );

    /**
     * List of config keys that denote paths, so they can be normalized
     * (= turned into "relative to project root" instead of "relative to config
     * file").
     *
     * @var string[]
     */
    protected $paths = array('build_path', 'exclude_folders');

    /**
     * @param string $project Project root path.
     * @param string $config  Config YML file path.
     */
    public function __construct($project, $config = null)
    {
        $this->config['path'] = rtrim($project, DIRECTORY_SEPARATOR);
        $this->config['config_path'] = $config ? rtrim($config, DIRECTORY_SEPARATOR) : null;
    }

    /**
     * {@inheritdoc.
     */
    public function offsetExists($offset)
    {
        return $this->offsetGet($offset) !== null;
    }

    /**
     * {@inheritdoc.
     */
    public function offsetGet($offset)
    {
        $path = $this->config['config_path'];
        $config = $this->config + $this->readConfig($path) + $this->defaults;

        // *always* exclude some folders - they're not project-specific code and
        // could easily be overlooked when overriding excludes
        $config['exclude_folders'][] = 'vendor';
        $config['exclude_folders'][] = '.git';
        $config['exclude_folders'][] = '.svn';
        $config['exclude_folders'][] = $config['build_path'];
        $config['exclude_folders'] = array_unique($config['exclude_folders']);

        return isset($config[$offset]) ? $config[$offset] : null;
    }

    /**
     * {@inheritdoc.
     */
    public function offsetSet($offset, $value)
    {
        throw new Exception('Can not set config.');
    }

    /**
     * {@inheritdoc.
     */
    public function offsetUnset($offset)
    {
        throw new Exception('Can not unset config.');
    }

    /**
     * @param string $path Path to config file.
     *
     * @return array
     */
    protected function readConfig($path)
    {
        if (!file_exists($path) || !is_file($path) || !is_readable($path)) {
            return array();
        }

        $yaml = new Parser();

        try {
            $config = (array) $yaml->parse(file_get_contents($path));
        } catch (ParseException $e) {
            return array();
        }

        // adjust relative paths
        foreach ($this->paths as $key) {
            if (isset($config[$key])) {
                $config[$key] = $this->normalizePath($config[$key]);
            }
        }

        return $config;
    }

    /**
     * Normalize all relative paths by prefixing them with the project path.
     *
     * @param string|string[] $value
     *
     * @return string|string[]
     */
    protected function normalizePath($value)
    {
        // array of paths = recursive
        if (is_array($value)) {
            foreach ($value as $i => $val) {
                $value[$i] = $this->normalizePath($val);
            }

            return $value;
        }

        $converter = new PathConverter(dirname($this->config['config_path']), $this->config['path']);

        return $converter->convert($value);
    }
}