Escape class names of result types named after PHP reserved keywords

spawnia · Oct 7, 2024 · 2416ae1 · 2416ae1
1 parent 340851f
commit 2416ae1
Show file tree

Hide file tree

Showing 32 changed files with 283 additions and 84 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## v0.33.1
+
+### Fixed
+
+- Escape class names of result types named after PHP reserved keywords
+
 ## v0.33.0
 
 ### Changed

diff --git a/README.md b/README.md
@@ -202,9 +202,9 @@ holds the decoded response returned from the server. You can just grab the `$dat
 or `$extensions` off of it:
 
 ```php
-$result->data        // `null` or a generated subclass of `\Spawnia\Sailor\ObjectLike`
-$result->errors      // `null` or a list of `\Spawnia\Sailor\Error\Error`
-$result->extensions  // `null` or an arbitrary map
+$catchResult->data        // `null` or a generated subclass of `\Spawnia\Sailor\ObjectLike`
+$catchResult->errors      // `null` or a list of `\Spawnia\Sailor\Error\Error`
+$catchResult->extensions  // `null` or an arbitrary map
 ```
 
 ### Error handling

diff --git a/examples/php-keywords/expected/Operations/AllCases.php b/examples/php-keywords/expected/Operations/AllCases.php
@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+
+namespace Spawnia\Sailor\PhpKeywords\Operations;
+
+/**
+ * @extends \Spawnia\Sailor\Operation<\Spawnia\Sailor\PhpKeywords\Operations\AllCases\AllCasesResult>
+ */
+class AllCases extends \Spawnia\Sailor\Operation
+{
+    public static function execute(): AllCases\AllCasesResult
+    {
+        return self::executeOperation(
+        );
+    }
+
+    protected static function converters(): array
+    {
+        static $converters;
+
+        return $converters ??= [
+        ];
+    }
+
+    public static function document(): string
+    {
+        return /* @lang GraphQL */ 'query AllCases {
+          __typename
+          cases {
+            __typename
+            id
+          }
+        }';
+    }
+
+    public static function endpoint(): string
+    {
+        return 'php-keywords';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../sailor.php');
+    }
+}
diff --git a/examples/php-keywords/expected/Operations/AllCases/AllCases.php b/examples/php-keywords/expected/Operations/AllCases/AllCases.php
@@ -0,0 +1,45 @@
+<?php declare(strict_types=1);
+
+namespace Spawnia\Sailor\PhpKeywords\Operations\AllCases;
+
+/**
+ * @property array<int, \Spawnia\Sailor\PhpKeywords\Operations\AllCases\Cases\_Case> $cases
+ * @property string $__typename
+ */
+class AllCases extends \Spawnia\Sailor\ObjectLike
+{
+    /**
+     * @param array<int, \Spawnia\Sailor\PhpKeywords\Operations\AllCases\Cases\_Case> $cases
+     */
+    public static function make($cases): self
+    {
+        $instance = new self;
+
+        if ($cases !== self::UNDEFINED) {
+            $instance->cases = $cases;
+        }
+        $instance->__typename = 'Query';
+
+        return $instance;
+    }
+
+    protected function converters(): array
+    {
+        static $converters;
+
+        return $converters ??= [
+            'cases' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\ListConverter(new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\PhpKeywords\Operations\AllCases\Cases\_Case))),
+            '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
+        ];
+    }
+
+    public static function endpoint(): string
+    {
+        return 'php-keywords';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../../sailor.php');
+    }
+}
diff --git a/examples/php-keywords/expected/Operations/AllCases/AllCasesErrorFreeResult.php b/examples/php-keywords/expected/Operations/AllCases/AllCasesErrorFreeResult.php
@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+namespace Spawnia\Sailor\PhpKeywords\Operations\AllCases;
+
+class AllCasesErrorFreeResult extends \Spawnia\Sailor\ErrorFreeResult
+{
+    public AllCases $data;
+
+    public static function endpoint(): string
+    {
+        return 'php-keywords';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../../sailor.php');
+    }
+}
diff --git a/examples/php-keywords/expected/Operations/AllCases/AllCasesResult.php b/examples/php-keywords/expected/Operations/AllCases/AllCasesResult.php
@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace Spawnia\Sailor\PhpKeywords\Operations\AllCases;
+
+class AllCasesResult extends \Spawnia\Sailor\Result
+{
+    public ?AllCases $data = null;
+
+    protected function setData(\stdClass $data): void
+    {
+        $this->data = AllCases::fromStdClass($data);
+    }
+
+    /**
+     * Useful for instantiation of successful mocked results.
+     *
+     * @return static
+     */
+    public static function fromData(AllCases $data): self
+    {
+        $instance = new static;
+        $instance->data = $data;
+
+        return $instance;
+    }
+
+    public function errorFree(): AllCasesErrorFreeResult
+    {
+        return AllCasesErrorFreeResult::fromResult($this);
+    }
+
+    public static function endpoint(): string
+    {
+        return 'php-keywords';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../../sailor.php');
+    }
+}
diff --git a/examples/php-keywords/expected/Operations/AllCases/Cases/_Case.php b/examples/php-keywords/expected/Operations/AllCases/Cases/_Case.php
@@ -0,0 +1,45 @@
+<?php declare(strict_types=1);
+
+namespace Spawnia\Sailor\PhpKeywords\Operations\AllCases\Cases;
+
+/**
+ * @property string $id
+ * @property string $__typename
+ */
+class _Case extends \Spawnia\Sailor\ObjectLike
+{
+    /**
+     * @param string $id
+     */
+    public static function make($id): self
+    {
+        $instance = new self;
+
+        if ($id !== self::UNDEFINED) {
+            $instance->id = $id;
+        }
+        $instance->__typename = 'Case';
+
+        return $instance;
+    }
+
+    protected function converters(): array
+    {
+        static $converters;
+
+        return $converters ??= [
+            'id' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\IDConverter),
+            '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
+        ];
+    }
+
+    public static function endpoint(): string
+    {
+        return 'php-keywords';
+    }
+
+    public static function config(): string
+    {
+        return \Safe\realpath(__DIR__ . '/../../../../sailor.php');
+    }
+}
diff --git a/examples/php-keywords/sailor.php b/examples/php-keywords/sailor.php
@@ -33,17 +33,37 @@ public function finder(): Finder
 
         public function makeClient(): Client
         {
-            return new MockClient(static fn(): Response => Response::fromStdClass((object) [
-                'data' => (object) [
-                    '__typename' => 'Query',
-                    'print' => (object) [
-                        '__typename' => 'Switch',
-                        'for' => _abstract::_class,
-                        'int' => 42,
-                        'as' => 69,
-                    ],
-                ],
-            ]));
+            return new MockClient(function (string $query, ?stdClass $variables): Response {
+                if (str_contains($query, 'print')) {
+                    return Response::fromStdClass((object) [
+                        'data' => (object) [
+                            '__typename' => 'Query',
+                            'print' => (object) [
+                                '__typename' => 'Switch',
+                                'for' => _abstract::_class,
+                                'int' => 42,
+                                'as' => 69,
+                            ],
+                        ],
+                    ]);
+                }
+
+                if (str_contains($query, 'cases')) {
+                    return Response::fromStdClass((object) [
+                        'data' => (object) [
+                            '__typename' => 'Query',
+                            'cases' => [
+                                (object) [
+                                    '__typename' => 'Case',
+                                    'id' => 'asdf',
+                                ],
+                            ],
+                        ],
+                    ]);
+                }
+
+                throw new Exception("Unexpected query: {$query}.");
+            });
         }
     },
 ];
diff --git a/examples/php-keywords/schema.graphql b/examples/php-keywords/schema.graphql
@@ -1,5 +1,6 @@
 type Query {
     print: Abstract
+    cases: [Case!]!
 }
 
 interface Abstract {
@@ -18,3 +19,7 @@ enum abstract {
 input new {
     unset: Float
 }
+
+type Case {
+    id: ID!
+}
diff --git a/examples/php-keywords/src/ReservedKeywords.graphql b/examples/php-keywords/src/ReservedKeywords.graphql
@@ -9,3 +9,9 @@ query Catch {
         }
     }
 }
+
+query AllCases {
+    cases {
+        id
+    }
+}
diff --git a/examples/php-keywords/src/test.php b/examples/php-keywords/src/test.php
@@ -3,14 +3,22 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 use Spawnia\Sailor\PhpKeywords\Operations\_Catch;
-use Spawnia\Sailor\PhpKeywords\Operations\_Catch\_Print\_Switch;
+use Spawnia\Sailor\PhpKeywords\Operations\AllCases;
 use Spawnia\Sailor\PhpKeywords\Types\_abstract;
 
-$result = _Catch::execute();
-
-$switch = $result->data->print;
-assert($switch instanceof _Switch);
+$catchResult = _Catch::execute();
 
+$switch = $catchResult->data->print;
+assert($switch instanceof _Catch\_Print\_Switch);
 assert($switch->for === _abstract::_class);
 assert($switch->int === 42);
 assert($switch->as === 69);
+
+$allCasesResult = AllCases::execute();
+
+$cases = $allCasesResult->data->cases;
+assert(is_array($cases));
+
+$case1 = $cases[0];
+assert($case1 instanceof AllCases\Cases\_Case);
+assert($case1->id === 'asdf');
diff --git a/src/Client/Log.php b/src/Client/Log.php
@@ -41,8 +41,8 @@ public function request(string $query, ?\stdClass $variables = null): Response
 
     /**
      * @return Generator<int, array{
-     *      query: string,
-     *      variables: array<string, mixed>|null,
+     *   query: string,
+     *   variables: array<string, mixed>|null,
      * }>
      */
     public function requests(): \Generator

diff --git a/src/Codegen/File.php b/src/Codegen/File.php
@@ -2,9 +2,7 @@
 
 namespace Spawnia\Sailor\Codegen;
 
-/**
- * A generated file that should be written to a target.
- */
+/** A generated file that should be written to a target. */
 class File
 {
     public string $content;

diff --git a/src/Codegen/Generator.php b/src/Codegen/Generator.php
@@ -160,8 +160,6 @@ protected static function asPhpFile(ClassType $classType, PhpNamespace $namespac
      *
      * @param  array<string, string>  $documents
      *
-     * @throws SyntaxError
-     *
      * @return array<string, \GraphQL\Language\AST\DocumentNode>
      */
     public static function parseDocuments(array $documents): array

diff --git a/src/Codegen/ObjectLikeBuilder.php b/src/Codegen/ObjectLikeBuilder.php
@@ -10,9 +10,7 @@
 use Nette\PhpGenerator\PhpNamespace;
 use Spawnia\Sailor\ObjectLike;
 
-/**
- * @phpstan-type PropertyArgs array{string, Type, string, string, mixed}
- */
+/** @phpstan-type PropertyArgs array{string, Type, string, string, mixed} */
 class ObjectLikeBuilder
 {
     private bool $isInputType;
@@ -32,7 +30,7 @@ class ObjectLikeBuilder
     public function __construct(string $name, string $namespace, bool $isInputType)
     {
         $class = new ClassType(
-            $name,
+            Escaper::escapeClassName($name),
             new PhpNamespace($namespace) // TODO drop escape when min PHP version is 8.0+
         );
 

diff --git a/src/Codegen/OperationBuilder.php b/src/Codegen/OperationBuilder.php
@@ -10,9 +10,7 @@
 use Spawnia\Sailor\ObjectLike;
 use Spawnia\Sailor\Operation;
 
-/**
- * @phpstan-type PropertyArgs array{string, Type, string, string, mixed}
- */
+/** @phpstan-type PropertyArgs array{string, Type, string, string, mixed} */
 class OperationBuilder
 {
     private ClassType $class;

diff --git a/src/Console/InteractsWithEndpoints.php b/src/Console/InteractsWithEndpoints.php
@@ -9,9 +9,7 @@
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 
-/**
- * @mixin Command
- */
+/** @mixin Command */
 trait InteractsWithEndpoints
 {
     /** @return array<string, EndpointConfig> */