PurpleBooth\GitGitHubLint\Command\EvaluatePullRequest

Complexity

Total Complexity

3

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	configure()	0	51	1
B	execute()	0	34	2

<?php
declare(strict_types = 1);

namespace PurpleBooth\GitGitHubLint\Command;

use Github\Client;
use PurpleBooth\GitGitHubLint\GitHubLintImplementation;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

class EvaluatePullRequest extends Command
{
    const ARGUMENT_GITHUB_USERNAME   = 'github-username';
    const ARGUMENT_GITHUB_REPOSITORY = 'github-repository';
    const ARGUMENT_PULL_REQUEST_ID   = 'pull-request-id';
    const OPTION_TOKEN_OR_USERNAME   = 'token-or-username';
    const OPTION_PASSWORD            = 'password';
    const COMMAND_NAME               = 'git-github-lint:pr';

    protected function configure()
    {
        $this->setName(self::COMMAND_NAME);
        $this->setDescription("Check the style of commit messages in a pull request");

        $help = '';

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

        $help .= "Evaluates a the commits in a pull request and checks that their messages match the style advised by ";
        $help .= "Git. It will then update the \"status\" in github (that little dot next to the commits).\n";
        $help .= "\n";
        $help .= "\n";
        $help .= "Here are some good articles on commit message style:\n";
        $help .= "\n";
        $help .= "* http://chris.beams.io/posts/git-commit/\n";
        $help .= "* https://git-scm.com/book/ch5-2.html#Commit-Guidelines\n";
        $help .= "* https://github.com/blog/926-shiny-new-commit-styles\n";

        $this->setHelp($help);
        $this->setDefinition(
            new InputDefinition(
                [
                    new InputArgument(
                        self::ARGUMENT_GITHUB_USERNAME,
                        InputArgument::REQUIRED,
                        'GitHub Username'
                    ),
                    new InputArgument(
                        self::ARGUMENT_GITHUB_REPOSITORY,
                        InputArgument::REQUIRED,
                        'GitHub Repository'
                    ),
                    new InputArgument(
                        self::ARGUMENT_PULL_REQUEST_ID,
                        InputArgument::REQUIRED,
                        'The ID of the pull request'
                    ),
                    new InputOption(
                        self::OPTION_TOKEN_OR_USERNAME,
                        ['t', 'u'],
                        InputOption::VALUE_REQUIRED,
                        'The token or username to authenticate to the API with. Assumed to be token without password'
                    ),
                    new InputOption(
                        self::OPTION_PASSWORD,
                        'p',
                        InputOption::VALUE_OPTIONAL,
                        'The password to authenticate to the API with'
                    ),
                ]
            )
        );
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $io     = new SymfonyStyle($input, $output);

Avoid variables with short names like $io. Configured minimum length is 3.

        $config = new Client();
        $linter = new GitHubLintImplementation($config);

        $password           = $input->getOption(self::OPTION_PASSWORD);
        $authenticationType = Client::AUTH_HTTP_TOKEN;

        if ($password) {
            $authenticationType = Client::AUTH_HTTP_PASSWORD;
        }

        $config->authenticate(
            $input->getOption(self::OPTION_TOKEN_OR_USERNAME),
            $password,
            $authenticationType
        );

        $gitHubUsername   = $input->getArgument(self::ARGUMENT_GITHUB_USERNAME);
        $gitHubRepository = $input->getArgument(self::ARGUMENT_GITHUB_REPOSITORY);
        $pullRequestId    = $input->getArgument(self::ARGUMENT_PULL_REQUEST_ID);


        $io->title(self::COMMAND_NAME);
        $io->comment("Analysing PR $gitHubUsername/$gitHubRepository#$pullRequestId");
        $linter->analyse(
            $gitHubUsername,
            $gitHubRepository,
            (int)$pullRequestId
        );
        $io->success("Analysed PR $gitHubUsername/$gitHubRepository#$pullRequestId");

    }
}