BaseMatcher::match() - Code Metrics - Inspection of "Add Parser subpackage" - byrokrat/autogiro - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 310596...ecf895 )

by Hannes

created 2016-05-07 10:17 UTC

BaseMatcher::match() A

↳ Parent: BaseMatcher

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2

Metric	Value
dl	0
loc	17
ccs	8
cts	8
cp	1
rs	9.4285
cc	2
eloc	10
nc	2
nop	1
crap	2

<?php

declare(strict_types=1);

namespace byrokrat\autogiro\Parser\Matcher;

use byrokrat\autogiro\Line;
use byrokrat\autogiro\Exception\InvalidContentException;

/**
 * Base implementation of the Matcher interface
 */
abstract class BaseMatcher implements Matcher
{
    /**
     * @var int Start matching from
     */
    private $startPos;

    /**
     * @var int Length to match
     */
    private $length;

    /**
     * Set match area
     *
     * Note that to make matcher definitions and the technical specifications of
     * autoirot appear as similar as possible the first character of a line is
     * regarded as being in position one (1).
     */
    public function __construct(int $startPos, int $length)
    {
        $this->startPos = $startPos;
        $this->length = $length;
    }

    /**
     * Get a description of the expected content
     */
    abstract protected function getDescription(): string;

    /**
     * Check if string is valid according to matching rules
     */
    abstract protected function isMatch(string $str): bool;

    /**
     * Match line and grab substring on success
     *
     * @throws InvalidContentException if line does not match
     */
    public function match(Line $line): string
    {
        $str = $line->substr($this->startPos - 1, $this->length);

        if (!$this->isMatch($str)) {
            throw new InvalidContentException(
                sprintf(
                    "Invalid content '%s' (expecting %s) starting at position %s",
                    $str,
                    $this->getDescription(),
                    $this->startPos - 1
                )
            );
        }

        return $str;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace byrokrat\autogiro\Parser\Matcher;
6
7		use byrokrat\autogiro\Line;
8		use byrokrat\autogiro\Exception\InvalidContentException;
9
10		/**
11		* Base implementation of the Matcher interface
12		*/
13		abstract class BaseMatcher implements Matcher
14		{
15		/**
16		* @var int Start matching from
17		*/
18		private $startPos;
19
20		/**
21		* @var int Length to match
22		*/
23		private $length;
24
25		/**
26		* Set match area
27		*
28		* Note that to make matcher definitions and the technical specifications of
29		* autoirot appear as similar as possible the first character of a line is
30		* regarded as being in position one (1).
31		*/
32	8	public function __construct(int $startPos, int $length)
33		{
34	8	$this->startPos = $startPos;
35	8	$this->length = $length;
36	8	}
37
38		/**
39		* Get a description of the expected content
40		*/
41		abstract protected function getDescription(): string;
42
43		/**
44		* Check if string is valid according to matching rules
45		*/
46		abstract protected function isMatch(string $str): bool;
47
48		/**
49		* Match line and grab substring on success
50		*
51		* @throws InvalidContentException if line does not match
52		*/
53	8	public function match(Line $line): string
54		{
55	8	$str = $line->substr($this->startPos - 1, $this->length);
56
57	8	if (!$this->isMatch($str)) {
58	4	throw new InvalidContentException(
59		sprintf(
60	4	"Invalid content '%s' (expecting %s) starting at position %s",
61		$str,
62	4	$this->getDescription(),
63	4	$this->startPos - 1
64		)
65		);
66		}
67
68	4	return $str;
69		}
70		}
71

byrokrat / autogiro

Push — master ( 310596...ecf895 )

BaseMatcher::match() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like