feat: improve object constructors parameters types inferring

The collision system that checks object constructors parameters types is now way more clever, as it no longer checks for parameters' names only. Types are now also checked, and only true collision will be detected, for instance when two constructors share a parameter with the same name and type. Note that when two parameters share the same name, the following type priority operates: 1. Non-scalar type 2. Integer type 3. Float type 4. String type 5. Boolean type With this change, the code below is now valid: ```php final readonly class Money { private function __construct( public int $value, ) {} #[\CuyZ\Valinor\Mapper\Object\Constructor] public static function fromInt(int $value): self { return new self($value); } #[\CuyZ\Valinor\Mapper\Object\Constructor] public static function fromString(string $value): self { if (! preg_match('/^\d+€$/', $value)) { throw new \InvalidArgumentException('Invalid money format'); } return new self((int)rtrim($value, '€')); } } $mapper = (new \CuyZ\Valinor\MapperBuilder())->mapper(); $mapper->map(Money::class, 42); // ✅ $mapper->map(Money::class, '42€'); // ✅ ```
CuyZ · Sep 2, 2024 · b08b890 · b08b890
1 parent 10f311e
commit b08b890
Show file tree

Hide file tree

Showing 24 changed files with 582 additions and 524 deletions.
diff --git a/src/Library/Container.php b/src/Library/Container.php
@@ -18,7 +18,7 @@
 use CuyZ\Valinor\Definition\Repository\Reflection\ReflectionFunctionDefinitionRepository;
 use CuyZ\Valinor\Mapper\ArgumentsMapper;
 use CuyZ\Valinor\Mapper\Object\Factory\CacheObjectBuilderFactory;
-use CuyZ\Valinor\Mapper\Object\Factory\CollisionObjectBuilderFactory;
+use CuyZ\Valinor\Mapper\Object\Factory\SortingObjectBuilderFactory;
 use CuyZ\Valinor\Mapper\Object\Factory\ConstructorObjectBuilderFactory;
 use CuyZ\Valinor\Mapper\Object\Factory\DateTimeObjectBuilderFactory;
 use CuyZ\Valinor\Mapper\Object\Factory\DateTimeZoneObjectBuilderFactory;
@@ -37,7 +37,6 @@
 use CuyZ\Valinor\Mapper\Tree\Builder\NodeBuilder;
 use CuyZ\Valinor\Mapper\Tree\Builder\NullNodeBuilder;
 use CuyZ\Valinor\Mapper\Tree\Builder\ObjectImplementations;
-use CuyZ\Valinor\Mapper\Tree\Builder\FilteredObjectNodeBuilder;
 use CuyZ\Valinor\Mapper\Tree\Builder\RootNodeBuilder;
 use CuyZ\Valinor\Mapper\Tree\Builder\ScalarNodeBuilder;
 use CuyZ\Valinor\Mapper\Tree\Builder\ShapedArrayNodeBuilder;
@@ -116,7 +115,6 @@ public function __construct(Settings $settings)
                     ObjectType::class => new ObjectNodeBuilder(
                         $this->get(ClassDefinitionRepository::class),
                         $this->get(ObjectBuilderFactory::class),
-                        $this->get(FilteredObjectNodeBuilder::class),
                     ),
                 ]);
 
@@ -126,8 +124,6 @@ public function __construct(Settings $settings)
                     $builder,
                     $this->get(ObjectImplementations::class),
                     $this->get(ClassDefinitionRepository::class),
-                    $this->get(ObjectBuilderFactory::class),
-                    $this->get(FilteredObjectNodeBuilder::class),
                     new FunctionsContainer(
                         $this->get(FunctionDefinitionRepository::class),
                         $settings->customConstructors
@@ -152,8 +148,6 @@ public function __construct(Settings $settings)
                 return new ErrorCatcherNodeBuilder($builder, $settings->exceptionFilter);
             },
 
