Make TypeBuilder extendable

Author: a-melnikov

src/Generator/AwareTypeBaseClassProvider.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator;
+
+use GraphQL\Type\Definition\Type;
+use Overblog\GraphQLBundle\Generator\TypeBaseClassProvider\TypeBaseClassProviderInterface;
+
+final class AwareTypeBaseClassProvider
+{
+    /**
+     * @var TypeBaseClassProviderInterface[]
+     */
+    private array $providers = [];
+
+    public function __construct(iterable $providers)
+    {
+        if ($providers instanceof \Traversable) {
+            $providers = iterator_to_array($providers);
+        }
+        array_walk($providers, fn (TypeBaseClassProviderInterface $x) => $this->addProvider($x));
+    }
+
+    public function addProvider(TypeBaseClassProviderInterface $provider): void
+    {
+        $this->providers[$provider::getType()] = $provider;
+    }
+
+    /**
+     * @return class-string<Type>
+     */
+    public function getFQCN(string $type): string
+    {
+        if (!\array_key_exists($type, $this->providers)) {
+            throw new \InvalidArgumentException(sprintf('Not configured type required: "%s"', $type));
+        }
+
+        return $this->providers[$type]->getBaseClass();
+    }
+}

src/Generator/TypeBaseClassProvider/CustomScalarTypeBaseClassProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator\TypeBaseClassProvider;
+
+use Overblog\GraphQLBundle\Definition\Type\CustomScalarType;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
+final class CustomScalarTypeBaseClassProvider implements TypeBaseClassProviderInterface
+{
+    public static function getType(): string
+    {
+        return TypeEnum::CUSTOM_SCALAR;
+    }
+
+    public function getBaseClass(): string
+    {
+        return CustomScalarType::class;
+    }
+}

src/Generator/TypeBaseClassProvider/EnumTypeBaseClassProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator\TypeBaseClassProvider;
+
+use GraphQL\Type\Definition\EnumType;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
+final class EnumTypeBaseClassProvider implements TypeBaseClassProviderInterface
+{
+    public static function getType(): string
+    {
+        return TypeEnum::ENUM;
+    }
+
+    public function getBaseClass(): string
+    {
+        return EnumType::class;
+    }
+}

src/Generator/TypeBaseClassProvider/InputObjectTypeBaseClassProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator\TypeBaseClassProvider;
+
+use GraphQL\Type\Definition\InputObjectType;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
+final class InputObjectTypeBaseClassProvider implements TypeBaseClassProviderInterface
+{
+    public static function getType(): string
+    {
+        return TypeEnum::INPUT_OBJECT;
+    }
+
+    public function getBaseClass(): string
+    {
+        return InputObjectType::class;
+    }
+}

src/Generator/TypeBaseClassProvider/InterfaceTypeBaseClassProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator\TypeBaseClassProvider;
+
+use GraphQL\Type\Definition\InterfaceType;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
+final class InterfaceTypeBaseClassProvider implements TypeBaseClassProviderInterface
+{
+    public static function getType(): string
+    {
+        return TypeEnum::INTERFACE;
+    }
+
+    public function getBaseClass(): string
+    {
+        return InterfaceType::class;
+    }
+}

src/Generator/TypeBaseClassProvider/ObjectTypeBaseClassProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator\TypeBaseClassProvider;
+
+use GraphQL\Type\Definition\ObjectType;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
+final class ObjectTypeBaseClassProvider implements TypeBaseClassProviderInterface
+{
+    public static function getType(): string
+    {
+        return TypeEnum::OBJECT;
+    }
+
+    public function getBaseClass(): string
+    {
+        return ObjectType::class;
+    }
+}

src/Generator/TypeBaseClassProvider/TypeBaseClassProviderInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator\TypeBaseClassProvider;
+
+use GraphQL\Type\Definition\Type;
+
+interface TypeBaseClassProviderInterface
+{
+    public static function getType(): string;
+
+    /**
+     * @return class-string<Type>
+     */
+    public function getBaseClass(): string;
+}

src/Generator/TypeBaseClassProvider/UnionTypeBaseClassProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Generator\TypeBaseClassProvider;
+
+use GraphQL\Type\Definition\UnionType;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
+final class UnionTypeBaseClassProvider implements TypeBaseClassProviderInterface
+{
+    public static function getType(): string
+    {
+        return TypeEnum::UNION;
+    }
+
+    public function getBaseClass(): string
+    {
+        return UnionType::class;
+    }
+}

src/Generator/TypeBuilder.php

