RuleBook::addRule() - Code Metrics - captainhook-git/captainhook - Measure and Improve Code Quality continuously with Scrutinizer

RuleBook::addRule() A
last analyzed 2025-06-07 07:48 UTC

↳ Parent: RuleBook

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10

<?php

/**
 * This file is part of CaptainHook
 *
 * (c) Sebastian Feldmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CaptainHook\App\Hook\Message;

use SebastianFeldmann\Git\CommitMessage;

/**
 * Class RuleBook
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <[email protected]>
 * @link    https://github.com/captainhook-git/captainhook
 * @since   Class available since Release 0.9.0
 */
class RuleBook
{
    /**
     * List of rules to check
     *
     * @var \CaptainHook\App\Hook\Message\Rule[]
     */
    private $rules = [];

    /**
     * Set rules to check
     *
     * @param  \CaptainHook\App\Hook\Message\Rule[] $rules
     * @return \CaptainHook\App\Hook\Message\RuleBook
     */
    public function setRules(array $rules): RuleBook
    {
        $this->rules = $rules;
        return $this;
    }

    /**
     * Add a rule to the list
     *
     * @param  \CaptainHook\App\Hook\Message\Rule $rule
     * @return \CaptainHook\App\Hook\Message\RuleBook
     */
    public function addRule(Rule $rule): RuleBook
    {
        $this->rules[] = $rule;
        return $this;
    }

    /**
     * Validates all rules
     *
     * Returns a list of problems found checking the commit message.
     * If the list is empty the message is valid.
     *
     * @param  \SebastianFeldmann\Git\CommitMessage $msg
     * @return array<string>
     */
    public function validate(CommitMessage $msg): array
    {
        $problems = [];
        foreach ($this->rules as $rule) {
            if (!$rule->pass($msg)) {
                $problems[] = $rule->getHint();
            }
        }
        return $problems;
    }
}


1		<?php
2
3		/**
4		* This file is part of CaptainHook
5		*
6		* (c) Sebastian Feldmann <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace CaptainHook\App\Hook\Message;
13
14		use SebastianFeldmann\Git\CommitMessage;
15
16		/**
17		* Class RuleBook
18		*
19		* @package CaptainHook
20		* @author Sebastian Feldmann <[email protected]>
21		* @link https://github.com/captainhook-git/captainhook
22		* @since Class available since Release 0.9.0
23		*/
24		class RuleBook
25		{
26		/**
27		* List of rules to check
28		*
29		* @var \CaptainHook\App\Hook\Message\Rule[]
30		*/
31		private $rules = [];
32
33		/**
34		* Set rules to check
35		*
36		* @param \CaptainHook\App\Hook\Message\Rule[] $rules
37		* @return \CaptainHook\App\Hook\Message\RuleBook
38		*/
39	7	public function setRules(array $rules): RuleBook
40		{
41	7	$this->rules = $rules;
42	7	return $this;
43		}
44
45		/**
46		* Add a rule to the list
47		*
48		* @param \CaptainHook\App\Hook\Message\Rule $rule
49		* @return \CaptainHook\App\Hook\Message\RuleBook
50		*/
51	4	public function addRule(Rule $rule): RuleBook
52		{
53	4	$this->rules[] = $rule;
54	4	return $this;
55		}
56
57		/**
58		* Validates all rules
59		*
60		* Returns a list of problems found checking the commit message.
61		* If the list is empty the message is valid.
62		*
63		* @param \SebastianFeldmann\Git\CommitMessage $msg
64		* @return array<string>
65		*/
66	12	public function validate(CommitMessage $msg): array
67		{
68	12	$problems = [];
69	12	foreach ($this->rules as $rule) {
70	10	if (!$rule->pass($msg)) {
71	6	$problems[] = $rule->getHint();
72		}
73		}
74	12	return $problems;
75		}
76		}
77

captainhook-git / captainhook

RuleBook::addRule() A last analyzed 2025-06-07 07:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RuleBook::addRule() A
last analyzed 2025-06-07 07:48 UTC