PurpleBooth\GitLintValidators\Composer\Scripts

Complexity

Total Complexity

10

Size/Duplication

Total Lines	147
Duplicated Lines	10.88 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes	4
Bugs	1	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
B	installGitMessageHook()	8	51	6
B	installGitCommitMessageTemplate()	8	41	4

<?php
declare(strict_types = 1);
namespace PurpleBooth\GitLintValidators\Composer;

use Composer\Script\Event;

class Scripts
{
    const BACKUP_EXTENSION  = '.bak';
    const GIT_PATH          = '.git';
    const HOOKS_PATH        = 'hooks';
    const HOOK_FILENAME     = 'commit-msg';
    const TEMPLATE_FILENAME = '.gitmessage';

    /**
     * Default Permissions (Copied from example hooks)
     *
     * User: Read, Write, Execute
     * Group: Read, Execute
     * Other: Execute
     */
    const EXECUTABLE_PERMISSIONS = 0751;
    const HOOK_CONTENTS          = <<<CONTENT
#!/bin/sh

vendor/bin/git-lint-validators git-lint-validator:hook $1
CONTENT;

    const TEMPLATE_CONTENTS      = <<<CONTENT

Equals sign not aligned correctly; expected 1 space but found 6 spaces

Subject line

# - Capitalise the subject line and do not end it with a period
# - Use the imperative mood in the subject line
# - Summarise changes in around 50 (soft limit, hard limit at 69)
#   characters or less in the subject line
# - Separate subject line from body with a blank line
Subject body
# - Use the subject body to explain what and why vs. how
# - Wrap the subject body at 72 characters

CONTENT;

    /**
     * Installs and activates the Git commit message
     * hook when confirmed by the user. An existing hook
     * is backed with the .bak extension.
     *
     * @param  Event $event The script event.
     *
     * @return boolean
     */
    public static function installGitMessageHook(Event $event)
    {
        $hookContent = self::HOOK_CONTENTS;
        $inputOutput = $event->getIO();
        $question    = "Do you want to install and activate the Git ";
        $question   .= "commit message hook? ";

        if ($inputOutput->askConfirmation($question, false)) {
            $gitDirectory = implode(DIRECTORY_SEPARATOR, [dirname(__DIR__, 4), self::GIT_PATH]);

            if (!is_dir($gitDirectory)) {

This code seems to be duplicated across your project.

                $errorMessage  = "Couldn't locate the .git directory. ";
                $errorMessage .= "Aborting the Git hook installation.";

                $inputOutput->error($errorMessage);

                return false;
            }

            $hookFile         = implode(DIRECTORY_SEPARATOR, [$gitDirectory, self::HOOKS_PATH, self::HOOK_FILENAME]);
            $existingHookFile = false;

            if (file_exists($hookFile)) {
                $existingHookFile = copy(
                    $hookFile,
                    $hookFile . self::BACKUP_EXTENSION
                );
            }

            file_put_contents($hookFile, $hookContent);
            chmod($hookFile, self::EXECUTABLE_PERMISSIONS);

            $inputOutput->write("Installed and activated the Git commit message hook.");

            if ($existingHookFile) {
                $inputOutput->write("Backed previous Git commit message hook.");
            }

            if ($inputOutput->isVerbose()) {
                $inputOutput->write("Wrote");
                $inputOutput->write("<comment>$hookContent</comment>");
                $inputOutput->write("into <info>$hookFile</info> and made it executable.");
            }

            return true;
        }

        $inputOutput->write("Aborted installation and activation of the Git commit message hook.");

        return false;
    }

    /**
     * Installs and configures the Git commit message
     * template when confirmed by the user.
     *
     * @param  Event $event The script event.
     *
     * @return boolean
     */
    public static function installGitCommitMessageTemplate(Event $event)

function installGitCommitMessageTemplate() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        $templateContent = self::TEMPLATE_CONTENTS;
        $inputOutput = $event->getIO();

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

        $question    = "Do you want to install and configure the Git ";

Equals sign not aligned with surrounding assignments; expected 8 spaces but found 4 spaces

        $question   .= "commit message template? ";

Equals sign not aligned with surrounding assignments; expected 7 spaces but found 3 spaces

        if ($inputOutput->askConfirmation($question, false)) {
            $gitDirectory = implode(DIRECTORY_SEPARATOR, [dirname(__DIR__, 4), self::GIT_PATH]);

            if (!is_dir($gitDirectory)) {

This code seems to be duplicated across your project.

                $errorMessage  = "Couldn't locate the .git directory. ";
                $errorMessage .= "Aborting the Git commit message template installation.";

                $inputOutput->error($errorMessage);

                return false;
            }

            $templateFile = implode(DIRECTORY_SEPARATOR, [$gitDirectory, self::TEMPLATE_FILENAME]);

            file_put_contents($templateFile, $templateContent);
            $gitConfigureCommand = "git config --add commit.template $templateFile";
            exec($gitConfigureCommand);

            $inputOutput->write("Installed and configured the Git commit message template.");

            if ($inputOutput->isVerbose()) {
                $inputOutput->write("Wrote");
                $inputOutput->write("<comment>$templateContent</comment>");
                $inputOutput->write("into <info>$templateFile</info> and configured the Git commit message template ");
                $inputOutput->write("via <comment>$gitConfigureCommand</comment>.");
            }

            return true;
        }

        $inputOutput->write("Aborted installation and configuration of the Git commit message template.");

        return false;
    }
}