refactor: improve clock testing

Author: innocenzi

packages/clock/src/MockClock.php

@@ -9,19 +9,14 @@
 use Tempest\DateTime\DateTime;
 use Tempest\DateTime\DateTimeInterface;
 use Tempest\DateTime\Duration;
-use Tempest\DateTime\Timestamp;
 
 final class MockClock implements Clock
 {
     private DateTimeInterface $now;
 
     public function __construct(DateTimeImmutable|DateTimeInterface|string $now = 'now')
     {
-        if ($now instanceof DateTimeImmutable) {
-            $this->now = DateTime::fromTimestamp($now->getTimestamp());
-        } else {
-            $this->now = DateTime::parse($now);
-        }
+        $this->setNow($now);
     }
 
     public function toPsrClock(): ClockInterface
@@ -34,13 +29,12 @@ public function now(): DateTimeInterface
         return $this->now;
     }
 
-    public function setNow(DateTimeInterface|string $now): void
+    /**
+     * Globally sets the current time to the specified value.
+     */
+    public function setNow(DateTimeImmutable|DateTimeInterface|string $now): void
     {
-        if ($now instanceof DateTimeInterface) {
-            $this->now = $now;
-        } else {
-            $this->now = DateTime::parse($now);
-        }
+        $this->now = DateTime::parse($now);
     }
 
     public function timestamp(): int
@@ -56,31 +50,35 @@ public function timestampMs(): int
     public function sleep(int|Duration $milliseconds): void
     {
         if ($milliseconds instanceof Duration) {
-            $this->addInterval($milliseconds);
+            $this->plus($milliseconds);
             return;
         }
 
         $this->now = $this->now->plusMilliseconds($milliseconds);
     }
 
-    public function addInterval(Duration $duration): void
+    /**
+     * Adds the given duration. Providing an integer value adds the corresponding seconds to the current time.
+     */
+    public function plus(int|Duration $duration): void
     {
-        $this->now = $this->now->plus($duration);
-    }
+        if (is_int($duration)) {
+            $duration = Duration::seconds($duration);
+        }
 
-    public function subInternal(Duration $duration): void
-    {
-        $this->now = $this->now->minus($duration);
+        $this->now = $this->now->plus($duration);
     }
 
-    public function changeTime(int $seconds): void
+    /**
+     * Removes the given duration. Providing an integer value removes the corresponding seconds to the current time.
+     */
+    public function minus(int|Duration $duration): void
     {
-        if ($seconds < 0) {
-            $seconds = abs($seconds);
-            $this->now = $this->now->minusSeconds($seconds);
-        } else {
-            $this->now = $this->now->plusSeconds($seconds);
+        if (is_int($duration)) {
+            $duration = Duration::seconds($duration);
         }
+
+        $this->now = $this->now->minus($duration);
     }
 
     public function dd(): void

packages/clock/tests/MockClockTest.php

@@ -62,12 +62,12 @@ public function test_mock_clock_can_change_time(): void
         $addedTime = DateTime::parse('2024-09-11 13:54:25');
         $clock = new MockClock($dateTime);
 
-        $clock->changeTime(-2);
+        $clock->minus(2);
 
         $this->assertEquals($subtractedTime, $clock->now());
         $this->assertEquals($subtractedTime->getTimestamp()->getSeconds(), $clock->timestamp());
 
-        $clock->changeTime(4);
+        $clock->plus(4);
 
         $this->assertEquals($addedTime, $clock->now());
         $this->assertEquals($addedTime->getTimestamp()->getSeconds(), $clock->timestamp());

src/Tempest/Framework/Testing/IntegrationTest.php

@@ -89,7 +89,7 @@ protected function migrate(string|object ...$migrationClasses): void
         }
     }
 
-    protected function clock(DateTimeInterface|string $now): MockClock
+    protected function clock(DateTimeInterface|string $now = 'now'): MockClock
     {
         $clock = new MockClock($now);
 

tests/Integration/Cache/CacheTest.php

@@ -30,7 +30,7 @@ public function test_put(): void
         $this->assertTrue($item->isHit());
         $this->assertSame('a', $item->get());
 
-        $clock->addInterval($interval);
+        $clock->plus($interval);
 
         $item = $pool->getItem('a');
         $this->assertFalse($item->isHit());
@@ -53,7 +53,7 @@ public function test_get(): void
         $this->assertSame('a', $cache->get('a'));
         $this->assertSame('b', $cache->get('b'));
 
-        $clock->addInterval($interval);
+        $clock->plus($interval);
 
         $this->assertSame(null, $cache->get('a'));
         $this->assertSame('b', $cache->get('b'));
@@ -76,7 +76,7 @@ public function test_resolve(): void
         $b = $cache->resolve('b', fn () => 'b');
         $this->assertSame('b', $b);
 
-        $clock->addInterval($interval);
+        $clock->plus($interval);
 
         $this->assertSame(null, $cache->get('a'));
         $this->assertSame('b', $cache->get('b'));

tests/Integration/Http/CleanupSessionsCommandTest.php

@@ -32,11 +32,11 @@ public function test_destroy_sessions(): void
 
         $sessionManager->set(new SessionId('session_a'), 'test', 'value');
 
-        $clock->changeTime(9);
+        $clock->plus(9);
 
         $sessionManager->set(new SessionId('session_b'), 'test', 'value');
 
-        $clock->changeTime(2);
+        $clock->plus(2);
 
         $this->console
             ->call('session:clean')

tests/Integration/Http/FileSessionTest.php

@@ -112,7 +112,7 @@ public function test_is_valid(): void
 
         $this->assertTrue($session->isValid());
 
-        $clock->changeTime(seconds: 1);
+        $clock->plus(1);
 
         $this->assertFalse($session->isValid());
     }