fix point in time type format being non standard

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+### Added
+
+- `Formal\ORM\Definition\Type\PointInTimeType::new()`
+
+### Deprecated
+
+- `Formal\ORM\Definition\Type\PointInTimeType::of()` as it uses a non standard string format. Use `::new()` instead, but don't forget to migrate your data.
+
 ### Fixed
 
 - Psalm was complaining of a missing argument when using `PointInTimeType::of()`

benchmark/fill_storage.php

@@ -11,19 +11,23 @@
     Adapter,
 };
 use Innmind\OperatingSystem\Factory;
+use Innmind\TimeContinuum\PointInTime;
 use Innmind\Url\Url;
 use Innmind\BlackBox\{
     Set,
     Random,
 };
 use Innmind\Immutable\Either;
 use Fixtures\Formal\ORM\User;
-use Fixtures\Innmind\TimeContinuum\Earth\PointInTime;
+use Fixtures\Innmind\TimeContinuum\Earth\PointInTime as FPointInTime;
 
 $os = Factory::build();
 $connection = $os->remote()->sql(Url::of("mysql://root:root@127.0.0.1:3306/example"));
 $aggregates = Aggregates::of(Types::of(
-    Type\PointInTimeType::of($os->clock()),
+    Type\Support::class(
+        PointInTime::class,
+        Type\PointInTimeType::new($os->clock()),
+    ),
 ));
 
 $_ = Adapter\SQL\ShowCreateTable::of($aggregates)(User::class)->foreach($connection);
@@ -33,7 +37,7 @@
 
 $users = Set\Composite::immutable(
     User::new(...),
-    PointInTime::any(),
+    FPointInTime::any(),
     Set\Strings::madeOf(Set\Chars::alphanumerical())->between(0, 250),
 );
 $users = Set\Randomize::of($users)->take(100_000)->values(Random::default);

benchmark/load.php

@@ -12,11 +12,15 @@
 use Innmind\OperatingSystem\Factory;
 use Innmind\Url\Url;
 use Fixtures\Formal\ORM\User;
+use Innmind\TimeContinuum\PointInTime;
 
 $os = Factory::build();
 $connection = $os->remote()->sql(Url::of("mysql://root:root@127.0.0.1:3306/example"));
 $aggregates = Aggregates::of(Types::of(
-    Type\PointInTimeType::of($os->clock()),
+    Type\Support::class(
+        PointInTime::class,
+        Type\PointInTimeType::new($os->clock()),
+    ),
 ));
 
 $manager = Manager::sql($connection, $aggregates);

documentation/mapping/index.md

@@ -33,14 +33,19 @@ By default Formal also supports:
         Manager,
         Definition\Aggregates,
         Definition\Types,
-        Definition\Type\PointInTime,
-    }
+        Definition\Type\Support,
+        Definition\Type\PointInTimeType,
+    };
+    use Innmind\TimeContinuum\PointInTime;
 
     $orm = Manager::of(
         /* any adapter (1) */,
         Aggregates::of(
             Types::of(
-                PointInTimeType::of($os->clock()),
+                Support::class(
+                    PointInTime::class,
+                    PointInTimeType::new($os->clock()),
+                ),
             ),
         ),
     );

proofs/adapter/elasticsearch/mapping.php

@@ -8,15 +8,21 @@
     Definition\Type,
     Definition\Types,
 };
