CaptainHook\App\Hook\Template\Local

Complexity

Total Complexity

3

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getBootstrapCmdOption()	0	3	1
A	__construct()	0	4	1
A	getCode()	0	3	1

<?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.
 */

declare(strict_types=1);

namespace CaptainHook\App\Hook\Template;

use CaptainHook\App\Config;
use CaptainHook\App\Hook\Template;
use CaptainHook\App\Runner\Bootstrap\Util;

abstract class Local implements Template
{
    /**
     * All template related path information
     *
     * @var \CaptainHook\App\Hook\Template\PathInfo
     */
    protected PathInfo $pathInfo;

    /**
     * CaptainHook configuration
     *
     * @var \CaptainHook\App\Config
     */
    protected Config $config;

    /**
     * Local constructor
     *
     * @param \CaptainHook\App\Hook\Template\PathInfo $pathInfo
     * @param \CaptainHook\App\Config                 $config
     */
    public function __construct(PathInfo $pathInfo, Config $config)
    {
        $this->pathInfo = $pathInfo;
        $this->config   = $config;
    }

    /**
     * Return the code for the git hook scripts
     *
     * @param  string $hook Name of the hook to generate the sourcecode for
     * @return string
     */
    public function getCode(string $hook): string
    {
        return implode(PHP_EOL, $this->getHookLines($hook)) . PHP_EOL;
    }

    /**
     * Returns the bootstrap option depending on the current runtime (can be empty)
     *
     * @return string
     */
    public function getBootstrapCmdOption(): string
    {
        return Util::bootstrapCmdOption($this->pathInfo->isPhar(), $this->config);
    }

    /**
     * Return the code for the git hook scripts
     *
     * @param  string $hook Name of the hook to generate the sourcecode for
     * @return array<string>
     */
    abstract protected function getHookLines(string $hook): array;
}