PurpleBooth\GitGitHubLint\Status\DoNotEndTheSubjectLineWithAPeriodStatus

Complexity

Total Complexity

5

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

5 Methods

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

<?php

declare(strict_types = 1);

namespace PurpleBooth\GitGitHubLint\Status;

use PurpleBooth\GitGitHubLint\Validator\DoNotEndTheSubjectLineWithAPeriodValidator;

/**
 * This is the status returned when the DoNotEndTheSubjectLineWithAPeriodValidator identifies a problem
 *
 * @see     DoNotEndTheSubjectLineWithAPeriodValidator
 *
 * @package PurpleBooth\GitGitHubLint\Status
 */
class DoNotEndTheSubjectLineWithAPeriodStatus 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 remove the full stop at the end of the subject line of the commit message';
    }

    /**
     * Is true if the status on GitHub would be success
     *
     * @return boolean
     */
    public function isPositive() : bool
    {
        return $this->getState() == Status::STATE_SUCCESS;
    }

    /**
     * The GitHub equivalent of this state
     *
     * Can be one of pending, success, error, or failure.
     *
     * @return string
     */
    public function getState() : string
    {
        return Status::STATE_FAILURE;
    }

    /**
     * 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/#end";
    }
}