Use Symfony clock component in AbsolutDate

Author: Florian Guimier

.github/workflows/build.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['8.2', '8.3']
+        php-versions: ['8.3']
         dependency-versions: ['lowest', 'highest']
     runs-on: ubuntu-latest
     steps:

composer.json

@@ -25,9 +25,10 @@
         "assoconnect/php-quality-config": "^1.16"
     },
     "require": {
-        "php": "^8.2",
+        "php": "^8.3",
         "ext-intl": "*",
-        "thecodingmachine/safe": "^3.0"
+        "thecodingmachine/safe": "^3.0",
+        "symfony/clock": "^6.4|^7.0"
     },
     "config": {
         "allow-plugins": {

src/AbsoluteDate.php

@@ -5,14 +5,15 @@
 namespace AssoConnect\PHPDate;
 
 use AssoConnect\PHPDate\Exception\ParsingException;
-use DateTimeImmutable;
 use DateTimeZone;
+use Symfony\Component\Clock\Clock;
+use Symfony\Component\Clock\DatePoint;
 
 class AbsoluteDate implements \Stringable
 {
     public const DEFAULT_DATE_FORMAT = 'Y-m-d';
 
-    private DateTimeImmutable $datetime;
+    private DatePoint $datetime;
 
     /**
      * AbsoluteDate constructor from a date as string
@@ -80,22 +81,22 @@ public function modify(string $modifier): self
     /**
      * Return the DateTime for a given DateTimeZone
      */
-    public function startsAt(DateTimeZone $timezone): DateTimeImmutable
+    public function startsAt(DateTimeZone $timezone): DatePoint
     {
         return $this->getDateTimeFromFormatAndTimezone(self::DEFAULT_DATE_FORMAT, $timezone);
     }
 
     /**
      * Return the DateTime at the end of the day for a given DateTimeZone
      */
-    public function endsAt(DateTimeZone $timezone): DateTimeImmutable
+    public function endsAt(DateTimeZone $timezone): DatePoint
     {
         return $this->getDateTimeFromFormatAndTimezone(self::DEFAULT_DATE_FORMAT . ' 23:59:59', $timezone);
     }
 
-    private function getDateTimeFromFormatAndTimezone(string $format, DateTimeZone $timezone): DateTimeImmutable
+    private function getDateTimeFromFormatAndTimezone(string $format, DateTimeZone $timezone): DatePoint
     {
-        return new DateTimeImmutable($this->format($format), $timezone);
+        return new DatePoint($this->format($format), $timezone);
     }
 
     /**
@@ -170,7 +171,7 @@ public function isBetweenOrEqualTo(self $other1, self $other2): bool
      */
     public function __toString(): string
     {
-        return $this->format(self::DEFAULT_DATE_FORMAT);
+        return $this->format();
     }
 
     /**
@@ -182,11 +183,12 @@ public function __toString(): string
      */
     public static function createInTimezone(DateTimeZone $timezone, \DateTimeInterface $datetime = null): self
     {
-        return new self(
-            (new DateTimeImmutable('@' . (null === $datetime ? time() : $datetime->getTimestamp())))
-            ->setTimezone($timezone)
-            ->format(self::DEFAULT_DATE_FORMAT)
+        $datetime = new DatePoint(
+            '@' . (null === $datetime ? Clock::get()->now()->getTimestamp() : $datetime->getTimestamp())
         );
+        $datetime->setTimezone($timezone);
+
+        return new self($datetime->format(self::DEFAULT_DATE_FORMAT));
     }
 
     /**
@@ -201,7 +203,7 @@ public static function createRelative(string $relative = 'now', DateTimeZone $ti
             $timezone = new DateTimeZone('UTC');
         }
 
-        $datetime = new DateTimeImmutable($relative, $timezone);
+        $datetime = new DatePoint($relative, $timezone);
 
         return self::createInTimezone($timezone, $datetime);
     }
@@ -212,13 +214,11 @@ private function initDatetime(string $date, string $format): void
         $format .= 'H:i:s';
         $date .= '00:00:00';
 
-        $datetime = DateTimeImmutable::createFromFormat($format, $date, $timezone);
-
-        if (false === $datetime) {
-            throw new ParsingException(sprintf('Cannot parse %s with format %s', $date, $format));
+        try {
+            $this->datetime = DatePoint::createFromFormat($format, $date, $timezone);
+        } catch (\DateMalformedStringException $e) {
+            throw new ParsingException(sprintf('Cannot parse %s with format %s', $date, $format), previous: $e);
         }
-
-        $this->datetime = $datetime;
     }
 
     /**

tests/AbsoluteDateTest.php

@@ -7,6 +7,7 @@
 use AssoConnect\PHPDate\AbsoluteDate;
 use AssoConnect\PHPDate\Exception\ParsingException;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Clock\DatePoint;
 
 class AbsoluteDateTest extends TestCase
 {
@@ -79,12 +80,11 @@ public function testWithPointInTime(): void
         $date = new AbsoluteDate('2020-01-02');
         self::assertSame('2020-01-02', $date->format());
 
-        $datetime = \DateTime::createFromFormat(
+        $datetime = DatePoint::createFromFormat(
             'Y-m-d H:i:s',
             '2019-12-27 23:00:00',
             new \DateTimeZone('UTC')
         );
-        self::assertNotFalse($datetime);
 
         $date = AbsoluteDate::createInTimezone(new \DateTimeZone('UTC'), $datetime);
         self::assertSame('2019-12-27', $date->format());
@@ -98,13 +98,13 @@ public function testWithPointInTime(): void
 
     public function testStartsAt(): void
     {
-        $date1 = \DateTime::createFromFormat(
+        $date1 = DatePoint::createFromFormat(
             'Y-m-d H:i:s',
             '2019-12-27 00:00:00',
             new \DateTimeZone('Europe/Paris')
         );
 
-        $date2 = \DateTime::createFromFormat(
+        $date2 = DatePoint::createFromFormat(
             'Y-m-d H:i:s',
             '2019-12-27 00:00:00',
             new \DateTimeZone('America/Los_Angeles')
@@ -118,13 +118,13 @@ public function testStartsAt(): void
 
     public function testEndsAt(): void
     {
-        $date1 = \DateTime::createFromFormat(
+        $date1 = DatePoint::createFromFormat(
             'Y-m-d H:i:s',
             '2019-12-27 23:59:59',
             new \DateTimeZone('Europe/Paris')
         );
 
-        $date2 = \DateTime::createFromFormat(
+        $date2 = DatePoint::createFromFormat(
             'Y-m-d H:i:s',
             '2019-12-27 23:59:59',
             new \DateTimeZone('America/Los_Angeles')
@@ -142,7 +142,7 @@ public function testEndsAt(): void
     public function testCreateRelative(): void
     {
         $date = AbsoluteDate::createRelative('yesterday', $timezone = new \DateTimeZone('America/Los_Angeles'));
-        $now = new \DateTimeImmutable('yesterday', $timezone);
+        $now = new DatePoint('yesterday', $timezone);
         self::assertSame($now->format(AbsoluteDate::DEFAULT_DATE_FORMAT), $date->format());
     }