Merge pull request #156 from php-api-clients/add-union-type-support-better-exampledata-and-schema-generation

Add union type support, better example data, and schema generation

Author: WyriHaximus

example/openapi-client-miele.yaml

@@ -4,19 +4,23 @@ state:
     - composer.json
     - composer.lock
 spec: https://www.miele.com/developer/swagger-ui/m3rdapi.yaml
+#spec: m3rdapi.yaml
 namespace:
   source: ApiClients\Client\Miele
   test: ApiClients\Tests\Client\Miele
 entryPoints:
   call: true
   operations: true
-  webHooks: true
+  webHooks: false
 destination:
   root: generated-miele
   source: src
   test: tests
 templates:
-  dir: ../templates
+  dir: templates
+  variables:
+    fullname: Miele
+    packageName: miele
 schemas:
   allowDuplication: true
   useAliasesForDuplication: true

example/openapi-client-one.yaml

@@ -4,7 +4,7 @@ state:
     - composer.json
     - composer.lock
 spec: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.yaml
-#spec: file:///home/wyrihaximus/Projects/PHPAPIClients/openapi-client-generator/example/api.github.com.yaml
+#spec: api.github.com.yaml
 entryPoints:
   call: true
   operations: true

example/openapi-client-subsplit.yaml

@@ -4,7 +4,7 @@ state:
     - composer.json
     - composer.lock
 spec: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.yaml
-#spec: file:///home/wyrihaximus/Projects/PHPAPIClients/openapi-client-generator/example/api.github.com.yaml
+#spec: api.github.com.yaml
 entryPoints:
   call: true
   operations: true

src/ContentType/Raw.php

@@ -17,6 +17,7 @@ public static function contentType(): iterable
         yield 'text/plain';
         yield 'text/x-markdown';
         yield 'text/html';
+        yield 'application/pdf';
     }
 
     public static function parse(Expr $expr): Expr

src/Gatherer/ExampleData.php

@@ -46,9 +46,14 @@ public static function gather(mixed $exampleData, PropertyType $type, string $pr
         }
 
         if ($exampleData === null && $type->type === 'scalar' && is_string($type->payload)) {
-            return self::scalarData($type->payload, $type->format, $type->pattern);
+            return self::scalarData(strlen($propertyName), $type->payload, $type->format, $type->pattern);
         }
 
