Add custom scalar type config

Author: Jeremiah VALERIE

src/Generator/AbstractTypeGenerator.php

@@ -31,6 +31,7 @@ function (%s) <closureUseStatements>{
         'enum' => 'GraphQL\\Type\\Definition\\EnumType',
         'union' => 'GraphQL\\Type\\Definition\\UnionType',
         'input-object' => 'GraphQL\\Type\\Definition\\InputObjectType',
+        'custom-scalar' => 'GraphQL\\Type\\Definition\\CustomScalarType',
     ];
 
 

src/Generator/TypeGenerator.php

@@ -123,4 +123,31 @@ protected function generateComplexity(array $value)
     {
         return $this->callableCallbackFromArrayValue($value, 'complexity', '$childrenComplexity, $args = []');
     }
+
+    /**
+     * @param array $value
+     * @return string
+     */
+    protected function generateSerialize(array $value)
+    {
+        return $this->callableCallbackFromArrayValue($value, 'serialize', '$value');
+    }
+
+    /**
+     * @param array $value
+     * @return string
+     */
+    protected function generateParseValue(array $value)
+    {
+        return $this->callableCallbackFromArrayValue($value, 'parseValue', '$value');
+    }
+
+    /**
+     * @param array $value
+     * @return string
+     */
+    protected function generateParseLiteral(array $value)
+    {
+        return $this->callableCallbackFromArrayValue($value, 'parseLiteral', '$value');
+    }
 }

src/Resources/skeleton/CustomScalarConfig.php.skeleton

@@ -0,0 +1,6 @@
+[
+<spaces>'name' => <name>,
+<spaces>'serialize' => <serialize>,
+<spaces>'parseValue' => <parseValue>,
+<spaces>'parseLiteral' => <parseLiteral>,
+]

tests/DateTimeType.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the OverblogGraphQLPhpGenerator package.
+ *
+ * (c) Overblog <http://github.com/overblog/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Overblog\GraphQLGenerator\Tests;
+
+use GraphQL\Language\AST\Node;
+
+class DateTimeType
+{
+    /**
+     * @param \DateTime $value
+     *
+     * @return string
+     */
+    public static function serialize(\DateTime $value)
+    {
+        return $value->format('Y-m-d H:i:s');
+    }
+
+    /**
+     * @param mixed $value
+     *
+     * @return mixed
+     */
+    public static function parseValue($value)
+    {
+        return new \DateTime($value);
+    }
+
+    /**
+     * @param Node $valueNode
+     *
+     * @return string
+     */
+    public static function parseLiteral($valueNode)
+    {
+        return new \DateTime($valueNode->value);
+    }
+}

tests/Resolver.php

@@ -86,4 +86,9 @@ public static function getDroid($root, $args)
         $droids = StarWarsData::droids();
         return isset($droids[$args['id']]) ? $droids[$args['id']] : null;
     }
+
+    public static function getDateTime($root, $args)
+    {
+        return isset($args['dateTime']) ? $args['dateTime'] : new \DateTime('2016-11-28 12:00:00');
+    }
 }

tests/StarWarsIntrospectionTest.php

@@ -36,6 +36,7 @@ public function testAllowsQueryingTheSchemaForTypes()
                     ['name' => 'String'],
                     ['name' => 'Human'],
                     ['name' => 'Droid'],
+                    ['name' => 'DateTime'],
                     ['name' => '__Schema'],
                     ['name' => '__Type'],
                     ['name' => '__TypeKind'],
@@ -358,6 +359,21 @@ public function testAllowsQueryingTheSchemaForFieldArgs()
                                 ],
                             ],
                         ],
+                        [
+                            'name' => 'dateTime',
+                            'args' => [
+                                [
+                                    'name' => 'dateTime',
+                                    'description' => null,
+                                    'type' => [
+                                        'name' => 'DateTime',
+                                        'kind' => 'SCALAR',
+                                        'ofType' => null,
+                                    ],
+                                    'defaultValue' => 'null',
+                                ]
+                            ],
+                        ],
                     ],
                 ],
             ],

tests/StarWarsQueryTest.php

