Yapeal\Configuration\ConfigWiring

Complexity

Total Complexity

10

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	wire()	0	54	6
A	gitVersionSetting()	0	9	4

<?php
declare(strict_types = 1);
/**
 * Contains class ConfigWiring.
 *
 * PHP version 7.0+
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
 * which can be used to access the Eve Online API data and place it into a
 * database.
 * Copyright (C) 2016 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see
 * <http://spdx.org/licenses/LGPL-3.0.html>.
 *
 * You should be able to find a copy of this license in the COPYING-LESSER.md
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
 *
 * @author    Michael Cummings <mgcummings@yahoo.com>
 * @copyright 2016 Michael Cummings
 * @license   LGPL-3.0+
 */
namespace Yapeal\Configuration;

use Yapeal\Cli\Yapeal\YamlConfigFile;
use Yapeal\Container\ContainerInterface;
use Yapeal\Container\DicAwareInterface;
use Yapeal\Container\DicAwareTrait;

/**
 * Class ConfigWiring.
 */
class ConfigWiring implements WiringInterface, DicAwareInterface
{
    use ConfigFileProcessingTrait;
    use DicAwareTrait;
    /**
     * @param ContainerInterface $dic
     *
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     */
    public function wire(ContainerInterface $dic)
    {
        $this->setDic($dic);
        if (empty($dic['Yapeal.Config.Yaml'])) {
            $dic['Yapeal.Config.Yaml'] = $dic->factory(function () {
                return new YamlConfigFile();
            });
        }
        $path = dirname(str_replace('\\', '/', __DIR__), 2) . '/';
        // These two paths are critical to Yapeal-ng working and can't be overridden.
        $dic['Yapeal.baseDir'] = $path;
        $dic['Yapeal.libDir'] = $path . 'lib/';
        $configFiles = [str_replace('\\', '/', __DIR__) . '/yapealDefaults.yaml'];
        $settings = [];
        /**
         * Do to the importance that the cache/ and log/ directories and the main configuration file _not_ point to
         * somewhere under Composer's vendor/ directory they are now forced to use either vendor parent directory or
         * Yapeal-ng's base directory depending on if Yapeal-ng finds itself under a vendor/ directory.
         *
         * If as an application developer you wish to use a different directory than cache/ or log/ in your
         * application's root directory you __MUST__ set the 'Yapeal.FileSystem.Cache.dir' and/or 'Yapeal.Log.dir'
         * setting(s) of the Container before you give it to the Wiring class to prevent them being changed here when
         * Wiring::wireAll() calls this class method during wireAll()'s normal processing. On the command line you have
         * the -c or --configFile option to override the settings as well.
         *
         * Read the existing [Configuration Files](../../docs/config/ConfigurationFiles.md) docs for more about how to
         * override the optional config/yapeal.yaml file as well.
         */
        if (false !== $vendorPos = strpos($path, 'vendor/')) {
            $dic['Yapeal.vendorParentDir'] = substr($path, 0, $vendorPos);
            $configFiles[] = $dic['Yapeal.vendorParentDir'] . 'config/yapeal.yaml';
            $settings['Yapeal.FileSystem.Cache.dir'] = '{Yapeal.vendorParentDir}cache/';
            $settings['Yapeal.Log.dir'] = '{Yapeal.vendorParentDir}log/';
        } else {
            $configFiles[] = $path . 'config/yapeal.yaml';
            $settings['Yapeal.FileSystem.Cache.dir'] = $path . 'cache/';
            $settings['Yapeal.Log.dir'] = $path . 'log/';
        }
        if (!empty($dic['Yapeal.Config.configFile'])) {
            $configFiles[] = $dic['Yapeal.Config.configFile'];
            unset($dic['Yapeal.Config.configFile']);
        }
        // Process each file in turn so any substitutions are done in a more
        // consistent way.
        foreach ($configFiles as $configFile) {
            $settings = $this->parserConfigFile($configFile, $settings);
        }
        $settings = $this->gitVersionSetting($settings);
        $settings = $this->doSubstitutions($settings, $dic);
        $additions = array_diff(array_keys($settings), $dic->keys());
        foreach ($additions as $add) {
            $dic[$add] = $settings[$add];
        }
    }
    /**
     * @param $settings
     *
     * @return array
     */
    private function gitVersionSetting($settings): array
    {
        $version = $settings['Yapeal.version'] ?? '0.0.0-0-dev+noGit-unknown';
        $gitVersion = trim(exec('git describe --always --long 2>&1', $junk, $status));
        if (0 === $status && '' !== $gitVersion && $gitVersion !== $version) {
            $settings['Yapeal.version'] = $gitVersion . '-dev';
        }
        return $settings;
    }
}