Merge pull request #9 from Innmind/force-at-format

Force the use of a format to parse a string
Innmind · Nov 24, 2024 · 828bb7c · 828bb7c
2 parents 4b49716 + 48a08ae
commit 828bb7c
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 52 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -39,6 +39,7 @@
 - `Innmind\TimeContinuum\PointInTime::timezone()` has been renamed `Innmind\TimeContinuum\PointInTime::offset()`
 - `Innmind\TimeContinuum\PointInTime\Day::toInt()` has been renamed `Innmind\TimeContinuum\PointInTime\Day::ofMonth()`
 - `Innmind\TimeContinuum\ElapsedPeriod::of()` is now an `internal` method
+- `Innmind\TimeContinuum\Clock::at()` now requires a `Format`
 
 ### Removed
 

diff --git a/README.md b/README.md
@@ -20,14 +20,18 @@ composer install innmind/time-continuum
 use Innmind\TimeContinuum\{
     Clock,
     PointInTime,
+    Format,
 };
 use Innmind\Immutable\Maybe;
 
 $clock = Clock::live();
 $now = $clock->now(); // return an instance of PointInTime
 echo $now->toString(); // 2016-10-11T12:17:30+02:00
 
-$epoch = $clock->at('1970-01-01T00:00:00.000000Z'); // Maybe<PointInTime>
+$epoch = $clock->at(
+    '1970-01-01T00:00:00.000000+00:00',
+    Format::iso8601(),
+); // Maybe<PointInTime>
 ```
 
 Here we reference 2 points in time, the first is the exact moment we call `now` down to the millisecond and the second one is the epoch time (you can verify it via `$epoch->milliseconds()` that returns `0`).

diff --git a/proofs/clock.php b/proofs/clock.php
@@ -98,7 +98,6 @@ static function($assert, $point) {
         given(
             Set\Unicode::strings(),
             Set\Elements::of(
-                null,
                 Format::cookie(),
                 Format::iso8601(),
                 Format::rfc1036(),

diff --git a/src/Clock.php b/src/Clock.php
@@ -53,7 +53,7 @@ public function switch(callable $changeTimezone): self
      *
      * @return Maybe<PointInTime>
      */
-    public function at(string $date, Format $format = null): Maybe
+    public function at(string $date, Format $format): Maybe
     {
         /**
          * @psalm-suppress ImpureVariable

diff --git a/src/Clock/Frozen.php b/src/Clock/Frozen.php
@@ -48,7 +48,7 @@ public function now(): PointInTime
      *
      * @return Maybe<PointInTime>
      */
-    public function at(string $date, Format $format = null): Maybe
+    public function at(string $date, Format $format): Maybe
     {
         /**
          * @psalm-suppress ImpureVariable

diff --git a/src/Clock/Live.php b/src/Clock/Live.php
@@ -57,36 +57,24 @@ public function now(): PointInTime
      *
      * @return Maybe<PointInTime>
      */
-    public function at(string $date, Format $format = null): Maybe
+    public function at(string $date, Format $format): Maybe
     {
-        if ($format instanceof Format) {
-            try {
-                /** @psalm-suppress ImpureMethodCall */
-                $datetime = \DateTimeImmutable::createFromFormat($format->toString(), $date);
-            } catch (\Throwable) {
-                /** @var Maybe<PointInTime> */
-                return Maybe::nothing();
-            }
-
-            if ($datetime === false) {
-                /** @var Maybe<PointInTime> */
-                return Maybe::nothing();
-            }
+        try {
+            /** @psalm-suppress ImpureMethodCall */
+            $datetime = \DateTimeImmutable::createFromFormat($format->toString(), $date);
+        } catch (\Throwable) {
+            /** @var Maybe<PointInTime> */
+            return Maybe::nothing();
+        }
 
-            if ($datetime->format($format->toString()) !== $date) {
-                /** @var Maybe<PointInTime> */
-                return Maybe::nothing();
-            }
+        if ($datetime === false) {
+            /** @var Maybe<PointInTime> */
+            return Maybe::nothing();
+        }
 
-            $date = $datetime->format(\DateTime::ATOM);
-        } else {
-            try {
-                /** @psalm-suppress ImpureMethodCall */
-                $datetime = new \DateTimeImmutable($date);
-            } catch (\Throwable) {
-                /** @var Maybe<PointInTime> */
-                return Maybe::nothing();
-            }
+        if ($datetime->format($format->toString()) !== $date) {
+            /** @var Maybe<PointInTime> */
+            return Maybe::nothing();
         }
 
         /**

diff --git a/src/Clock/Logger.php b/src/Clock/Logger.php
@@ -55,7 +55,7 @@ public function now(): PointInTime
      *
      * @return Maybe<PointInTime>
      */
-    public function at(string $date, Format $format = null): Maybe
+    public function at(string $date, Format $format): Maybe
     {
         /**
          * @psalm-suppress ImpureVariable
@@ -67,22 +67,10 @@ public function at(string $date, Format $format = null): Maybe
             ->map(fn($point) => $this->log($point, $date, $format));
     }
 
-    /**
-     * @psalm-pure
-     */
-    private function format(?Format $format): string
-    {
-        if (\is_null($format)) {
-            return 'unknown';
-        }
-
-        return $format->toString();
-    }
-
     private function log(
         PointInTime $point,
         string $date,
-        ?Format $format,
+        Format $format,
     ): PointInTime {
         /**
          * @psalm-suppress ImpureVariable
@@ -91,7 +79,7 @@ private function log(
          */
         $this->logger->debug('Asked time {date} ({format}) resolved to {point}', [
             'date' => $date,
-            'format' => $this->format($format),
+            'format' => $format->toString(),
             'point' => $point->format(Format::iso8601()),
         ]);
 

diff --git a/tests/Clock/FrozenTest.php b/tests/Clock/FrozenTest.php
@@ -37,7 +37,7 @@ public function testAtReturnWithTheSameTimezoneAsNow()
             ->then(function($now, $at) {
                 $clock = Clock::frozen($now);
 
-                $point = $clock->at($at->format(Format::iso8601()))->match(
+                $point = $clock->at($at->format(Format::iso8601()), Format::iso8601())->match(
                     static fn($point) => $point,
                     static fn() => null,
                 );

diff --git a/tests/Clock/LiveTest.php b/tests/Clock/LiveTest.php
@@ -37,7 +37,7 @@ public function testAt()
     {
         $this->assertInstanceOf(
             PointInTime::class,
-            $point = Clock::live()->at('2016-10-08T16:08:30+02:00')->match(
+            $point = Clock::live()->at('2016-10-08T16:08:30+02:00', Format::iso8601())->match(
                 static fn($point) => $point,
                 static fn() => null,
             ),

diff --git a/tests/Clock/LoggerTest.php b/tests/Clock/LoggerTest.php
@@ -77,7 +77,7 @@ public function log($level, string|\Stringable $message, array $context = []): v
 
                 $this->assertSame(
                     $point->toString(),
-                    $clock->at($point->toString())->match(
+                    $clock->at($point->format(Format::iso8601()), Format::iso8601())->match(
                         static fn($found) => $found->toString(),
                         static fn() => null,
                     ),
@@ -88,8 +88,8 @@ public function log($level, string|\Stringable $message, array $context = []): v
                         'debug',
                         'Asked time {date} ({format}) resolved to {point}',
                         [
-                            'date' => $point->toString(),
-                            'format' => 'unknown',
+                            'date' => $point->format(Format::iso8601()),
+                            'format' => Format::iso8601()->toString(),
                             'point' => $point->format(Format::iso8601()),
                         ],
                     ],

diff --git a/tests/ClockTest.php b/tests/ClockTest.php
@@ -107,7 +107,7 @@ public function testFrozenClockDoesntChangeItsTimezone()
                 );
                 $this->assertSame(
                     $frozen->now()->toString(),
-                    $clock->at($point->toString())->match(
+                    $clock->at($point->format(Format::iso8601()), Format::iso8601())->match(
                         static fn($point) => $point->toString(),
                         static fn() => null,
                     ),