@@ -42,6 +42,7 @@ public function testCorrectlyIdentifiesR2D2AsTheHeroOfTheStarWarsSaga()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     public function testAllowsUsToQueryForTheIDAndFriendsOfR2D2()
     {
         $query = '
@@ -74,6 +75,7 @@ public function testAllowsUsToQueryForTheIDAndFriendsOfR2D2()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     // Nested Queries
     public function testAllowsUsToQueryForTheFriendsOfFriendsOfR2D2()
     {
@@ -130,6 +132,7 @@ public function testAllowsUsToQueryForTheFriendsOfFriendsOfR2D2()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     // Using IDs and query parameters to refetch objects
     public function testAllowsUsToQueryForLukeSkywalkerDirectlyUsingHisID()
     {
@@ -167,6 +170,7 @@ public function testGenericQueryToGetLukeSkywalkerById()
         ];
         $this->assertValidQuery($query, $expected, $params);
     }
+
     public function testGenericQueryToGetHanSoloById()
     {
         // Allows us to create a generic query, then use it to fetch Han Solo using his ID
@@ -187,6 +191,7 @@ public function testGenericQueryToGetHanSoloById()
         ];
         $this->assertValidQuery($query, $expected, $params);
     }
+
     public function testGenericQueryWithInvalidId()
     {
         // Allows us to create a generic query, then pass an invalid ID to get null back
@@ -205,6 +210,7 @@ public function testGenericQueryWithInvalidId()
         ];
         $this->assertValidQuery($query, $expected, $params);
     }
+
     // Using aliases to change the key in the response
     public function testLukeKeyAlias()
     {
@@ -223,6 +229,7 @@ public function testLukeKeyAlias()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     public function testTwoRootKeysAsAnAlias()
     {
         // Allows us to query for both Luke and Leia, using two root fields and an alias
@@ -246,6 +253,7 @@ public function testTwoRootKeysAsAnAlias()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     // Uses fragments to express more complex queries
     public function testQueryUsingDuplicatedContent()
     {
@@ -274,6 +282,7 @@ public function testQueryUsingDuplicatedContent()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     public function testUsingFragment()
     {
         // Allows us to use a fragment to avoid duplicating content
@@ -303,6 +312,7 @@ public function testUsingFragment()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     // Using __typename to find the type of an object
     public function testVerifyThatR2D2IsADroid()
     {
@@ -322,6 +332,7 @@ public function testVerifyThatR2D2IsADroid()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
     public function testVerifyThatLukeIsHuman()
     {
         $query = '
@@ -340,4 +351,19 @@ public function testVerifyThatLukeIsHuman()
         ];
         $this->assertValidQuery($query, $expected);
     }
+
+    public function testDateTime()
+    {
+        $query = '{ dateTime }';
+        $expected = [
+            'dateTime' => '2016-11-28 12:00:00',
+        ];
+        $this->assertValidQuery($query, $expected);
+
+        $query = '{ dateTime(dateTime: "2016-01-18 23:00:00") }';
+        $expected = [
+            'dateTime' => '2016-01-18 23:00:00',
+        ];
+        $this->assertValidQuery($query, $expected);
+    }
 }

tests/starWarsSchema.yml

@@ -1,4 +1,11 @@
 ---
+DateTime:
+    type: custom-scalar
+    config:
+        serialize: ["Overblog\\GraphQLGenerator\\Tests\\DateTimeType", "serialize"]
+        parseValue: ["Overblog\\GraphQLGenerator\\Tests\\DateTimeType", "parseValue"]
+        parseLiteral: ["Overblog\\GraphQLGenerator\\Tests\\DateTimeType", "parseLiteral"]
+
 # Characters in the Star Wars trilogy are either humans or droids.
 #
 # This implements the following type system shorthand:
@@ -152,6 +159,12 @@ Query:
                         description: "id of the droid"
                         type: "String!"
                 resolve: ["Overblog\\GraphQLGenerator\\Tests\\Resolver", "getDroid"]
+            dateTime:
+                type: "DateTime!"
+                args:
+                    dateTime:
+                        type: "DateTime"
+                resolve: ["Overblog\\GraphQLGenerator\\Tests\\Resolver", "getDateTime"]
 
 HumanAndDroid:
     type: union