CaptainHook\App\Runner\Action\PHP

Complexity

Total Complexity

14

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	isApplicable()	0	7	2
A	execute()	0	28	5
A	createAction()	0	9	2
A	isStaticMethodCall()	0	3	1
A	executeStatic()	0	12	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\Runner\Action;

use CaptainHook\App\Config;
use CaptainHook\App\Console\IO;
use CaptainHook\App\Exception\ActionFailed;
use CaptainHook\App\Hook\Action;
use CaptainHook\App\Hook\Constrained;
use Exception;
use RuntimeException;
use SebastianFeldmann\Git\Repository;

/**
 * Class PHP
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/captainhookphp/captainhook
 * @since   Class available since Release 0.9.0
 */
class PHP
{
    /**
     * Name of the currently executed hook
     *
     * @var string
     */
    private $hook;

    /**
     * PHP constructor.
     *
     * @param string $hook Name of the currently executed hook
     */
    public function __construct(string $hook)
    {
        $this->hook = $hook;
    }

    /**
     * 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 \CaptainHook\App\Exception\ActionFailed
     */
    public function execute(Config $config, IO $io, Repository $repository, Config\Action $action): void
    {
        $class = $action->getAction();

        try {
            // if the configured action is a static php method display the captured output and exit
            if ($this->isStaticMethodCall($class)) {
                $io->write($this->executeStatic($class));
                return;
            }

            // if not static it has to be an 'Action' so let's instantiate
            $exe = $this->createAction($class);
            // check for any given restrictions
            if (!$this->isApplicable($exe)) {
                $io->write('Action skipped due to hook constraint', true, IO::VERBOSE);
                return;
            }

            // no restrictions run it!
            $exe->execute($config, $io, $repository, $action);
        } catch (Exception $e) {
            throw new ActionFailed(
                'Execution failed: ' . PHP_EOL .
                $e->getMessage() . ' in ' . $e->getFile() . ' line ' . $e->getLine()
            );
        } catch (\Error $e) {
            throw new ActionFailed('PHP Error:' . $e->getMessage());
        }
    }

    /**
     * Execute static method call and return its output
     *
     * @param  string $class
     * @return string
     */
    private function executeStatic(string $class): string
    {
        [$class, $method] = explode('::', $class);
        if (!class_exists($class)) {
            throw new RuntimeException('could not find class: ' . $class);
        }
        if (!method_exists($class, $method)) {
            throw new RuntimeException('could not find method in class: ' . $method);
        }
        ob_start();
        $class::$method();
        return (string)ob_get_clean();
    }

    /**
     * Create an action instance
     *
     * @param  string $class
     * @return \CaptainHook\App\Hook\Action
     * @throws \CaptainHook\App\Exception\ActionFailed
     */
    private function createAction(string $class): Action
    {
        $action = new $class();
        if (!$action instanceof Action) {
            throw new ActionFailed(
                'PHP class ' . $class . ' has to implement the \'Action\' interface'
            );
        }
        return $action;
    }

    /**
     * Is this a static method call
     *
     * @param  string $class
     * @return bool
     */
    private function isStaticMethodCall(string $class): bool
    {
        return (bool)preg_match('#^\\\\.+::.+$#i', $class);
    }

    /**
     * Make sure the action can be used during this hook
     *
     * @param  \CaptainHook\App\Hook\Action $action
     * @return bool
     */
    private function isApplicable(Action $action)
    {
        if ($action instanceof Constrained) {
            /** @var \CaptainHook\App\Hook\Constrained $action */
            return $action->getRestriction()->isApplicableFor($this->hook);
        }
        return true;
    }
}