CaptainHook\App\Hook\Branch\Action\EnsureNaming

Complexity

Total Complexity

9

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getErrorMessage()	0	4	2
A	getRegex()	0	7	2
A	execute()	0	12	2
A	getRestriction()	0	3	1
A	getSuccessMessage()	0	4	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 CaptainHook\App\Hook\Branch\Action;

use CaptainHook\App\Config;
use CaptainHook\App\Console\IO;
use CaptainHook\App\Exception\ActionFailed;
use CaptainHook\App\Hook\Action;
use CaptainHook\App\Hook\Restriction;
use CaptainHook\App\Hooks;
use SebastianFeldmann\Git\Repository;

/**
 * Class EnsureNaming
 *
 * This Action makes sure you are on a branch that follows your naming conventions.
 *
 * Example configuration:
 * <code>
 * {
 *   "action": "CaptainHook.Branch.EnsureNaming",
 *   "options": {
 *     "regex": "#feature/issue[0-9]+-.*#i",
 *     "error": "Arr matey! Ye be on the wrong branch!",
 *     "success": "All clear, Captain! Full speed ahead!",
 *   }
 * }
 * </code>
 *
 * @package CaptainHook
 * @author  Felix Edelmann <fxedel@gmail.com>
 * @link    https://github.com/captainhook-git/captainhook
 * @since   Class available since Release 5.4.0
 */
class EnsureNaming implements Action
{
    /**
     * Return hook restriction
     *
     * @return \CaptainHook\App\Hook\Restriction
     */
    public static function getRestriction(): Restriction
    {
        return Restriction::fromArray([Hooks::PRE_COMMIT, Hooks::PRE_PUSH, Hooks::POST_CHECKOUT]);
    }

    /**
     * Execute the configured action
     *
     * @param  \CaptainHook\App\Config           $config
     * @param  \CaptainHook\App\Console\IO       $io
     * @param  \SebastianFeldmann\Git\Repository $repository
     * @param  \CaptainHook\App\Config\Action    $action
     * @return void
     * @throws \Exception
     */
    public function execute(Config $config, IO $io, Repository $repository, Config\Action $action): void
    {
        $regex      = $this->getRegex($action->getOptions());
        $errorMsg   = $this->getErrorMessage($action->getOptions());
        $successMsg = $this->getSuccessMessage($action->getOptions());

        $branch = $repository->getInfoOperator()->getCurrentBranch();
        if (!preg_match($regex, $branch)) {
            throw new ActionFailed(sprintf($errorMsg, $regex));
        }

        $io->write(['', '', sprintf($successMsg, $regex), ''], true, IO::VERBOSE);
    }

    /**
     * Extract regex from options array
     *
     * @param  \CaptainHook\App\Config\Options $options
     * @return string
     * @throws \CaptainHook\App\Exception\ActionFailed
     */
    protected function getRegex(Config\Options $options): string
    {
        $regex = $options->get('regex', '');
        if (empty($regex)) {
            throw new ActionFailed('No regex option');
        }
        return $regex;
    }

    /**
     * Determine the error message to use
     *
     * @param  \CaptainHook\App\Config\Options $options
     * @return string
     */
    protected function getErrorMessage(Config\Options $options): string
    {
        $msg = $options->get('error', '');
        return !empty($msg) ? $msg : '<error>FAIL</error> Branch name does not match regex: %s';
    }

    /**
     * Determine the error message to use
     *
     * @param  \CaptainHook\App\Config\Options $options
     * @return string
     */
    protected function getSuccessMessage(Config\Options $options): string
    {
        $msg = $options->get('success', '');
        return !empty($msg) ? $msg : '<info>OK</info> Branch name does match regex: %s';
    }
}