+        return self::determiteType($exampleData);
+    }
+
+    public static function determiteType(mixed $exampleData): Representation\ExampleData
+    {
         return match (gettype($exampleData)) {
             'boolean' => new Representation\ExampleData(
                 $exampleData,
@@ -83,14 +88,14 @@ public static function gather(mixed $exampleData, PropertyType $type, string $pr
     }
 
     /** @phpstan-ignore-next-line */
-    public static function scalarData(string $type, ?string $format, ?string $pattern = null): Representation\ExampleData
+    public static function scalarData(int $seed, string $type, ?string $format, ?string $pattern = null): Representation\ExampleData
     {
         if ($type === 'int' || $type === '?int') {
-            return new Representation\ExampleData(13, new Node\Scalar\LNumber(13));
+            return new Representation\ExampleData($seed, new Node\Scalar\LNumber($seed));
         }
 
         if ($type === 'float' || $type === '?float' || $type === 'int|float' || $type === 'null|int|float') {
-            return new Representation\ExampleData(13.13, new Node\Scalar\DNumber(13.13));
+            return new Representation\ExampleData($seed / 10, new Node\Scalar\DNumber($seed / 10));
         }
 
         if ($type === 'bool' || $type === '?bool') {

src/Gatherer/HydratorUtils.php

@@ -17,9 +17,7 @@ public static function listSchemas(Schema $schema): iterable
         yield $schema;
 
         foreach ($schema->properties as $property) {
-            foreach ($property->type as $propertyType) {
-                yield from self::listSchemasFromPropertyType($propertyType);
-            }
+            yield from self::listSchemasFromPropertyType($property->type);
         }
     }
 

src/Gatherer/Operation.php

@@ -9,7 +9,7 @@
 use ApiClients\Tools\OpenApiClientGenerator\Registry\Schema as SchemaRegistry;
 use ApiClients\Tools\OpenApiClientGenerator\Registry\ThrowableSchema;
 use ApiClients\Tools\OpenApiClientGenerator\Representation\Header;
-use ApiClients\Tools\OpenApiClientGenerator\Representation\OperationRedirect;
+use ApiClients\Tools\OpenApiClientGenerator\Representation\OperationEmptyResponse;
 use ApiClients\Tools\OpenApiClientGenerator\Representation\OperationRequestBody;
 use ApiClients\Tools\OpenApiClientGenerator\Representation\OperationResponse;
 use ApiClients\Tools\OpenApiClientGenerator\Representation\Parameter;
@@ -27,6 +27,7 @@
 use function lcfirst;
 use function Safe\preg_replace;
 use function str_replace;
+use function strlen;
 use function strtoupper;
 use function trim;
 use function ucfirst;
@@ -49,15 +50,15 @@ public static function gather(
     ): \ApiClients\Tools\OpenApiClientGenerator\Representation\Operation {
         $returnType = [];
         $parameters = [];
-        $redirects  = [];
+        $empties  = [];
         foreach ($operation->parameters as $parameter) {
             $parameterType = str_replace([
                 'integer',
                 'any',
                 'boolean',
             ], [
                 'int',
-                'mixed',
+                'string|object',
                 'bool',
             ], implode('|', is_array($parameter->schema->type) ? $parameter->schema->type : [$parameter->schema->type]));
 
@@ -69,7 +70,7 @@ public static function gather(
                 $parameter->schema->format,
                 $parameter->in,
                 $parameter->schema->default,
-                ExampleData::scalarData($parameterType, $parameter->schema->format),
+                ExampleData::scalarData(strlen($parameter->name),$parameterType, $parameter->schema->format),
             );
         }
 
@@ -91,7 +92,9 @@ public static function gather(
         $response = [];
         foreach ($operation->responses ?? [] as $code => $spec) {
             $isError = $code >= 400;
+            $contentCount = 0;
             foreach ($spec->content as $contentType => $contentTypeMediaType) {
+                $contentCount++;
                 $responseClassname = $schemaRegistry->get(
                     $contentTypeMediaType->schema,
                     'Operations\\' . $classNameSanitized . '\\Response\\' . Utils::className(
@@ -106,10 +109,12 @@ public static function gather(
                     $code,
                     $contentType,
                     $spec->description,
-                    Schema::gather(
+                    Type::gather(
                         $baseNamespace,
                         $responseClassname,
+                        $contentType,
                         $contentTypeMediaType->schema,
+                        true,
                         $schemaRegistry,
                     ),
                 );
@@ -121,28 +126,22 @@ public static function gather(
                 $returnType[] = $responseClassname;
             }
 
-            if ($code < 300 || $code >= 400) {
-                continue;
-            }
-
-            $headers = [];
-            foreach ($spec->headers as $headerName => $headerSpec) {
-                $headers[$headerName] = new Header($headerName, Schema::gather(
-                    $baseNamespace,
-                    $schemaRegistry->get(
+            if ($contentCount === 0) {
+                $headers = [];
+                foreach ($spec->headers as $headerName => $headerSpec) {
+                    $headers[$headerName] = new Header($headerName, Schema::gather(
+                        $baseNamespace,
+                        $schemaRegistry->get(
+                            $headerSpec->schema,
+                            'WebHookHeader\\' . ucfirst(preg_replace('/\PL/u', '', $headerName)),
+                        ),
                         $headerSpec->schema,
-                        'WebHookHeader\\' . ucfirst(preg_replace('/\PL/u', '', $headerName)),
-                    ),
-                    $headerSpec->schema,
-                    $schemaRegistry
-                ));
-            }
+                        $schemaRegistry
+                    ), ExampleData::determiteType($headerSpec->example));
+                }
 
-            if (count($headers) <= 0) {
-                continue;
+                $empties[] = new OperationEmptyResponse($code, $spec->description, $headers);
             }
-
-            $redirects[] = new OperationRedirect($code, $spec->description, $headers);
         }
 
         if (count($returnType) === 0) {
@@ -154,7 +153,7 @@ public static function gather(
             ClassString::factory($baseNamespace, $classNameSanitized),
             ClassString::factory($baseNamespace, 'Operator\\' . Utils::fixKeyword($className)),
             lcfirst(trim(Utils::basename($className), '\\')),
-            trim(Utils::dirname($className), '\\'),
+            strlen(trim(trim(Utils::dirname($className), '\\'), '.')) > 0 ? trim(Utils::dirname($className), '\\') : 'Fallback',
             $operation->operationId,
             strtoupper($matchMethod),
             strtoupper($method),
@@ -167,7 +166,7 @@ public static function gather(
             ],
             $requestBody,
             $response,
-            $redirects,
+            $empties,
         );
     }
 }

src/Gatherer/OperationHydrator.php

@@ -18,8 +18,10 @@ public static function gather(
 
         foreach ($operations as $operation) {
             foreach ($operation->response as $response) {
-                foreach (HydratorUtils::listSchemas($response->schema) as $schema) {
-                    $schemaClasses[] = $schema;
+                if ($response->content->payload instanceof \ApiClients\Tools\OpenApiClientGenerator\Representation\Schema) {
+                    foreach (HydratorUtils::listSchemas($response->content->payload) as $schema) {
+                        $schemaClasses[] = $schema;
+                    }
                 }
             }
         }

src/Gatherer/Property.php

@@ -6,12 +6,16 @@
 
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\Namespace_;
 use ApiClients\Tools\OpenApiClientGenerator\Registry\Schema as SchemaRegistry;
-use ApiClients\Tools\OpenApiClientGenerator\Representation\PropertyType;
-use ApiClients\Tools\OpenApiClientGenerator\Representation\Schema;
 use cebe\openapi\spec\Schema as baseSchema;
 use Jawira\CaseConverter\Convert;
+use ApiClients\Tools\OpenApiClientGenerator\Representation;
+use PhpParser\Node;
+use NumberToWords\NumberToWords;
 
+use function array_filter;
+use function array_values;
 use function count;
+use function preg_replace_callback;
 use function str_replace;
 use function strlen;
 
@@ -20,28 +24,32 @@ final class Property
     public static function gather(
         Namespace_ $baseNamespace,
         string $className,
-        string $propertyName,
+        string $sourcePropertyName,
         bool $required,
         baseSchema $property,
         SchemaRegistry $schemaRegistry,
-    ): \ApiClients\Tools\OpenApiClientGenerator\Representation\Property {
+    ): Representation\Property {
+        $enum        = [];
         $exampleData = null;
 
         /** @phpstan-ignore-next-line */
         if (count($property->examples ?? []) > 0) {
+            $examples = array_values(array_filter($property->examples, static fn (mixed $value): bool => $value !== null));
             // Main reason we're doing this is so we cause more variety in the example data when a list of examples is provided, but also consistently pick the same item so we do don't cause code churn
             /** @phpstan-ignore-next-line */
-            $exampleData = $property->examples[strlen($propertyName) % 2 ? 0 : count($property->examples) - 1];
+            $exampleData = $examples[strlen($sourcePropertyName) % 2 ? 0 : count($examples) - 1];
         }
 
         if ($exampleData === null && $property->example !== null) {
             $exampleData = $property->example;
         }
 
         if ($exampleData === null && count($property->enum ?? []) > 0) {
+            $enum  = $property->enum;
+            $enums = array_values(array_filter($property->enum, static fn (mixed $value): bool => $value !== null));
             // Main reason we're doing this is so we cause more variety in the enum based example data, but also consistently pick the same item so we do don't cause code churn
             /** @phpstan-ignore-next-line */
-            $exampleData = $property->enum[strlen($propertyName) % 2 ? 0 : count($property->enum) - 1];
+            $exampleData = $enums[strlen($sourcePropertyName) % 2 ? 0 : count($enums) - 1];
         }
 
         $propertyName = str_replace([
@@ -51,10 +59,17 @@ public static function gather(
             '$',
         ], [
             '_AT_',
-            '_PLUSES_',
-            '_MINUS_',
-            '',
-        ], $propertyName);
+            '_PLUS_',
+            '_MIN_',
+            '_DOLLAR_',
+        ], $sourcePropertyName);
+        $propertyName = preg_replace_callback(
+            '/[0-9]+/',
+            static function ($matches) {
+                return '_' . str_replace(['-', ' '], '_', NumberToWords::transformNumber('en', (int) $matches[0])) . '_';
+            },
+            $propertyName,
+        );
 
         $type = Type::gather(
             $baseNamespace,
@@ -64,25 +79,39 @@ public static function gather(
             $required,
             $schemaRegistry,
         );
-        if ($type->payload instanceof Schema) {
+        if ($type->payload instanceof Representation\Schema) {
             if (count($type->payload->properties) === 0) {
-                $type = new PropertyType('scalar', null, null, 'mixed', false);
+                $type = new Representation\PropertyType('scalar', null, null, 'string', false);
             }
-        } elseif ($type->payload instanceof PropertyType && $type->payload->payload instanceof Schema) {
+        } elseif ($type->payload instanceof Representation\PropertyType && $type->payload->payload instanceof Representation\Schema) {
             if (count($type->payload->payload->properties) === 0) {
-                $type = new PropertyType('scalar', null, null, 'mixed', false);
+                $type = new Representation\PropertyType('scalar', null, null, 'string', false);
             }
         }
 
-        $exampleData = ExampleData::gather($exampleData, $type, $propertyName);
+        if ($property->type === 'array' && is_array($type->payload)) {
+            $arrayItemsRaw = [];
+            $arrayItemsNode = [];
+
+            foreach ($type->payload as $index => $arrayItem) {
+                $arrayItemExampleData = ExampleData::gather($exampleData, $arrayItem, $propertyName . str_pad('', $index + 1, '_'));
+                $arrayItemsRaw[] = $arrayItemExampleData->raw;
+                $arrayItemsNode[] = new Node\Expr\ArrayItem($arrayItemExampleData->node);
+            }
 
-        return new \ApiClients\Tools\OpenApiClientGenerator\Representation\Property(
+            $exampleData = new Representation\ExampleData($arrayItemsRaw, new Node\Expr\Array_($arrayItemsNode));
+        } else {
+            $exampleData = ExampleData::gather($exampleData, $type, $propertyName);
+        }
+
+        return new Representation\Property(
             (new Convert($propertyName))->toCamel(),
-            $propertyName,
+            $sourcePropertyName,
             $property->description ?? '',
             $exampleData,
-            [$type],
-            $type->nullable
+            $type,
+            $type->nullable,
+            $enum,
         );
     }
 }

src/Gatherer/Schema.php

@@ -72,6 +72,7 @@ public static function gather(
             $properties,
             $schema,
             $isArray,
+            ($schema->type === null ? ['object'] : (is_array($schema->type) ? $schema->type : [$schema->type]))
         );
     }
 }