Merge pull request #137 from patchlevel/clock-trait

add recorded clock trait

src/Aggregate/ClockRecordDate.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Aggregate;
+
+use DateTimeImmutable;
+use Patchlevel\EventSourcing\Clock;
+
+/**
+ * @psalm-require-extends AggregateChanged
+ */
+trait ClockRecordDate
+{
+    protected function createRecordDate(): DateTimeImmutable
+    {
+        return Clock::createDateTimeImmutable();
+    }
+}

tests/Unit/Aggregate/AggregateChangedWithClockTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Tests\Unit\Aggregate;
+
+use DateTimeImmutable;
+use Patchlevel\EventSourcing\Clock;
+use Patchlevel\EventSourcing\Tests\Unit\Fixture\ProfileId;
+use Patchlevel\EventSourcing\Tests\Unit\Fixture\ProfileVisitedWithClock;
+use PHPUnit\Framework\TestCase;
+
+class AggregateChangedWithClockTest extends TestCase
+{
+    public function testRecordedAt(): void
+    {
+        $date = new DateTimeImmutable();
+
+        Clock::freeze($date);
+
+        $profile1 = ProfileId::fromString('1');
+        $profile2 = ProfileId::fromString('2');
+
+        $event = ProfileVisitedWithClock::raise($profile1, $profile2);
+        $recordedEvent = $event->recordNow(1);
+
+        self::assertSame($date, $recordedEvent->recordedOn());
+    }
+}

tests/Unit/Fixture/ProfileVisitedWithClock.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Tests\Unit\Fixture;
+
+use Patchlevel\EventSourcing\Aggregate\AggregateChanged;
+use Patchlevel\EventSourcing\Aggregate\ClockRecordDate;
+
+/**
+ * @template-extends AggregateChanged<array{visitorId: string}>
+ */
+final class ProfileVisitedWithClock extends AggregateChanged
+{
+    use ClockRecordDate;
+
+    public static function raise(ProfileId $visitedId, ProfileId $visitorId): self
+    {
+        return new self(
+            $visitedId->toString(),
+            [
+                'visitorId' => $visitorId->toString(),
+            ]
+        );
+    }
+
+    public function visitedId(): ProfileId
+    {
+        return ProfileId::fromString($this->aggregateId);
+    }
+
+    public function visitorId(): ProfileId
+    {
+        return ProfileId::fromString($this->payload['visitorId']);
+    }
+}