Use base type enum

a-melnikov · a-melnikov · commit 547f00cd1aab · 2022-07-27T17:09:29.000+03:00
diff --git a/src/Config/Parser/GraphQL/ASTConverter/CustomScalarNode.php b/src/Config/Parser/GraphQL/ASTConverter/CustomScalarNode.php
@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
 use GraphQL\Language\AST\Node;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use RuntimeException;
 
 class CustomScalarNode implements NodeInterface
@@ -19,7 +20,7 @@ public static function toConfig(Node $node): array
         ];
 
         return [
-            'type' => 'custom-scalar',
+            'type' => TypeEnum::CUSTOM_SCALAR,
             'config' => $config,
         ];
     }
diff --git a/src/Config/Parser/GraphQL/ASTConverter/EnumNode.php b/src/Config/Parser/GraphQL/ASTConverter/EnumNode.php
@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
 use GraphQL\Language\AST\Node;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 
 class EnumNode implements NodeInterface
 {
@@ -28,7 +29,7 @@ public static function toConfig(Node $node): array
         $config['values'] = $values;
 
         return [
-            'type' => 'enum',
+            'type' => TypeEnum::ENUM,
             'config' => $config,
         ];
     }
diff --git a/src/Config/Parser/GraphQL/ASTConverter/InputObjectNode.php b/src/Config/Parser/GraphQL/ASTConverter/InputObjectNode.php
@@ -4,7 +4,9 @@
 
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
 class InputObjectNode extends ObjectNode
 {
-    protected const TYPENAME = 'input-object';
+    protected const TYPENAME = TypeEnum::INPUT_OBJECT;
 }
diff --git a/src/Config/Parser/GraphQL/ASTConverter/InterfaceNode.php b/src/Config/Parser/GraphQL/ASTConverter/InterfaceNode.php
@@ -4,7 +4,9 @@
 
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
 class InterfaceNode extends ObjectNode
 {
-    protected const TYPENAME = 'interface';
+    protected const TYPENAME = TypeEnum::INTERFACE;
 }
