Merge pull request #15 from moufmouf/resultiteratortype

Adding a result iterator type

Author: moufmouf

src/Registry/Registry.php

@@ -13,6 +13,7 @@
  * The role of the registry is to provide access to all GraphQL types.
  * If the type is not found, it can be queried from the container, or if not in the container, it can be created from the Registry itself.
  *
+ * @deprecated Use TheCodingMachine\GraphQL\Controllers\Registry instead
  */
 class Registry implements ContainerInterface
 {

src/ResultIteratorType.php

@@ -0,0 +1,67 @@
+<?php
+
+
+namespace TheCodingMachine\Tdbm\GraphQL;
+
+use TheCodingMachine\TDBM\ResultIterator;
+use Youshido\GraphQL\Config\Object\ObjectTypeConfig;
+use Youshido\GraphQL\Type\ListType\ListType;
+use Youshido\GraphQL\Type\NonNullType;
+use Youshido\GraphQL\Type\Object\AbstractObjectType;
+use Youshido\GraphQL\Type\Scalar\IntType;
+use Youshido\GraphQL\Type\Scalar\StringType;
+use Youshido\GraphQL\Type\TypeInterface;
+
+/**
+ * Type mapping a TDBM ResultIterator.
+ * It allows easy pagination and sorting in the iterator.
+ */
+class ResultIteratorType extends AbstractObjectType
+{
+    /**
+     * @var TypeInterface
+     */
+    private $beanType;
+
+    public function __construct(TypeInterface $beanType)
+    {
+        parent::__construct([]);
+        $this->beanType = $beanType;
+    }
+
+    /**
+     * @param ObjectTypeConfig $config
+     */
+    public function build($config)
+    {
+        $config->addField('count', [
+            'type' => new IntType(),
+            'description' => 'Returns the total number of items in the collection.',
+            'resolve' => function (ResultIterator $source, $args, $info) {
+                return $source->count();
+            }
+        ]);
+        $config->addField('items', [
+            'type' => new NonNullType(new ListType(new NonNullType($this->beanType))),
+            'description' => 'Returns the list of items in the collection.',
+            'args' => [
+                'limit' => new IntType(),
+                'offset' => new IntType(),
+                'order' => new StringType(),
+            ],
+            'resolve' => function (ResultIterator $source, $args, $info) {
+                if (isset($args['order'])) {
+                    $source = $source->withOrder($args['order']);
+                }
+                if (!isset($args['limit']) && isset($args['offset'])) {
+                    throw new GraphQLException('In "items" field, you can specify an offset without a limit.');
+                }
+                if (isset($args['limit']) || isset($args['offset'])) {
+                    $source = $source->take($args['offset'] ?? 0, $args['limit']);
+                }
+
+                return $source->toArray();
+            }
+        ]);
+    }
+}

tests/GraphQLTypeGeneratorTest.php

@@ -9,14 +9,20 @@
 use TheCodingMachine\Tdbm\GraphQL\Fixtures\TestSchema;
 use TheCodingMachine\Tdbm\GraphQL\Registry\EmptyContainer;
 use TheCodingMachine\Tdbm\GraphQL\Registry\Registry;
+use TheCodingMachine\Tdbm\GraphQL\Tests\Beans\Country;
+use TheCodingMachine\Tdbm\GraphQL\Tests\DAOs\CountryDao;
 use TheCodingMachine\Tdbm\GraphQL\Tests\DAOs\UserDao;
+use TheCodingMachine\Tdbm\GraphQL\Tests\GraphQL\CountryType;
 use TheCodingMachine\Tdbm\GraphQL\Tests\GraphQL\Generated\AbstractCountryType;
 use TheCodingMachine\Tdbm\GraphQL\Tests\GraphQL\Generated\AbstractUserType;
 use TheCodingMachine\Tdbm\GraphQL\Tests\GraphQL\TdbmGraphQLTypeMapper;
 use TheCodingMachine\TDBM\TDBMService;
 use TheCodingMachine\TDBM\Utils\DefaultNamingStrategy as TdbmDefaultNamingStrategy;
 use PHPUnit\Framework\TestCase;
+use Youshido\GraphQL\Execution\Context\ExecutionContext;
 use Youshido\GraphQL\Execution\Processor;
+use Youshido\GraphQL\Execution\ResolveInfo;
+use Youshido\GraphQL\Schema\Schema;
 use Youshido\GraphQL\Type\Scalar\StringType;
 
 class GraphQLTypeGeneratorTest extends TestCase
@@ -182,4 +188,32 @@ private function recursiveDelete(string $str) : bool
         }
         return false;
     }
+
+    public function testResultIteratorType()
+    {
+        $type = new ResultIteratorType(new CountryType(new Registry(new EmptyContainer())));
+
+        $tdbmService = self::getTDBMService();
+        $countryDao = new CountryDao($tdbmService);
+
+        $countries = $countryDao->findAll();
+
+        $countField = $type->getField('count');
+        $resolveInfo = $this->getMockBuilder(ResolveInfo::class)->disableOriginalConstructor()->getMock();
+        $this->assertEquals(3, $countField->resolve($countries, [], $resolveInfo));
+
+        $itemsField = $type->getField('items');
+        $result = $itemsField->resolve($countries, [], $resolveInfo);
+        $this->assertCount(3, $result);
+        $this->assertInstanceOf(Country::class, $result[0]);
+
+        $result = $itemsField->resolve($countries, ['order'=>'label'], $resolveInfo);
+        $this->assertEquals('Jamaica', $result[1]->getLabel());
+
+        $result = $itemsField->resolve($countries, ['offset'=>1, 'limit'=>1], $resolveInfo);
+        $this->assertCount(1, $result);
+
+        $this->expectException(GraphQLException::class);
+        $result = $itemsField->resolve($countries, ['offset'=>1], $resolveInfo);
+    }
 }