-            FilteredObjectNodeBuilder::class => fn () => new FilteredObjectNodeBuilder(),
-
             ObjectImplementations::class => fn () => new ObjectImplementations(
                 new FunctionsContainer(
                     $this->get(FunctionDefinitionRepository::class),
@@ -172,7 +166,7 @@ public function __construct(Settings $settings)
                 $factory = new ConstructorObjectBuilderFactory($factory, $settings->nativeConstructors, $constructors);
                 $factory = new DateTimeZoneObjectBuilderFactory($factory, $this->get(FunctionDefinitionRepository::class));
                 $factory = new DateTimeObjectBuilderFactory($factory, $settings->supportedDateFormats, $this->get(FunctionDefinitionRepository::class));
-                $factory = new CollisionObjectBuilderFactory($factory);
+                $factory = new SortingObjectBuilderFactory($factory);
 
                 if (! $settings->allowPermissiveTypes) {
                     $factory = new StrictTypesObjectBuilderFactory($factory);

diff --git a/src/Mapper/Object/Arguments.php b/src/Mapper/Object/Arguments.php
@@ -12,8 +12,10 @@
 use IteratorAggregate;
 use Traversable;
 
+use function array_keys;
 use function array_map;
 use function array_values;
+use function count;
 
 /**
  * @internal
@@ -22,44 +24,51 @@
  */
 final class Arguments implements IteratorAggregate, Countable
 {
-    /** @var Argument[] */
-    private array $arguments;
+    /** @var array<string, Argument> */
+    private array $arguments = [];
 
     public function __construct(Argument ...$arguments)
     {
-        $this->arguments = $arguments;
+        foreach ($arguments as $argument) {
+            $this->arguments[$argument->name()] = $argument;
+        }
     }
 
     public static function fromParameters(Parameters $parameters): self
     {
         return new self(...array_map(
             fn (ParameterDefinition $parameter) => Argument::fromParameter($parameter),
-            array_values([...$parameters])
+            [...$parameters],
         ));
     }
 
     public static function fromProperties(Properties $properties): self
     {
         return new self(...array_map(
             fn (PropertyDefinition $property) => Argument::fromProperty($property),
-            array_values([...$properties])
+            [...$properties],
         ));
     }
 
     public function at(int $index): Argument
     {
-        return $this->arguments[$index];
+        return array_values($this->arguments)[$index];
     }
 
-    public function has(string $name): bool
+    /**
+     * @return list<string>
+     */
+    public function names(): array
     {
-        foreach ($this->arguments as $argument) {
-            if ($argument->name() === $name) {
-                return true;
-            }
-        }
+        return array_keys($this->arguments);
+    }
 
-        return false;
+    /**
+     * @return array<string, Argument>
+     */
+    public function toArray(): array
+    {
+        return $this->arguments;
     }
 
     public function count(): int

diff --git a/src/Mapper/Object/ArgumentsValues.php b/src/Mapper/Object/ArgumentsValues.php
@@ -4,7 +4,6 @@
 
 namespace CuyZ\Valinor\Mapper\Object;
 
-use CuyZ\Valinor\Mapper\Object\Exception\InvalidSource;
 use CuyZ\Valinor\Mapper\Tree\Shell;
 use CuyZ\Valinor\Type\CompositeTraversableType;
 use CuyZ\Valinor\Type\Types\ArrayKeyType;
@@ -27,6 +26,8 @@ final class ArgumentsValues implements IteratorAggregate
 
     private Arguments $arguments;
 
+    private bool $hasInvalidValue = false;
+
     private bool $forInterface = false;
 
     private bool $hadSingleArgument = false;
@@ -42,7 +43,7 @@ public static function forInterface(Arguments $arguments, Shell $shell): self
         $self->forInterface = true;
 
         if (count($arguments) > 0) {
-            $self = $self->transform($shell);
+            $self->transform($shell);
         }
 
         return $self;
@@ -51,11 +52,16 @@ public static function forInterface(Arguments $arguments, Shell $shell): self
     public static function forClass(Arguments $arguments, Shell $shell): self
     {
         $self = new self($arguments);
-        $self = $self->transform($shell);
+        $self->transform($shell);
 
         return $self;
     }
 
+    public function hasInvalidValue(): bool
+    {
+        return $this->hasInvalidValue;
+    }
+
     public function hasValue(string $name): bool
     {
         return array_key_exists($name, $this->value);
@@ -71,18 +77,18 @@ public function hadSingleArgument(): bool
         return $this->hadSingleArgument;
     }
 
-    private function transform(Shell $shell): self
+    private function transform(Shell $shell): void
     {
-        $clone = clone $this;
-
         $transformedValue = $this->transformValueForSingleArgument($shell);
 
         if (! is_array($transformedValue)) {
-            throw new InvalidSource($transformedValue, $this->arguments);
+            $this->hasInvalidValue = true;
+
+            return;
         }
 
         if ($transformedValue !== $shell->value()) {
-            $clone->hadSingleArgument = true;
+            $this->hadSingleArgument = true;
         }
 
         foreach ($this->arguments as $argument) {
@@ -93,9 +99,7 @@ private function transform(Shell $shell): self
             }
         }
 
-        $clone->value = $transformedValue;
-
-        return $clone;
+        $this->value = $transformedValue;
     }
 
     private function transformValueForSingleArgument(Shell $shell): mixed

diff --git a/src/Mapper/Object/Exception/ObjectBuildersCollision.php b/src/Mapper/Object/Exception/ObjectBuildersCollision.php
@@ -4,23 +4,16 @@
 
 namespace CuyZ\Valinor\Mapper\Object\Exception;
 
-use CuyZ\Valinor\Definition\ClassDefinition;
 use CuyZ\Valinor\Mapper\Object\ObjectBuilder;
 use RuntimeException;
 
-use function array_map;
-use function implode;
-
 /** @internal */
 final class ObjectBuildersCollision extends RuntimeException
 {
-    public function __construct(ClassDefinition $class, ObjectBuilder ...$builders)
+    public function __construct(ObjectBuilder $builderA, ObjectBuilder $builderB)
     {
-        $constructors = array_map(fn (ObjectBuilder $builder) => $builder->signature(), $builders);
-        $constructors = implode('`, `', $constructors);
-
         parent::__construct(
-            "A collision was detected between the following constructors of the class `{$class->type->toString()}`: `$constructors`.",
+            "A type collision was detected between the constructors `{$builderA->signature()}` and `{$builderB->signature()}`.",
             1654955787
         );
     }

diff --git a/src/Mapper/Object/Exception/SeveralObjectBuildersFound.php b/src/Mapper/Object/Exception/SeveralObjectBuildersFound.php
diff --git a/src/Mapper/Object/Factory/CollisionObjectBuilderFactory.php b/src/Mapper/Object/Factory/CollisionObjectBuilderFactory.php
diff --git a/src/Mapper/Object/Factory/DateTimeObjectBuilderFactory.php b/src/Mapper/Object/Factory/DateTimeObjectBuilderFactory.php
@@ -48,6 +48,7 @@ public function for(ClassDefinition $class): array
             $builders[] = $this->internalDateTimeBuilder($class->type);
         }
 
+        /** @var non-empty-list<ObjectBuilder> */
         return $builders;
     }
 

diff --git a/src/Mapper/Object/Factory/DateTimeZoneObjectBuilderFactory.php b/src/Mapper/Object/Factory/DateTimeZoneObjectBuilderFactory.php
@@ -57,6 +57,7 @@ public function for(ClassDefinition $class): array
             $builders[] = $this->defaultBuilder($class->type);
         }
 
+        /** @var non-empty-list<ObjectBuilder> */
         return $builders;
     }
 

diff --git a/src/Mapper/Object/Factory/ObjectBuilderFactory.php b/src/Mapper/Object/Factory/ObjectBuilderFactory.php
@@ -11,7 +11,7 @@
 interface ObjectBuilderFactory
 {
     /**
-     * @return list<ObjectBuilder>
+     * @return non-empty-list<ObjectBuilder>
      */
     public function for(ClassDefinition $class): array;
 }
diff --git a/src/Mapper/Object/Factory/ReflectionObjectBuilderFactory.php b/src/Mapper/Object/Factory/ReflectionObjectBuilderFactory.php
@@ -6,17 +6,12 @@
 
 use CuyZ\Valinor\Definition\ClassDefinition;
 use CuyZ\Valinor\Mapper\Object\ReflectionObjectBuilder;
-use CuyZ\Valinor\Utility\Reflection\Reflection;
 
 /** @internal */
 final class ReflectionObjectBuilderFactory implements ObjectBuilderFactory
 {
     public function for(ClassDefinition $class): array
     {
-        if (Reflection::enumExists($class->name)) {
-            return [];
-        }
-
         return [new ReflectionObjectBuilder($class)];
     }
 }