Merge pull request #233 from moufmouf/enum_issue

Fixing enum does not work as a response parameter

Author: moufmouf

docs/pagination.md

@@ -14,6 +14,14 @@ PHP arrays, Doctrine and [TDBM](https://thecodingmachine.github.io/tdbm/doc/limi
 <div class="alert alert-warning">If you are a Laravel user, Eloquent does not come with a Porpaginas
 iterator. However, <a href="laravel-package-advanced">the GraphQLite Laravel bundle comes with its own pagination system</a>.</div>
 
+## Installation
+
+You will need to install the [Porpaginas](https://github.com/beberlei/porpaginas) library to benefit from this feature.
+
+```bash
+$ composer require beberlei/porpaginas
+```
+
 ## Usage
 
 In your query, simply return a class that implements `Porpaginas\Result`:

src/Mappers/Root/MyCLabsEnumTypeMapper.php

@@ -14,6 +14,7 @@
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\Object_;
 use ReflectionMethod;
+use TheCodingMachine\GraphQLite\Types\MyCLabsEnumType;
 use function is_a;
 use function str_replace;
 use function strpos;
@@ -87,16 +88,7 @@ private function mapByClassName(string $enumClass): ?EnumType
             return $this->cache[$enumClass];
         }
 
-        $consts         = $enumClass::toArray();
-        $constInstances = [];
-        foreach ($consts as $key => $value) {
-            $constInstances[$key] = ['value' => $enumClass::$key()];
-        }
-
-        return $this->cache[$enumClass] = new EnumType([
-            'name' => 'MyCLabsEnum_' . str_replace('\\', '__', $enumClass),
-            'values' => $constInstances,
-        ]);
+        return $this->cache[$enumClass] = new MyCLabsEnumType($enumClass);
     }
 
     /**

src/Types/MyCLabsEnumType.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\GraphQLite\Types;
+
+use GraphQL\Type\Definition\EnumType;
+use InvalidArgumentException;
+use MyCLabs\Enum\Enum;
+use function str_replace;
+
+/**
+ * An extension of the EnumType to support Myclabs enum.
+ *
+ * This implementation is needed to overwrite the default "serialize" method, that expects to see the exact same object
+ * (while there can be several instances of the same enum value with MyclabsEnum)
+ */
+class MyCLabsEnumType extends EnumType
+{
+    public function __construct(string $enumClassName)
+    {
+        $consts         = $enumClassName::toArray();
+        $constInstances = [];
+        foreach ($consts as $key => $value) {
+            $constInstances[$key] = ['value' => $enumClassName::$key()];
+        }
+
+        parent::__construct([
+            'name' => 'MyCLabsEnum_' . str_replace('\\', '__', $enumClassName),
+            'values' => $constInstances,
+        ]);
+    }
+
+    /**
+     * @param mixed $value
+     *
+     * @return mixed
+     */
+    public function serialize($value)
+    {
+        if (! $value instanceof Enum) {
+            throw new InvalidArgumentException('Expected a Myclabs Enum instance');
+        }
+        return $value->getKey();
+    }
+}

tests/Fixtures/Integration/Controllers/ProductController.php

@@ -51,6 +51,14 @@ public function echoProductType(ProductTypeEnum $productType): ProductTypeEnum
         return $productType;
     }
 
+    /**
+     * @Query()
+     */
+    public function echoSomeProductType(): ProductTypeEnum
+    {
+        return ProductTypeEnum::FOOD();
+    }
+
     /**
      * @Query()
      */

tests/Integration/EndToEndTest.php

@@ -934,6 +934,29 @@ public function testEndToEndEnums(): void
         ], $result->toArray(Debug::RETHROW_INTERNAL_EXCEPTIONS)['data']);
     }
 
+    public function testEndToEndEnums2(): void
+    {
+        /**
+         * @var Schema $schema
+         */
+        $schema = $this->mainContainer->get(Schema::class);
+
+        $queryString = '
+        query {
+            echoSomeProductType
+        }
+        ';
+
+        $result = GraphQL::executeQuery(
+            $schema,
+            $queryString
+        );
+
+        $this->assertSame([
+            'echoSomeProductType' => 'FOOD'
+        ], $result->toArray(Debug::RETHROW_INTERNAL_EXCEPTIONS)['data']);
+    }
+
     public function testEndToEndDateTime(): void
     {
         /**

tests/Types/MyclabsEnumTypeTest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace TheCodingMachine\GraphQLite\Types;
+
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+use TheCodingMachine\GraphQLite\Fixtures\Integration\Models\ProductTypeEnum;
+
+class MyclabsEnumTypeTest extends TestCase
+{
+    public function testException()
+    {
+        $enumType = new MyCLabsEnumType(ProductTypeEnum::class);
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Expected a Myclabs Enum instance');
+        $enumType->serialize('foo');
+    }
+}

website/versioned_docs/version-4.0/pagination.md

@@ -15,6 +15,14 @@ PHP arrays, Doctrine and [TDBM](https://thecodingmachine.github.io/tdbm/doc/limi
 <div class="alert alert-warning">If you are a Laravel user, Eloquent does not come with a Porpaginas
 iterator. However, the GraphQLite Laravel bundle <a href="laravel-package-advanced.md">comes with its own pagination system</a>.</div>
 
+## Installation
+
+You will need to install the [Porpaginas](https://github.com/beberlei/porpaginas) library to benefit from this feature.
+
+```bash
+$ composer require beberlei/porpaginas
+```
+
 ## Usage
 
 In your query, simply return a class that implements `Porpaginas\Result`: