CaptainHook\App\Hook\Message\Rule\UseImperativeMood

Complexity

Total Complexity

2

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	22	2

<?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\App\Hook\Message\Rule;

/**
 * Class UseImperativeMood
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/captainhookphp/captainhook
 * @since   Class available since Release 0.9.0
 */
class UseImperativeMood extends Blacklist
{
    /**
     * Constructor
     *
     * @param bool $checkOnlyBeginning
     */
    public function __construct(bool $checkOnlyBeginning = false)
    {
        parent::__construct(false);
        $this->hint = 'Subject should be written in imperative mood';
        $this->setSubjectBlacklist(
            [
                'added',
                'changed',
                'created',
                'deleted',
                'fixed',
                'reformatted',
                'removed',
                'updated',
                'uploaded'
            ]
        );

        if ($checkOnlyBeginning) {
            // overwrite the detection logic to only check the beginning og the string
            $this->stringDetection = function (string $content, string $term): bool {
                return strpos($content, $term) === 0;
            };
        }
    }
}