FEATURE: Major rework (2.0)

composer.json

@@ -28,7 +28,7 @@
     "roave/security-advisories": "dev-latest",
     "phpstan/phpstan": "^1.10",
     "squizlabs/php_codesniffer": "^4.0.x-dev",
-    "phpunit/phpunit": "^10.1"
+    "phpunit/phpunit": "^10.2"
   },
   "autoload": {
     "psr-4": {
@@ -44,11 +44,13 @@
     "test-phpstan": "phpstan",
     "test-cs": "phpcs --colors --standard=PSR12 --exclude=Generic.Files.LineLength src",
     "test-cs:fix": "phpcbf --colors --standard=PSR12 --exclude=Generic.Files.LineLength src",
-    "test-unit": "phpunit tests",
+    "test-unit": "phpunit tests/Unit",
+    "test-integration": "phpunit tests/Integration",
     "test": [
       "@test-phpstan",
       "@test-cs",
-      "@test-unit"
+      "@test-unit",
+      "@test-integration"
     ]
   }
 }

phpunit.xml

@@ -11,7 +11,7 @@
          failOnWarning="true">
     <testsuites>
         <testsuite name="default">
-            <directory>tests/unit</directory>
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
 

src/EventStore.php

@@ -5,8 +5,8 @@
 namespace Wwwision\DCBEventStore;
 
 use Wwwision\DCBEventStore\Exception\ConditionalAppendFailed;
-use Wwwision\DCBEventStore\Model\EventId;
 use Wwwision\DCBEventStore\Model\Events;
+use Wwwision\DCBEventStore\Model\ExpectedLastEventId;
 use Wwwision\DCBEventStore\Model\StreamQuery;
 
 /**
@@ -20,18 +20,28 @@ interface EventStore
     public function setup(): void;
 
     /**
-     * Returns an event stream matching the specified {@see StreamQuery}
+     * Returns an event stream that contains all events in the order they occurred
+     */
+    public function streamAll(): EventStream;
+
+    /**
+     * Returns an event stream that contains events matching the specified {@see StreamQuery} in the order they occurred
      */
     public function stream(StreamQuery $query): EventStream;
 
     /**
-     * Commits the specified $events by checking if the specified $query and $lastEventId match
+     * Commits the specified $events without checking any constraints
+     */
+    public function append(Events $events): void;
+
+    /**
+     * Commits the specified $events by checking if the specified $query and $expectedLastEventId match
      *
      * *NOTE:* If the $lastEventId is specified, the last event matching the given $query has to match.
-     * If $lastEventId is NULL, _no_ event must match the specified $query
+     * If {@see $expectedLastEventId->isNone()}, _no_ event must match the specified $query
      *
-     * @param ?EventId $lastEventId If specified, the last event matching the given $query has to match. If NULL, _no_ event must match the specified $query
-     * @throws ConditionalAppendFailed If specified $query and $lastEventId don't match
+     * @param ExpectedLastEventId $expectedLastEventId If not NONE, the last event matching the given $query has to match. Otherwise, _no_ event must match the specified $query
+     * @throws ConditionalAppendFailed If specified $query and $expectedLastEventId don't match
      */
-    public function append(Events $events, StreamQuery $query, ?EventId $lastEventId): void;
+    public function conditionalAppend(Events $events, StreamQuery $query, ExpectedLastEventId $expectedLastEventId): void;
 }

src/Exception/ConditionalAppendFailed.php

@@ -7,9 +7,10 @@
 use RuntimeException;
 use Wwwision\DCBEventStore\EventStore;
 use Wwwision\DCBEventStore\Model\EventId;
+use Wwwision\DCBEventStore\Model\ExpectedLastEventId;
 
 /**
- * An exception that is thrown when a {@see EventStore::append()} call has failed
+ * An exception that is thrown when a {@see EventStore::conditionalAppend()} call has failed
  */
 final class ConditionalAppendFailed extends RuntimeException
 {
@@ -27,8 +28,8 @@ public static function becauseNoEventWhereExpected(): self
         return new self('The event store contained events matching the specified query but none were expected');
     }
 
