PurpleBooth\GitLintValidators\Status\SoftLimitTheTitleLengthTo50CharactersStatus

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);

/*
 * 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\SoftLimitTheTitleLengthTo50CharactersValidator;

/**
 * This is the status returned when the SoftLimitTheTitleLengthTo50CharactersValidator identifies a problem.
 *
 * @see     SoftLimitTheTitleLengthTo50CharactersValidator
 */
class SoftLimitTheTitleLengthTo50CharactersStatus 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_WARN;
    }

    /**
     * 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 'Looks good, but can you shorten the subject of the commit message to 50 characters or less?';
    }

    /**
     * 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 true;
    }

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

    /**
     * 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/#limit-50';
    }
}