-use Innmind\TimeContinuum\Earth\Clock;
+use Innmind\TimeContinuum\{
+    Earth\Clock,
+    PointInTime,
+};
 use Fixtures\Formal\ORM\User;
 
 return static function() {
     yield test(
         'Define Elasticsearch index mapping for the User fixture',
         static function($assert) {
             $aggregates = Aggregates::of(Types::of(
-                Type\PointInTimeType::of(new Clock),
+                Type\Support::class(
+                    PointInTime::class,
+                    Type\PointInTimeType::new(new Clock),
+                ),
             ));
 
             $mapping = Mapping::new()($aggregates->get(User::class));

proofs/adapter/sql/showCreateTable.php

@@ -9,7 +9,10 @@
     Definition\Types,
 };
 use Formal\AccessLayer\Driver;
-use Innmind\TimeContinuum\Earth\Clock;
+use Innmind\TimeContinuum\{
+    Earth\Clock,
+    PointInTime,
+};
 use Fixtures\Formal\ORM\User;
 
 return static function() {
@@ -18,7 +21,10 @@
         static function($assert) {
             $show = ShowCreateTable::of(
                 Aggregates::of(Types::of(
-                    Type\PointInTimeType::of(new Clock),
+                    Type\Support::class(
+                        PointInTime::class,
+                        Type\PointInTimeType::new(new Clock),
+                    ),
                 )),
             );
 
@@ -53,7 +59,10 @@ static function($assert) {
         static function($assert) {
             $show = ShowCreateTable::of(
                 Aggregates::of(Types::of(
-                    Type\PointInTimeType::of(new Clock),
+                    Type\Support::class(
+                        PointInTime::class,
+                        Type\PointInTimeType::new(new Clock),
+                    ),
                 ))->mapName(static fn($string) => match ($string) {
                     User::class => 'some_user',
                 }),

proofs/manager.php

@@ -28,7 +28,10 @@
 };
 use Innmind\OperatingSystem\Factory;
 use Innmind\Filesystem\Adapter\InMemory;
-use Innmind\TimeContinuum\Earth\Clock;
+use Innmind\TimeContinuum\{
+    Earth\Clock,
+    PointInTime,
+};
 use Innmind\Url\Url;
 use Innmind\Immutable\Either;
 use Innmind\BlackBox\Set;
@@ -82,7 +85,10 @@ static function($assert) {
         Set\Call::of(static fn() => Manager::filesystem(
             InMemory::emulateFilesystem(),
             Aggregates::of(Types::of(
-                Type\PointInTimeType::of(new Clock),
+                Type\Support::class(
+                    PointInTime::class,
+                    Type\PointInTimeType::new(new Clock),
+                ),
                 SortableType::of(...),
             )),
         )),
@@ -94,7 +100,10 @@ static function($assert) {
             Set\Call::of(static fn() => Manager::filesystem(
                 InMemory::emulateFilesystem(),
                 Aggregates::of(Types::of(
-                    Type\PointInTimeType::of(new Clock),
+                    Type\Support::class(
+                        PointInTime::class,
+                        Type\PointInTimeType::new(new Clock),
+                    ),
                     SortableType::of(...),
                 )),
             )),
@@ -105,7 +114,10 @@ static function($assert) {
 
     $os = Factory::build();
     $aggregates = Aggregates::of(Types::of(
-        Type\PointInTimeType::of($os->clock()),
+        Type\Support::class(
+            PointInTime::class,
+            Type\PointInTimeType::new($os->clock()),
+        ),
         SortableType::of(...),
     ));
 

src/Definition/Type/PointInTimeType.php

@@ -26,27 +26,38 @@
 final class PointInTimeType implements Type
 {
     private Clock $clock;
+    private Format $format;
 
-    private function __construct(Clock $clock)
+    private function __construct(Clock $clock, Format $format)
     {
         $this->clock = $clock;
+        $this->format = $format;
     }
 
     /**
      * @psalm-pure
+     */
+    public static function new(Clock $clock): self
+    {
+        return new self($clock, Format::new());
+    }
+
+    /**
+     * @psalm-pure
+     * @deprecated Use ::new() instead
      *
      * @return callable(Types, Concrete, ?Contains): Maybe<self>
      */
     public static function of(Clock $clock): callable
     {
         return static fn(Types $types, Concrete $type) => Maybe::just($type)
             ->filter(static fn($type) => $type->accepts(ClassName::of(PointInTime::class)))
-            ->map(static fn() => new self($clock));
+            ->map(static fn() => new self($clock, new Format));
     }
 
     public function normalize(mixed $value): null|string|int|bool
     {
-        return $value->format(new Format);
+        return $value->format($this->format);
     }
 
     public function denormalize(null|string|int|bool $value): mixed
@@ -57,7 +68,7 @@ public function denormalize(null|string|int|bool $value): mixed
 
         return $this
             ->clock
-            ->at($value, new Format)
+            ->at($value, $this->format)
             ->match(
                 static fn($point) => $point,
                 static fn() => throw new \LogicException("'$value' is not a date"),

src/Definition/Type/PointInTimeType/Format.php

@@ -10,8 +10,23 @@
  */
 final class Format implements FormatInterface
 {
+    /**
+     * This is a non standard format (stupid mistake) but is kept as is until
+     * the next major release. The ::new named constructor should be used to
+     * have the correct format (that will be the future default).
+     */
+    private string $format = 'Y:m:d\TH:i:s.uP';
+
+    public static function new(): self
+    {
+        $self = new self;
+        $self->format = 'Y-m-d\TH:i:s.uP';
+
+        return $self;
+    }
+
     public function toString(): string
     {
-        return 'Y:m:d\TH:i:s.uP';
+        return $this->format;
     }
 }