PurpleBooth\GitLintValidators\Status\CapitalizeTheSubjectLineStatus

Complexity

Total Complexity

4

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getWeight()	0	4	1
A	getMessage()	0	4	1
A	isPositive()	0	4	1
A	getDetailsUrl()	0	4	1

<?php

declare(strict_types=1);

/*
 * Copyright (C) 2016 Billie Thompson
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace PurpleBooth\GitLintValidators\Status;

use PurpleBooth\GitLintValidators\Validator\CapitalizeTheSubjectLineValidator;

/**
 * This is the status returned when the CapitalizeTheSubjectLineValidator identifies a problem.
 *
 * @see     CapitalizeTheSubjectLineValidator
 */
class CapitalizeTheSubjectLineStatus implements Status
{
    /**
     * Get the importance of this status.
     *
     * The lower the value the less important it is, the higher the more important.
     *
     * @return int
     */
    public function getWeight(): int
    {
        return Status::WEIGHT_ERROR;
    }

    /**
     * A human readable message that describes this state.
     *
     * This will be displayed to the user via the GitHub state
     *
     * @return string
     */
    public function getMessage(): string
    {
        return 'Please capitalise the subject line of the commit message';
    }

    /**
     * Is true if the status is one that should not be taken as indicative of a incorrectly formatted message.
     *
     * @return bool
     */
    public function isPositive(): bool
    {
        return false;
    }

    /**
     * Get a URL with further explanation about this commit message status.
     *
     * @return string
     */
    public function getDetailsUrl(): string
    {
        return 'http://chris.beams.io/posts/git-commit/#capitalize';
    }
}