Giter VIP home page Giter VIP logo

spec's Introduction

Specification

This library implements the Specification Pattern for use in any project.

Create composable logic by encapsulating decisions in a class that adheres to the SpecificationInterface.

Install

$ composer require emarref/spec

Usage

Given the following specifications:

<?php

use Emarref\Spec\SpecificationInterface;
use Emarref\Spec\LogicalSpecificationTrait;

class MorningSpecification implements SpecificationInterface
{
    use LogicalSpecificationTrait;

    public function isSatisfiedBy($subject): bool
    {
        if (!$subject instanceof \DateTimeInterface) {
            throw new \InvalidArgumentException('Subject must be a date time object.');
        }

        $hour = (int) $subject->format('G');

        return $hour < 12;
    }
}

class AfternoonSpecification implements SpecificationInterface
{
    use LogicalSpecificationTrait;

    public function isSatisfiedBy($subject): bool
    {
        if (!$subject instanceof \DateTimeInterface) {
            throw new \InvalidArgumentException('Subject must be a date time object.');
        }

        $hour = (int) $subject->format('G');

        return $hour > 12 && $hour < 18;
    }
}

class NightSpecification implements SpecificationInterface
{
    use LogicalSpecificationTrait;

    public function isSatisfiedBy($subject): bool
    {
        if (!$subject instanceof \DateTimeInterface) {
            throw new \InvalidArgumentException('Subject must be a date time object.');
        }

        $hour = (int) $subject->format('G');

        return $hour > 17;
    }
}

We can test if a date is in the morning:

<?php

$morning = new \DateTime('8am');
$isMorning = new MorningSpecification();

$isMorning->isSatisfiedBy($morning); // true

or afternoon:

<?php

$isAfternoon = new AfternoonSpecification();
$isAfternoon->isSatisfiedBy($morning); // false

We can chain specs together:

<?php

$night = new \DateTime('11pm');

$isMorning->or($isAfternoon)->isSatisfiedBy($morning); // true
$isMorning->or($isAfternoon)->isSatisfiedBy($night); // false

Chaining can be deep:

<?php

$isMorning->or($isAfternoon->andNot($isNight))->isSatisfiedBy($morning); // true

Business logic can be encapsulated by custom specs. Create a class that implements the Emarref\Spec\SpecificationInterface. Use the Emarref\Spec\LogicalSpecificationTrait to implement most of the boilerplate.

<?php

class StoreIsOpen implements SpecificationInterface
{
    use LogicalSpecificationTrait;

    public function isSatisfiedBy($subject): bool
    {
        if (!$subject instanceof \DateTimeInterface) {
            throw new \InvalidArgumentException('Subject must be a date time object.');
        }

        $isMorning = new MorningSpec();
        $isAfternoon = new AfternoonSpec();

        return $isMorning->or($isAfternoon)->isSatisfiedBy($subject);
    }
}

$storeIsOpen = new StoreIsOpen();
$storeIsOpen->isSatisfiedBy(new DateTime('10am')); // true
$storeIsOpen->isSatisfiedBy(new DateTime('11pm')); // false

spec's People

Contributors

emarref avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.