byrokrat\autogiro\Parser\Matcher\BaseMatcher

Complexity

Total Complexity

3

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
	getDescription()	0	1	?
	isMatch()	0	1	?
A	match()	0	17	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;
    }
}