feat!: Replace Factory with Clock; Remove redundant factory methods

Author: pauci

src/ClockInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pauci\DateTime;
+
+interface ClockInterface
+{
+    public function now(): DateTimeInterface;
+}

src/DateTime.php

@@ -4,74 +4,85 @@
 
 namespace Pauci\DateTime;
 
+use DateTimeImmutable;
 use DateTimeZone;
+use Exception;
 
-class DateTime extends \DateTimeImmutable implements DateTimeInterface
+class DateTime extends DateTimeImmutable implements DateTimeInterface
 {
-    private static ?DateTimeFactoryInterface $factory;
+    protected static ?ClockInterface $clock = null;
 
-    public static function getFactory(): DateTimeFactoryInterface
+    public static function getClock(): ClockInterface
     {
-        return self::$factory ??= new DateTimeFactory();
+        return static::$clock ??= new SystemClock();
     }
 
-    public static function setFactory(DateTimeFactoryInterface $factory): void
+    public static function setClock(ClockInterface $clock): void
     {
-        self::$factory = $factory;
+        static::$clock = $clock;
     }
 
-    public static function now(): DateTimeInterface
+    final public function __construct(string $datetime = 'now', ?DateTimeZone $timezone = null)
     {
-        return self::getFactory()->now();
-    }
+        if ('now' === $datetime
+            && null !== static::$clock
+            && !static::$clock instanceof SystemClock
+        ) {
+            $datetime = static::getClock()->now()->toString();
+        }
 
-    public static function microsecondsNow(): DateTimeInterface
-    {
-        return self::getFactory()->microsecondsNow();
+        parent::__construct($datetime, $timezone);
     }
 
-    public static function fromString(string $time, DateTimeZone $timezone = null): DateTimeInterface
+    public static function now(): DateTimeInterface
     {
-        return self::getFactory()->fromString($time, $timezone);
+        return static::getClock()->now();
     }
 
-    public static function fromFormat(string $format, string $time, DateTimeZone $timezone = null): DateTimeInterface
+    /**
+     * @throws Exception
+     */
+    public static function fromString(string $time, DateTimeZone $timezone = null): static
     {
-        return self::getFactory()->fromFormat($format, $time, $timezone);
+        return new static($time, $timezone);
     }
 
-    public static function fromTimestamp(int $timestamp, DateTimeZone $timezone = null): DateTimeInterface
+    /**
+     * @throws Exception
+     */
+    public static function fromTimestamp(int $timestamp, DateTimeZone $timezone = null): static
     {
-        return self::getFactory()->fromTimestamp($timestamp, $timezone);
+        return (new static('@' . $timestamp))
+            ->setTimezone($timezone ?? new DateTimeZone(date_default_timezone_get()));
     }
 
-    public static function fromFloatTimestamp(float $timestamp, DateTimeZone $timezone = null): DateTimeInterface
+    public static function fromFloatTimestamp(float $timestamp, DateTimeZone $timezone = null): static
     {
-        return self::getFactory()->fromFloatTimestamp($timestamp, $timezone);
-    }
+        $integerPart = (int) floor($timestamp);
+        $fractionalPart = substr(sprintf('%.6f', $timestamp - $integerPart), 2);
 
-    public static function fromDateTime(\DateTimeInterface $dateTime): DateTimeInterface
-    {
-        return self::getFactory()->fromDateTime($dateTime);
+        $dateTime = new static(date('Y-m-d H:i:s.' . $fractionalPart, $integerPart));
+
+        return $timezone ? $dateTime->setTimezone($timezone) : $dateTime;
     }
 
     #[\ReturnTypeWillChange]
     public static function createFromFormat(
         string $format,
         string $datetime,
         DateTimeZone $timezone = null
-    ): DateTimeInterface {
-        return self::fromFormat($format, $datetime, $timezone);
+    ): static|false {
+        return parent::createFromFormat($format, $datetime, $timezone);
     }
 
     #[\ReturnTypeWillChange]
-    public static function createFromMutable(\DateTime $object): DateTimeInterface
+    public static function createFromMutable(\DateTime $object): static
     {
-        return self::fromDateTime($object);
+        return parent::createFromMutable($object);
     }
 
     /**
-     * @throws \Exception
+     * @throws Exception
      */
     public function diff(\DateTimeInterface $targetObject, bool $absolute = false): DateInterval
     {
@@ -90,17 +101,9 @@ public function sub(\DateInterval $interval): static
         return parent::sub($interval);
     }
 
-    public function modify(string $modifier): static
+    public function modify(string $modifier): static|false
     {
-        try {
-            $dateTime = parent::modify($modifier);
-        } catch (\Throwable $e) {
-            $message = strtr($e->getMessage(), [\DateTimeImmutable::class => static::class]);
-
-            throw new Exception\FailedToModifyException($message, previous: $e);
-        }
-
-        return $dateTime;
+        return parent::modify($modifier);
     }
 
     public function setDate(int $year, int $month, int $day): static
@@ -133,7 +136,7 @@ public function equals(DateTimeInterface $dateTime): bool
         return $this == $dateTime;
     }
 
-    public function inDefaultTimezone(): DateTimeInterface
+    public function inDefaultTimezone(): static
     {
         return $this->setTimezone(new DateTimeZone(date_default_timezone_get()));
     }

src/DateTimeFactory.php

@@ -10,15 +10,15 @@ public function diff(\DateTimeInterface $targetObject, bool $absolute = false):
 
     public function equals(self $dateTime): bool;
 
-    public function inDefaultTimezone(): DateTimeInterface;
+    public function inDefaultTimezone(): static;
 
     public function toString(): string;
 
     public function add(\DateInterval $interval): static;
 
     public function sub(\DateInterval $interval): static;
 
-    public function modify(string $modifier): static;
+    public function modify(string $modifier): static|false;
 
     public function setDate(int $year, int $month, int $day): static;
 

src/DateTimeFactoryInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pauci\DateTime;
+
+class FrozenClock implements ClockInterface
+{
+    private DateTimeInterface $now;
+
+    public function __construct(DateTimeInterface $now = null)
+    {
+        $this->now = $now ?? new DateTime();
+    }
+
+    public function set(DateTimeInterface $now): void
+    {
+        $this->now = $now;
+    }
+
+    public function modify(string $modifier): void
+    {
+        $now = $this->now->modify($modifier);
+
+        if (false !== $now) {
+            $this->now = $now;
+        }
+    }
+
+    public function now(): DateTimeInterface
+    {
+        return $this->now;
+    }
+}

src/DateTimeInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pauci\DateTime;
+
+class SystemClock implements ClockInterface
+{
+    public function now(): DateTimeInterface
+    {
+        return new DateTime();
+    }
+}