Peridot\Leo\Matcher\RangeMatcher

Complexity

Total Complexity

11

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getDefaultCountableTemplate()	0	7	1
A	getDefaultTemplate()	0	7	1
A	setLowerBound()	0	10	2
A	setUpperBound()	0	10	2
A	getLowerBound()	0	4	1
A	getUpperBound()	0	4	1
A	matchNumeric()	0	4	2

<?php

namespace Peridot\Leo\Matcher;

use Peridot\Leo\Matcher\Template\ArrayTemplate;
use Peridot\Leo\Matcher\Template\TemplateInterface;

/**
 * RangeMatcher matches a number or the length of a countable
 * between a lower and upper bound - both of which are inclusive.
 *
 * @package Peridot\Leo\Matcher
 */
class RangeMatcher extends CountableMatcher
{
    /**
     * @var mixed
     */
    protected $lowerBound;

    /**
     * @var mixed
     */
    protected $upperBound;

    /**
     * @param mixed $lower
     * @param mixed $upper
     */
    public function __construct($lower, $upper)
    {
        $this->setLowerBound($lower);
        $this->setUpperBound($upper);
    }

    /**
     * {@inheritdoc}
     *
     * @return TemplateInterface
     */
    public function getDefaultCountableTemplate()
    {
        return new ArrayTemplate([
            'default' => "Expected {{actual}} to be within {$this->lowerBound}..{$this->upperBound}",
            'negated' => "Expected {{actual}} to not be within {$this->lowerBound}..{$this->upperBound}",
        ]);
    }

    /**
     * {@inheritdoc}
     *
     * @return TemplateInterface
     */
    public function getDefaultTemplate()
    {
        return new ArrayTemplate([
            'default' => "Expected {{actual}} to be within {$this->lowerBound}..{$this->upperBound}",
            'negated' => "Expected {{actual}} to not be within {$this->lowerBound}..{$this->upperBound}",
        ]);
    }

    /**
     * Set the lower bound of the range matcher.
     *
     * @param  mixed $lowerBound
     * @return $this
     */
    public function setLowerBound($lowerBound)
    {
        if (!is_numeric($lowerBound)) {
            throw new \InvalidArgumentException('Lower bound must be a numeric value');
        }

        $this->lowerBound = $lowerBound;

        return $this;
    }

    /**
     * Set the upper bound of the range matcher.
     *
     * @param  mixed $upperBound
     * @return $this
     */
    public function setUpperBound($upperBound)
    {
        if (!is_numeric($upperBound)) {
            throw new \InvalidArgumentException('Upper bound must be a numeric value');
        }

        $this->upperBound = $upperBound;

        return $this;
    }

    /**
     * Return the lower bound of the range matcher.
     *
     * @return mixed
     */
    public function getLowerBound()
    {
        return $this->lowerBound;
    }

    /**
     * Return the upper bound of the range matcher.
     *
     * @return mixed
     */
    public function getUpperBound()
    {
        return $this->upperBound;
    }

    /**
     * Determine if the number is between an upper and lower bound (inclusive).
     *
     * @param $number
     * @return bool
     */
    protected function matchNumeric($number)
    {
        return $number <= $this->upperBound && $number >= $this->lowerBound;
    }
}