-    public static function becauseEventIdsDontMatch(EventId $expectedId, EventId $actualId): self
+    public static function becauseEventIdsDontMatch(ExpectedLastEventId $expectedId, EventId $actualId): self
     {
-        return new self("Expected event id \"$expectedId->value\" does not match the actual id of \"$actualId->value\"");
+        return new self("Expected event id \"$expectedId\" does not match the actual id of \"$actualId->value\"");
     }
 }

src/Helper/InMemoryEventStore.php

@@ -5,10 +5,11 @@
 namespace Wwwision\DCBEventStore\Helper;
 
 use Wwwision\DCBEventStore\EventStore;
+use Wwwision\DCBEventStore\EventStream;
 use Wwwision\DCBEventStore\Exception\ConditionalAppendFailed;
 use Wwwision\DCBEventStore\Model\EventEnvelope;
-use Wwwision\DCBEventStore\Model\EventId;
 use Wwwision\DCBEventStore\Model\Events;
+use Wwwision\DCBEventStore\Model\ExpectedLastEventId;
 use Wwwision\DCBEventStore\Model\SequenceNumber;
 use Wwwision\DCBEventStore\Model\StreamQuery;
 
@@ -17,6 +18,8 @@
 /**
  * An in-memory implementation of the {@see EventStore} interface that mostly serves testing or debugging purposes
  *
+ * NOTE: This implementation is not transaction-safe (and obviously not thread-safe), it should never be used in productive code!
+ *
  * Usage:
  * $eventStore = InMemoryEventStore::create();
  * $eventStore->append($events);
@@ -44,26 +47,33 @@ public function setup(): void
         // In-memory event store does not need any setup
     }
 
+    public function streamAll(): EventStream
+    {
+        return InMemoryEventStream::create(...$this->eventEnvelopes);
+    }
+
     public function stream(StreamQuery $query): InMemoryEventStream
     {
-        if ($query->matchesNone()) {
-            return InMemoryEventStream::empty();
-        }
         return InMemoryEventStream::create(...array_filter($this->eventEnvelopes, static fn (EventEnvelope $eventEnvelope) => $query->matches($eventEnvelope->event)));
     }
 
-    public function append(Events $events, StreamQuery $query, ?EventId $lastEventId): void
+    public function conditionalAppend(Events $events, StreamQuery $query, ExpectedLastEventId $expectedLastEventId): void
     {
         $lastEvent = $this->stream($query)->last();
         if ($lastEvent === null) {
-            if ($lastEventId !== null) {
+            if (!$expectedLastEventId->isNone()) {
                 throw ConditionalAppendFailed::becauseNoEventMatchedTheQuery();
             }
-        } elseif ($lastEventId === null) {
+        } elseif ($expectedLastEventId->isNone()) {
             throw ConditionalAppendFailed::becauseNoEventWhereExpected();
-        } elseif (!$lastEvent->event->id->equals($lastEventId)) {
-            throw ConditionalAppendFailed::becauseEventIdsDontMatch($lastEventId, $lastEvent->event->id);
+        } elseif (!$expectedLastEventId->matches($lastEvent->event->id)) {
+            throw ConditionalAppendFailed::becauseEventIdsDontMatch($expectedLastEventId, $lastEvent->event->id);
         }
+        $this->append($events);
+    }
+
+    public function append(Events $events): void
+    {
         $sequenceNumber = SequenceNumber::fromInteger(count($this->eventEnvelopes));
         foreach ($events as $event) {
             $sequenceNumber = $sequenceNumber->next();

src/Model/DomainEvents.php

@@ -30,6 +30,11 @@ public static function none(): self
         return new self();
     }
 
+    public static function single(DomainEvent $domainEvent): self
+    {
+        return new self($domainEvent);
+    }
+
     /**
      * @param DomainEvent[] $domainEvents
      */