feat: support 'default' attribute for required parameters (#32)

JasonBenett · Jason Benedetti · web-flow · commit 95b81a8450d5 · 2021-04-27T17:23:50.000+02:00
* feat: support 'default' attribute for required parameters

* test: fix CS issue

* test: fix PHPStan issue

* docs: update changelog

* refactor: simplify the parameter sorting

Co-authored-by: Jason Benedetti &lt;jason.benedetti@doclerholding.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,9 @@ 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).
 
+## [5.5.0] - 2021-04-27
+### Added
+- Support for `default` property on required request parameters.
 
 ## [5.4.0] - 2021-04-22
 ### Added
diff --git a/src/Entity/Field.php b/src/Entity/Field.php
@@ -23,6 +23,8 @@ class Field
     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;
 
     public function __construct(
         string $name,
@@ -154,6 +156,24 @@ public function isArrayOfObjects(): bool
                && $this->getArrayItem()->isObject();
     }
 
+    /**
+     * @return mixed
+     */
+    public function getDefault()
+    {
+        return $this->default;
+    }
+
+    /**
+     * @param mixed $default
+     */
+    public function setDefault($default): self
+    {
+        $this->default = $default;
+
+        return $this;
+    }
+
     public function getPhpVariableName(): string
     {
         return CaseCaster::toCamel($this->name);
@@ -208,7 +228,7 @@ public function getPhpDocType(bool $allowNullable = true): string
 
         if ($this->isArray() && !$this->isArrayOfObjects()) {
             $arraySuffix = '[]';
-            $typeHint = $this->getArrayItem()->getPhpDocType();
+            $typeHint    = $this->getArrayItem()->getPhpDocType();
         }
 
         return sprintf('%s%s%s', $typeHint, $arraySuffix, $nullableSuffix);
diff --git a/src/Generator/RequestGenerator.php b/src/Generator/RequestGenerator.php
@@ -4,6 +4,7 @@
 
 namespace DoclerLabs\ApiClientGenerator\Generator;
 
+use DoclerLabs\ApiClientGenerator\Ast\ParameterNode;
 use DoclerLabs\ApiClientGenerator\Entity\Field;
 use DoclerLabs\ApiClientGenerator\Entity\Operation;
 use DoclerLabs\ApiClientGenerator\Entity\Request;
@@ -98,10 +99,15 @@ protected function generateConstructor(Request $request): ?ClassMethod
                 if ($field->isRequired()) {
                     array_push($paramInits, ...$this->generateValidationStmts($field));
 
-                    $params[] = $this->builder
+                    $param = $this->builder
                         ->param($field->getPhpVariableName())
-                        ->setType($field->getPhpTypeHint(), $field->isNullable())
-                        ->getNode();
+                        ->setType($field->getPhpTypeHint(), $field->isNullable());
+
+                    if (null !== $field->getDefault()) {
+                        $param->setDefault($field->getDefault());
+                    }
+
+                    $params[] = $param->getNode();
 
                     $paramInits[] = $this->builder->assign(
                         $this->builder->localPropertyFetch($field->getPhpVariableName()),
@@ -129,6 +135,8 @@ protected function generateConstructor(Request $request): ?ClassMethod
             return null;
         }
 
+        $params = $this->sortParameters(...$params);
+
         return $this->builder
             ->method('__construct')
             ->makePublic()
@@ -138,7 +146,7 @@ protected function generateConstructor(Request $request): ?ClassMethod
             ->getNode();
     }
 
-    protected function generateSetters(Request $request): array
+    private function generateSetters(Request $request): array
     {
         $statements = [];
         foreach ($request->getFields() as $fields) {
@@ -152,7 +160,7 @@ protected function generateSetters(Request $request): array
         return $statements;
     }
 
-    protected function generateGetContentType(): ClassMethod
+    private function generateGetContentType(): ClassMethod
     {
         $return     = $this->builder->return($this->builder->localPropertyFetch('contentType'));
         $returnType = 'string';
@@ -166,7 +174,7 @@ protected function generateGetContentType(): ClassMethod
             ->getNode();
     }
 
-    protected function generateGetMethod(Request $request): ClassMethod
+    private function generateGetMethod(Request $request): ClassMethod
     {
         $return     = $this->builder->return($this->builder->val($request->getMethod()));
         $returnType = 'string';
@@ -180,7 +188,7 @@ protected function generateGetMethod(Request $request): ClassMethod
             ->getNode();
     }
 
-    protected function generateGetRoute(Request $request): ClassMethod
+    private function generateGetRoute(Request $request): ClassMethod
     {
         $values     = [];
         $returnType = 'string';
@@ -216,7 +224,7 @@ protected function generateGetRoute(Request $request): ClassMethod
             ->getNode();
     }
 
-    protected function generateGetParametersMethods(Request $request): array
+    private function generateGetParametersMethods(Request $request): array
     {
         $methods   = [];
         $fields    = $request->getFields();
@@ -238,7 +246,7 @@ protected function generateGetParametersMethods(Request $request): array
         return $methods;
     }
 
-    protected function generateGetParametersMethod(string $methodName, array $fields): ClassMethod
+    private function generateGetParametersMethod(string $methodName, array $fields): ClassMethod
     {
         $returnVal  = $this->builder->array([]);
         $fieldsArr  = [];
@@ -260,7 +268,7 @@ protected function generateGetParametersMethod(string $methodName, array $fields
             ->getNode();
     }
 
-    protected function generateGetRawParametersMethod(string $methodName, array $fields): ClassMethod
+    private function generateGetRawParametersMethod(string $methodName, array $fields): ClassMethod
     {
         $fieldsArr  = [];
         $returnType = 'array';
@@ -277,7 +285,7 @@ protected function generateGetRawParametersMethod(string $methodName, array $fie
             ->getNode();
     }
 
-    protected function generateGetBody(?Field $body): ClassMethod
+    private function generateGetBody(?Field $body): ClassMethod
     {
         if ($body !== null) {
             $returnType = $body->getPhpTypeHint();
@@ -369,4 +377,16 @@ private function generateParametersFromFields(array $fields): FuncCall
             ]
         );
     }
+
+    private function sortParameters(ParameterNode ...$parameterNodes): array
+    {
+        usort(
+            $parameterNodes,
+            static function (ParameterNode $paramA, ParameterNode $paramB) {
+                return $paramA->default <=> $paramB->default;
+            }
+        );
+
+        return $parameterNodes;
+    }
 }
diff --git a/src/Input/Factory/FieldFactory.php b/src/Input/Factory/FieldFactory.php
@@ -126,6 +126,10 @@ public function create(
                 $field->setFormat($schema->format);
             }
 
+            if (isset($schema->default)) {
+                $field->setDefault($schema->default);
+            }
+
             return $field;
         } catch (Throwable $exception) {
             throw new InvalidSpecificationException(
diff --git a/src/Input/Parser.php b/src/Input/Parser.php
@@ -45,7 +45,7 @@ private function extractCompositeRequestFields(OperationCollection $operations):
         $allFields = new FieldCollection();
         foreach ($operations as $operation) {
             $request = $operation->getRequest();
-            foreach ($request->getFields() as $origin => $fields) {
+            foreach ($request->getFields() as $fields) {
                 foreach ($fields as $field) {
                     $this->extractField($field, $allFields);
                 }
diff --git a/test/suite/functional/Generator/Request/PatchResourceRequest.php b/test/suite/functional/Generator/Request/PatchResourceRequest.php
@@ -8,16 +8,30 @@
 
 namespace Test\Request;
 
+use DoclerLabs\ApiClientException\RequestValidationException;
 use Test\Schema\PatchResourceRequestBody;
+use Test\Schema\SerializableInterface;
 
 class PatchResourceRequest implements RequestInterface
 {
+    public const ACCEPT_APPLICATION_JSON = 'application/json';
+
+    public const ACCEPT_APPLICATION_XML = 'application/xml';
+
+    public const ALLOWED_ACCEPT_LIST = [self::ACCEPT_APPLICATION_JSON, self::ACCEPT_APPLICATION_XML];
+
+    private string $accept;
+
     private PatchResourceRequestBody $patchResourceRequestBody;
 
     private string $contentType = 'application/json';
 
-    public function __construct(PatchResourceRequestBody $patchResourceRequestBody)
+    public function __construct(PatchResourceRequestBody $patchResourceRequestBody, string $accept = 'application/json')
     {
+        if (! \in_array($accept, self::ALLOWED_ACCEPT_LIST, true)) {
+            throw new RequestValidationException(\sprintf('Invalid %s value. Given: `%s` Allowed: %s', 'Accept', $accept, \json_encode(self::ALLOWED_ACCEPT_LIST)));
+        }
+        $this->accept                   = $accept;
         $this->patchResourceRequestBody = $patchResourceRequestBody;
     }
 
@@ -53,7 +67,11 @@ public function getCookies(): array
 
     public function getHeaders(): array
     {
-        return ['Content-Type' => $this->contentType];
+        return \array_merge(['Content-Type' => $this->contentType], \array_map(static function ($value) {
+            return $value instanceof SerializableInterface ? $value->toArray() : $value;
+        }, \array_filter(['Accept' => $this->accept], static function ($value) {
+            return null !== $value;
+        })));
     }
 
     /**
diff --git a/test/suite/functional/Generator/Request/patchResource.yaml b/test/suite/functional/Generator/Request/patchResource.yaml
@@ -7,6 +7,16 @@ paths:
     patch:
       description: Update resource
       operationId: patchResource
+      parameters:
+        - in: header
+          name: Accept
+          required: true
+          schema:
+            type: string
+            default: application/json
+            enum:
+              - application/json
+              - application/xml
       requestBody:
         $ref: '#/components/requestBodies/UpdateResourceBody'
       responses:

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace DoclerLabs\ApiClientGenerator\Generator;`
`6`	`6`
	`7`	`+use DoclerLabs\ApiClientGenerator\Ast\ParameterNode;`
`7`	`8`	`use DoclerLabs\ApiClientGenerator\Entity\Field;`
`8`	`9`	`use DoclerLabs\ApiClientGenerator\Entity\Operation;`
`9`	`10`	`use DoclerLabs\ApiClientGenerator\Entity\Request;`
`@@ -98,10 +99,15 @@ protected function generateConstructor(Request $request): ?ClassMethod`
`98`	`99`	`if ($field->isRequired()) {`
`99`	`100`	`array_push($paramInits, ...$this->generateValidationStmts($field));`
`100`	`101`
`101`		`- $params[] = $this->builder`
	`102`	`+ $param = $this->builder`
`102`	`103`	`->param($field->getPhpVariableName())`
`103`		`- ->setType($field->getPhpTypeHint(), $field->isNullable())`
`104`		`- ->getNode();`
	`104`	`+ ->setType($field->getPhpTypeHint(), $field->isNullable());`
	`105`	`+`
	`106`	`+ if (null !== $field->getDefault()) {`
	`107`	`+ $param->setDefault($field->getDefault());`
	`108`	`+ }`
	`109`	`+`
	`110`	`+ $params[] = $param->getNode();`
`105`	`111`
`106`	`112`	`$paramInits[] = $this->builder->assign(`
`107`	`113`	`$this->builder->localPropertyFetch($field->getPhpVariableName()),`
`@@ -129,6 +135,8 @@ protected function generateConstructor(Request $request): ?ClassMethod`
`129`	`135`	`return null;`
`130`	`136`	`}`
`131`	`137`
	`138`	`+ $params = $this->sortParameters(...$params);`
	`139`	`+`
`132`	`140`	`return $this->builder`
`133`	`141`	`->method('__construct')`
`134`	`142`	`->makePublic()`
`@@ -138,7 +146,7 @@ protected function generateConstructor(Request $request): ?ClassMethod`
`138`	`146`	`->getNode();`
`139`	`147`	`}`
`140`	`148`
`141`		`- protected function generateSetters(Request $request): array`
	`149`	`+ private function generateSetters(Request $request): array`
`142`	`150`	`{`
`143`	`151`	`$statements = [];`
`144`	`152`	`foreach ($request->getFields() as $fields) {`
`@@ -152,7 +160,7 @@ protected function generateSetters(Request $request): array`
`152`	`160`	`return $statements;`
`153`	`161`	`}`
`154`	`162`
`155`		`- protected function generateGetContentType(): ClassMethod`
	`163`	`+ private function generateGetContentType(): ClassMethod`
`156`	`164`	`{`
`157`	`165`	`$return = $this->builder->return($this->builder->localPropertyFetch('contentType'));`
`158`	`166`	`$returnType = 'string';`
`@@ -166,7 +174,7 @@ protected function generateGetContentType(): ClassMethod`
`166`	`174`	`->getNode();`
`167`	`175`	`}`
`168`	`176`
`169`		`- protected function generateGetMethod(Request $request): ClassMethod`
	`177`	`+ private function generateGetMethod(Request $request): ClassMethod`
`170`	`178`	`{`
`171`	`179`	`$return = $this->builder->return($this->builder->val($request->getMethod()));`
`172`	`180`	`$returnType = 'string';`
`@@ -180,7 +188,7 @@ protected function generateGetMethod(Request $request): ClassMethod`
`180`	`188`	`->getNode();`
`181`	`189`	`}`
`182`	`190`
`183`		`- protected function generateGetRoute(Request $request): ClassMethod`
	`191`	`+ private function generateGetRoute(Request $request): ClassMethod`
`184`	`192`	`{`
`185`	`193`	`$values = [];`
`186`	`194`	`$returnType = 'string';`
`@@ -216,7 +224,7 @@ protected function generateGetRoute(Request $request): ClassMethod`
`216`	`224`	`->getNode();`
`217`	`225`	`}`
`218`	`226`
`219`		`- protected function generateGetParametersMethods(Request $request): array`
	`227`	`+ private function generateGetParametersMethods(Request $request): array`
`220`	`228`	`{`
`221`	`229`	`$methods = [];`
`222`	`230`	`$fields = $request->getFields();`
`@@ -238,7 +246,7 @@ protected function generateGetParametersMethods(Request $request): array`
`238`	`246`	`return $methods;`
`239`	`247`	`}`
`240`	`248`
`241`		`- protected function generateGetParametersMethod(string $methodName, array $fields): ClassMethod`
	`249`	`+ private function generateGetParametersMethod(string $methodName, array $fields): ClassMethod`
`242`	`250`	`{`
`243`	`251`	`$returnVal = $this->builder->array([]);`
`244`	`252`	`$fieldsArr = [];`
`@@ -260,7 +268,7 @@ protected function generateGetParametersMethod(string $methodName, array $fields`
`260`	`268`	`->getNode();`
`261`	`269`	`}`
`262`	`270`
`263`		`- protected function generateGetRawParametersMethod(string $methodName, array $fields): ClassMethod`
	`271`	`+ private function generateGetRawParametersMethod(string $methodName, array $fields): ClassMethod`
`264`	`272`	`{`
`265`	`273`	`$fieldsArr = [];`
`266`	`274`	`$returnType = 'array';`
`@@ -277,7 +285,7 @@ protected function generateGetRawParametersMethod(string $methodName, array $fie`
`277`	`285`	`->getNode();`
`278`	`286`	`}`
`279`	`287`
`280`		`- protected function generateGetBody(?Field $body): ClassMethod`
	`288`	`+ private function generateGetBody(?Field $body): ClassMethod`
`281`	`289`	`{`
`282`	`290`	`if ($body !== null) {`
`283`	`291`	`$returnType = $body->getPhpTypeHint();`
`@@ -369,4 +377,16 @@ private function generateParametersFromFields(array $fields): FuncCall`
`369`	`377`	`]`
`370`	`378`	`);`
`371`	`379`	`}`
	`380`	`+`
	`381`	`+ private function sortParameters(ParameterNode ...$parameterNodes): array`
	`382`	`+ {`
	`383`	`+ usort(`
	`384`	`+ $parameterNodes,`
	`385`	`+ static function (ParameterNode $paramA, ParameterNode $paramB) {`
	`386`	`+ return $paramA->default <=> $paramB->default;`
	`387`	`+ }`
	`388`	`+ );`
	`389`	`+`
	`390`	`+ return $parameterNodes;`
	`391`	`+ }`
`372`	`392`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ private function extractCompositeRequestFields(OperationCollection $operations):`
`45`	`45`	`$allFields = new FieldCollection();`
`46`	`46`	`foreach ($operations as $operation) {`
`47`	`47`	`$request = $operation->getRequest();`
`48`		`- foreach ($request->getFields() as $origin => $fields) {`
	`48`	`+ foreach ($request->getFields() as $fields) {`
`49`	`49`	`foreach ($fields as $field) {`
`50`	`50`	`$this->extractField($field, $allFields);`
`51`	`51`	`}`