Introduce InputFieldBuilder and InputObjectBuilder

Author: simPod

README.md

@@ -32,7 +32,16 @@ composer require simpod/graphql-utils
 
 ### Schema Builders
 
-Instead of defining your schema as an array, use can use more objective-oriented approach. This library provides set of strictly typed builders that help you build your schema.
+Instead of defining your schema as an array, use can use more objective-oriented approach. This library provides set of strictly typed builders that help you build your schema:
+
+- EnumBuilder
+- FieldBuilder
+- InputFieldBuilder
+- InputObjectBuilder
+- InterfaceBuilder
+- ObjectBuilder
+- TypeBuilder
+- UnionBuilder
 
 #### ObjectBuilder and FieldBuilder
 

src/Builder/InputFieldBuilder.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\GraphQLUtils\Builder;
+
+use ReflectionProperty;
+
+class InputFieldBuilder
+{
+    private string $name;
+
+    private mixed $type;
+
+    private string|null $description = null;
+
+    private mixed $defaultValue;
+
+    final private function __construct(string $name, mixed $type)
+    {
+        $this->name = $name;
+        $this->type = $type;
+    }
+
+    /**
+     * @return static
+     */
+    public static function create(string $name, mixed $type): self
+    {
+        return new static($name, $type);
+    }
+
+    /**
+     * @return $this
+     */
+    public function setDefaultValue(mixed $defaultValue): self
+    {
+        $this->defaultValue = $defaultValue;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setDescription(string $description): self
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
+    /**
+     * @psalm-return array<string, mixed>
+     */
+    public function build(): array
+    {
+        $config = [
+            'name' => $this->name,
+            'description' => $this->description,
+            'type' => $this->type,
+        ];
+
+        $property = new ReflectionProperty($this, 'defaultValue');
+        $property->setAccessible(true);
+        if ($property->isInitialized($this)) {
+            /** @psalm-suppress MixedAssignment */
+            $config['defaultValue'] = $this->defaultValue;
+        }
+
+        return $config;
+    }
+}

src/Builder/InputObjectBuilder.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\GraphQLUtils\Builder;
+
+use GraphQL\Type\Definition\InputObjectField;
+
+class InputObjectBuilder extends TypeBuilder
+{
+    /** @var callable():array<string, mixed>|array<string, mixed>|InputObjectField */
+    private $fields = [];
+
+    /**
+     * @return static
+     */
+    public static function create(string $name): self
+    {
+        return new static($name);
+    }
+
+    /**
+     * @param callable():array<string, mixed>|array<string, mixed>|InputObjectField $fields
+     *
+     * @return $this
+     */
+    public function setFields(callable|array $fields): self
+    {
+        $this->fields = $fields;
+
+        return $this;
+    }
+
+    /**
+     * @psalm-return array<string, mixed>
+     */
+    public function build(): array
+    {
+        return [
+            'name' => $this->name,
+            'description' => $this->description,
+            'fields' => $this->fields,
+        ];
+    }
+}

src/Builder/TypeBuilder.php

@@ -12,9 +12,9 @@ abstract class TypeBuilder
 {
     public const VALID_NAME_PATTERN = '~^[_a-zA-Z][_a-zA-Z0-9]*$~';
 
-    private string $name;
+    protected string $name;
 
-    private ?string $description = null;
+    protected ?string $description = null;
 
     final protected function __construct(string $name)
     {

tests/Builder/InputFieldBuilderTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\GraphQLUtils\Tests\Builder;
+
+use GraphQL\Type\Definition\Type;
+use PHPUnit\Framework\TestCase;
+use SimPod\GraphQLUtils\Builder\InputFieldBuilder;
+
+final class InputFieldBuilderTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $field = InputFieldBuilder::create('SomeField', Type::string())
+            ->setDefaultValue(null)
+            ->setDeprecationReason('Deprecated')
+            ->setDescription('SomeDescription')
+            ->build();
+
+        self::assertSame('SomeField', $field['name']);
+        self::assertArrayHasKey('deprecationReason', $field);
+        self::assertSame('Deprecated', $field['deprecationReason']);
+        self::assertArrayHasKey('defaultValue', $field);
+        self::assertNull($field['defaultValue']);
+        self::assertArrayHasKey('description', $field);
+        self::assertSame('SomeDescription', $field['description']);
+    }
+
+    public function testCreateWithoutDefaultValue(): void
+    {
+        $field = InputFieldBuilder::create('SomeField', Type::string())
+            ->build();
+
+        self::assertArrayNotHasKey('defaultValue', $field);
+    }
+}

tests/Builder/InputObjectBuilderTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\GraphQLUtils\Tests\Builder;
+
+use GraphQL\Type\Definition\InputObjectField;
+use GraphQL\Type\Definition\InterfaceType;
+use GraphQL\Type\Definition\Type;
+use PHPUnit\Framework\TestCase;
+use SimPod\GraphQLUtils\Builder\InputFieldBuilder;
+use SimPod\GraphQLUtils\Builder\InputObjectBuilder;
+use SimPod\GraphQLUtils\Builder\InterfaceBuilder;
+
+final class InputObjectBuilderTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $description = 'To the sichuan-style nachos add ghee, noodles, buttermilk and heated herring.';
+        $name        = 'SomeType';
+        $interface   = new class () extends InterfaceType {
+            public function __construct()
+            {
+                $builder = InterfaceBuilder::create('InterfaceA');
+                parent::__construct($builder->build());
+            }
+        };
+
+        $fieldResolver = static function (): void {
+        };
+
+        $builder = InputObjectBuilder::create($name);
+        $object  = $builder
+            ->setDescription($description)
+            ->setFields(
+                [
+                    InputFieldBuilder::create('SomeField', Type::string())->build(),
+                    new InputObjectField(InputFieldBuilder::create('Another', Type::string())->build()),
+                ]
+            )
+            ->build();
+
+        self::assertArrayHasKey('name', $object);
+        self::assertSame($name, $object['name']);
+        self::assertArrayHasKey('description', $object);
+        self::assertSame($description, $object['description']);
+        self::assertIsArray($object['fields']);
+        self::assertCount(2, $object['fields']);
+    }
+}