feat: extract method to fetch schema

Author: mathieutu

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Support PHP 8
+- In addition to `schemaPath()` it's now possible to override the `schema()` method. This can be useful if your GraphQL schema needs to be fetched from some other source than a file on disk. [#33](https://github.com/glesys/butler-graphql/pull/33)
 
 ### Changed
 - **BREAKING**: Upgrade to webonyx/[email protected]. See https://github.com/webonyx/graphql-php/blob/v14.3.0/UPGRADE.md for breaking changes.

src/Concerns/HandlesGraphqlRequests.php

@@ -31,7 +31,8 @@ trait HandlesGraphqlRequests
     public function __invoke(Request $request)
     {
         $loader = app(DataLoader::class);
-        $schema = BuildSchema::build(file_get_contents($this->schemaPath()), [$this, 'decorateTypeConfig']);
+
+        $schema = BuildSchema::build($this->schema(), [$this, 'decorateTypeConfig']);
 
         /** @var \GraphQL\Executor\ExecutionResult */
         $result = null;
@@ -95,6 +96,11 @@ public function reportException(Exception $exception)
         app(ExceptionHandler::class)->report($exception);
     }
 
+    public function schema()
+    {
+        return file_get_contents($this->schemaPath());
+    }
+
     public function schemaPath()
     {
         return config('butler.graphql.schema');

tests/HandlesGraphqlRequestsTest.php

@@ -607,4 +607,21 @@ public function test_nested_collections()
             $data
         );
     }
+
+    public function test_custom_schema()
+    {
+        $controller = $this->app->make(GraphqlControllerWithCustomSchema::class);
+        $data = $controller(Request::create('/', 'POST', [
+            'query' => 'query { foo }'
+        ]));
+
+        $this->assertSame(
+            [
+                'data' => [
+                    'foo' => 'bar',
+                ],
+            ],
+            $data
+        );
+    }
 }

tests/stubs/GraphqlControllerWithCustomSchema.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Butler\Graphql\Tests;
+
+use Butler\Graphql\Concerns\HandlesGraphqlRequests;
+
+class GraphqlControllerWithCustomSchema
+{
+    use HandlesGraphqlRequests;
+
+    public function schema()
+    {
+        return 'type Query { foo: String! }';
+    }
+}

tests/stubs/Queries/Foo.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Butler\Graphql\Tests\Queries;
+
+class Foo
+{
+    public function __invoke($root, $args, $context)
+    {
+        return 'bar';
+    }
+}