CaptainHook\Hook\Message\Validator\Rule\UseImperativeMood

Complexity

Total Complexity

4

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	pass()	0	17	3

<?php
/**
 * This file is part of CaptainHook.
 *
 * (c) Sebastian Feldmann <sf@sebastian.feldmann.info>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace CaptainHook\Hook\Message\Validator\Rule;

use CaptainHook\Git\CommitMessage;

/**
 * Class UseImperativeMood
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/sebastianfeldmann/captainhook
 * @since   Class available since Release 0.9.0
 */
class UseImperativeMood extends Base
{
    /**
     * Constructor.
     */
    public function __construct()
    {
        $this->hint = 'Subject should be written in imperative mood';
    }

    /**
     * Check if commit message is written in imperative mood.
     *
     * @param  \CaptainHook\Git\CommitMessage $msg
     * @return bool
     */
    public function pass(CommitMessage $msg)
    {
        $lowerSubject = strtolower($msg->getSubject());
        $blackList    = [
            'uploaded',
            'updated',
            'added',
            'created',
        ];
        foreach ($blackList as $term) {
            if (strpos($lowerSubject, $term) !== false) {
                $this->hint .= PHP_EOL . 'Invalid use of \'' . $term . '\'';
                return false;
            }
        }
        return true;
    }
}