CaptainHook\App\Hook\Message\Rule\LimitBodyLineLength

Complexity

Total Complexity

4

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	pass()	0	11	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\App\Hook\Message\Rule;

use SebastianFeldmann\Git\CommitMessage;

/**
 * Class LimitBodyLineLength
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/captainhook-git/captainhook
 * @since   Class available since Release 0.9.0
 */
class LimitBodyLineLength extends Base
{
    /**
     * Length limit
     *
     * @var int
     */
    protected $maxLength;

    /**
     * Constructor
     *
     * @param int $length
     */
    public function __construct($length = 72)
    {
        $this->hint      = 'Body lines should not exceed ' . $length . ' characters';
        $this->maxLength = $length;
    }

    /**
     * Check if a body line doesn't exceed the max length limit
     *
     * @param  \SebastianFeldmann\Git\CommitMessage $msg
     * @return bool
     */
    public function pass(CommitMessage $msg): bool
    {
        $lineNr = 1;
        foreach ($msg->getBodyLines() as $line) {
            if (mb_strlen($line) > $this->maxLength) {
                $this->hint .= PHP_EOL . 'Line ' . $lineNr . ' of your body exceeds the max line length';
                return false;
            }
            $lineNr++;
        }
        return true;
    }
}