Dgame\Ensurance\NumericEnsurance

Complexity

Total Complexity

17

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

83.72%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isInt()	0	6	1
A	isFloat()	0	6	1
A	isGreaterThan()	0	6	1
A	isGreaterThanOrEqualTo()	0	6	1
A	isLessThan()	0	6	1
A	isLessThanOrEqualTo()	0	6	1
A	isPositive()	0	4	1
A	isNegative()	0	4	1
A	isEven()	0	6	1
A	isOdd()	0	6	1
A	isEqualTo()	0	6	1
A	isNotEqualTo()	0	6	1
A	isBetween()	0	7	2
A	isNotBetween()	0	7	2

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 5 and the first side effect is on line 5.

namespace Dgame\Ensurance;

defined('PHP_FLOAT_EPSILON') or define('PHP_FLOAT_EPSILON', 2.2204460492503e-16);

Using logical operators such as or instead of || is generally not recommended.

/**
 * Class NumericEnsurance
 * @package Dgame\Ensurance
 */
final class NumericEnsurance implements EnsuranceInterface
{
    use EnsuranceTrait;

    /**
     * NumericEnsurance constructor.
     *
     * @param EnsuranceInterface $ensurance
     */
    public function __construct(EnsuranceInterface $ensurance)
    {
        $this->transferEnsurance($ensurance);
    }

    /**
     * @return NumericEnsurance
     */
    public function isInt(): self
    {
        $this->ensure(is_int($this->value))->orThrow('"%s" is not an int', $this->value);

        return $this;
    }

    /**
     * @return NumericEnsurance
     */
    public function isFloat(): self
    {
        $this->ensure(is_float($this->value))->orThrow('"%s" is not a float', $this->value);

        return $this;
    }

    /**
     * @param float $value
     *
     * @return NumericEnsurance
     */
    public function isGreaterThan(float $value): self
    {
        $this->ensure($this->value > $value)->orThrow('"%s" is not greater than "%s"', $this->value, $value);

        return $this;
    }

    /**
     * @param float $value
     *
     * @return NumericEnsurance
     */
    public function isGreaterThanOrEqualTo(float $value): self
    {
        $this->ensure($this->value >= $value)->orThrow('"%s" is not greater or equal than "%s"', $this->value, $value);

        return $this;
    }

    /**
     * @param float $value
     *
     * @return NumericEnsurance
     */
    public function isLessThan(float $value): self
    {
        $this->ensure($this->value < $value)->orThrow('"%s" is greater or equal to "%s"', $this->value, $value);

        return $this;
    }

    /**
     * @param float $value
     *
     * @return NumericEnsurance
     */
    public function isLessThanOrEqualTo(float $value): self
    {
        $this->ensure($this->value <= $value)->orThrow('"%s" is greater than "%s"', $this->value, $value);

        return $this;
    }

    /**
     * @return NumericEnsurance

Should the return type not be \self?

     */
    public function isPositive(): self
    {
        return $this->isGreaterThanOrEqualTo(0);
    }

    /**
     * @return NumericEnsurance

Should the return type not be \self?

     */
    public function isNegative(): self
    {
        return $this->isLessThan(0);
    }

    /**
     * @return NumericEnsurance
     */
    public function isEven(): self
    {
        $this->ensure(($this->value & 1) === 0)->orThrow('"%s is not even"', $this->value);

        return $this;
    }

    /**
     * @return NumericEnsurance
     */
    public function isOdd(): self
    {
        $this->ensure(($this->value & 1) === 1)->orThrow('"%s is not odd"', $this->value);

        return $this;
    }

    /**
     * @param float $value
     *
     * @return NumericEnsurance
     */
    public function isEqualTo(float $value): self
    {
        $this->ensure(abs($this->value - $value) < PHP_FLOAT_EPSILON)->orThrow('"%s" is not equal to "%s"', $this->value, $value);

        return $this;
    }

    /**
     * @param float $value
     *
     * @return NumericEnsurance
     */
    public function isNotEqualTo(float $value): self
    {
        $this->ensure(abs($this->value - $value) > PHP_FLOAT_EPSILON)->orThrow('"%s" is equal to "%s"', $this->value, $value);

        return $this;
    }

    /**
     * @param float $lhs
     * @param float $rhs
     *
     * @return NumericEnsurance
     */
    public function isBetween(float $lhs, float $rhs): self
    {
        $this->ensure($lhs <= $this->value && $rhs >= $this->value)
             ->orThrow('"%s" is not between "%s" and "%s"', $this->value, $lhs, $rhs);

        return $this;
    }

    /**
     * @param float $lhs
     * @param float $rhs
     *
     * @return NumericEnsurance
     */
    public function isNotBetween(float $lhs, float $rhs): self
    {
        $this->ensure($lhs > $this->value || $rhs < $this->value)
             ->orThrow('"%s" is between "%s" and "%s"', $this->value, $lhs, $rhs);

        return $this;
    }
}