CaptainHook\App\Console\Command\Hook\PrepareCommitMsg

Complexity

Total Complexity

3

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	configure()	0	7	1
A	setup()	0	12	1
A	tearDown()	0	4	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.
 */
namespace CaptainHook\App\Console\Command\Hook;

use CaptainHook\App\Config;
use CaptainHook\App\Console\Command\Hook;
use CaptainHook\App\Hooks;
use SebastianFeldmann\Git\CommitMessage;
use SebastianFeldmann\Git\Repository;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class PrepareCommitMessage
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/sebastianfeldmann/captainhook
 * @since   Class available since Release 3.0.1
 */
class PrepareCommitMsg extends Hook
{
    /**
     * Hook to execute
     *
     * @var string
     */
    protected $hookName = Hooks::PREPARE_COMMIT_MSG;

    /**
     * File to read/write the commit message from/to
     *
     * @var string
     */
    private $file;

    /**
     * Commit mode [null|message|template|merge|squash|commit]
     *
     * @var string
     */
    private $mode;

    /**
     * Commit hash if mode is commit during -c or --amend
     *
     * @var string
     */
    private $hash;

    /**
     * Configure the command
     */
    protected function configure()
    {
        parent::configure();
        $this->addArgument('file', InputArgument::REQUIRED, 'File containing the commit log message');
        $this->addArgument('mode', InputArgument::OPTIONAL, 'Current commit mode');
        $this->addArgument('hash', InputArgument::OPTIONAL, 'Given commit hash');
    }
    /**
     * Read the commit message from file
     *
     * @param \Symfony\Component\Console\Input\InputInterface   $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     * @param \CaptainHook\App\Config                           $config
     * @param \SebastianFeldmann\Git\Repository                 $repository
     */
    protected function setup(InputInterface $input, OutputInterface $output, Config $config, Repository $repository)
    {
        $this->file       = $input->getArgument('file');

It seems like $input->getArgument('file') can also be of type array<integer,string>. However, the property $file is declared as type string. Maybe add an additional type check?

        $this->mode       = $input->getArgument('mode');

It seems like $input->getArgument('mode') can also be of type array<integer,string>. However, the property $mode is declared as type string. Maybe add an additional type check?

        $this->hash       = $input->getArgument('hash');

It seems like $input->getArgument('hash') can also be of type array<integer,string>. However, the property $hash is declared as type string. Maybe add an additional type check?

        $gitConfig        = $repository->getConfigOperator();
        $commentCharacter = $gitConfig->getSafely('core.commentchar', '#');

        $repository->setCommitMsg(CommitMessage::createFromFile($this->file, $commentCharacter));

It seems like $this->file can also be of type array<integer,string> or null; however, SebastianFeldmann\Git\CommitMessage::createFromFile() does only seem to accept string, maybe add an additional type check?

        parent::setup($input, $output, $config, $repository);
    }

    /**
     * Post action after all the configured actions are executed
     *
     * @param \Symfony\Component\Console\Input\InputInterface   $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     * @param \CaptainHook\App\Config                           $config
     * @param \SebastianFeldmann\Git\Repository                 $repository
     */
    protected function tearDown(InputInterface $input, OutputInterface $output, Config $config, Repository $repository)
    {
        file_put_contents($this->file, $repository->getCommitMsg()->getRawContent());
    }
}