Improve date time building (allow interfaces)

Author: SerafimArts

src/Type/Builder/DateTimeFromStringTypeBuilder.php

@@ -4,16 +4,42 @@
 
 namespace TypeLang\Mapper\Type\Builder;
 
+use TypeLang\Mapper\Exception\Definition\InternalTypeException;
 use TypeLang\Mapper\Type\DateTimeFromStringType;
+use TypeLang\Parser\Node\Stmt\NamedTypeNode;
 
 /**
- * @template TDateTime of \DateTime|\DateTimeImmutable = \DateTimeImmutable
+ * @template TDateTime of \DateTimeInterface = \DateTimeInterface
  * @template-extends DateTimeTypeBuilder<TDateTime, TDateTime>
  */
 class DateTimeFromStringTypeBuilder extends DateTimeTypeBuilder
 {
-    protected function create(string $class, ?string $format = null): DateTimeFromStringType
+    /**
+     * @var array<class-string<\DateTimeInterface>, class-string<\DateTimeInterface>>
+     */
+    private const DATE_INTERFACE_MAPPING = [
+        \DateTimeInterface::class => \DateTimeImmutable::class,
+        \Carbon\CarbonInterface::class => \Carbon\CarbonImmutable::class,
+    ];
+
+    protected function create(NamedTypeNode $stmt, string $class, ?string $format = null): DateTimeFromStringType
     {
+        if (\interface_exists($class)) {
+            foreach (self::DATE_INTERFACE_MAPPING as $interface => $impl) {
+                if (\is_a($interface, $class, true)) {
+                    $class = $impl;
+                    break;
+                }
+            }
+        }
+
+        if (!\class_exists($class)) {
+            throw InternalTypeException::becauseInternalTypeErrorOccurs(
+                type: $stmt,
+                message: 'To create a date object from a string, a class must be specified, but {{type}} is not one'
+            );
+        }
+
         return new DateTimeFromStringType($class, $format);
     }
 }

src/Type/Builder/DateTimeToStringTypeBuilder.php

@@ -5,14 +5,15 @@
 namespace TypeLang\Mapper\Type\Builder;
 
 use TypeLang\Mapper\Type\DateTimeToStringType;
+use TypeLang\Parser\Node\Stmt\NamedTypeNode;
 
 /**
- * @template TDateTime of \DateTime|\DateTimeImmutable = \DateTimeImmutable
+ * @template TDateTime of \DateTimeInterface = \DateTimeInterface
  * @template-extends DateTimeTypeBuilder<TDateTime, string>
  */
 class DateTimeToStringTypeBuilder extends DateTimeTypeBuilder
 {
-    protected function create(string $class, ?string $format = null): DateTimeToStringType
+    protected function create(NamedTypeNode $stmt, string $class, ?string $format = null): DateTimeToStringType
     {
         $format ??= DateTimeToStringType::DEFAULT_DATETIME_FORMAT;
 

src/Type/Builder/DateTimeTypeBuilder.php

@@ -14,7 +14,7 @@
 use TypeLang\Parser\Node\Stmt\TypeStatement;
 
 /**
- * @template TDateTime of \DateTime|\DateTimeImmutable = \DateTimeImmutable
+ * @template TDateTime of \DateTimeInterface = \DateTimeInterface
  * @template TResult of mixed = mixed
  * @template-extends Builder<NamedTypeNode, TypeInterface<TResult>>
  */
@@ -26,21 +26,6 @@ public function isSupported(TypeStatement $statement): bool
             && \is_a($statement->name->toLowerString(), \DateTimeInterface::class, true);
     }
 
-    /**
-     * @return class-string<TDateTime>
-     * @return class-string<TDateTime>
-     */
-    private function getDateTimeClass(string $name): string
-    {
-        if ($name === \DateTimeInterface::class || \interface_exists($name)) {
-            /** @phpstan-ignore-next-line : If an interface is passed, then return the base class */
-            return \DateTimeImmutable::class;
-        }
-
-        /** @var class-string<TDateTime> */
-        return $name;
-    }
-
     public function build(
         TypeStatement $statement,
         TypeRepositoryInterface $types,
@@ -50,11 +35,7 @@ public function build(
         $this->expectTemplateArgumentsLessOrEqualThan($statement, 1, 0);
 
         if ($statement->arguments === null) {
-            return $this->create(
-                class: $this->getDateTimeClass(
-                    name: $statement->name->toString(),
-                ),
-            );
+            return $this->create($statement, $statement->name->toString());
         }
 
         /** @var TemplateArgumentNode $formatArgument */
@@ -71,9 +52,8 @@ class: $this->getDateTimeClass(
         }
 
         return $this->create(
-            class: $this->getDateTimeClass(
-                name: $statement->name->toString(),
-            ),
+            stmt: $statement,
+            class: $statement->name->toString(),
             format: $formatArgument->value->value,
         );
     }
@@ -83,5 +63,5 @@ class: $this->getDateTimeClass(
      *
      * @return TypeInterface<TResult>
      */
-    abstract protected function create(string $class, ?string $format = null): TypeInterface;
+    abstract protected function create(NamedTypeNode $stmt, string $class, ?string $format = null): TypeInterface;
 }

src/Type/DateTimeFromStringType.php

@@ -4,12 +4,11 @@
 
 namespace TypeLang\Mapper\Type;
 
-use DateTime as TDateTime;
 use TypeLang\Mapper\Context\Context;
 use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
 
 /**
- * @template TDateTime of \DateTime|\DateTimeImmutable = \DateTimeImmutable
+ * @template TDateTime of \DateTimeInterface = \DateTimeInterface
  * @template-implements TypeInterface<TDateTime>
  */
 class DateTimeFromStringType implements TypeInterface
@@ -24,7 +23,24 @@ public function __construct(
          * @var TypeInterface<string>
          */
         protected readonly TypeInterface $input = new StringType(),
-    ) {}
+    ) {
+        $this->assertDateTimeClassExists($class);
+    }
+
+    /**
+     * @param class-string<TDateTime> $class
+     */
+    private function assertDateTimeClassExists(string $class): void
+    {
+        if (\class_exists($class)) {
+            return;
+        }
+
+        throw new \InvalidArgumentException(\sprintf(
+            'Creating a date instance requires a date class, but %s is not one',
+            $class,
+        ));
+    }
 
     /**
      * @phpstan-assert-if-true string $value