@@ -6,13 +6,8 @@
 
 use GraphQL\Language\AST\NodeKind;
 use GraphQL\Language\Parser;
-use GraphQL\Type\Definition\EnumType;
-use GraphQL\Type\Definition\InputObjectType;
-use GraphQL\Type\Definition\InterfaceType;
-use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\ResolveInfo;
 use GraphQL\Type\Definition\Type;
-use GraphQL\Type\Definition\UnionType;
 use Murtukov\PHPCodeGenerator\ArrowFunction;
 use Murtukov\PHPCodeGenerator\Closure;
 use Murtukov\PHPCodeGenerator\Config;
@@ -25,7 +20,6 @@
 use Overblog\GraphQLBundle\Definition\ConfigProcessor;
 use Overblog\GraphQLBundle\Definition\GraphQLServices;
 use Overblog\GraphQLBundle\Definition\Resolver\AliasedInterface;
-use Overblog\GraphQLBundle\Definition\Type\CustomScalarType;
 use Overblog\GraphQLBundle\Definition\Type\GeneratedTypeInterface;
 use Overblog\GraphQLBundle\Enum\TypeEnum;
 use Overblog\GraphQLBundle\Error\ResolveErrors;
@@ -35,7 +29,6 @@
 use Overblog\GraphQLBundle\Validator\InputValidator;
 use function array_map;
 use function class_exists;
-use function count;
 use function explode;
 use function in_array;
 use function is_array;
@@ -66,15 +59,7 @@ class TypeBuilder
     protected const DOCBLOCK_TEXT = 'THIS FILE WAS GENERATED AND SHOULD NOT BE EDITED MANUALLY.';
     protected const BUILT_IN_TYPES = [Type::STRING, Type::INT, Type::FLOAT, Type::BOOLEAN, Type::ID];
 
-    protected const EXTENDS = [
-        TypeEnum::OBJECT => ObjectType::class,
-        TypeEnum::INPUT_OBJECT => InputObjectType::class,
-        TypeEnum::INTERFACE => InterfaceType::class,
-        TypeEnum::UNION => UnionType::class,
-        TypeEnum::ENUM => EnumType::class,
-        TypeEnum::CUSTOM_SCALAR => CustomScalarType::class,
-    ];
-
+    protected AwareTypeBaseClassProvider $baseClassProvider;
     protected ExpressionConverter $expressionConverter;
     protected PhpFile $file;
     protected string $namespace;
@@ -83,8 +68,9 @@ class TypeBuilder
     protected string $currentField;
     protected string $gqlServices = '$'.TypeGenerator::GRAPHQL_SERVICES;
 
-    public function __construct(ExpressionConverter $expressionConverter, string $namespace)
+    public function __construct(AwareTypeBaseClassProvider $baseClassProvider, ExpressionConverter $expressionConverter, string $namespace)
     {
+        $this->baseClassProvider = $baseClassProvider;
         $this->expressionConverter = $expressionConverter;
         $this->namespace = $namespace;
 
@@ -120,7 +106,7 @@ public function build(array $config, string $type): PhpFile
 
         $class = $this->file->createClass($config['class_name'])
             ->setFinal()
-            ->setExtends(static::EXTENDS[$type])
+            ->setExtends($this->baseClassProvider->getFQCN($type))
             ->addImplements(GeneratedTypeInterface::class, AliasedInterface::class)
             ->addConst('NAME', $config['name'])
             ->setDocBlock(static::DOCBLOCK_TEXT);

src/Resources/config/services.yaml

@@ -5,6 +5,10 @@ services:
     _defaults:
         autowire: true
 
+    _instanceof:
+        Overblog\GraphQLBundle\Generator\TypeBaseClassProvider\TypeBaseClassProviderInterface:
+            tags: [ 'overblog_graphql.type_base_class.provider' ]
+
     Overblog\GraphQLBundle\Executor\Executor: ~
     Overblog\GraphQLBundle\Request\Parser: ~
     Overblog\GraphQLBundle\Request\BatchParser: ~
@@ -106,6 +110,13 @@ services:
         arguments:
             $namespace: '%overblog_graphql.class_namespace%'
 
+    Overblog\GraphQLBundle\Generator\AwareTypeBaseClassProvider:
+        arguments:
+            $providers: !tagged_iterator 'overblog_graphql.type_base_class.provider'
+
+    Overblog\GraphQLBundle\Generator\TypeBaseClassProvider\:
+        resource: '../../Generator/TypeBaseClassProvider/*'
+
     Overblog\GraphQLBundle\Validator\InputValidatorFactory:
         arguments:
             - '@?validator.validator_factory'