diff --git a/src/Config/Parser/GraphQL/ASTConverter/ObjectNode.php b/src/Config/Parser/GraphQL/ASTConverter/ObjectNode.php
@@ -6,10 +6,11 @@
 
 use GraphQL\Language\AST\Node;
 use GraphQL\Language\AST\ObjectTypeDefinitionNode;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 
 class ObjectNode implements NodeInterface
 {
-    protected const TYPENAME = 'object';
+    protected const TYPENAME = TypeEnum::OBJECT;
 
     public static function toConfig(Node $node): array
     {
diff --git a/src/Config/Parser/GraphQL/ASTConverter/UnionNode.php b/src/Config/Parser/GraphQL/ASTConverter/UnionNode.php
@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
 use GraphQL\Language\AST\Node;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 
 class UnionNode implements NodeInterface
 {
@@ -21,7 +22,7 @@ public static function toConfig(Node $node): array
         }
 
         return [
-            'type' => 'union',
+            'type' => TypeEnum::UNION,
             'config' => $config,
         ];
     }
diff --git a/src/Config/Parser/MetadataParser/MetadataParser.php b/src/Config/Parser/MetadataParser/MetadataParser.php
@@ -12,6 +12,7 @@
 use Overblog\GraphQLBundle\Config\Parser\MetadataParser\TypeGuesser\TypeGuessingException;
 use Overblog\GraphQLBundle\Config\Parser\MetadataParser\TypeGuesser\TypeHintTypeGuesser;
 use Overblog\GraphQLBundle\Config\Parser\PreParserInterface;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use Overblog\GraphQLBundle\Relay\Connection\ConnectionInterface;
 use Overblog\GraphQLBundle\Relay\Connection\EdgeInterface;
 use ReflectionClass;
@@ -169,7 +170,7 @@ private static function classMetadatasToGQLConfiguration(
                         if (!$edgeType) {
                             $edgeType = $gqlName.'Edge';
                             $gqlTypes[$edgeType] = [
-                                'type' => 'object',
+                                'type' => TypeEnum::OBJECT,
                                 'config' => [
                                     'builders' => [
                                         ['builder' => 'relay-edge', 'builderConfig' => ['nodeType' => $classMetadata->node]],
@@ -397,7 +398,7 @@ private static function inputMetadataToGQLConfiguration(ReflectionClass $reflect
             'fields' => self::getGraphQLInputFieldsFromMetadatas($reflectionClass, self::getClassProperties($reflectionClass)),
         ], self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)));
 
-        return ['type' => $inputAnnotation->isRelay ? 'relay-mutation-input' : 'input-object', 'config' => $inputConfiguration];
+        return ['type' => $inputAnnotation->isRelay ? 'relay-mutation-input' : TypeEnum::INPUT_OBJECT, 'config' => $inputConfiguration];
     }
 
     /**
@@ -421,7 +422,7 @@ private static function scalarMetadataToGQLConfiguration(ReflectionClass $reflec
 
         $scalarConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $scalarConfiguration;
 
-        return ['type' => 'custom-scalar', 'config' => $scalarConfiguration];
+        return ['type' => TypeEnum::CUSTOM_SCALAR, 'config' => $scalarConfiguration];
     }
 
     /**
@@ -459,7 +460,7 @@ private static function enumMetadataToGQLConfiguration(ReflectionClass $reflecti
         $enumConfiguration = ['values' => $values];
         $enumConfiguration = self::getDescriptionConfiguration(static::getMetadatas($reflectionClass)) + $enumConfiguration;
 
-        return ['type' => 'enum', 'config' => $enumConfiguration];
+        return ['type' => TypeEnum::ENUM, 'config' => $enumConfiguration];
     }
 
     /**
@@ -504,7 +505,7 @@ private static function unionMetadataToGQLConfiguration(ReflectionClass $reflect
             }
         }
 
-        return ['type' => 'union', 'config' => $unionConfiguration];
+        return ['type' => TypeEnum::UNION, 'config' => $unionConfiguration];
     }
 
     /**
diff --git a/src/Config/Processor/InheritanceProcessor.php b/src/Config/Processor/InheritanceProcessor.php
@@ -6,6 +6,7 @@
 
 use Exception;
 use InvalidArgumentException;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use function array_column;
 use function array_filter;
 use function array_flip;
@@ -80,8 +81,8 @@ private static function processConfigsInherits(array $configs): array
             }
 
             $allowedTypes = [$config['type']];
-            if ('object' === $config['type']) {
-                $allowedTypes[] = 'interface';
+            if (TypeEnum::OBJECT === $config['type']) {
+                $allowedTypes[] = TypeEnum::INTERFACE;
             }
             $flattenInherits = self::flattenInherits($name, $configs, $allowedTypes);
             if (empty($flattenInherits)) {
@@ -106,7 +107,7 @@ private static function inheritsTypeConfig(string $child, array $parents, array
         $mergedParentsConfig = self::mergeConfigs(...array_column($parentTypes, 'config'));
         $childType = $configs[$child];
         // unset resolveType field resulting from the merge of a "interface" type
-        if ('object' === $childType['type']) {
+        if (TypeEnum::OBJECT === $childType['type']) {
             unset($mergedParentsConfig['resolveType']);
         }
 
diff --git a/src/DependencyInjection/TypesConfiguration.php b/src/DependencyInjection/TypesConfiguration.php
@@ -6,6 +6,7 @@
 
 use Overblog\GraphQLBundle\Config;
 use Overblog\GraphQLBundle\Config\Processor\InheritanceProcessor;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
@@ -22,12 +23,12 @@
 class TypesConfiguration implements ConfigurationInterface
 {
     private static array $types = [
-        'object',
-        'enum',
-        'interface',
-        'union',
-        'input-object',
-        'custom-scalar',
+        TypeEnum::OBJECT,
+        TypeEnum::ENUM,
+        TypeEnum::INTERFACE,
+        TypeEnum::UNION,
+        TypeEnum::INPUT_OBJECT,
+        TypeEnum::CUSTOM_SCALAR,
     ];
 
     public function getConfigTreeBuilder(): TreeBuilder
diff --git a/src/Enum/TypeEnum.php b/src/Enum/TypeEnum.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Enum;
+
+class TypeEnum
+{
+    public const OBJECT = 'object';
+    public const INPUT_OBJECT = 'input-object';
+    public const INTERFACE = 'interface';
+    public const UNION = 'union';
+    public const ENUM = 'enum';
+    public const CUSTOM_SCALAR = 'custom-scalar';
+
+    private function __construct()
+    {
+        // forbid creation of an object
+    }
+}
diff --git a/src/Generator/TypeBuilder.php b/src/Generator/TypeBuilder.php
@@ -27,6 +27,7 @@
 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;
 use Overblog\GraphQLBundle\ExpressionLanguage\ExpressionLanguage as EL;
 use Overblog\GraphQLBundle\Generator\Converter\ExpressionConverter;
@@ -66,12 +67,12 @@ class TypeBuilder
     protected const BUILT_IN_TYPES = [Type::STRING, Type::INT, Type::FLOAT, Type::BOOLEAN, Type::ID];
 
     protected const EXTENDS = [
-        'object' => ObjectType::class,
-        'input-object' => InputObjectType::class,
-        'interface' => InterfaceType::class,
-        'union' => UnionType::class,
-        'enum' => EnumType::class,
-        'custom-scalar' => CustomScalarType::class,
+        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 ExpressionConverter $expressionConverter;
@@ -344,7 +345,7 @@ protected function buildConfig(array $config): Collection
         }
 
         // only by custom-scalar types
-        if ('custom-scalar' === $this->type) {
+        if (TypeEnum::CUSTOM_SCALAR === $this->type) {
             if (isset($c->scalarType)) {
                 $configLoader->addItem('scalarType', $c->scalarType);
             }
@@ -755,7 +756,7 @@ public function buildField(array $fieldConfig, string $fieldname)
             $field->addItem('useStrictAccess', false);
         }
 
-        if ('input-object' === $this->type) {
+        if (TypeEnum::INPUT_OBJECT === $this->type) {
             if (property_exists($c, 'defaultValue')) {
                 $field->addItem('defaultValue', $c->defaultValue);
             }
diff --git a/src/Relay/Connection/ConnectionDefinition.php b/src/Relay/Connection/ConnectionDefinition.php
@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Relay\Connection;
 
 use Overblog\GraphQLBundle\Definition\Builder\MappingInterface;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use function array_merge;
 use function is_array;
 use function is_string;
@@ -33,7 +34,7 @@ public function toMappingDefinition(array $config): array
 
         return [
             $edgeAlias => [
-                'type' => 'object',
+                'type' => TypeEnum::OBJECT,
                 'config' => [
                     'name' => $edgeName,
                     'description' => 'An edge in a connection.',
@@ -55,7 +56,7 @@ public function toMappingDefinition(array $config): array
                 ],
             ],
             $connectionAlias => [
-                'type' => 'object',
+                'type' => TypeEnum::OBJECT,
                 'config' => [
                     'name' => $connectionName,
                     'description' => 'A connection to a list of items.',
diff --git a/src/Relay/Mutation/InputDefinition.php b/src/Relay/Mutation/InputDefinition.php
@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Relay\Mutation;
 
 use Overblog\GraphQLBundle\Definition\Builder\MappingInterface;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use function array_merge;
 use function is_array;
 use function preg_replace;
@@ -21,7 +22,7 @@ public function toMappingDefinition(array $config): array
 
         return [
             $alias => [
-                'type' => 'input-object',
+                'type' => TypeEnum::INPUT_OBJECT,
                 'config' => [
                     'name' => $name,
                     'fields' => array_merge(
diff --git a/src/Relay/Mutation/PayloadDefinition.php b/src/Relay/Mutation/PayloadDefinition.php
@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Relay\Mutation;
 
 use Overblog\GraphQLBundle\Definition\Builder\MappingInterface;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use function array_merge;
 use function is_array;
 use function preg_replace;
@@ -20,7 +21,7 @@ public function toMappingDefinition(array $config): array
 
         return [
             $alias => [
-                'type' => 'object',
+                'type' => TypeEnum::OBJECT,
                 'config' => [
                     'name' => $name,
                     'fields' => array_merge(

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;`
`6`	`6`
`7`	`7`	`use GraphQL\Language\AST\Node;`
	`8`	`+use Overblog\GraphQLBundle\Enum\TypeEnum;`
`8`	`9`
`9`	`10`	`class EnumNode implements NodeInterface`
`10`	`11`	`{`
`@@ -28,7 +29,7 @@ public static function toConfig(Node $node): array`
`28`	`29`	`$config['values'] = $values;`
`29`	`30`
`30`	`31`	`return [`
`31`		`- 'type' => 'enum',`
	`32`	`+ 'type' => TypeEnum::ENUM,`
`32`	`33`	`'config' => $config,`
`33`	`34`	`];`
`34`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;`
`6`	`6`
	`7`	`+use Overblog\GraphQLBundle\Enum\TypeEnum;`
	`8`	`+`
`7`	`9`	`class InputObjectNode extends ObjectNode`
`8`	`10`	`{`
`9`		`- protected const TYPENAME = 'input-object';`
	`11`	`+ protected const TYPENAME = TypeEnum::INPUT_OBJECT;`
`10`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,11 @@`
`6`	`6`
`7`	`7`	`use GraphQL\Language\AST\Node;`
`8`	`8`	`use GraphQL\Language\AST\ObjectTypeDefinitionNode;`
	`9`	`+use Overblog\GraphQLBundle\Enum\TypeEnum;`
`9`	`10`
`10`	`11`	`class ObjectNode implements NodeInterface`
`11`	`12`	`{`
`12`		`- protected const TYPENAME = 'object';`
	`13`	`+ protected const TYPENAME = TypeEnum::OBJECT;`
`13`	`14`
`14`	`15`	`public static function toConfig(Node $node): array`
`15`	`16`	`{`