Merge pull request #51 from Yarre/free-form-response-object-support

Free-form response object support

Author: vsouz4

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [7.1.0] - 2021-08-30
+### Added
+- Support for free-form object in response
+
 ## [7.0.1] - 2021-08-29
 ### Fixed
 - Added `ext-intl` to composer.json. It was missing since 7.0.0.
@@ -12,10 +16,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixed
 - Using `grapheme_strlen` to properly count string lengths.
 
-## [6.1.0] - 2021-08-27
-### Added
-- Readded enums as consts only
-
 ## [6.0.2] - 2021-08-12
 ### Fixed
 - The array of serializers in BodySerializer depends on both requests and responses content type
@@ -197,4 +197,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [1.0.0] - 2020-07-09
 ### Added
- - Initial API client generator release
+ - Initial API client generator release

example/gen/src/Schema/GetInventoryResponseBody.php

@@ -9,14 +9,25 @@
 namespace OpenApi\PetStoreClient\Schema;
 
 use JsonSerializable;
+use stdClass;
 
 class GetInventoryResponseBody implements SerializableInterface, JsonSerializable
 {
-    public function toArray(): array
+    private stdClass $data;
+
+    public function __construct(array $data)
+    {
+        $this->data = (object) $data;
+    }
+
+    public function getData(): stdClass
     {
-        $fields = [];
+        return $this->data;
+    }
 
-        return $fields;
+    public function toArray(): array
+    {
+        return (array) $this->data;
     }
 
     public function jsonSerialize(): array

example/gen/src/Schema/Mapper/GetInventoryResponseBodyMapper.php

@@ -14,6 +14,6 @@ class GetInventoryResponseBodyMapper implements SchemaMapperInterface
 {
     public function toSchema(array $payload): GetInventoryResponseBody
     {
-        return new GetInventoryResponseBody();
+        return new GetInventoryResponseBody($payload);
     }
 }

src/Ast/Builder/CodeBuilder.php

@@ -30,6 +30,7 @@
 use PhpParser\Node\Expr\BinaryOp\Smaller;
 use PhpParser\Node\Expr\BinaryOp\SmallerOrEqual;
 use PhpParser\Node\Expr\BooleanNot;
+use PhpParser\Node\Expr\Cast;
 use PhpParser\Node\Expr\Closure;
 use PhpParser\Node\Expr\Instanceof_;
 use PhpParser\Node\Expr\MethodCall;
@@ -195,6 +196,16 @@ public function return(Expr $expr = null, array $attributes = []): Return_
         return new Return_($expr, $attributes);
     }
 
