[LOAN-3602] Added mutable now (#4)

* [LOAN-3602] Added mutable now. A mutable \DateTime will help with converting a codebase to using an immutable option in stages. * [LOAN-3602] Renamed constant Co-authored-by: Ben Challis <[email protected]> * [LOAN-3602] Added todo comments for 7.3 bump work Co-authored-by: Ben Challis <[email protected]> * Fix ups re: new CI pipeline checks
Lendable · Sep 12, 2019 · 72df79f · 72df79f
1 parent 9bc7d04
commit 72df79f
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 2 deletions.
diff --git a/lib/Clock.php b/lib/Clock.php
@@ -7,4 +7,6 @@
 interface Clock
 {
     public function now(): \DateTimeImmutable;
+
+    public function nowMutable(): \DateTime;
 }
diff --git a/lib/FixedClock.php b/lib/FixedClock.php
@@ -9,6 +9,8 @@
  */
 final class FixedClock implements Clock
 {
+    private const ISO8601_MICROSECONDS_FORMAT = 'Y-m-d\TH:i:s.uP';
+
     /**
      * @var \DateTimeImmutable
      */
@@ -23,4 +25,13 @@ public function now(): \DateTimeImmutable
     {
         return $this->now;
     }
+
+    public function nowMutable(): \DateTime
+    {
+        // @TODO Use \DateTime::createFromImmutable when PHP version is >=7.3
+        $instance = \DateTime::createFromFormat(self::ISO8601_MICROSECONDS_FORMAT, $this->now->format(self::ISO8601_MICROSECONDS_FORMAT));
+        \assert($instance instanceof \DateTime);
+
+        return $instance;
+    }
 }
diff --git a/lib/PersistedFixedClock.php b/lib/PersistedFixedClock.php
@@ -65,6 +65,11 @@ public function now(): \DateTimeImmutable
         return $this->delegate->now();
     }
 
+    public function nowMutable(): \DateTime
+    {
+        return $this->delegate->nowMutable();
+    }
+
     private function load(): void
     {
         $path = $this->getSerializationFilePath();

diff --git a/lib/SystemClock.php b/lib/SystemClock.php
@@ -11,6 +11,8 @@ final class SystemClock implements Clock
 {
     private const DEFAULT_TIMEZONE = 'UTC';
 
+    private const ISO8601_MICROSECONDS_FORMAT = 'Y-m-d\TH:i:s.uP';
+
     /**
      * @var \DateTimeZone
      */
@@ -25,4 +27,13 @@ public function now(): \DateTimeImmutable
     {
         return new \DateTimeImmutable('now', $this->timeZone);
     }
+
+    public function nowMutable(): \DateTime
+    {
+        // @TODO Use \DateTime::createFromImmutable when PHP version is >=7.3
+        $instance = \DateTime::createFromFormat(self::ISO8601_MICROSECONDS_FORMAT, $this->now()->format(self::ISO8601_MICROSECONDS_FORMAT));
+        \assert($instance instanceof \DateTime);
+
+        return $instance;
+    }
 }
diff --git a/tests/unit/FixedClockTest.php b/tests/unit/FixedClockTest.php
@@ -23,5 +23,9 @@ public function it_always_returns_the_given_time(): void
         $this->assertSame($timeString, $clock->now()->format($timeFormat));
         $this->assertSame($timeString, $clock->now()->format($timeFormat));
         $this->assertSame($timeString, $clock->now()->format($timeFormat));
+
+        $this->assertSame($timeString, $clock->nowMutable()->format($timeFormat));
+        $this->assertSame($timeString, $clock->nowMutable()->format($timeFormat));
+        $this->assertSame($timeString, $clock->nowMutable()->format($timeFormat));
     }
 }
diff --git a/tests/unit/SystemClockTest.php b/tests/unit/SystemClockTest.php
@@ -17,6 +17,12 @@ public function exampleTimeZoneNames(): iterable
         yield ['Europe/Paris'];
     }
 
+    public function nowMethodProvider(): iterable
+    {
+        yield ['now'];
+        yield ['nowMutable'];
+    }
+
     /**
      * @test
      * @dataProvider exampleTimeZoneNames
@@ -38,15 +44,36 @@ public function it_defaults_timezone_to_utc(): void
 
     /**
      * @test
+     * @dataProvider nowMethodProvider
      */
-    public function it_gives_the_current_system_time(): void
+    public function it_gives_the_current_system_time(string $nowMethod): void
     {
         $now = new \DateTimeImmutable('now', new \DateTimeZone('UTC'));
         $clock = new SystemClock(new \DateTimeZone('UTC'));
 
-        $difference = $clock->now()->getTimestamp() - $now->getTimestamp();
+        $difference = $clock->{$nowMethod}()->getTimestamp() - $now->getTimestamp();
 
         $this->assertGreaterThanOrEqual(0, $difference);
         $this->assertLessThanOrEqual(1, $difference);
     }
+
+    /**
+     * @test
+     */
+    public function now_returns_DateTimeImmutable(): void
+    {
+        $clock = new SystemClock(new \DateTimeZone('UTC'));
+
+        $this->assertInstanceOf(\DateTimeImmutable::class, $clock->now());
+    }
+
+    /**
+     * @test
+     */
+    public function nowMutable_returns_DateTime(): void
+    {
+        $clock = new SystemClock(new \DateTimeZone('UTC'));
+
+        $this->assertInstanceOf(\DateTime::class, $clock->nowMutable());
+    }
 }