id() and uuid() columns now have GraphQL outputType ID by default

Author: moufmouf

src/TdbmFluidColumnGraphqlOptions.php

@@ -5,6 +5,7 @@
 
 
 use function addslashes;
+use Doctrine\DBAL\Types\Type;
 use function var_export;
 
 class TdbmFluidColumnGraphqlOptions
@@ -21,10 +22,25 @@ class TdbmFluidColumnGraphqlOptions
      * @var string
      */
     private $outputType;
+    /**
+     * @var FluidColumn
+     */
+    private $fluidColumn;
 
-    public function __construct(TdbmFluidColumnOptions $tdbmFluidColumnOptions)
+    public function __construct(TdbmFluidColumnOptions $tdbmFluidColumnOptions, FluidColumn $fluidColumn)
     {
         $this->tdbmFluidColumnOptions = $tdbmFluidColumnOptions;
+        $this->fluidColumn = $fluidColumn;
+        if (!$this->getComment()->hasAnnotation('TheCodingMachine\\GraphQLite\\Annotations\\Field')) {
+            $this->generateFieldAnnotation();
+        }
+    }
+
+    private function getComment(): Comment
+    {
+        $comment = $this->fluidColumn->getDbalColumn()->getComment();
+
+        return new Comment($comment ?? '');
     }
 
     public function fieldName(string $name): self
@@ -43,9 +59,22 @@ public function outputType(string $outputType): self
 
     private function generateFieldAnnotation(): void
     {
+        $outputType = null;
+        if ($this->outputType !== null) {
+            $outputType = $this->outputType;
+        } elseif ($this->fluidColumn->getDbalColumn()->getType() === Type::getType(Type::GUID)) {
+            $outputType = 'ID';
+        } else {
+            // If the column is the primary key, let's add an ID type
+            $pk = $this->tdbmFluidColumnOptions->then()->getDbalTable()->getPrimaryKey();
+            if ($pk !== null && $pk->getColumns() === [$this->fluidColumn->getDbalColumn()->getName()]) {
+                $outputType = 'ID';
+            }
+        }
+
         $parameters = array_filter([
             'name' => $this->name,
-            'outputType' => $this->outputType
+            'outputType' => $outputType
         ]);
         if (empty($parameters)) {
             $parameters = null;

src/TdbmFluidColumnOptions.php

@@ -104,11 +104,8 @@ public function column(string $name): TdbmFluidColumn
 
     public function graphql(): TdbmFluidColumnGraphqlOptions
     {
-        if (!$this->getComment()->hasAnnotation('TheCodingMachine\\GraphQLite\\Annotations\\Field')) {
-            $this->addAnnotation('TheCodingMachine\\GraphQLite\\Annotations\\Field');
-        }
         $this->tdbmFluidTable->graphqlType();
-        return new TdbmFluidColumnGraphqlOptions($this);
+        return new TdbmFluidColumnGraphqlOptions($this, $this->fluidColumn);
     }
 
     private function getComment(): Comment

src/TdbmFluidTable.php

@@ -60,21 +60,21 @@ public function primaryKey(array $columnNames, ?string $indexName = null): TdbmF
         return $this;
     }
 
-    public function id(): TdbmFluidTable
+    public function id(): TdbmFluidColumnOptions
     {
         $this->fluidTable->id();
-        return $this;
+        return $this->column('id')->integer();
     }
 
-    public function uuid(string $version = 'v4'): TdbmFluidTable
+    public function uuid(string $version = 'v4'): TdbmFluidColumnOptions
     {
         if ($version !== 'v1' && $version !== 'v4') {
             throw new FluidSchemaException('UUID version must be one of "v1" or "v4"');
         }
         $this->fluidTable->uuid();
 
         $this->column('uuid')->guid()->addAnnotation('UUID', $version);
-        return $this;
+        return $this->column('uuid')->guid();
     }
 
     public function timestamps(): TdbmFluidTable

tests/DoctrineAnnotationDumperTest.php

@@ -2,6 +2,7 @@
 
 namespace TheCodingMachine\FluidSchema;
 
+use Exception;
 use PHPUnit\Framework\TestCase;
 
 class DoctrineAnnotationDumperTest extends TestCase
@@ -12,7 +13,13 @@ public function testExportValues()
         $this->assertSame('', DoctrineAnnotationDumper::exportValues(null));
         $this->assertSame('({})', DoctrineAnnotationDumper::exportValues([]));
         $this->assertSame('("foo")', DoctrineAnnotationDumper::exportValues("foo"));
+        $this->assertSame('(foo = null)', DoctrineAnnotationDumper::exportValues(["foo"=>null]));
+        $this->assertSame('(foo = 42)', DoctrineAnnotationDumper::exportValues(["foo"=>42]));
         $this->assertSame('(foo = "bar")', DoctrineAnnotationDumper::exportValues(["foo"=>"bar"]));
         $this->assertSame('(foo = {"bar":"baz", "baz":"bar"})', DoctrineAnnotationDumper::exportValues(["foo"=>["bar"=>"baz","baz"=>"bar"]]));
+        $this->assertSame('(foo = {"baz", "bar"})', DoctrineAnnotationDumper::exportValues(["foo"=>["baz","bar"]]));
+
+        $this->expectException(\RuntimeException::class);
+        DoctrineAnnotationDumper::exportValues(new Exception());
     }
 }

tests/TdbmFluidColumnGraphqlOptionsTest.php

@@ -44,5 +44,13 @@ public function testGraphql()
         $this->assertSame($column2, $column);
 
         $this->assertContains('@TheCodingMachine\GraphQLite\Annotations\Type', $schema->getTable('posts')->getOptions()['comment']);
+
+        $idColumn = $posts->id()->graphql();
+        $this->assertContains('outputType = "ID"', $schema->getTable('posts')->getColumn('id')->getComment());
+
+        $users = $fluid->table('users');
+        $uuidColumn = $users->uuid()->graphql();
+        $this->assertContains('outputType = "ID"', $schema->getTable('users')->getColumn('uuid')->getComment());
+
     }
 }