remove old clock and replace it with a service, also add decorator

src/Clock/Clock.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Clock;
+
+use DateTimeImmutable;
+
+interface Clock
+{
+    public function createDateTimeImmutable(): DateTimeImmutable;
+}

src/Clock/FreezeClock.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Clock;
+
+use DateTimeImmutable;
+
+use function sprintf;
+
+final class FreezeClock implements Clock
+{
+    public function __construct(private DateTimeImmutable $frozenDateTime)
+    {
+    }
+
+    public function freeze(DateTimeImmutable $frozenDateTime): void
+    {
+        $this->frozenDateTime = $frozenDateTime;
+    }
+
+    /**
+     * @param positive-int $seconds
+     */
+    public function sleep(int $seconds): void
+    {
+        $this->frozenDateTime = $this->frozenDateTime->modify(sprintf('+%s seconds', $seconds));
+    }
+
+    public function createDateTimeImmutable(): DateTimeImmutable
+    {
+        return $this->frozenDateTime;
+    }
+}

src/Clock/SystemClock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Clock;
+
+use DateTimeImmutable;
+
+final class SystemClock implements Clock
+{
+    public function createDateTimeImmutable(): DateTimeImmutable
+    {
+        return new DateTimeImmutable();
+    }
+}

src/EventBus/Decorator/RecordedOnDecorator.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\EventBus\Decorator;
+
+use Patchlevel\EventSourcing\Clock\Clock;
+use Patchlevel\EventSourcing\EventBus\Message;
+
+final class RecordedOnDecorator implements MessageDecorator
+{
+    public function __construct(private readonly Clock $clock)
+    {
+    }
+
+    public function __invoke(Message $message): Message
+    {
+        return $message->withRecordedOn($this->clock->createDateTimeImmutable());
+    }
+}

src/Repository/DefaultRepository.php

@@ -4,8 +4,8 @@
 
 namespace Patchlevel\EventSourcing\Repository;
 
+use DateTimeImmutable;
 use Patchlevel\EventSourcing\Aggregate\AggregateRoot;
-use Patchlevel\EventSourcing\Clock;
 use Patchlevel\EventSourcing\EventBus\Decorator\MessageDecorator;
 use Patchlevel\EventSourcing\EventBus\EventBus;
 use Patchlevel\EventSourcing\EventBus\Message;
@@ -129,7 +129,7 @@ static function (object $event) use ($aggregate, &$playhead, $messageDecorator)
                     ->withAggregateClass($aggregate::class)
                     ->withAggregateId($aggregate->aggregateRootId())
                     ->withPlayhead(++$playhead)
-                    ->withRecordedOn(Clock::createDateTimeImmutable());
+                    ->withRecordedOn(new DateTimeImmutable());
 
                 if ($messageDecorator) {
                     $message = $messageDecorator($message);

tests/Unit/Clock/FreezeClockTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Tests\Unit\Clock;
+
+use DateTimeImmutable;
+use Patchlevel\EventSourcing\Clock\FreezeClock;
+use PHPUnit\Framework\TestCase;
+
+/** @covers \Patchlevel\EventSourcing\Clock\FreezeClock */
+class FreezeClockTest extends TestCase
+{
+    public function testCreateDateTimeImmutableWithFrozenClock(): void
+    {
+        $current = new DateTimeImmutable();
+        $clock = new FreezeClock($current);
+
+        $new = $clock->createDateTimeImmutable();
+
+        self::assertSame($current, $new);
+    }
+
+    public function testSleep(): void
+    {
+        $date1 = new DateTimeImmutable();
+        $clock = new FreezeClock($date1);
+        $clock->sleep(1);
+        $date2 = $clock->createDateTimeImmutable();
+
+        $diff = $date1->diff($date2);
+
+        self::assertSame(1, $diff->s);
+    }
+
+    public function testReFreeze(): void
+    {
+        $date1 = new DateTimeImmutable();
+        $clock = new FreezeClock($date1);
+        $new1 = $clock->createDateTimeImmutable();
+
+        $date2 = new DateTimeImmutable();
+        $clock->freeze($date2);
+        $new2 = $clock->createDateTimeImmutable();
+
+        self::assertSame($date1, $new1);
+        self::assertSame($date2, $new2);
+        self::assertNotSame($new1, $new2);
+    }
+}

tests/Unit/Clock/SystemClockTest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Tests\Unit\Clock;
+
+use DateTimeImmutable;
+use Patchlevel\EventSourcing\Clock\SystemClock;
+use PHPUnit\Framework\TestCase;
+
+/** @covers \Patchlevel\EventSourcing\Clock\SystemClock */
+class SystemClockTest extends TestCase
+{
+    public function testCreateDateTimeImmutable(): void
+    {
+        $before = new DateTimeImmutable();
+        $date = (new SystemClock())->createDateTimeImmutable();
+        $after = new DateTimeImmutable();
+
+        self::assertGreaterThanOrEqual($before, $date);
+        self::assertLessThanOrEqual($after, $date);
+    }
+}

tests/Unit/EventBus/MessageTest.php

@@ -5,7 +5,6 @@
 namespace Patchlevel\EventSourcing\Tests\Unit\EventBus;
 
 use DateTimeImmutable;
-use Patchlevel\EventSourcing\Clock;
 use Patchlevel\EventSourcing\EventBus\HeaderNotFound;
 use Patchlevel\EventSourcing\EventBus\Message;
 use Patchlevel\EventSourcing\Tests\Unit\Fixture\Email;
@@ -17,17 +16,8 @@
 /** @covers \Patchlevel\EventSourcing\EventBus\Message */
 class MessageTest extends TestCase
 {
-    public function tearDown(): void
-    {
-        Clock::reset();
-    }
-
     public function testEmptyMessage(): void
     {
-        $recordedAt = new DateTimeImmutable('2020-05-06 13:34:24');
-
-        Clock::freeze($recordedAt);
-
         $id = ProfileId::fromString('1');
         $email = Email::fromString('hallo@patchlevel.de');
 
@@ -47,8 +37,6 @@ public function testCreateMessageWithHeader(): void
     {
         $recordedAt = new DateTimeImmutable('2020-05-06 13:34:24');
 
-        Clock::freeze($recordedAt);
-
         $id = ProfileId::fromString('1');
         $email = Email::fromString('hallo@patchlevel.de');
 
@@ -74,8 +62,6 @@ public function testChangeHeader(): void
     {
         $recordedAt = new DateTimeImmutable('2020-05-06 13:34:24');
 
-        Clock::freeze($recordedAt);
-
         $id = ProfileId::fromString('1');
         $email = Email::fromString('hallo@patchlevel.de');
 
@@ -120,8 +106,6 @@ public function testCustomHeaders(): void
     {
         $recordedAt = new DateTimeImmutable('2020-05-06 13:34:24');
 
-        Clock::freeze($recordedAt);
-
         $id = ProfileId::fromString('1');
         $email = Email::fromString('hallo@patchlevel.de');