Remorhaz\IntRangeSets\Range

Complexity

Total Complexity

18

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	3
A	getFinish()	0	3	1
A	contains()	0	3	2
A	asRangeSet()	0	3	1
A	equals()	0	3	2
A	containsValue()	0	3	2
A	withFinish()	0	3	1
A	follows()	0	3	1
A	withStart()	0	3	1
A	intersects()	0	3	2
A	getStart()	0	3	1
A	getLength()	0	3	1

<?php

declare(strict_types=1);

namespace Remorhaz\IntRangeSets;

/**
 * Immutable non-empty range of integers.
 *
 * @psalm-immutable
 */
final class Range implements RangeInterface
{

    /**
     * @var int
     */
    private $start;

    /**
     * @var int
     */
    private $finish;

    /**
     * @param int      $start  First value of the range.
     * @param int|null $finish Last value of the range. If null than equals first value, otherwise must be greater or
     *                         equal than first value.
     * @throws Exception\InvalidRangeException
     */
    public function __construct(int $start, ?int $finish = null)
    {
        if (!isset($finish)) {
            $finish = $start;
        } elseif ($finish < $start) {
            throw new Exception\InvalidRangeException($start, $finish);
        }

        $this->start = $start;
        $this->finish = $finish;
    }

    /**
     * {@inheritDoc}
     *
     * @return int
     */
    public function getStart(): int
    {
        return $this->start;
    }

    /**
     * {@inheritDoc}
     *
     * @return int
     */
    public function getFinish(): int
    {
        return $this->finish;
    }

    /**
     * {@inheritDoc}
     *
     * @return int
     */
    public function getLength(): int
    {
        return $this->finish - $this->start + 1;
    }

    /**
     * {@inheritDoc}
     *
     * @param RangeInterface $range
     * @return bool
     */
    public function equals(RangeInterface $range): bool
    {
        return $range->getStart() == $this->start && $range->getFinish() == $this->finish;
    }

    /**
     * {@inheritDoc}
     *
     * @param int $value
     * @return bool
     */
    public function containsValue(int $value): bool
    {
        return $this->start <= $value && $value <= $this->finish;
    }

    /**
     * {@inheritDoc}
     *
     * @param RangeInterface $range
     * @return bool
     */
    public function contains(RangeInterface $range): bool
    {
        return $range->getStart() >= $this->start && $range->getFinish() <= $this->finish;
    }

    /**
     * {@inheritDoc}
     *
     * @param RangeInterface $range
     * @return bool
     */
    public function intersects(RangeInterface $range): bool
    {
        return $this->finish >= $range->getStart() && $range->getFinish() >= $this->start;
    }

    /**
     * {@inheritDoc}
     *
     * @param RangeInterface $range
     * @return bool
     */
    public function follows(RangeInterface $range): bool
    {
        return $this->start == $range->getFinish() + 1;
    }

    /**
     * {@inheritDoc}
     *
     * @return RangeSetInterface
     */
    public function asRangeSet(): RangeSetInterface
    {
        return RangeSet::createUnsafe($this);
    }

    /**
     * {@inheritDoc}
     *
     * @param int $value
     * @return RangeInterface
     */
    public function withStart(int $value): RangeInterface
    {
        return new self($value, $this->finish);
    }

    /**
     * {@inheritDoc}
     *
     * @param int $value
     * @return RangeInterface
     */
    public function withFinish(int $value): RangeInterface
    {
        return new self($this->start, $value);
    }
}