Add object type builder

Author: Kirill Nesmeyanov

bench/composer.json

@@ -18,10 +18,11 @@
         "phpdocumentor/reflection-docblock": "^5.4",
         "phpdocumentor/type-resolver": "^1.8",
         "symfony/cache": "^5.4|^6.0|^7.0",
-        "symfony/property-access": "^7.1",
-        "symfony/serializer": "^7.1",
+        "symfony/property-access": "^5.4|^6.0|^7.1",
+        "symfony/serializer": "^5.4|^6.0|^7.1",
         "type-lang/phpdoc": "^1.0",
-        "type-lang/phpdoc-standard-tags": "^1.0"
+        "type-lang/phpdoc-standard-tags": "^1.0",
+        "symfony/var-dumper": "^7.1"
     },
     "scripts": {
         "bench": "phpbench run --report=grouped"

example/03.types/04.custom-platform.php

@@ -5,7 +5,7 @@
 use TypeLang\Mapper\Mapper;
 use TypeLang\Mapper\Platform\GrammarFeature;
 use TypeLang\Mapper\Platform\PlatformInterface;
-use TypeLang\Mapper\Type\Builder\ObjectTypeBuilder;
+use TypeLang\Mapper\Type\Builder\ClassTypeBuilder;
 
 require __DIR__ . '/../../vendor/autoload.php';
 
@@ -26,7 +26,7 @@ public function getTypes(): iterable
     {
         // The platform will only support objects, that is,
         // references to existing classes.
-        yield new ObjectTypeBuilder();
+        yield new ClassTypeBuilder();
     }
 
     public function isFeatureSupported(GrammarFeature $feature): bool

src/Mapper.php

@@ -62,7 +62,7 @@ private function createTypeRepository(PlatformInterface $platform): TypeReposito
             delegate: TypeRepository::createFromPlatform(
                 platform: $platform,
                 parser: $this->parser,
-            )
+            ),
         );
 
         if (($tracer = $this->config->getTracer()) !== null) {
@@ -189,4 +189,18 @@ private function getType(mixed $value, ?string $type): TypeInterface
 
         return $this->types->getTypeByDefinition($type);
     }
+
+    /**
+     * @param class-string|object $class
+     * @throws TypeNotFoundException
+     * @throws \Throwable
+     */
+    public function warmup(string|object $class): void
+    {
+        if (\is_object($class)) {
+            $class = $class::class;
+        }
+
+        $this->types->getTypeByDefinition($class);
+    }
 }

src/Platform/StandardPlatform.php

@@ -31,7 +31,6 @@ public function getTypes(): iterable
     {
         // Adds support for the "mixed" type
         yield new Builder\SimpleTypeBuilder('mixed', Type\MixedType::class);
-        yield new Builder\SimpleTypeBuilder('array-key', Type\ArrayKeyType::class);
 
         // Adds support for the "bool" type
         yield new Builder\SimpleTypeBuilder(['bool', 'boolean'], Type\BoolType::class);
@@ -40,13 +39,26 @@ public function getTypes(): iterable
         yield new Builder\SimpleTypeBuilder('string', Type\StringType::class);
 
         // Adds support for the "int" type
-        yield new Builder\SimpleTypeBuilder(['int', 'integer'], Type\IntType::class);
+        yield new Builder\IntRangeTypeBuilder(['int', 'integer']);
 
         // Adds support for the "float" type
         yield new Builder\SimpleTypeBuilder(['float', 'double', 'real'], Type\FloatType::class);
 
         // Adds support for the "array" type
-        yield new Builder\SimpleTypeBuilder('array', Type\ArrayType::class);
+        yield new Builder\ArrayTypeBuilder([
+            'array',
+            'iterable',
+            \Iterator::class,
+            \Generator::class,
+            \Traversable::class,
+            \IteratorAggregate::class,
+        ]);
+
+        // Adds support for the "object" type
+        yield new Builder\ObjectTypeBuilder([
+            'object',
+            \stdClass::class,
+        ]);
 
         // Adds support for the "?T" statement
         yield new Builder\NullableTypeBuilder();
@@ -79,7 +91,7 @@ public function getTypes(): iterable
         yield new Builder\UnitEnumTypeBuilder();
 
         // Adds support for the "Path\To\Class" statement
-        yield new Builder\ObjectTypeBuilder($this->driver);
+        yield new Builder\ClassTypeBuilder($this->driver);
     }
 
     public function isFeatureSupported(GrammarFeature $feature): bool

