Merge pull request #143 from ergebnis/feature/freeze

Enhancement: Allow creation of FrozenClock by freezing SystemClock

CHANGELOG.md

@@ -6,7 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## Unreleased
 
-For a full diff see [`2.0.1...master`][2.0.1...master].
+For a full diff see [`2.1.0...master`][2.1.0...master].
+
+## [`2.1.0`][2.1.0]
+
+For a full diff see [`2.0.1...2.1.0`][2.0.1...2.1.0].
+
+### Added
+
+* Added possibility to create a `FrozenClock` by freezing a `SystemClock` ([#143]), by [@localheinz]
 
 ## [`2.0.1`][2.0.1]
 
@@ -72,18 +80,21 @@ For a full diff see [`36912f6...1.0.0`][36912f6...1.0.0].
 [1.0.0]: https://github.com/ergebnis/clock/releases/tag/1.0.0
 [2.0.0]: https://github.com/ergebnis/clock/releases/tag/2.0.0
 [2.0.1]: https://github.com/ergebnis/clock/releases/tag/2.0.1
+[2.1.0]: https://github.com/ergebnis/clock/releases/tag/2.1.0
 
 [36912f6...1.0.0]: https://github.com/ergebnis/clock/compare/36912f6...1.0.0
 [1.0.0...2.0.0]: https://github.com/ergebnis/clock/compare/1.0.0...2.0.0
 [2.0.0...2.0.1]: https://github.com/ergebnis/clock/compare/2.0.0...2.0.1
-[2.0.1...master]: https://github.com/ergebnis/clock/compare/2.0.1...master
+[2.0.1...2.1.0]: https://github.com/ergebnis/clock/compare/2.0.1...2.1.0
+[2.1.0...master]: https://github.com/ergebnis/clock/compare/2.1.0...master
 
 [#1]: https://github.com/ergebnis/clock/pull/1
 [#2]: https://github.com/ergebnis/clock/pull/2
 [#41]: https://github.com/ergebnis/clock/pull/41
 [#52]: https://github.com/ergebnis/clock/pull/52
 [#53]: https://github.com/ergebnis/clock/pull/53
 [#57]: https://github.com/ergebnis/clock/pull/57
+[#143]: https://github.com/ergebnis/clock/pull/143
 
 [@ergebnis]: https://github.com/ergebnis
 [@localheinz]: https://github.com/localheinz

README.md

@@ -57,6 +57,26 @@ sleep(5);
 $stillNow = $clock->now();
 ```
 
+Alternatively, create a new frozen clock by freezing a system clock:
+
+```php
+<?php
+
+use Ergebnis\Clock;
+
+$timeZone = new \DateTimeZone('Europe/Berlin');
+
+$clock = new Clock\SystemClock($timeZone);
+
+$frozenClock = $clock->freeze();
+
+$now = $clock->now();
+
+sleep(5);
+
+$stillNow = $clock->now();
+```
+
 ## Changelog
 
 Please have a look at [`CHANGELOG.md`](CHANGELOG.md).

psalm-baseline.xml

@@ -1,2 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="3.10.1@eeed5ecccc10131397f0eb7ee6da810c0be3a7fc"/>
+<files psalm-version="3.11.2@d470903722cfcbc1cd04744c5491d3e6d13ec3d9">
+  <file src="test/Unit/SystemClockTest.php">
+    <RedundantCondition occurrences="1">
+      <code>assertInstanceOf</code>
+    </RedundantCondition>
+  </file>
+</files>

src/SystemClock.php

@@ -29,4 +29,9 @@ public function now(): \DateTimeImmutable
             $this->timezone
         );
     }
+
+    public function freeze(): FrozenClock
+    {
+        return new FrozenClock($this->now());
+    }
 }

test/Unit/SystemClockTest.php

@@ -14,6 +14,7 @@
 namespace Ergebnis\Clock\Test\Unit;
 
 use Ergebnis\Clock\Clock;
+use Ergebnis\Clock\FrozenClock;
 use Ergebnis\Clock\SystemClock;
 use Ergebnis\Test\Util\Helper;
 use PHPUnit\Framework;
@@ -22,6 +23,8 @@
  * @internal
  *
  * @covers \Ergebnis\Clock\SystemClock
+ *
+ * @uses \Ergebnis\Clock\FrozenClock
  */
 final class SystemClockTest extends Framework\TestCase
 {
@@ -53,4 +56,32 @@ public function testNowReturnsCurrentDateTime(): void
         self::assertGreaterThanOrEqual($before, $now);
         self::assertLessThanOrEqual($after, $now);
     }
+
+    public function testFreezeReturnsFrozenClock(): void
+    {
+        $timeZone = new \DateTimeZone('Europe/Berlin');
+
+        $clock = new SystemClock($timeZone);
+
+        $before = new \DateTimeImmutable(
+            'now',
+            $timeZone
+        );
+
+        $frozenClock = $clock->freeze();
+
+        $after = new \DateTimeImmutable(
+            'now',
+            $timeZone
+        );
+
+        self::assertInstanceOf(FrozenClock::class, $frozenClock);
+
+        $now = $frozenClock->now();
+
+        self::assertGreaterThanOrEqual($before, $now);
+        self::assertLessThanOrEqual($after, $now);
+
+        self::assertSame($now, $frozenClock->now());
+    }
 }