Merge pull request #6 from moufmouf/datetime_typehint

Adding support for type-hinting against DateTime and DateTimeInterface

Author: moufmouf

README.md

@@ -44,6 +44,16 @@ class UserController
 }
 ```
 
+Your methods can type-hint against:
+
+- int
+- string
+- bool
+- float
+- DateTimeImmutable or DateTimeInterface
+- an array
+- any object (if you provide an hydrator for the object type)
+
 There is an additional support for authentication and authorization:
 
 ```php
@@ -65,7 +75,28 @@ class UserController
 }
 ```
 
+Type-hinting against arrays
+---------------------------
+
+You can type-hint against arrays as long as you document the PHP-Doc correctly:
+
+```php
+/**
+ * @Query
+ * @return User[] <=== we specify that the array is an array of User objects.
+ */
+public function users(int $limit, int $offset): array
+{
+    // Some code that returns an array of "users".
+    // This completely replaces the "resolve" method.
+}
+```
+
+Type-hinting against objects
+----------------------------
 
+When you specify an object type-hint, graphql-controllers will delegate the object creation to an hydrator.
+You must pass this hydrator in parameter when building the `ControllerQueryProvider`.
 
 Troubleshooting
 ---------------

src/ControllerQueryProvider.php

@@ -5,6 +5,8 @@
 
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\Array_;
+use phpDocumentor\Reflection\Types\Boolean;
+use phpDocumentor\Reflection\Types\Float_;
 use phpDocumentor\Reflection\Types\Mixed;
 use phpDocumentor\Reflection\Types\Object_;
 use phpDocumentor\Reflection\Types\String_;
@@ -21,6 +23,9 @@
 use Youshido\GraphQL\Field\Field;
 use Youshido\GraphQL\Type\ListType\ListType;
 use Youshido\GraphQL\Type\NonNullType;
+use Youshido\GraphQL\Type\Scalar\BooleanType;
+use Youshido\GraphQL\Type\Scalar\DateTimeType;
+use Youshido\GraphQL\Type\Scalar\FloatType;
 use Youshido\GraphQL\Type\Scalar\IntType;
 use Youshido\GraphQL\Type\Scalar\StringType;
 use Youshido\GraphQL\Type\TypeInterface;
@@ -219,7 +224,18 @@ private function toGraphQlType(Type $type): TypeInterface
             return new IntType();
         } elseif ($type instanceof String_) {
             return new StringType();
+        } elseif ($type instanceof Boolean) {
+            return new BooleanType();
+        } elseif ($type instanceof Float_) {
+            return new FloatType();
         } elseif ($type instanceof Object_) {
+            $fqcn = (string) $type->getFqsen();
+            if ($fqcn === '\\DateTimeImmutable' || $fqcn === '\\DateTimeInterface') {
+                return new DateTimeType();
+            } elseif ($fqcn === '\\DateTime') {
+                throw new GraphQLException('Type-hinting a parameter against DateTime is not allowed. Please use the DateTimeImmutable type instead.');
+            }
+
             return $this->typeMapper->mapClassToType(ltrim($type->getFqsen(), '\\'));
         } elseif ($type instanceof Array_) {
             return new ListType(new NonNullType($this->toGraphQlType($type->getValueType())));

src/GraphQLException.php

@@ -0,0 +1,9 @@
+<?php
+
+
+namespace TheCodingMachine\GraphQL\Controllers;
+
+
+class GraphQLException extends \RuntimeException
+{
+}

src/QueryField.php

@@ -10,6 +10,7 @@
 use Youshido\GraphQL\Type\ListType\ListType;
 use Youshido\GraphQL\Type\NonNullType;
 use Youshido\GraphQL\Type\Object\AbstractObjectType;
+use Youshido\GraphQL\Type\Scalar\DateTimeType;
 use Youshido\GraphQL\Type\TypeInterface;
 use Youshido\GraphQL\Type\TypeMap;
 
@@ -47,11 +48,15 @@ public function __construct(string $name, TypeInterface $type, array $arguments,
                 if ($type instanceof ListType) {
                     $subtype = $this->stripNonNullType($type->getItemType());
                     $val = array_map(function ($item) use ($subtype) {
-                        if ($subtype->getKind() === TypeMap::KIND_OBJECT) {
+                        if ($subtype instanceof DateTimeType) {
+                            return new \DateTimeImmutable($item);
+                        } elseif ($subtype->getKind() === TypeMap::KIND_OBJECT) {
                             return $this->hydrator->hydrate($item, $subtype);
                         };
                         return $item;
                     }, $val);
+                } elseif ($type instanceof DateTimeType) {
+                    $val = new \DateTimeImmutable($val);
                 } elseif ($type->getKind() === TypeMap::KIND_OBJECT) {
                     $val = $this->hydrator->hydrate($val, $type);
                 }

tests/ControllerQueryProviderTest.php

@@ -12,6 +12,9 @@
 use Youshido\GraphQL\Type\ListType\ListType;
 use Youshido\GraphQL\Type\NonNullType;
 use Youshido\GraphQL\Type\Object\ObjectType;
+use Youshido\GraphQL\Type\Scalar\BooleanType;
+use Youshido\GraphQL\Type\Scalar\DateTimeType;
+use Youshido\GraphQL\Type\Scalar\FloatType;
 use Youshido\GraphQL\Type\Scalar\IntType;
 use Youshido\GraphQL\Type\Scalar\StringType;
 use Youshido\GraphQL\Type\TypeInterface;
@@ -32,25 +35,34 @@ public function testQueryProvider()
         $usersQuery = $queries[0];
         $this->assertSame('test', $usersQuery->getName());
 
-        $this->assertCount(3, $usersQuery->getArguments());
+        $this->assertCount(7, $usersQuery->getArguments());
         $this->assertInstanceOf(NonNullType::class, $usersQuery->getArgument('int')->getType());
         $this->assertInstanceOf(IntType::class, $usersQuery->getArgument('int')->getType()->getTypeOf());
         $this->assertInstanceOf(StringType::class, $usersQuery->getArgument('string')->getType());
         $this->assertInstanceOf(NonNullType::class, $usersQuery->getArgument('list')->getType());
         $this->assertInstanceOf(ListType::class, $usersQuery->getArgument('list')->getType()->getTypeOf());
         $this->assertInstanceOf(NonNullType::class, $usersQuery->getArgument('list')->getType()->getTypeOf()->getItemType());
         $this->assertInstanceOf(ObjectType::class, $usersQuery->getArgument('list')->getType()->getTypeOf()->getItemType()->getTypeOf());
+        $this->assertInstanceOf(BooleanType::class, $usersQuery->getArgument('boolean')->getType());
+        $this->assertInstanceOf(FloatType::class, $usersQuery->getArgument('float')->getType());
+        $this->assertInstanceOf(DateTimeType::class, $usersQuery->getArgument('dateTimeImmutable')->getType());
+        $this->assertInstanceOf(DateTimeType::class, $usersQuery->getArgument('dateTime')->getType());
         $this->assertSame('TestObject', $usersQuery->getArgument('list')->getType()->getTypeOf()->getItemType()->getTypeOf()->getName());
 
         $mockResolveInfo = $this->createMock(ResolveInfo::class);
 
         $result = $usersQuery->resolve('foo', ['int'=>42, 'string'=>'foo', 'list'=>[
-            ['test'=>42],
-            ['test'=>12],
-        ]], $mockResolveInfo);
+                ['test'=>42],
+                ['test'=>12],
+            ],
+            'boolean'=>true,
+            'float'=>4.2,
+            'dateTimeImmutable'=>'2017-01-01 01:01:01',
+            'dateTime'=>'2017-01-01 01:01:01'
+        ], $mockResolveInfo);
 
         $this->assertInstanceOf(TestObject::class, $result);
-        $this->assertSame('foo424212', $result->getTest());
+        $this->assertSame('foo424212true4.22017010101010120170101010101', $result->getTest());
     }
 
     public function testMutations()

tests/Fixtures/TestController.php

@@ -15,9 +15,13 @@ class TestController
      * @param int $int
      * @param null|string $string
      * @param TestObject[] $list
+     * @param bool|null $boolean
+     * @param float|null $float
+     * @param \DateTimeImmutable|null $dateTimeImmutable
+     * @param \DateTime|null $dateTime
      * @return TestObject
      */
-    public function test(int $int, ?string $string, array $list): TestObject
+    public function test(int $int, ?string $string, array $list, ?bool $boolean, ?float $float, ?\DateTimeImmutable $dateTimeImmutable, ?\DateTimeInterface $dateTime): TestObject
     {
         $str = '';
         foreach ($list as $test) {
@@ -26,7 +30,7 @@ public function test(int $int, ?string $string, array $list): TestObject
             }
             $str .= $test->getTest();
         }
-        return new TestObject($string.$int.$str);
+        return new TestObject($string.$int.$str.($boolean?'true':'false').$float.$dateTimeImmutable->format('YmdHis').$dateTime->format('YmdHis'));
     }
 
     /**