src/Type/ArrayType.php

@@ -31,10 +31,15 @@ public function __construct(
 
     public function match(mixed $value, Context $context): bool
     {
-        if (!\is_array($value)) {
+        if (!\is_iterable($value)) {
             return false;
         }
 
+        // Force return true if the iterator does not allow rewinding.
+        if ($value instanceof \Generator) {
+            return true;
+        }
+
         foreach ($value as $key => $item) {
             $entrance = $context->enter($item, new ArrayIndexEntry($key));
 

src/Type/Builder/ClassTypeBuilder.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Type\Builder;
+
+use TypeLang\Mapper\Mapping\Driver\DriverInterface;
+use TypeLang\Mapper\Mapping\Driver\ReflectionDriver;
+use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
+use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
+use TypeLang\Mapper\Type\ClassType;
+use TypeLang\Mapper\Type\ClassType\ClassInstantiator\ClassInstantiatorInterface;
+use TypeLang\Mapper\Type\ClassType\ClassInstantiator\ReflectionClassInstantiator;
+use TypeLang\Mapper\Type\ClassType\PropertyAccessor\PropertyAccessorInterface;
+use TypeLang\Mapper\Type\ClassType\PropertyAccessor\ReflectionPropertyAccessor;
+use TypeLang\Parser\Node\Stmt\NamedTypeNode;
+use TypeLang\Parser\Node\Stmt\TypeStatement;
+
+/**
+ * Creates an {@see ClassType} from a type name containing a reference to an
+ * existing class.
+ *
+ * @template T of object
+ * @template-extends Builder<NamedTypeNode, ClassType<T>>
+ */
+class ClassTypeBuilder extends Builder
+{
+    public function __construct(
+        protected readonly DriverInterface $driver = new ReflectionDriver(),
+        protected readonly PropertyAccessorInterface $accessor = new ReflectionPropertyAccessor(),
+        protected readonly ClassInstantiatorInterface $instantiator = new ReflectionClassInstantiator(),
+    ) {}
+
+    /**
+     * Returns {@see true} if the type contains a reference to an existing class.
+     */
+    public function isSupported(TypeStatement $statement): bool
+    {
+        if (!$statement instanceof NamedTypeNode) {
+            return false;
+        }
+
+        /** @var non-empty-string $name */
+        $name = $statement->name->toString();
+
+        if (!\class_exists($name)) {
+            return false;
+        }
+
+        $reflection = new \ReflectionClass($name);
+
+        return $reflection->isInstantiable();
+    }
+
+    public function build(
+        TypeStatement $statement,
+        TypeRepositoryInterface $types,
+        TypeParserInterface $parser,
+    ): ClassType {
+        $this->expectNoShapeFields($statement);
+        $this->expectNoTemplateArguments($statement);
+
+        /** @var class-string<T> $class */
+        $class = $statement->name->toString();
+
+        $metadata = $this->driver->getClassMetadata(
+            class: new \ReflectionClass($class),
+            types: $types,
+            parser: $parser,
+        );
+
+        return new ClassType(
+            metadata: $metadata,
+            accessor: $this->accessor,
+            instantiator: $this->instantiator,
+        );
+    }
+}

src/Type/Builder/ObjectTypeBuilder.php

@@ -4,54 +4,16 @@
 
 namespace TypeLang\Mapper\Type\Builder;
 
-use TypeLang\Mapper\Mapping\Driver\DriverInterface;
-use TypeLang\Mapper\Mapping\Driver\ReflectionDriver;
 use TypeLang\Mapper\Runtime\Parser\TypeParserInterface;
 use TypeLang\Mapper\Runtime\Repository\TypeRepositoryInterface;
 use TypeLang\Mapper\Type\ObjectType;
-use TypeLang\Mapper\Type\ObjectType\ObjectInstantiator\ObjectInstantiatorInterface;
-use TypeLang\Mapper\Type\ObjectType\ObjectInstantiator\ReflectionObjectInstantiator;
-use TypeLang\Mapper\Type\ObjectType\PropertyAccessor\PropertyAccessorInterface;
-use TypeLang\Mapper\Type\ObjectType\PropertyAccessor\ReflectionPropertyAccessor;
-use TypeLang\Parser\Node\Stmt\NamedTypeNode;
 use TypeLang\Parser\Node\Stmt\TypeStatement;
 
 /**
- * Creates an {@see ObjectType} from a type name containing a reference to an
- * existing class.
- *
- * @template T of object
- * @template-extends Builder<NamedTypeNode, ObjectType<T>>
+ * @template-extends NamedTypeBuilder<ObjectType>
  */
-class ObjectTypeBuilder extends Builder
+class ObjectTypeBuilder extends NamedTypeBuilder
 {
-    public function __construct(
-        protected readonly DriverInterface $driver = new ReflectionDriver(),
-        protected readonly PropertyAccessorInterface $accessor = new ReflectionPropertyAccessor(),
-        protected readonly ObjectInstantiatorInterface $instantiator = new ReflectionObjectInstantiator(),
-    ) {}
-
-    /**
-     * Returns {@see true} if the type contains a reference to an existing class.
-     */
-    public function isSupported(TypeStatement $statement): bool
-    {
-        if (!$statement instanceof NamedTypeNode) {
-            return false;
-        }
-
-        /** @var non-empty-string $name */
-        $name = $statement->name->toString();
-
-        if (!\class_exists($name)) {
-            return false;
-        }
-
-        $reflection = new \ReflectionClass($name);
-
-        return $reflection->isInstantiable();
-    }
-
     public function build(
         TypeStatement $statement,
         TypeRepositoryInterface $types,
@@ -60,19 +22,6 @@ public function build(
         $this->expectNoShapeFields($statement);
         $this->expectNoTemplateArguments($statement);
 
-        /** @var class-string<T> $class */
-        $class = $statement->name->toString();
-
-        $metadata = $this->driver->getClassMetadata(
-            class: new \ReflectionClass($class),
-            types: $types,
-            parser: $parser,
-        );
-
-        return new ObjectType(
-            metadata: $metadata,
-            accessor: $this->accessor,
-            instantiator: $this->instantiator,
-        );
+        return new ObjectType();
     }
 }

src/Type/ClassType.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Mapper\Type;
+
+use TypeLang\Mapper\Mapping\Metadata\ClassMetadata;
+use TypeLang\Mapper\Type\ClassType\ClassInstantiator\ClassInstantiatorInterface;
+use TypeLang\Mapper\Type\ClassType\ClassTypeDenormalizer;
+use TypeLang\Mapper\Type\ClassType\ClassTypeNormalizer;
+use TypeLang\Mapper\Type\ClassType\PropertyAccessor\PropertyAccessorInterface;
+
+/**
+ * @template T of object
+ * @template-extends AsymmetricType<ClassTypeNormalizer<T>, ClassTypeDenormalizer<T>>
+ */
+class ClassType extends AsymmetricType
+{
+    /**
+     * @param ClassMetadata<T> $metadata
+     */
+    public function __construct(
+        ClassMetadata $metadata,
+        PropertyAccessorInterface $accessor,
+        ClassInstantiatorInterface $instantiator,
+    ) {
+        parent::__construct(
+            normalizer: new ClassTypeNormalizer(
+                metadata: $metadata,
+                accessor: $accessor,
+            ),
+            denormalizer: new ClassTypeDenormalizer(
+                metadata: $metadata,
+                accessor: $accessor,
+                instantiator: $instantiator,
+            ),
+        );
+    }
+}

src/Type/ObjectType/ObjectInstantiator/ObjectInstantiatorInterface.php renamed to src/Type/ClassType/ClassInstantiator/ClassInstantiatorInterface.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace TypeLang\Mapper\Type\ObjectType\ObjectInstantiator;
+namespace TypeLang\Mapper\Type\ClassType\ClassInstantiator;
 
 use TypeLang\Mapper\Mapping\Metadata\ClassMetadata;
 
-interface ObjectInstantiatorInterface
+interface ClassInstantiatorInterface
 {
     /**
      * @template T of object

src/Type/ObjectType/ObjectInstantiator/ReflectionObjectInstantiator.php renamed to src/Type/ClassType/ClassInstantiator/ReflectionClassInstantiator.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace TypeLang\Mapper\Type\ObjectType\ObjectInstantiator;
+namespace TypeLang\Mapper\Type\ClassType\ClassInstantiator;
 
 use TypeLang\Mapper\Mapping\Metadata\ClassMetadata;
 
-final class ReflectionObjectInstantiator implements ObjectInstantiatorInterface
+final class ReflectionClassInstantiator implements ClassInstantiatorInterface
 {
     public function instantiate(ClassMetadata $class): object
     {