Dgame\Ensurance\ClassEnsurance

Complexity

Total Complexity

13

Size/Duplication

Total Lines	164
Duplicated Lines	21.34 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	is()	0	6	1
A	isNot()	0	6	1
A	extends()	0	6	1
A	extendsNot()	0	6	1
A	implements()	7	7	1
A	implementsNot()	7	7	1
A	isParentOf()	7	7	1
A	isNotParentOf()	7	7	1
A	uses()	7	7	1
A	hasProperty()	0	7	1
A	hasMethod()	0	7	1

<?php

namespace Dgame\Ensurance;

use Dgame\Ensurance\Exception\EnsuranceException;
use Dgame\Ensurance\Traits\EnforcementTrait;

/**
 * Class ClassEnsurance
 * @package Dgame\Ensurance
 */
class ClassEnsurance
{
    /**
     * @var string
     */
    private $class;

    use EnforcementTrait;

    /**
     * ClassEnsurance constructor.
     *
     * @param string $class
     *
     * @throws EnsuranceException
     */
    public function __construct(string $class)
    {
        if (!class_exists($class)) {
            throw new EnsuranceException('"%s" is not a class', $class);
        }

        $this->class = $class;
    }

    /**
     * @param string $class
     *
     * @return ClassEnsurance
     */
    public function is(string $class): ClassEnsurance
    {
        $this->enforce($this->class === $class)->orThrow('"%s" is not "%s"', $this->class, $class);

        return $this;
    }

    /**
     * @param string $class
     *
     * @return ClassEnsurance
     */
    public function isNot(string $class): ClassEnsurance
    {
        $this->enforce($this->class !== $class)->orThrow('"%s" is "%s"', $this->class, $class);

        return $this;
    }

    /**
     * @param string $class
     *
     * @return ClassEnsurance
     */
    public function extends (string $class): ClassEnsurance
    {
        $this->enforce(is_subclass_of($this->class, $class))->orThrow('"%s" did not extend "%s"', $this->class, $class);

Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if $class can be an interface. If so, you could instead use ReflectionClass::implementsInterface.

        return $this;
    }

    /**
     * @param string $class
     *
     * @return ClassEnsurance
     */
    public function extendsNot(string $class): ClassEnsurance
    {
        $this->enforce(!is_subclass_of($this->class, $class))->orThrow('"%s" did extend "%s"', $this->class, $class);

Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if $class can be an interface. If so, you could instead use ReflectionClass::implementsInterface.

        return $this;
    }

    /**
     * @param string $interface
     *
     * @return ClassEnsurance
     */
    public function implements (string $interface): ClassEnsurance

This method seems to be duplicated in your project.

    {
        $this->enforce(array_key_exists($interface, class_implements($this->class)))
             ->orThrow('"%s" does not implements interface "%s"', $this->class, $interface);

        return $this;
    }

    /**
     * @param string $interface
     *
     * @return ClassEnsurance
     */
    public function implementsNot(string $interface): ClassEnsurance

This method seems to be duplicated in your project.

    {
        $this->enforce(!array_key_exists($interface, class_implements($this->class)))
             ->orThrow('"%s" does implements interface "%s"', $this->class, $interface);

        return $this;
    }

    /**
     * @param string $class
     *
     * @return ClassEnsurance
     */
    public function isParentOf(string $class): ClassEnsurance

This method seems to be duplicated in your project.

    {
        $this->enforce(array_key_exists($this->class, class_parents($class, true)))
             ->orThrow('"%s" is not a parent of "%s"', $this->class, $class);

        return $this;
    }

    /**
     * @param string $class
     *
     * @return ClassEnsurance
     */
    public function isNotParentOf(string $class): ClassEnsurance

This method seems to be duplicated in your project.

    {
        $this->enforce(!array_key_exists($this->class, class_parents($class, true)))
             ->orThrow('"%s" is a parent of "%s"', $this->class, $class);

        return $this;
    }

    /**
     * @param string $trait
     *
     * @return ClassEnsurance
     */
    public function uses(string $trait): ClassEnsurance

This method seems to be duplicated in your project.

    {
        $this->enforce(array_key_exists($trait, class_uses($this->class)))
             ->orThrow('"%s" does not use trait "%s"', $this->class, $trait);

        return $this;
    }

    /**
     * @param string $property
     *
     * @return ClassEnsurance
     */
    public function hasProperty(string $property): ClassEnsurance
    {
        $this->enforce(property_exists($this->class, $property))
             ->orThrow('"%s" does not have a property "%s"', $this->class, $property);

        return $this;
    }

    /**
     * @param string $method
     *
     * @return ClassEnsurance
     */
    public function hasMethod(string $method): ClassEnsurance
    {
        $this->enforce(method_exists($this->class, $method))
             ->orThrow('"%s" does not have a method "%s"', $this->class, $method);

        return $this;
    }
}