+    public function castToObject(Expr $expr): Cast\Object_
+    {
+        return new Cast\Object_($expr);
+    }
+
+    public function castToArray(Expr $expr): Cast\Array_
+    {
+        return new Cast\Array_($expr);
+    }
+
     public function expr(Expr $expr): Expression
     {
         return new Expression($expr);

src/Entity/Field.php

@@ -12,19 +12,33 @@
 class Field
 {
     public const FORMAT_DATE      = 'date';
+
     public const FORMAT_DATE_TIME = 'date-time';
+
     public const TYPE_MIXED       = 'mixed';
 
+    private bool                 $additionalProperties;
+
     private string               $name;
+
     private FieldType            $type;
+
     private ConstraintCollection $constraints;
+
     private string               $referenceName;
+
     private bool                 $required;
+
     private bool                 $nullable;
+
     private ?Field               $arrayItem        = null;
+
     private array                $objectProperties = [];
+
     private array                $enumValues       = [];
+
     private string               $format           = '';
+
     /** @phpstan-ignore-next-line cannot use strict type before PHP8 with "mixed" pseudo type */
     private $default;
 
@@ -34,14 +48,16 @@ public function __construct(
         ConstraintCollection $constraints,
         string $referenceName,
         bool $required,
-        bool $nullable
+        bool $nullable,
+        bool $additionalProperties
     ) {
-        $this->name          = $name;
-        $this->type          = $type;
-        $this->constraints   = $constraints;
-        $this->referenceName = $referenceName;
-        $this->required      = $required;
-        $this->nullable      = $nullable;
+        $this->name                 = $name;
+        $this->type                 = $type;
+        $this->constraints          = $constraints;
+        $this->referenceName        = $referenceName;
+        $this->required             = $required;
+        $this->nullable             = $nullable;
+        $this->additionalProperties = $additionalProperties;
     }
 
     public function getArrayItem(): Field
@@ -146,6 +162,11 @@ public function isObject(): bool
         return $this->type->isObject();
     }
 
+    public function isFreeFormObject(): bool
+    {
+        return $this->isObject() && $this->additionalProperties && count($this->getObjectProperties()) === 0;
+    }
+
     public function isArray(): bool
     {
         return $this->type->isArray();

src/Generator/FreeFormSchemaGenerator.php

@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientGenerator\Generator;
+
+use DoclerLabs\ApiClientGenerator\Entity\Constraint\ConstraintCollection;
+use DoclerLabs\ApiClientGenerator\Entity\Field;
+use DoclerLabs\ApiClientGenerator\Entity\FieldType;
+use DoclerLabs\ApiClientGenerator\Input\Specification;
+use DoclerLabs\ApiClientGenerator\Output\Php\PhpFileCollection;
+use JsonSerializable;
+use PhpParser\Node\Stmt\ClassMethod;
+use stdClass;
+
+class FreeFormSchemaGenerator extends MutatorAccessorClassGeneratorAbstract
+{
+    private const FREE_FORM_SCHEMA_VARIABLE = 'data';
+
+    public function generate(Specification $specification, PhpFileCollection $fileRegistry): void
+    {
+        $compositeFields = $specification->getCompositeFields()->getUniqueByPhpClassName();
+        foreach ($compositeFields as $field) {
+            if ($field->isFreeFormObject()) {
+                $this->generateFreeFormSchema($field, $fileRegistry);
+            }
+        }
+    }
+
+    private function generateFreeFormSchema(Field $field, PhpFileCollection $fileRegistry): void
+    {
+        $this->addImport(JsonSerializable::class);
+        $this->addImport(stdClass::class);
+
+        $className     = $field->getPhpClassName();
+        $freeFormField = $this->generateFreeFormField();
+
+        $classBuilder = $this->builder
+            ->class($className)
+            ->implement('SerializableInterface', 'JsonSerializable')
+            ->addStmt($this->generateProperty($freeFormField))
+            ->addStmt($this->generateConstructor())
+            ->addStmt($this->generateGet($freeFormField))
+            ->addStmt($this->generateToArray())
+            ->addStmt($this->generateJsonSerialize());
+
+        $this->registerFile($fileRegistry, $classBuilder, SchemaGenerator::SUBDIRECTORY, SchemaGenerator::NAMESPACE_SUBPATH);
+    }
+
+    private function generateConstructor(): ClassMethod
+    {
+        $param = $this->builder
+            ->param(self::FREE_FORM_SCHEMA_VARIABLE)
+            ->setType(FieldType::PHP_TYPE_ARRAY)
+            ->getNode();
+
+        $paramInit = $this->builder->assign(
+            $this->builder->localPropertyFetch(self::FREE_FORM_SCHEMA_VARIABLE),
+            $this->builder->castToObject(
+                $this->builder->var(self::FREE_FORM_SCHEMA_VARIABLE)
+            )
+        );
+
+        return $this->builder
+            ->method('__construct')
+            ->makePublic()
+            ->addParam($param)
+            ->addStmt($paramInit)
+            ->getNode();
+    }
+
+    private function generateFreeFormField(): Field
+    {
+        return new Field(
+            self::FREE_FORM_SCHEMA_VARIABLE,
+            new FieldType(FieldType::PHP_TYPE_OBJECT),
+            new ConstraintCollection(),
+            stdClass::class,
+            true,
+            false,
+            true
+        );
+    }
+
+    private function generateToArray(): ClassMethod
+    {
+        $return     = $this->builder->return(
+            $this->builder->castToArray(
+                $this->builder->localPropertyFetch(self::FREE_FORM_SCHEMA_VARIABLE)
+            )
+        );
+        $returnType = FieldType::PHP_TYPE_ARRAY;
+
+        return $this->builder
+            ->method('toArray')
+            ->makePublic()
+            ->addStmt($return)
+            ->setReturnType($returnType)
+            ->composeDocBlock([], $returnType)
+            ->getNode();
+    }
+}

src/Generator/GeneratorAbstract.php

@@ -4,10 +4,12 @@
 
 use DoclerLabs\ApiClientGenerator\Ast\Builder\ClassBuilder;
 use DoclerLabs\ApiClientGenerator\Ast\Builder\CodeBuilder;
+use DoclerLabs\ApiClientGenerator\Entity\FieldType;
 use DoclerLabs\ApiClientGenerator\Entity\ImportCollection;
 use DoclerLabs\ApiClientGenerator\Input\Specification;
 use DoclerLabs\ApiClientGenerator\Output\Php\PhpFile;
 use DoclerLabs\ApiClientGenerator\Output\Php\PhpFileCollection;
+use PhpParser\Node\Stmt\ClassMethod;
 
 abstract class GeneratorAbstract implements GeneratorInterface
 {
@@ -63,4 +65,15 @@ protected function resetImports(): void
     {
         $this->imports = new ImportCollection();
     }
+
+    protected function generateJsonSerialize(): ClassMethod
+    {
+        return $this->builder
+            ->method('jsonSerialize')
+            ->makePublic()
+            ->addStmts([$this->builder->return($this->builder->localMethodCall('toArray'))])
+            ->setReturnType(FieldType::PHP_TYPE_ARRAY)
+            ->composeDocBlock([], FieldType::PHP_TYPE_ARRAY)
+            ->getNode();
+    }
 }

src/Generator/SchemaCollectionGenerator.php

@@ -85,17 +85,6 @@ protected function generateConstructor(Field $item): ClassMethod
             ->getNode();
     }
 
-    protected function generateJsonSerialize(): ClassMethod
-    {
-        return $this->builder
-            ->method('jsonSerialize')
-            ->makePublic()
-            ->addStmts([$this->builder->return($this->builder->localMethodCall('toArray'))])
-            ->setReturnType(FieldType::PHP_TYPE_ARRAY)
-            ->composeDocBlock([], FieldType::PHP_TYPE_ARRAY)
-            ->getNode();
-    }
-
     protected function generateToArray(Field $field): ClassMethod
     {
         $statements = [];

src/Generator/SchemaGenerator.php

@@ -21,7 +21,7 @@ public function generate(Specification $specification, PhpFileCollection $fileRe
     {
         $compositeFields = $specification->getCompositeFields()->getUniqueByPhpClassName();
         foreach ($compositeFields as $field) {
-            if ($field->isObject()) {
+            if ($field->isObject() && !$field->isFreeFormObject()) {
                 $this->generateSchema($field, $fileRegistry);
             }
         }
@@ -135,17 +135,6 @@ protected function generateGetMethods(Field $root): array
         return $statements;
     }
 
-    protected function generateJsonSerialize(): ClassMethod
-    {
-        return $this->builder
-            ->method('jsonSerialize')
-            ->makePublic()
-            ->addStmts([$this->builder->return($this->builder->localMethodCall('toArray'))])
-            ->setReturnType(FieldType::PHP_TYPE_ARRAY)
-            ->composeDocBlock([], FieldType::PHP_TYPE_ARRAY)
-            ->getNode();
-    }
-
     protected function generateToArray(Field $root): ClassMethod
     {
         $statements    = [];

src/Generator/SchemaMapperGenerator.php

@@ -9,12 +9,15 @@
 use DoclerLabs\ApiClientGenerator\Naming\SchemaMapperNaming;
 use DoclerLabs\ApiClientGenerator\Output\Php\PhpFileCollection;
 use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\ClassMethod;
 
 class SchemaMapperGenerator extends MutatorAccessorClassGeneratorAbstract
 {
     public const NAMESPACE_SUBPATH = '\\Schema\\Mapper';
+
     public const SUBDIRECTORY      = 'Schema/Mapper/';
+
     private array $mapMethodThrownExceptions;
 
     public function generate(Specification $specification, PhpFileCollection $fileRegistry): void
@@ -132,7 +135,6 @@ protected function generateConstructor(Field $root): ?ClassMethod
     protected function generateMap(Field $root): ClassMethod
     {
         $statements   = [];
-        $returnObj    = null;
         $payloadParam = $this->builder
             ->param('payload')
             ->setType('array')
@@ -148,7 +150,9 @@ protected function generateMap(Field $root): ClassMethod
             )
         );
 
-        if ($root->isObject()) {
+        if ($root->isFreeFormObject()) {
+            $statements[] = $this->generateMapStatementForFreeFormObject($root, $payloadVariable);
+        } elseif ($root->isObject()) {
             $statements = array_merge(
                 $statements,
                 $this->generateMapStatementsForObject($root, $payloadVariable)
@@ -202,6 +206,13 @@ protected function generateMapStatementsForArrayOfObjects(
         return $statements;
     }
 
+    protected function generateMapStatementForFreeFormObject(Field $root, Variable $payloadVariable): Stmt
+    {
+        $schemaInit = $this->builder->new($root->getPhpClassName(), [$payloadVariable]);
+
+        return $this->builder->return($schemaInit);
+    }
+
     protected function generateMapStatementsForObject(Field $root, Variable $payloadVariable): array
     {
         $statements = [];