fix: handle variadic parameters declared in docblock

Co-authored-by: Romain Canon <romain.hydrocanon@gmail.com>
WoltLab · Sep 11, 2023 · f4884cf · f4884cf
1 parent c231020
commit f4884cf
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 28 deletions.
diff --git a/src/Definition/Repository/Reflection/ReflectionTypeResolver.php b/src/Definition/Repository/Reflection/ReflectionTypeResolver.php
@@ -8,6 +8,8 @@
 use CuyZ\Valinor\Type\Parser\Exception\InvalidType;
 use CuyZ\Valinor\Type\Parser\TypeParser;
 use CuyZ\Valinor\Type\Type;
+use CuyZ\Valinor\Type\Types\ArrayKeyType;
+use CuyZ\Valinor\Type\Types\ArrayType;
 use CuyZ\Valinor\Type\Types\MixedType;
 use CuyZ\Valinor\Type\Types\UnresolvableType;
 use CuyZ\Valinor\Utility\Reflection\DocParser;
@@ -75,7 +77,9 @@ private function typeFromDocBlock(ReflectionProperty|ReflectionParameter|Reflect
             return null;
         }
 
-        return $this->parseType($type, $reflection, $this->advancedParser);
+        $type = $this->parseType($type, $reflection, $this->advancedParser);
+
+        return $this->handleVariadicType($reflection, $type);
     }
 
     private function nativeType(ReflectionProperty|ReflectionParameter|ReflectionFunctionAbstract $reflection): ?Type
@@ -89,12 +93,9 @@ private function nativeType(ReflectionProperty|ReflectionParameter|ReflectionFun
         }
 
         $type = Reflection::flattenType($reflectionType);
+        $type = $this->parseType($type, $reflection, $this->nativeParser);
 
-        if ($reflection instanceof ReflectionParameter && $reflection->isVariadic()) {
-            $type .= '[]';
-        }
-
-        return $this->parseType($type, $reflection, $this->nativeParser);
+        return $this->handleVariadicType($reflection, $type);
     }
 
     private function parseType(string $raw, ReflectionProperty|ReflectionParameter|ReflectionFunctionAbstract $reflection, TypeParser $parser): Type
@@ -116,4 +117,13 @@ private function parseType(string $raw, ReflectionProperty|ReflectionParameter|R
             return UnresolvableType::forMethodReturnType($raw, $signature, $exception);
         }
     }
+
+    private function handleVariadicType(ReflectionProperty|ReflectionParameter|ReflectionFunctionAbstract $reflection, Type $type): Type
+    {
+        if (! $reflection instanceof ReflectionParameter || ! $reflection->isVariadic()) {
+            return $type;
+        }
+
+        return new ArrayType(ArrayKeyType::default(), $type);
+    }
 }
diff --git a/src/Utility/Reflection/DocParser.php b/src/Utility/Reflection/DocParser.php
@@ -17,6 +17,7 @@
 use function str_split;
 use function strrpos;
 use function substr;
+use function trim;
 
 /** @internal */
 final class DocParser

diff --git a/tests/Integration/Mapping/VariadicParameterMappingTest.php b/tests/Integration/Mapping/VariadicParameterMappingTest.php
@@ -36,19 +36,17 @@ public function test_variadic_parameters_are_mapped_properly_when_string_keys_ar
         self::assertSame(['foo', 'bar', 'baz'], $object->values);
     }
 
-    public function test_named_constructor_with_only_variadic_parameters_are_mapped_properly(): void
+    public function test_constructor_with_variadic_parameters_with_dots_in_dot_blocks_are_defined_properly(): void
     {
         try {
-            $object = (new MapperBuilder())
-                // PHP8.1 first-class callable syntax
-                ->registerConstructor([SomeClassWithNamedConstructorWithOnlyVariadicParameters::class, 'new'])
+            (new MapperBuilder())
                 ->mapper()
-                ->map(SomeClassWithNamedConstructorWithOnlyVariadicParameters::class, ['foo', 'bar', 'baz']);
-        } catch (MappingError $error) {
-            $this->mappingFail($error);
-        }
+                ->map(SomeClassWithVariadicParametersInDocBlock::class, ['']);
+        } catch (MappingError $exception) {
+            $error = $exception->node()->children()[0]->messages()[0];
 
-        self::assertSame(['foo', 'bar', 'baz'], $object->values);
+            self::assertSame("Value '' is not a valid non-empty string.", (string)$error);
+        }
     }
 
     public function test_non_variadic_and_variadic_parameters_are_mapped_properly(): void
@@ -113,19 +111,19 @@ public static function new(string ...$values): self
     }
 }
 
-//final class SomeClassWithListVariadicParameters
-//{
-//    /** @var list<string> */
-//    public array $values;
-//
-//    /**
-//     * @param list<string> $values
-//     */
-//    public function __construct(string ...$values)
-//    {
-//        $this->values = $values;
-//    }
-//}
+final class SomeClassWithVariadicParametersInDocBlock
+{
+    /** @var array<non-empty-string> */
+    public array $values;
+
+    /**
+     * @param non-empty-string ...$values
+     */
+    public function __construct(string ...$values)
+    {
+        $this->values = $values;
+    }
+}
 
 final class SomeClassWithNonVariadicAndVariadicParameters
 {