CaptainHook\App\Config\Util

Complexity

Total Complexity

21

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	writeToDisk()	0	5	1
A	validateConditionsConfig()	0	8	6
A	validateJsonConfiguration()	0	5	3
A	keysExist()	0	8	3
A	validateActionsConfig()	0	11	5
A	validateHookConfig()	0	9	3

<?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 CaptainHook\App\Config;

use CaptainHook\App\Hook\Util as HookUtil;
use CaptainHook\App\Config;
use CaptainHook\App\Storage\File\Json;
use RuntimeException;

/**
 * Class Util
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/captainhookphp/captainhook
 * @since   Class available since Release 1.0.3
 * @internal
 */
abstract class Util
{
    /**
     * Validate a configuration
     *
     * @param  array $json
     * @return void
     * @throws \RuntimeException
     */
    public static function validateJsonConfiguration(array $json): void
    {
        foreach (HookUtil::getValidHooks() as $hook => $class) {
            if (isset($json[$hook])) {
                self::validateHookConfig($json[$hook]);
            }
        }
    }

    /**
     * Validate a hook configuration
     *
     * @param  array $json
     * @return void
     * @throws \RuntimeException
     */
    public static function validateHookConfig(array $json): void
    {
        if (!self::keysExist(['enabled', 'actions'], $json)) {
            throw new RuntimeException('Config error: invalid hook configuration');
        }
        if (!is_array($json['actions'])) {
            throw new RuntimeException('Config error: \'actions\' must be an array');
        }
        self::validateActionsConfig($json['actions']);
    }

    /**
     * Validate a list of action configurations
     *
     * @param  array $json
     * @return void
     * @throws \RuntimeException
     */
    public static function validateActionsConfig(array $json): void
    {
        foreach ($json as $action) {
            if (!self::keysExist(['action'], $action)) {
                throw new RuntimeException('Config error: \'action\' missing');
            }
            if (empty($action['action'])) {
                throw new RuntimeException('Config error: \'action\' can\'t be empty');
            }
            if (!empty($action['conditions'])) {
                self::validateConditionsConfig($action['conditions']);
            }
        }
    }

    /**
     * Validate a list of condition configurations
     *
     * @param  array $json
     * @throws \RuntimeException
     */
    public static function validateConditionsConfig(array $json): void
    {
        foreach ($json as $condition) {
            if (!self::keysExist(['exec'], $condition) || empty($condition['exec'])) {
                throw new RuntimeException('Config error: \'exec\' is required for conditions');
            }
            if (!empty($condition['args']) && !is_array($condition['args'])) {
                throw new RuntimeException('Config error: invalid \'args\' configuration');
            }
        }
    }

    /**
     * Write the config to disk
     *
     * @param  \CaptainHook\App\Config $config
     * @return void
     */
    public static function writeToDisk(Config $config): void
    {
        $filePath = $config->getPath();
        $file     = new Json($filePath);
        $file->write($config->getJsonData());
    }

    /**
     * Does an array have the expected keys
     *
     * @param  array $keys
     * @param  array $subject
     * @return bool
     */
    private static function keysExist(array $keys, array $subject): bool
    {
        foreach ($keys as $key) {
            if (!isset($subject[$key])) {
                return false;
            }
        }
        return true;
    }
}