misc: refactor generic types parsing and checking

This refactor is needed for an upcoming change in the types parsing system, which will allow to distinguish native types and types coming from doc-blocks.
CuyZ · Mar 17, 2024 · ba67703 · ba67703
1 parent 2738de1
commit ba67703
Show file tree

Hide file tree

Showing 31 changed files with 498 additions and 478 deletions.
diff --git a/.../Exception/Generic/ExtendTagTypeError.php → ...finition/Exception/ExtendTagTypeError.php b/.../Exception/Generic/ExtendTagTypeError.php → ...finition/Exception/ExtendTagTypeError.php
@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace CuyZ\Valinor\Type\Parser\Exception\Generic;
+namespace CuyZ\Valinor\Definition\Exception;
 
 use CuyZ\Valinor\Type\Parser\Exception\InvalidType;
 use ReflectionClass;
 use RuntimeException;
 
 /** @internal */
-final class ExtendTagTypeError extends RuntimeException implements InvalidType
+final class ExtendTagTypeError extends RuntimeException
 {
     /**
      * @param ReflectionClass<object> $reflection
@@ -19,7 +19,7 @@ public function __construct(ReflectionClass $reflection, InvalidType $previous)
         parent::__construct(
             "The `@extends` tag of the class `$reflection->name` is not valid: {$previous->getMessage()}",
             1670193574,
-            $previous
+            $previous,
         );
     }
 }
diff --git a/...ion/Generic/InvalidExtendTagClassName.php → ...n/Exception/InvalidExtendTagClassName.php b/...ion/Generic/InvalidExtendTagClassName.php → ...n/Exception/InvalidExtendTagClassName.php
@@ -2,15 +2,14 @@
 
 declare(strict_types=1);
 
-namespace CuyZ\Valinor\Type\Parser\Exception\Generic;
+namespace CuyZ\Valinor\Definition\Exception;
 
-use CuyZ\Valinor\Type\Parser\Exception\InvalidType;
 use CuyZ\Valinor\Type\Type;
 use ReflectionClass;
 use RuntimeException;
 
 /** @internal */
-final class InvalidExtendTagClassName extends RuntimeException implements InvalidType
+final class InvalidExtendTagClassName extends RuntimeException
 {
     /**
      * @param ReflectionClass<object> $reflection
@@ -22,7 +21,7 @@ public function __construct(ReflectionClass $reflection, Type $invalidExtendTag)
 
         parent::__construct(
             "The `@extends` tag of the class `$reflection->name` has invalid class `{$invalidExtendTag->toString()}`, it should be `$parentClass->name`.",
-            1670183564
+            1670183564,
         );
     }
 }
diff --git a/...xception/Generic/InvalidExtendTagType.php → ...nition/Exception/InvalidExtendTagType.php b/...xception/Generic/InvalidExtendTagType.php → ...nition/Exception/InvalidExtendTagType.php
@@ -2,15 +2,14 @@
 
 declare(strict_types=1);
 
-namespace CuyZ\Valinor\Type\Parser\Exception\Generic;
+namespace CuyZ\Valinor\Definition\Exception;
 
-use CuyZ\Valinor\Type\Parser\Exception\InvalidType;
 use CuyZ\Valinor\Type\Type;
 use ReflectionClass;
 use RuntimeException;
 
 /** @internal */
-final class InvalidExtendTagType extends RuntimeException implements InvalidType
+final class InvalidExtendTagType extends RuntimeException
 {
     /**
      * @param ReflectionClass<object> $reflection
@@ -22,7 +21,7 @@ public function __construct(ReflectionClass $reflection, Type $invalidExtendTag)
 
         parent::__construct(
             "The `@extends` tag of the class `$reflection->name` has invalid type `{$invalidExtendTag->toString()}`, it should be `{$parentClass->name}`.",
-            1670181134
+            1670181134,
         );
     }
 }
diff --git a/...eption/Generic/SeveralExtendTagsFound.php → ...tion/Exception/SeveralExtendTagsFound.php b/...eption/Generic/SeveralExtendTagsFound.php → ...tion/Exception/SeveralExtendTagsFound.php
@@ -2,14 +2,13 @@
 
 declare(strict_types=1);
 
-namespace CuyZ\Valinor\Type\Parser\Exception\Generic;
+namespace CuyZ\Valinor\Definition\Exception;
 
-use CuyZ\Valinor\Type\Parser\Exception\InvalidType;
 use ReflectionClass;
 use RuntimeException;
 
 /** @internal */
-final class SeveralExtendTagsFound extends RuntimeException implements InvalidType
+final class SeveralExtendTagsFound extends RuntimeException
 {
     /**
      * @param ReflectionClass<object> $reflection
@@ -18,7 +17,7 @@ public function __construct(ReflectionClass $reflection)
     {
         parent::__construct(
             "Only one `@extends` tag should be set for the class `$reflection->name`.",
-            1670195494
+            1670195494,
         );
     }
 }
diff --git a/src/Definition/Repository/Cache/Compiler/TypeCompiler.php b/src/Definition/Repository/Cache/Compiler/TypeCompiler.php
@@ -138,15 +138,7 @@ public function compile(Type $type): string
 
                 $generics = implode(', ', $generics);
 
-                if ($type instanceof InterfaceType) {
-                    return "new $class('{$type->className()}', [$generics])";
-                }
-
-                $parent = $type->hasParent()
-                    ? $this->compile($type->parent())
-                    : 'null';
-
-                return "new $class('{$type->className()}', [$generics], $parent)";
+                return "new $class('{$type->className()}', [$generics])";
             case $type instanceof ClassStringType:
                 if (null === $type->subType()) {
                     return "new $class()";

diff --git a/src/Definition/Repository/Reflection/ReflectionAttributesRepository.php b/src/Definition/Repository/Reflection/ReflectionAttributesRepository.php
@@ -17,7 +17,7 @@ public function __construct(private ClassDefinitionRepository $classDefinitionRe
 
     public function for(ReflectionAttribute $reflection): AttributeDefinition
     {
-        $class = $this->classDefinitionRepository->for(NativeClassType::for($reflection->getName()));
+        $class = $this->classDefinitionRepository->for(new NativeClassType($reflection->getName()));
 
         return new AttributeDefinition(
             $class,

diff --git a/src/Definition/Repository/Reflection/ReflectionClassDefinitionRepository.php b/src/Definition/Repository/Reflection/ReflectionClassDefinitionRepository.php
@@ -8,8 +8,12 @@
 use CuyZ\Valinor\Definition\Attributes;
 use CuyZ\Valinor\Definition\ClassDefinition;
 use CuyZ\Valinor\Definition\Exception\ClassTypeAliasesDuplication;
+use CuyZ\Valinor\Definition\Exception\ExtendTagTypeError;
+use CuyZ\Valinor\Definition\Exception\InvalidExtendTagClassName;
+use CuyZ\Valinor\Definition\Exception\InvalidExtendTagType;
 use CuyZ\Valinor\Definition\Exception\InvalidTypeAliasImportClass;
 use CuyZ\Valinor\Definition\Exception\InvalidTypeAliasImportClassType;
+use CuyZ\Valinor\Definition\Exception\SeveralExtendTagsFound;
 use CuyZ\Valinor\Definition\Exception\UnknownTypeAliasImport;
 use CuyZ\Valinor\Definition\MethodDefinition;
 use CuyZ\Valinor\Definition\Methods;
@@ -22,17 +26,19 @@
 use CuyZ\Valinor\Type\Parser\Exception\InvalidType;
 use CuyZ\Valinor\Type\Parser\Factory\Specifications\AliasSpecification;
 use CuyZ\Valinor\Type\Parser\Factory\Specifications\ClassContextSpecification;
+use CuyZ\Valinor\Type\Parser\Factory\Specifications\GenericCheckerSpecification;
 use CuyZ\Valinor\Type\Parser\Factory\Specifications\TypeAliasAssignerSpecification;
 use CuyZ\Valinor\Type\Parser\Factory\TypeParserFactory;
 use CuyZ\Valinor\Type\Parser\TypeParser;
 use CuyZ\Valinor\Type\Type;
+use CuyZ\Valinor\Type\Types\NativeClassType;
 use CuyZ\Valinor\Type\Types\UnresolvableType;
+use CuyZ\Valinor\Utility\Reflection\DocParser;
 use CuyZ\Valinor\Utility\Reflection\Reflection;
 use ReflectionAttribute;
 use ReflectionClass;
 use ReflectionMethod;
 use ReflectionProperty;
-use CuyZ\Valinor\Utility\Reflection\DocParser;
 
 use function array_filter;
 use function array_keys;
@@ -138,7 +144,7 @@ private function typeResolver(ClassType $type, ReflectionClass $target): Reflect
         }
 
         while ($type->className() !== $target->name) {
-            $type = $type->parent();
+            $type = $this->parentType($type);
         }
 
         $generics = $type instanceof GenericType ? $type->generics() : [];
@@ -164,6 +170,7 @@ private function typeResolver(ClassType $type, ReflectionClass $target): Reflect
             new ClassContextSpecification($type->className()),
             new AliasSpecification(Reflection::class($type->className())),
             new TypeAliasAssignerSpecification($generics + $localAliases + $importedAliases),
+            new GenericCheckerSpecification(),
         );
 
         $nativeParser = $this->typeParserFactory->get(
@@ -240,6 +247,7 @@ private function typeParser(ClassType $type): TypeParser
         $specs = [
             new ClassContextSpecification($type->className()),
             new AliasSpecification(Reflection::class($type->className())),
+            new GenericCheckerSpecification(),
         ];
 
         if ($type instanceof GenericType) {
@@ -248,4 +256,38 @@ private function typeParser(ClassType $type): TypeParser
 
         return $this->typeParserFactory->get(...$specs);
     }
+
+    private function parentType(ClassType $type): NativeClassType
+    {
+        $reflection = Reflection::class($type->className());
+
+        /** @var ReflectionClass<object> $parentReflection */
+        $parentReflection = $reflection->getParentClass();
+
+        $extendedClass = DocParser::classExtendsTypes($reflection);
+
+        if (count($extendedClass) > 1) {
+            throw new SeveralExtendTagsFound($reflection);
+        } elseif (count($extendedClass) === 0) {
+            $extendedClass = $parentReflection->name;
+        } else {
+            $extendedClass = $extendedClass[0];
+        }
+
+        try {
+            $parentType = $this->typeParser($type)->parse($extendedClass);
+        } catch (InvalidType $exception) {
+            throw new ExtendTagTypeError($reflection, $exception);
+        }
+
+        if (! $parentType instanceof NativeClassType) {
+            throw new InvalidExtendTagType($reflection, $parentType);
+        }
+
+        if ($parentType->className() !== $parentReflection->name) {
+            throw new InvalidExtendTagClassName($reflection, $parentType);
+        }
+
+        return $parentType;
+    }
 }
diff --git a/src/Definition/Repository/Reflection/ReflectionFunctionDefinitionRepository.php b/src/Definition/Repository/Reflection/ReflectionFunctionDefinitionRepository.php
@@ -12,6 +12,7 @@
 use CuyZ\Valinor\Definition\Repository\FunctionDefinitionRepository;
 use CuyZ\Valinor\Type\Parser\Factory\Specifications\AliasSpecification;
 use CuyZ\Valinor\Type\Parser\Factory\Specifications\ClassContextSpecification;
+use CuyZ\Valinor\Type\Parser\Factory\Specifications\GenericCheckerSpecification;
 use CuyZ\Valinor\Type\Parser\Factory\TypeParserFactory;
 use CuyZ\Valinor\Utility\Reflection\Reflection;
 use ReflectionAttribute;
@@ -71,7 +72,10 @@ private function typeResolver(ReflectionFunction $reflection): ReflectionTypeRes
         $class = $reflection->getClosureScopeClass();
 
         $nativeSpecifications = [];
-        $advancedSpecification = [new AliasSpecification($reflection)];
+        $advancedSpecification = [
+            new AliasSpecification($reflection),
+            new GenericCheckerSpecification(),
+        ];
 
         if ($class !== null) {
             $nativeSpecifications[] = new ClassContextSpecification($class->name);

diff --git a/src/Definition/Repository/Reflection/ReflectionTypeResolver.php b/src/Definition/Repository/Reflection/ReflectionTypeResolver.php
@@ -5,6 +5,7 @@
 namespace CuyZ\Valinor\Definition\Repository\Reflection;
 
 use CuyZ\Valinor\Definition\Exception\TypesDoNotMatch;
+use CuyZ\Valinor\Type\GenericType;
 use CuyZ\Valinor\Type\Parser\Exception\InvalidType;
 use CuyZ\Valinor\Type\Parser\TypeParser;
 use CuyZ\Valinor\Type\Type;
@@ -41,6 +42,14 @@ public function resolveType(ReflectionProperty|ReflectionParameter|ReflectionFun
         }
 
         if (! $typeFromDocBlock) {
+            // When the type is a class, it may declare templates that must be
+            // filled with generics. PHP does not handle generics natively, so
+            // we need to make sure that no generics are left unassigned by
+            // parsing the type again using the advanced parser.
+            if ($nativeType instanceof GenericType) {
+                $nativeType = $this->parseType($nativeType->toString(), $reflection, $this->advancedParser);
+            }
+
             return $nativeType;
         }
 

diff --git a/src/Normalizer/Transformer/RecursiveTransformer.php b/src/Normalizer/Transformer/RecursiveTransformer.php
@@ -67,7 +67,7 @@ private function doTransform(mixed $value, WeakMap $references, array $attribute
         }
 
         if (is_object($value)) {
-            $classAttributes = $this->classDefinitionRepository->for(NativeClassType::for($value::class))->attributes;
+            $classAttributes = $this->classDefinitionRepository->for(new NativeClassType($value::class))->attributes;
             $classAttributes = $this->filterAttributes($classAttributes);
 
             $attributes = [...$attributes, ...$classAttributes];
@@ -123,7 +123,7 @@ private function defaultTransformer(mixed $value, WeakMap $references): mixed
 
             $transformed = [];
 
-            $class = $this->classDefinitionRepository->for(NativeClassType::for($value::class));
+            $class = $this->classDefinitionRepository->for(new NativeClassType($value::class));
 
             foreach ($values as $key => $subValue) {
                 $attributes = $this->filterAttributes($class->properties->get($key)->attributes)->toArray();

diff --git a/src/Type/GenericType.php b/src/Type/GenericType.php
@@ -6,7 +6,12 @@
 interface GenericType extends CompositeType
 {
     /**
-     * @return array<string, Type>
+     * @return class-string
+     */
+    public function className(): string;
+
+    /**
+     * @return array<non-empty-string, Type>
      */
     public function generics(): array;
 }
diff --git a/src/Type/Parser/Exception/Generic/MissingGenerics.php b/src/Type/Parser/Exception/Generic/MissingGenerics.php
@@ -19,7 +19,7 @@ final class MissingGenerics extends RuntimeException implements InvalidType
     /**
      * @param class-string $className
      * @param Type[] $generics
-     * @param Type[] $templates
+     * @param array<non-empty-string> $templates
      */
     public function __construct(string $className, array $generics, array $templates)
     {

diff --git a/src/Type/Parser/Factory/LexingTypeParserFactory.php b/src/Type/Parser/Factory/LexingTypeParserFactory.php
@@ -6,7 +6,6 @@
 
 use CuyZ\Valinor\Type\Parser\CachedParser;
 use CuyZ\Valinor\Type\Parser\Factory\Specifications\TypeParserSpecification;
-use CuyZ\Valinor\Type\Parser\Lexer\AdvancedClassLexer;
 use CuyZ\Valinor\Type\Parser\Lexer\NativeLexer;
 use CuyZ\Valinor\Type\Parser\Lexer\ObjectLexer;
 use CuyZ\Valinor\Type\Parser\LexingParser;
@@ -19,29 +18,29 @@ final class LexingTypeParserFactory implements TypeParserFactory
 
     public function get(TypeParserSpecification ...$specifications): TypeParser
     {
-        if (empty($specifications)) {
-            return $this->nativeParser ??= $this->nativeParser();
+        if ($specifications === []) {
+            return $this->nativeParser ??= new CachedParser($this->buildTypeParser());
         }
 
+        return $this->buildTypeParser(...$specifications);
+    }
+
+    private function buildTypeParser(TypeParserSpecification ...$specifications): TypeParser
+    {
         $lexer = new ObjectLexer();
-        $lexer = new AdvancedClassLexer($lexer, $this);
 
         foreach ($specifications as $specification) {
-            $lexer = $specification->transform($lexer);
+            $lexer = $specification->manipulateLexer($lexer);
         }
 
         $lexer = new NativeLexer($lexer);
 
-        return new LexingParser($lexer);
-    }
-
-    private function nativeParser(): TypeParser
-    {
-        $lexer = new ObjectLexer();
-        $lexer = new AdvancedClassLexer($lexer, $this);
-        $lexer = new NativeLexer($lexer);
         $parser = new LexingParser($lexer);
 
-        return new CachedParser($parser);
+        foreach ($specifications as $specification) {
+            $parser = $specification->manipulateParser($parser, $this);
+        }
+
+        return $parser;
     }
 }
diff --git a/src/Type/Parser/Factory/Specifications/AliasSpecification.php b/src/Type/Parser/Factory/Specifications/AliasSpecification.php
@@ -4,8 +4,10 @@
 
 namespace CuyZ\Valinor\Type\Parser\Factory\Specifications;
 
+use CuyZ\Valinor\Type\Parser\Factory\TypeParserFactory;
 use CuyZ\Valinor\Type\Parser\Lexer\AliasLexer;
 use CuyZ\Valinor\Type\Parser\Lexer\TypeLexer;
+use CuyZ\Valinor\Type\Parser\TypeParser;
 use ReflectionClass;
 use ReflectionFunction;
 use Reflector;
@@ -18,8 +20,13 @@ public function __construct(
         private Reflector $reflection
     ) {}
 
-    public function transform(TypeLexer $lexer): TypeLexer
+    public function manipulateLexer(TypeLexer $lexer): TypeLexer
     {
         return new AliasLexer($lexer, $this->reflection);
     }
+
+    public function manipulateParser(TypeParser $parser, TypeParserFactory $typeParserFactory): TypeParser
+    {
+        return $parser;
+    }
 }