Gerrie\Component\Configuration\ConfigurationFactory

Complexity

Total Complexity

11

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfigurationByConfigFile()	0	13	2
A	getConfigurationByConfigFileAndCommandOptionsAndArguments()	0	13	2
B	mergeCommandOptionsIntoConfiguration()	0	25	4
A	mergeCommandArgumentsIntoConfiguration()	0	17	3

<?php
/**
 * This file is part of the Gerrie package.
 *
 * (c) Andreas Grunwald <andygrunwald@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gerrie\Component\Configuration;

use Gerrie\Component\Console\InputExtendedInterface;
use Symfony\Component\Yaml\Yaml;

class ConfigurationFactory
{
    /**
     * Creates a configuration based on a YAML configuration file.
     *
     * @param string $configFile
     * @return Configuration
     */
    public static function getConfigurationByConfigFile($configFile)
    {
        if (file_exists($configFile) === false) {
            $message = 'Configuration file "%s" not found or accessible.';
            $message = sprintf($message, $configFile);
            throw new \RuntimeException($message, 1415381521);
        }

        $config = Yaml::parse($configFile);
        $configuration = new Configuration($config);

It seems like $config defined by \Symfony\Component\Yaml\Yaml::parse($configFile) on line 32 can also be of type string; however, Gerrie\Component\Configuration\Configuration::__construct() does only seem to accept array, maybe add an additional type check?

        return $configuration;
    }

    /**
     * Creates a configuration based on a YAML configuration file, command line options and command line arguments.
     * The command line options will be merged into the configuration.
     * The command line arguments will be merged into the configuration as well.
     *
     * The command line options got a higher priority as the configuration file.
     * The command line arguments will be added to the configuration file and not overwritten.
     *
     * @param string $configFile
     * @param InputExtendedInterface $input
     * @return Configuration
     */
    public static function getConfigurationByConfigFileAndCommandOptionsAndArguments($configFile, InputExtendedInterface $input)
    {
        if ($input->isOptionSet('config-file') === true) {
            $configuration = self::getConfigurationByConfigFile($configFile);
        } else {
            $configuration = new Configuration();
        }

        $configuration = self::mergeCommandOptionsIntoConfiguration($configuration, $input);
        $configuration = self::mergeCommandArgumentsIntoConfiguration($configuration, $input);

        return $configuration;
    }

    /**
     * Merges the command line options into a existing configuration.
     *
     * E.g.
     *  * Database credentials
     *  * SSH settings
     *
     * @param Configuration $config
     * @param InputExtendedInterface $input
     * @return Configuration
     */
    protected static function mergeCommandOptionsIntoConfiguration(Configuration $config, InputExtendedInterface $input)
    {
        $configurationMapping = [
            // Database credentials
            'database-host' => 'Database.Host',
            'database-user' => 'Database.Username',
            'database-pass' => 'Database.Password',
            'database-port' => 'Database.Port',
            'database-name' => 'Database.Name',
            // SSH settings
            'ssh-key'       => 'SSH.KeyFile',
        ];

        foreach ($configurationMapping as $optionName => $configName) {
            if ($input->isOptionSet($optionName) === true) {
                $config->setConfigurationValue($configName, $input->getOption($optionName));

            // If the value is not set / available, set this to nothing
            } elseif (!$config->getConfigurationValue($configName)) {
                $config->setConfigurationValue($configName, null);
            }
        }

        return $config;
    }

    /**
     * Merges the command line arguments into a existing configuration.
     *
     * E.g.
     *  * Instances
     *
     * @param Configuration $config
     * @param InputExtendedInterface $input
     * @return Configuration
     */
    protected static function mergeCommandArgumentsIntoConfiguration(Configuration $config, InputExtendedInterface $input)
    {
        if ($input->hasArgument('instances') === false) {
            return $config;
        }

        $argumentInstances = $input->getArgument('instances');

        if (count($argumentInstances) === 0) {
            return $config;
        }

        // Gerrie is a reserved keyword for project names
        $config->setConfigurationValue('Gerrit.Gerrie', $argumentInstances);

        return $config;
    }
}