SebastianFeldmann\CaptainHook\Runner\Configurator

Complexity

Total Complexity

23

Size/Duplication

Total Lines	206
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	15	2
A	force()	0	5	1
A	extend()	0	5	2
A	getConfigToManipulate()	0	10	2
A	ensureForce()	0	6	3
A	configureHook()	0	22	3
A	getActionConfig()	0	8	1
A	getActionOptions()	0	4	2
A	getPHPActionOptions()	0	11	2
A	getPHPActionOption()	0	15	2
A	writeConfig()	0	6	1
A	isPHPActionOptionValid()	0	7	2

<?php
/**
 * This file is part of CaptainHook.
 *
 * (c) Sebastian Feldmann <sf@sebastian.feldmann.info>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace SebastianFeldmann\CaptainHook\Runner;

use SebastianFeldmann\CaptainHook\Config;
use SebastianFeldmann\CaptainHook\Console\IOUtil;
use SebastianFeldmann\CaptainHook\Hook\Util;
use SebastianFeldmann\CaptainHook\Runner;
use SebastianFeldmann\CaptainHook\Storage\File\Json;

/**
 * Class Configurator
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/sebastianfeldmann/captainhook
 * @since   Class available since Release 0.9.0
 */
class Configurator extends Runner
{
    /**
     * Force mode
     *
     * @var bool
     */
    private $force;

    /**
     * Extend existing config or create new one
     *
     * @var string
     */
    private $mode;

    /**
     * Execute the configurator.
     */
    public function run()
    {
        $config = $this->getConfigToManipulate();
        foreach (Util::getHooks() as $hook) {
            $this->configureHook($config, $hook);
        }
        $this->writeConfig($config);

        $this->io->write(
            [
                '<info>Configuration created successfully</info>',
                'Run <comment>\'vendor/bin/captainhook install\'</comment> to activate your hook configuration',
            ]
        );
    }

    /**
     * Force mode setter.
     *
     * @param  bool $force
     * @return \SebastianFeldmann\CaptainHook\Runner\Configurator
     */
    public function force(bool $force) : Configurator
    {
        $this->force = $force;
        return $this;
    }

    /**
     * Set configuration mode.
     *
     * @param  bool $extend
     * @return \SebastianFeldmann\CaptainHook\Runner\Configurator
     */
    public function extend(bool $extend) : Configurator
    {
        $this->mode = $extend ? 'extend' : 'create';
        return $this;
    }

    /**
     * Return config to handle.
     *
     * @return \SebastianFeldmann\CaptainHook\Config
     */
    public function getConfigToManipulate() : Config
    {
        // create mode, create blank configuration
        if ('extend' !== $this->mode) {
            // make sure the force option is set if the configuration file exists
            $this->ensureForce();
            return new Config($this->config->getPath());
        }
        return $this->config;
    }

    /**
     * Make sure force mode is set if config file exists.
     *
     * @throws \RuntimeException
     */
    private function ensureForce()
    {
        if ($this->config->isLoadedFromFile() && !$this->force) {
            throw new \RuntimeException('Configuration file exists, use -f to overwrite, or -e to extend');
        }
    }

    /**
     * Configure a hook.
     *
     * @param \SebastianFeldmann\CaptainHook\Config $config
     * @param string           $hook
     */
    public function configureHook(Config $config, string $hook)
    {
        $answer = $this->io->ask('  <info>Enable \'' . $hook . '\' hook?</info> <comment>[y,n]</comment> ', 'n');
        $enable = IOUtil::answerToBool($answer);

        /** @var \SebastianFeldmann\CaptainHook\Config\Hook $hookConfig */
        $hookConfig = $config->getHookConfig($hook);
        $hookConfig->setEnabled($enable);

        if ($enable) {
            $addAction = $this->io->ask('  <info>Add a validation action?</info> <comment>[y,n]</comment> ', 'n');

            while (IOUtil::answerToBool($addAction)) {
                $hookConfig->addAction($this->getActionConfig());
                // add another action?
                $addAction = $this->io->ask(
                    '  <info>Add another validation action?</info> <comment>[y,n]</comment> ',
                    'n'
                );
            }
        }
    }

    /**
     * Setup a action config with user input.
     *
     * @return \SebastianFeldmann\CaptainHook\Config\Action
     */
    public function getActionConfig() : Config\Action
    {
        $call    = $this->io->ask('  <info>PHP class or shell command to execute?</info> ', '');
        $type    = Util::getActionType($call);
        $options = $this->getActionOptions($type);

        return new Config\Action($type, $call, $options);
    }

    /**
     * Ask the user for any action options.
     *
     * @param  string $type
     * @return array
     */
    public function getActionOptions(string $type) : array
    {
        return 'php' === $type ? $this->getPHPActionOptions() : [];
    }

    /**
     * Get the php action options.
     *
     * @return array
     */
    protected function getPHPActionOptions() : array
    {
        $options = [];
        $addOption = $this->io->ask('  <info>Add a validator option?</info> <comment>[y,n]</comment> ', 'n');
        while (IOUtil::answerToBool($addOption)) {
            $options = array_merge($options, $this->getPHPActionOption());
            // add another action?
            $addOption = $this->io->ask('  <info>Add another validator option?</info> <comment>[y,n]</comment> ', 'n');
        }
        return $options;
    }

    /**
     * Ask the user for a php action option.
     *
     * @return array
     */
    protected function getPHPActionOption() : array
    {
        $result = [];
        $answer = $this->io->askAndValidate(
            '  <info>Specify options key and value</info> <comment>[key:value]</comment> ',
            ['\\SebastianFeldmann\\CaptainHook\\Runner\\Configurator', 'isPHPActionOptionValid'],
            3,
            null
        );
        if (null !== $answer) {
            list($key, $value) = explode(':', $answer);
            $result = [$key => $value];
        }
        return $result;
    }

    /**
     * Write config to project root.
     *
     * @param \SebastianFeldmann\CaptainHook\Config $config
     */
    public function writeConfig(Config $config)
    {
        $filePath = $this->config->getPath();
        $file     = new Json($filePath);
        $file->write($config->getJsonData());
    }

    /**
     * PHP action option validation.
     *
     * @param  $option
     * @return string
     * @throws \Exception
     */
    public static function isPHPActionOptionValid(string $option) : string
    {
        if (count(explode(':', $option)) !== 2) {
            throw new \Exception('Invalid option, use "key:value"');
        }
        return $option;
    }
}