Adding missing basic specification classes

CHANGELOG.md

@@ -2,17 +2,48 @@
 
 All Notable changes to `bakame/spec` will be documented in this file
 
+## [1.1.0] - 2022-05-13
+
+### Added
+
+- `AndNotX` and `OrNotX` Specifications
+- `Composite::andNotX` and `Composite::orNotX` methods
+
+### Fixed
+
+- added missing `declare(strict_types=1);` declaration
+- made protected properties private
+
+### Deprecated
+
+- none
+
+### Removed
+
+- none
+
 ## [1.0.1] - 2022-05-13
 
+### Added
+
+- none
+
 ### Fixed
 
-Remove development files from package download.
+- Remove development files from package download.
 
+### Deprecated
+
+- none
+
+### Removed
+
+- none
 
 ## [1.0.0] - 2022-05-13
 
 **Initial release!**
 
-
-[1.0.1]: https://github.com/bakame-php/spec/releases/tag/1.0.0...1.0.1
+[1.1.0]: https://github.com/bakame-php/spec/compare/1.0.1...1.1.0
+[1.0.1]: https://github.com/bakame-php/spec/compare/1.0.0...1.0.1
 [1.0.0]: https://github.com/bakame-php/spec/releases/tag/1.0.0

README.md

@@ -105,14 +105,16 @@ foreach ($invoiceCollection as $invoice) {
 Under the hood the `Specification\Chain` class calls and uses the following classes
 to allow the implementations of complex business rules.
 
-| Classes | Logical usage                                                      | Chain methods                   |
-|---------|--------------------------------------------------------------------|---------------------------------|
-| All     | All specifications must be satisfied by the subject                | `Chain::all` named constructor  |
-| Any     | At least one of the specifications provided must be satisfied      | `Chain::any` named constructor  |
-| None    | None of all provided specification must be satisfied by the author | `Chain::none` named constructor |
-| AndX    | Combined two specifications where both must be satisfied           | `Chain::andX` method            |
-| OrX     | Combined two specifications where at least one must be satisfied   | `Chain::orX` method             |
-| Not     | Returns the opposite result of the provided specification          | `Chain::not` method             |
+| Classes | Logical usage                                                                                      | Chain methods                   |
+|---------|----------------------------------------------------------------------------------------------------|---------------------------------|
+| All     | All specifications must be satisfied by the subject                                                | `Chain::all` named constructor  |
+| AndX    | Combined two specifications where both must be satisfied                                           | `Chain::andX` method            |
+| AndNotX | Combined two specifications where the left specification is satisfied **and** the right one is not | `Chain::andNotX` method         |
+| Any     | At least one of the specifications provided must be satisfied                                      | `Chain::any` named constructor  |
+| None    | None of all provided specification must be satisfied by the author                                 | `Chain::none` named constructor |
+| Not     | Returns the opposite result of the provided specification                                          | `Chain::not` method             |
+| OrX     | Combined two specifications where at least one must be satisfied                                   | `Chain::orX` method             |
+| OrNotX  | Combined two specifications where the left specification is satisfied **or** the right one is not  | `Chain::orNotX` method          |
 
 Creating more complex rules that you can individually test becomes trivial as do their maintenance.
 

src/All.php

@@ -14,7 +14,7 @@
 final class All implements Specification, Countable, IteratorAggregate
 {
     /** @var array<Specification> */
-    protected array $specifications;
+    private array $specifications;
 
     final public function __construct(Specification ...$specifications)
     {

src/AndNotX.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bakame\Specification;
+
+final class AndNotX implements Specification
+{
+    public function __construct(
+        private Specification $specificationA,
+        private Specification $specificationB
+    ) {
+    }
+
+    public function isSatisfiedBy(mixed $subject): bool
+    {
+        return $this->specificationA->isSatisfiedBy($subject)
+            && !$this->specificationB->isSatisfiedBy($subject);
+    }
+}

src/AndNotXSpec.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bakame\Specification;
+
+use PhpSpec\ObjectBehavior;
+
+final class AndNotXSpec extends ObjectBehavior
+{
+    public function let(Specification $spec1, Specification $spec2): void
+    {
+        $this->beConstructedWith($spec1, $spec2);
+    }
+
+    public function it_is_initializable(): void
+    {
+        $this->shouldHaveType(AndNotX::class);
+    }
+
+    public function it_implements_the_specification_interface(): void
+    {
+        $this->shouldImplement(Specification::class);
+    }
+
+    public function it_will_pass_with_both_spec_being_satisfied(Specification $spec1, Specification $spec2): void
+    {
+        $spec1->isSatisfiedBy('anything')->willReturn(true);
+        $spec2->isSatisfiedBy('anything')->willReturn(false);
+
+        $this->isSatisfiedBy('anything')->shouldEqual(true);
+    }
+
+    public function it_will_fail_with_at_least_one_spec_not_being_satisfied(Specification $spec1, Specification $spec2): void
+    {
+        $spec1->isSatisfiedBy('anything')->willReturn(false);
+        $spec2->isSatisfiedBy('anything')->willReturn(true);
+
+        $this->isSatisfiedBy('anything')->shouldEqual(false);
+    }
+
+    public function it_will_fail_with_both_spec_failing(Specification $spec1, Specification $spec2): void
+    {
+        $spec1->isSatisfiedBy('anything')->willReturn(false);
+        $spec2->isSatisfiedBy('anything')->willReturn(false);
+
+        $this->isSatisfiedBy('anything')->shouldEqual(false);
+    }
+}

src/AndX.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Bakame\Specification;
 
 final class AndX implements Specification

src/Any.php

@@ -14,7 +14,7 @@
 final class Any implements Specification, Countable, IteratorAggregate
 {
     /** @var array<Specification> */
-    protected array $specifications;
+    private array $specifications;
 
     final public function __construct(Specification ...$specifications)
     {

src/Chain.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Bakame\Specification;
 
 final class Chain implements Composite
@@ -43,11 +45,21 @@ public function andX(Specification $specification): Composite
         return new self(new AndX($this->specification, $specification));
     }
 
+    public function andNotX(Specification $specification): Composite
+    {
+        return new self(new AndNotX($this->specification, $specification));
+    }
+
     public function orX(Specification $specification): Composite
     {
         return new self(new OrX($this->specification, $specification));
     }
 
+    public function orNotX(Specification $specification): Composite
+    {
+        return new self(new OrNotX($this->specification, $specification));
+    }
+
     public function not(): Composite
     {
         return new self(new Not($this->specification));

src/Composite.php

@@ -5,6 +5,8 @@
 interface Composite extends Specification
 {
     public function andX(Specification $specification): Composite;
+    public function andNotX(Specification $specification): Composite;
     public function orX(Specification $specification): Composite;
+    public function orNotX(Specification $specification): Composite;
     public function not(): Composite;
 }

src/None.php

@@ -14,7 +14,7 @@
 final class None implements Specification, Countable, IteratorAggregate
 {
     /** @var array<Specification> */
-    protected array $specifications;
+    private array $specifications;
 
     final public function __construct(Specification ...$specifications)
     {

src/OrNotX.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bakame\Specification;
+
+final class OrNotX implements Specification
+{
+    public function __construct(
+        private Specification $specificationA,
+        private Specification $specificationB
+    ) {
+    }
+
+    public function isSatisfiedBy(mixed $subject): bool
+    {
+        return $this->specificationA->isSatisfiedBy($subject)
+            || !$this->specificationB->isSatisfiedBy($subject);
+    }
+}

src/OrNotXSpec.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bakame\Specification;
+
+use PhpSpec\ObjectBehavior;
+
+final class OrNotXSpec extends ObjectBehavior
+{
+    public function let(Specification $spec1, Specification $spec2): void
+    {
+        $this->beConstructedWith($spec1, $spec2);
+    }
+
+    public function it_is_initializable(): void
+    {
+        $this->shouldHaveType(OrNotX::class);
+    }
+
+    public function it_implements_the_specification_interface(): void
+    {
+        $this->shouldImplement(Specification::class);
+    }
+
+    public function it_will_pass_with_both_spec_being_satisfied(Specification $spec1, Specification $spec2): void
+    {
+        $spec1->isSatisfiedBy('anything')->willReturn(true);
+        $spec2->isSatisfiedBy('anything')->willReturn(true);
+
+        $this->isSatisfiedBy('anything')->shouldEqual(true);
+    }
+
+    public function it_will_pass_with_at_least_one_spec_not_being_satisfied(Specification $spec1, Specification $spec2): void
+    {
+        $spec1->isSatisfiedBy('anything')->willReturn(false);
+        $spec2->isSatisfiedBy('anything')->willReturn(true);
+
+        $this->isSatisfiedBy('anything')->shouldEqual(false);
+    }
+
+    public function it_will_fail_with_both_spec_failing(Specification $spec1, Specification $spec2): void
+    {
+        $spec1->isSatisfiedBy('anything')->willReturn(false);
+        $spec2->isSatisfiedBy('anything')->willReturn(false);
+
+        $this->isSatisfiedBy('anything')->shouldEqual(true);
+    }
+}

src/OrX.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Bakame\Specification;
 
 final class OrX implements Specification

src/Specification.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Bakame\Specification;
 
 interface Specification