Improve doc block reader

Author: SerafimArts

src/Mapping/Driver/ArrayConfigDriver.php

@@ -7,7 +7,7 @@
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\ClassConfigLoaderInterface;
 use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\ErrorMessagePropertyConfigLoader;
-use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\NamePropertyConfigLoader;
+use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\AliasPropertyConfigLoader;
 use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\PropertyConfigLoaderInterface;
 use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\SchemaValidator;
 use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\SkipConditionsPropertyConfigLoader;
@@ -82,7 +82,7 @@ private function createPropertyLoaders(): array
     {
         return [
             new TypePropertyConfigLoader(),
-            new NamePropertyConfigLoader(),
+            new AliasPropertyConfigLoader(),
             new ErrorMessagePropertyConfigLoader(),
             new SkipConditionsPropertyConfigLoader($this->expression),
         ];

src/Mapping/Driver/ArrayConfigDriver/NamePropertyConfigLoader.php renamed to src/Mapping/Driver/ArrayConfigDriver/AliasPropertyConfigLoader.php

@@ -8,7 +8,7 @@
 use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
 use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
 
-final class NamePropertyConfigLoader extends PropertyConfigLoader
+final class AliasPropertyConfigLoader extends PropertyConfigLoader
 {
     public function load(
         array $config,

src/Mapping/Driver/AttributeDriver.php

@@ -8,7 +8,7 @@
 use TypeLang\Mapper\Mapping\Driver\AttributeDriver\ClassMetadataLoaderInterface;
 use TypeLang\Mapper\Mapping\Driver\AttributeDriver\DiscriminatorMapClassMetadataLoader;
 use TypeLang\Mapper\Mapping\Driver\AttributeDriver\ErrorMessagePropertyMetadataLoader;
-use TypeLang\Mapper\Mapping\Driver\AttributeDriver\NamePropertyMetadataLoader;
+use TypeLang\Mapper\Mapping\Driver\AttributeDriver\AliasPropertyMetadataLoader;
 use TypeLang\Mapper\Mapping\Driver\AttributeDriver\NormalizeAsArrayClassMetadataLoader;
 use TypeLang\Mapper\Mapping\Driver\AttributeDriver\PropertyMetadataLoaderInterface;
 use TypeLang\Mapper\Mapping\Driver\AttributeDriver\SkipConditionsPropertyMetadataLoader;
@@ -57,7 +57,7 @@ private function createPropertyLoaders(): array
     {
         return [
             new TypePropertyMetadataLoader(),
-            new NamePropertyMetadataLoader(),
+            new AliasPropertyMetadataLoader(),
             new ErrorMessagePropertyMetadataLoader(),
             new SkipConditionsPropertyMetadataLoader($this->expression),
         ];

src/Mapping/Driver/AttributeDriver/NamePropertyMetadataLoader.php renamed to src/Mapping/Driver/AttributeDriver/AliasPropertyMetadataLoader.php

@@ -9,7 +9,7 @@
 use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
 use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
 
-final class NamePropertyMetadataLoader extends PropertyMetadataLoader
+final class AliasPropertyMetadataLoader extends PropertyMetadataLoader
 {
     /**
      * @throws \Throwable

src/Mapping/Driver/DocBlockDriver.php

@@ -4,17 +4,17 @@
 
 namespace TypeLang\Mapper\Mapping\Driver;
 
-use TypeLang\Mapper\Exception\Definition\PropertyTypeNotFoundException;
-use TypeLang\Mapper\Exception\Definition\TypeNotFoundException;
 use TypeLang\Mapper\Exception\Environment\ComposerPackageRequiredException;
+use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\ClassConfigLoaderInterface;
+use TypeLang\Mapper\Mapping\Driver\ArrayConfigDriver\PropertyConfigLoaderInterface;
+use TypeLang\Mapper\Mapping\Driver\DocBlockDriver\ClassDocBlockLoaderInterface;
 use TypeLang\Mapper\Mapping\Driver\DocBlockDriver\ClassPropertyTypeDriver;
 use TypeLang\Mapper\Mapping\Driver\DocBlockDriver\PromotedPropertyTypeDriver;
+use TypeLang\Mapper\Mapping\Driver\DocBlockDriver\PropertyDocBlockLoaderInterface;
+use TypeLang\Mapper\Mapping\Driver\DocBlockDriver\TypePropertyDocBlockLoader;
 use TypeLang\Mapper\Mapping\Metadata\ClassMetadata;
-use TypeLang\Mapper\Mapping\Metadata\PropertyMetadata;
-use TypeLang\Mapper\Mapping\Metadata\TypeMetadata;
 use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
 use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
-use TypeLang\Parser\Node\Stmt\TypeStatement;
 use TypeLang\PHPDoc\Parser;
 use TypeLang\PHPDoc\Standard\ParamTagFactory;
 use TypeLang\PHPDoc\Standard\VarTagFactory;
@@ -40,6 +40,16 @@ final class DocBlockDriver extends LoadableDriver
 
     private readonly ClassPropertyTypeDriver $classProperties;
 
+    /**
+     * @var list<ClassConfigLoaderInterface>
+     */
+    private readonly array $classDocBlockLoaders;
+
+    /**
+     * @var list<PropertyConfigLoaderInterface>
+     */
+    private readonly array $propertyDocBlockLoaders;
+
     /**
      * @param non-empty-string $paramTagName
      * @param non-empty-string $varTagName
@@ -69,9 +79,34 @@ classProperties: $this->classProperties,
             parser: $parser,
         );
 
+        $this->classDocBlockLoaders = $this->createClassLoaders();
+        $this->propertyDocBlockLoaders = $this->createPropertyLoaders();
+
         parent::__construct($delegate);
     }
 
+    /**
+     * @return list<ClassDocBlockLoaderInterface>
+     */
+    private function createClassLoaders(): array
+    {
+        return [
+        ];
+    }
+
+    /**
+     * @return list<PropertyDocBlockLoaderInterface>
+     */
+    private function createPropertyLoaders(): array
+    {
+        return [
+            new TypePropertyDocBlockLoader(
+                promotedProperties: $this->promotedProperties,
+                classProperties: $this->classProperties,
+            ),
+        ];
+    }
+
     /**
      * @throws ComposerPackageRequiredException
      */
@@ -99,53 +134,33 @@ private static function assertKernelPackageIsInstalled(): void
         }
     }
 
-    /**
-     * @param \ReflectionClass<object> $class
-     *
-     * @throws \ReflectionException
-     */
-    private function findType(\ReflectionClass $class, PropertyMetadata $meta): ?TypeStatement
-    {
-        $property = $class->getProperty($meta->name);
-
-        if ($property->isPromoted()) {
-            return $this->promotedProperties->findType($property, $meta);
-        }
-
-        return $this->classProperties->findType($property);
-    }
-
     #[\Override]
     protected function load(
         \ReflectionClass $reflection,
         ClassMetadata $class,
         TypeRepositoryInterface $types,
         TypeParserInterface $parser,
     ): void {
+        foreach ($this->classDocBlockLoaders as $classDocBlockLoader) {
+            $classDocBlockLoader->load(
+                class: $reflection,
+                metadata: $class,
+                types: $types,
+                parser: $parser,
+            );
+        }
+
         foreach ($reflection->getProperties() as $property) {
             $metadata = $class->getPropertyOrCreate($property->getName());
 
-            $statement = $this->findType($reflection, $metadata);
-
-            if ($statement !== null) {
-                try {
-                    $type = $types->getTypeByStatement($statement, $reflection);
-                } catch (TypeNotFoundException $e) {
-                    throw PropertyTypeNotFoundException::becauseTypeOfPropertyNotDefined(
-                        class: $class->name,
-                        property: $metadata->name,
-                        type: $e->getType(),
-                        previous: $e,
-                    );
-                }
-
-                $metadata->type = new TypeMetadata(
-                    type: $type,
-                    statement: $statement,
+            foreach ($this->propertyDocBlockLoaders as $propertyDocBlockLoader) {
+                $propertyDocBlockLoader->load(
+                    property: $property,
+                    metadata: $metadata,
+                    types: $types,
+                    parser: $parser,
                 );
             }
-
-            $class->addProperty($metadata);
         }
 
         $this->promotedProperties->cleanup();

src/Mapping/Driver/DocBlockDriver/ClassDocBlockLoader.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Mapping\Driver\DocBlockDriver;
+
+abstract class ClassDocBlockLoader implements ClassDocBlockLoaderInterface {}

src/Mapping/Driver/DocBlockDriver/ClassDocBlockLoaderInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Mapping\Driver\DocBlockDriver;
+
+use TypeLang\Mapper\Mapping\Metadata\ClassMetadata;
+use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
+use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
+
+interface ClassDocBlockLoaderInterface
+{
+    /**
+     * @template T of object
+     *
+     * @param \ReflectionClass<T> $class
+     * @param ClassMetadata<T> $metadata
+     */
+    public function load(
+        \ReflectionClass $class,
+        ClassMetadata $metadata,
+        TypeRepositoryInterface $types,
+        TypeParserInterface $parser,
+    ): void;
+}

src/Mapping/Driver/DocBlockDriver/PropertyDocBlockLoader.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Mapping\Driver\DocBlockDriver;
+
+abstract class PropertyDocBlockLoader implements PropertyDocBlockLoaderInterface {}

src/Mapping/Driver/DocBlockDriver/PropertyDocBlockLoaderInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Mapping\Driver\DocBlockDriver;
+
+use TypeLang\Mapper\Mapping\Metadata\PropertyMetadata;
+use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
+use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
+
+interface PropertyDocBlockLoaderInterface
+{
+    public function load(
+        \ReflectionProperty $property,
+        PropertyMetadata $metadata,
+        TypeRepositoryInterface $types,
+        TypeParserInterface $parser,
+    ): void;
+}

src/Mapping/Driver/DocBlockDriver/TypePropertyDocBlockLoader.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Mapping\Driver\DocBlockDriver;
+
+use TypeLang\Mapper\Exception\Definition\PropertyTypeNotFoundException;
+use TypeLang\Mapper\Exception\Definition\TypeNotFoundException;
+use TypeLang\Mapper\Mapping\Metadata\PropertyMetadata;
+use TypeLang\Mapper\Mapping\Metadata\TypeMetadata;
+use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
+use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
+use TypeLang\Parser\Node\Stmt\TypeStatement;
+
+final class TypePropertyDocBlockLoader extends PropertyDocBlockLoader
+{
+    public function __construct(
+        private readonly PromotedPropertyTypeDriver $promotedProperties,
+        private readonly ClassPropertyTypeDriver $classProperties,
+    ) {}
+
+    public function load(
+        \ReflectionProperty $property,
+        PropertyMetadata $metadata,
+        TypeRepositoryInterface $types,
+        TypeParserInterface $parser,
+    ): void {
+        $reflection = $property->getDeclaringClass();
+
+        $statement = $this->findType($reflection, $metadata);
+
+        if ($statement === null) {
+            return;
+        }
+
+        try {
+            $type = $types->getTypeByStatement($statement, $reflection);
+        } catch (TypeNotFoundException $e) {
+            throw PropertyTypeNotFoundException::becauseTypeOfPropertyNotDefined(
+                class: $reflection->name,
+                property: $metadata->name,
+                type: $e->getType(),
+                previous: $e,
+            );
+        }
+
+        $metadata->type = new TypeMetadata(
+            type: $type,
+            statement: $statement,
+        );
+    }
+
+    /**
+     * @param \ReflectionClass<object> $class
+     *
+     * @throws \ReflectionException
+     */
+    private function findType(\ReflectionClass $class, PropertyMetadata $meta): ?TypeStatement
+    {
+        $property = $class->getProperty($meta->name);
+
+        if ($property->isPromoted()) {
+            return $this->promotedProperties->findType($property, $meta);
+        }
+
+        return $this->classProperties->findType($property);
+    }
+}