Merge pull request #4 from patchlevel/add-command-bus-like-support

Add support for command bus like syntax, Drop PHP 8.1

Author: DanielBadura

.github/workflows/unit.yml

@@ -21,7 +21,6 @@ jobs:
                     - "lowest"
                     - "highest"
                 php-version:
-                    - "8.1"
                     - "8.2"
                     - "8.3"
                 operating-system:

README.md

@@ -121,6 +121,48 @@ final class ProfileTest extends AggregateRootTestCase
 }
 ```
 
+### Using Commandbus like syntax
+
+When using the command bus and the `#[Handle]` attributes in your aggregate you can also provide the command directly
+for the `when` method.
+
+```php
+final class ProfileTest extends AggregateRootTestCase
+{ 
+    // protected function aggregateClass(): string;
+    
+    public function testBehaviour(): void
+    {
+        $this
+            ->when(new CreateProfile(ProfileId::fromString('1'), Email::fromString('hq@patchlevel.de')))
+            ->then(new ProfileCreated(ProfileId::fromString('1'), Email::fromString('hq@patchlevel.de')));
+    }
+}
+```
+
+If more parameters than the command is needed, these can also be provided as additional parameters for `when`. In this
+example the we need a string which will be directly passed to the event.
+
+```php
+final class ProfileTest extends AggregateRootTestCase
+{ 
+    // protected function aggregateClass(): string;
+    
+    public function testBehaviour(): void
+    {
+        $this
+            ->given(
+                new ProfileCreated(
+                    ProfileId::fromString('1'),
+                    Email::fromString('hq@patchlevel.de'),
+                ),
+            )
+            ->when(new VisitProfile(ProfileId::fromString('2')), 'Extra Parameter / Dependency')
+            ->then(new ProfileVisited(ProfileId::fromString('2'), 'Extra Parameter / Dependency'));
+    }
+}
+```
+
 ## Testing Subscriber
 
 For testing a subscriber there is a utility class which you can use. Using `SubscriberUtilities` will provide you a

composer.json

@@ -21,8 +21,8 @@
     }
   ],
   "require": {
-    "php": "~8.1.0 || ~8.2.0 || ~8.3.0",
-    "patchlevel/event-sourcing": "^3.0.0",
+    "php": "~8.2.0 || ~8.3.0",
+    "patchlevel/event-sourcing": "^3.8.0",
     "phpunit/phpunit": "^10.1.0||^11.0.0"
   },
   "require-dev": {

composer.lock

@@ -6,18 +6,23 @@
 
 use Closure;
 use Patchlevel\EventSourcing\Aggregate\AggregateRoot;
+use Patchlevel\EventSourcing\CommandBus\HandlerFinder;
 use PHPUnit\Framework\Attributes\After;
 use PHPUnit\Framework\Attributes\Before;
 use PHPUnit\Framework\Constraint\Exception as ExceptionConstraint;
 use PHPUnit\Framework\Constraint\ExceptionMessageIsOrContains;
 use PHPUnit\Framework\TestCase;
+use ReflectionClass;
 use Throwable;
 
 abstract class AggregateRootTestCase extends TestCase
 {
     /** @var array<object> */
     private array $givenEvents = [];
-    private Closure|null $when = null;
+    private object|null $when = null;
+
+    /** @var array<mixed> */
+    private array $parameters = [];
 
     /** @var array<object> */
     private array $expectedEvents = [];
@@ -35,9 +40,11 @@ final public function given(object ...$events): self
         return $this;
     }
 
-    final public function when(Closure $callable): self
+    /** @param object|Closure $callable */
+    final public function when(object $callable, mixed ...$parameters): self
     {
         $this->when = $callable;
+        $this->parameters = $parameters;
 
         return $this;
     }
@@ -78,7 +85,29 @@ final public function assert(): self
         }
 
         try {
-            $return = ($this->when)($aggregate);
+            $callableOrCommand = $this->when;
+            $return = null;
+
+            if ($callableOrCommand instanceof Closure) {
+                $return = $callableOrCommand($aggregate);
+            } else {
+                foreach (HandlerFinder::findInClass($this->aggregateClass()) as $handler) {
+                    if (!$callableOrCommand instanceof $handler->commandClass) {
+                        continue;
+                    }
+
+                    $reflection = new ReflectionClass($this->aggregateClass());
+                    $reflectionMethod = $reflection->getMethod($handler->method);
+
+                    $return = $reflectionMethod->invokeArgs(
+                        $handler->static ? null : $aggregate,
+                        [
+                            $callableOrCommand,
+                            ...$this->parameters,
+                        ],
+                    );
+                }
+            }
 
             if ($aggregate !== null && $return instanceof AggregateRoot) {
                 throw new AggregateAlreadySet();
@@ -107,6 +136,7 @@ final public function reset(): void
     {
         $this->givenEvents = [];
         $this->when = null;
+        $this->parameters = [];
         $this->expectedEvents = [];
         $this->expectedException = null;
         $this->expectedExceptionMessage = null;

src/Test/AggregateRootTestCase.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\PhpUnit\Tests\Unit\Fixture;
+
+final readonly class CreateProfile
+{
+    public function __construct(
+        public ProfileId $id,
+        public Email $email,
+    ) {
+    }
+}

tests/Unit/Fixture/CreateProfile.php

@@ -7,6 +7,7 @@
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
+use Patchlevel\EventSourcing\Attribute\Handle;
 use Patchlevel\EventSourcing\Attribute\Id;
 
 #[Aggregate('profile')]
@@ -27,17 +28,19 @@ public function email(): Email
         return $this->email;
     }
 
-    public static function createProfile(ProfileId $id, Email $email): self
+    #[Handle]
+    public static function createProfile(CreateProfile $createProfile): self
     {
         $self = new self();
-        $self->recordThat(new ProfileCreated($id, $email));
+        $self->recordThat(new ProfileCreated($createProfile->id, $createProfile->email));
 
         return $self;
     }
 
-    public function visitProfile(ProfileId $profileId): void
+    #[Handle]
+    public function visitProfile(VisitProfile $visitProfile, string|null $token = null): void
     {
-        $this->recordThat(new ProfileVisited($profileId));
+        $this->recordThat(new ProfileVisited($visitProfile->id, $token));
     }
 
     public function throwException(): void

tests/Unit/Fixture/Profile.php

@@ -14,6 +14,7 @@ final class ProfileVisited implements Stringable
     public function __construct(
         #[IdNormalizer]
         public ProfileId $visitorId,
+        public string|null $token = null,
     ) {
     }
 

tests/Unit/Fixture/ProfileVisited.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\PhpUnit\Tests\Unit\Fixture;
+
+final readonly class VisitProfile
+{
+    public function __construct(
+        public ProfileId $id,
+    ) {
+    }
+}