BenTools\Specification\Specification

Complexity

Total Complexity

14

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getLabel()	0	4	1
A	withLabel()	0	6	1
A	and()	0	4	1
A	or()	0	4	1
A	negate()	0	4	1
A	asGroup()	0	4	1
	validate()	0	1	?
A	isSatisfied()	0	9	2
B	factory()	0	13	6

<?php

namespace BenTools\Specification;

use BenTools\Specification\Exception\UnmetSpecificationException;
use BenTools\Specification\Helper\BooleanSpecification;
use BenTools\Specification\Helper\CallbackSpecification;
use BenTools\Specification\Logical\AndSpecification;
use BenTools\Specification\Logical\GroupSpecification;
use BenTools\Specification\Logical\NotSpecification;
use BenTools\Specification\Logical\OrSpecification;

abstract class Specification
{
    /**
     * @var string
     */
    protected $label;

    /**
     * @return null|string
     */
    final public function getLabel(): ?string
    {
        return $this->label;
    }

    /**
     * @param null|string $label
     * @return Specification
     */
    final public function withLabel(?string $label): Specification
    {
        $clone = clone $this;
        $clone->label = $label;
        return $clone;
    }

    /**
     * @param             $specification
     * @param null|string $label
     * @return Specification
     * @throws \RuntimeException
     */
    final public function and($specification, ?string $label = null): Specification
    {
        return new AndSpecification($this, self::factory($specification, $label), $label);
    }

    /**
     * @param             $specification
     * @param null|string $label
     * @return Specification
     * @throws \RuntimeException
     */
    final public function or($specification, ?string $label = null): Specification
    {
        return new OrSpecification($this, self::factory($specification, $label), $label);
    }

    /**
     * @param null|string $label
     * @return Specification
     */
    final public function negate(?string $label = null): Specification
    {
        return new NotSpecification($this, $label);
    }

    /**
     * @param null|string $label
     * @return Specification
     */
    final public function asGroup(?string $label = null): Specification
    {
        return new GroupSpecification($this, $label);
    }

    /**
     * Validate the specification.
     * If the specification is unmet the implementation MUST throw an UnmetSpecificationException.
     *
     * @throws UnmetSpecificationException
     */
    abstract public function validate(): void;

    /**
     * @return bool
     */
    final public function isSatisfied(): bool
    {
        try {
            $this->validate();
            return true;
        } catch (UnmetSpecificationException $e) {
            return false;
        }
    }

    /**
     * @param             $specification
     * @param null|string $label
     * @return Specification
     * @throws \RuntimeException
     */
    final public static function factory($specification, ?string $label = null): Specification
    {
        if ($specification instanceof Specification) {
            return (null !== $label && $label !== $specification->getLabel()) ? $specification->withLabel($label) : $specification;
        }
        if (is_bool($specification)) {
            return new BooleanSpecification($specification, $label);
        }
        if (is_callable($specification)) {
            return new CallbackSpecification($specification, $label);
        }
        throw new \RuntimeException("Unable to determine specificaton type.");
    }
}