Add support for MongoDB-based UTCDateTime clock

Author: dbellettini

src/Clock/AbstractClock.php

@@ -13,6 +13,11 @@ public function asUTC(): UTCClock
         return new PsrUTCClock($this);
     }
 
+    public function asMongoUTC(): MongoUTCClock
+    {
+        return new PsrMongoUTCClock($this);
+    }
+
     public function asMicrotime(): MicrotimeClock
     {
         return new PsrMicrotimeClock($this);

src/Clock/MongoUTCClock.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Recruiter\Clock;
+
+use MongoDB\BSON\UTCDateTime;
+
+interface MongoUTCClock
+{
+    public function now(): UTCDateTime;
+}

src/Clock/PsrMongoUTCClock.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Recruiter\Clock;
+
+use MongoDB\BSON\UTCDateTime;
+use Psr\Clock\ClockInterface;
+
+final readonly class PsrMongoUTCClock implements MongoUTCClock
+{
+    public function __construct(private ClockInterface $wrapped)
+    {
+    }
+
+    public function now(): UTCDateTime
+    {
+        return new UTCDateTime($this->wrapped->now());
+    }
+}

tests/Clock/ManualClockTest.php

@@ -4,6 +4,7 @@
 
 namespace Recruiter\Clock;
 
+use MongoDB\BSON\UTCDateTime as MongoUTCDateTime;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\UsesClass;
 use Recruiter\DateTime\UTCDateTime;
@@ -144,6 +145,18 @@ public function testConversionToUTC(): void
         );
     }
 
+    public function testConversionToMongoUTC(): void
+    {
+        $fixedTime = new \DateTimeImmutable('2023-10-01 12:00:00', new \DateTimeZone('Europe/Berlin'));
+        $clock = new ManualClock($fixedTime)->asMongoUTC();
+
+        $this->assertEquals(
+            new MongoUTCDateTime(1_696_154_400_000),
+            $clock->now(),
+            'Clock should convert fixed time to MongoDB UTCDateTime correctly',
+        );
+    }
+
     public function testStopWatch(): void
     {
         $clock = new ManualClock(new \DateTimeImmutable('2023-10-01 12:00:00'));

tests/Clock/PsrMongoUTCClockTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Clock;
+
+use MongoDB\BSON\UTCDateTime;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
+use PHPUnit\Framework\MockObject\Exception;
+use PHPUnit\Framework\TestCase;
+use Psr\Clock\ClockInterface;
+use Recruiter\Clock\PsrMongoUTCClock;
+
+#[CoversClass(PsrMongoUTCClock::class)]
+#[UsesClass(UTCDateTime::class)]
+class PsrMongoUTCClockTest extends TestCase
+{
+    /**
+     * @throws Exception
+     */
+    public function testItCanWrapExistingPSRClock(): void
+    {
+        $original = $this->createMock(ClockInterface::class);
+        $clock = new PsrMongoUTCClock($original);
+
+        $original->expects($this->once())
+                 ->method('now')
+                 ->willReturn(new \DateTimeImmutable('1989-11-09T18:57:00 Europe/Berlin'))
+        ;
+
+        $this->assertEquals(
+            new UTCDateTime(626_637_420_000),
+            $clock->now(),
+        );
+    }
+}