GQL-45: Added support for the client to run query builders natively

- Added an QueryBuilderInterface that all query builders must adhere to
- Added support for running query builders in the runQuery method in the client class
- Minor tweaks in the QueryBuilder implementation to allow for adding the interface in a clean way
- Modified examples and README to show how client can be used to run QueryBuilderInterface directly
- Added tests to cover the new implementation

Author: mghoneimy

README.md

@@ -256,9 +256,8 @@ $builder = (new QueryBuilder('pokemon'))
                     )
             )
     );
-$gql = $builder->getQuery();
 try {
-    $results = $client->runQuery($gql, true);
+    $results = $client->runQuery($builder, true);
 }
 catch (QueryError $exception) {
     print_r($exception->getErrorDetails());

examples/query_builder_example.php

@@ -43,11 +43,9 @@
             )
     );
 
-$gql = $builder->getQuery();
-
 // Run query to get results
 try {
-    $results = $client->runQuery($gql);
+    $results = $client->runQuery($builder);
 }
 catch (QueryError $exception) {
 

src/Client.php

@@ -3,7 +3,9 @@
 namespace GraphQL;
 
 use GraphQL\Exception\QueryError;
+use GraphQL\QueryBuilder\QueryBuilderInterface;
 use GuzzleHttp\Exception\ClientException;
+use TypeError;
 
 /**
  * Class Client
@@ -41,16 +43,22 @@ public function __construct(string $endpointUrl, array $authorizationHeaders = [
     }
 
     /**
-     * @codeCoverageIgnore
-     *
-     * @param Query $query
-     * @param bool  $resultsAsArray
+     * @param Query|QueryBuilderInterface $query
+     * @param bool                        $resultsAsArray
      *
      * @return Results|null
      * @throws QueryError
      */
-    public function runQuery(Query $query, bool $resultsAsArray = false): ?Results
+    public function runQuery($query, bool $resultsAsArray = false): ?Results
     {
+        if ($query instanceof QueryBuilderInterface) {
+            $query = $query->getQuery();
+        }
+
+        if (!$query instanceof Query) {
+            throw new TypeError('Client::runQuery accepts the first argument of type Query or QueryBuilderInterface');
+        }
+
         return $this->runRawQuery((string) $query, $resultsAsArray);
     }
 
@@ -60,8 +68,6 @@ public function runQuery(Query $query, bool $resultsAsArray = false): ?Results
      *
      * @return Results|null
      * @throws QueryError
-     *
-     * TODO: Rename this to runStringQuery on v1.0
      */
     public function runRawQuery(string $queryString, $resultsAsArray = false): ?Results
     {

src/QueryBuilder/AbstractQueryBuilder.php

@@ -11,7 +11,7 @@
  *
  * @package GraphQL
  */
-abstract class AbstractQueryBuilder
+abstract class AbstractQueryBuilder implements QueryBuilderInterface
 {
     /**
      * @var Query
@@ -43,7 +43,7 @@ public function __construct(string $queryObject)
     /**
      * @return Query
      */
-    protected function getQuery(): Query
+    public function getQuery(): Query
     {
         if (empty($this->selectionSet)) {
             throw new EmptySelectionSetException(static::class);

src/QueryBuilder/QueryBuilder.php

@@ -35,14 +35,4 @@ public function setArgument(string $argumentName, $argumentValue)
     {
         return parent::setArgument($argumentName, $argumentValue);
     }
-
-    /**
-     * Changing method visibility to public
-     *
-     * @return Query
-     */
-    public function getQuery(): Query
-    {
-        return parent::getQuery();
-    }
 }

src/QueryBuilder/QueryBuilderInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace GraphQL\QueryBuilder;
+
+use GraphQL\Query;
+
+/**
+ * Interface QueryBuilderInterface
+ *
+ * @package GraphQL\QueryBuilder
+ */
+interface QueryBuilderInterface
+{
+    /**
+     * @return Query
+     */
+    function getQuery(): Query;
+}

tests/ClientTest.php

@@ -4,6 +4,8 @@
 
 use GraphQL\Client;
 use GraphQL\Exception\QueryError;
+use GraphQL\QueryBuilder\QueryBuilder;
+use GraphQL\RawObject;
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\Exception\ServerException;
 use GuzzleHttp\Handler\MockHandler;
@@ -12,6 +14,7 @@
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use PHPUnit\Framework\TestCase;
+use TypeError;
 
 /**
  * Class ClientTest
@@ -74,6 +77,30 @@ public function testConstructClient()
         );
     }
 
+    /**
+     * @covers \GraphQL\Client::runQuery
+     */
+    public function testRunQueryBuilder()
+    {
+        $this->mockHandler->append(new Response(200, [], json_encode([
+            'data' => [
+                'someData'
+            ]
+        ])));
+
+        $response = $this->client->runQuery((new QueryBuilder('obj'))->selectField('field'));
+        $this->assertNotNull($response->getData());
+    }
+
+    /**
+     * @covers \GraphQL\Client::runQuery
+     */
+    public function testRunInvalidQueryClass()
+    {
+        $this->expectException(TypeError::class);
+        $this->client->runQuery(new RawObject('obj'));
+    }
+
     /**
      * @covers \GraphQL\Client::runRawQuery
      */