Merge pull request #47 from DoclerLabs/readd-enum-consts

readd enum consts

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).
 
+## [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

example/gen/src/Request/FindPetsByStatusRequest.php

@@ -12,6 +12,12 @@
 
 class FindPetsByStatusRequest implements RequestInterface
 {
+    public const STATUS_AVAILABLE = 'available';
+
+    public const STATUS_PENDING = 'pending';
+
+    public const STATUS_SOLD = 'sold';
+
     private ?string $status = null;
 
     private string $contentType = '';

example/gen/src/Schema/Order.php

@@ -13,6 +13,12 @@
 
 class Order implements SerializableInterface, JsonSerializable
 {
+    public const STATUS_PLACED = 'placed';
+
+    public const STATUS_APPROVED = 'approved';
+
+    public const STATUS_DELIVERED = 'delivered';
+
     private ?int $id = null;
 
     private ?int $petId = null;

example/gen/src/Schema/Pet.php

@@ -12,6 +12,12 @@
 
 class Pet implements SerializableInterface, JsonSerializable
 {
+    public const STATUS_AVAILABLE = 'available';
+
+    public const STATUS_PENDING = 'pending';
+
+    public const STATUS_SOLD = 'sold';
+
     private ?int $id = null;
 
     private string $name;

example/test-example.php

@@ -15,7 +15,7 @@
 use OpenApi\PetStoreClient\SwaggerPetstoreOpenAPI3ClientFactory;
 
 // https://petstore3.swagger.io/api/v3/openapi.json
-$client  = new Client(['base_uri' => 'https://petstore.swagger.io/v2/pet']);
+$client  = new Client(['base_uri' => 'https://petstore.swagger.io/v2/']);
 $factory = new SwaggerPetstoreOpenAPI3ClientFactory();
 $client  = $factory->create($client);
 

src/Entity/Field.php

@@ -23,6 +23,7 @@ class Field
     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;
@@ -74,6 +75,18 @@ public function setObjectProperties(array $objectProperties): self
         return $this;
     }
 
+    public function getEnumValues(): ?array
+    {
+        return $this->enumValues;
+    }
+
+    public function setEnumValues(array $enumValues): self
+    {
+        $this->enumValues = $enumValues;
+
+        return $this;
+    }
+
     public function getFormat(): ?string
     {
         return $this->format;

src/Generator/MutatorAccessorClassGeneratorAbstract.php

@@ -10,6 +10,7 @@
 use DoclerLabs\ApiClientGenerator\Entity\Constraint\ConstraintInterface;
 use DoclerLabs\ApiClientGenerator\Entity\Field;
 use DoclerLabs\ApiClientGenerator\Input\Specification;
+use DoclerLabs\ApiClientGenerator\Naming\SchemaNaming;
 use DoclerLabs\ApiClientGenerator\Output\Php\PhpFileCollection;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Property;
@@ -98,6 +99,23 @@ protected function getGetMethodName(Field $field): string
         return sprintf('get%s', ucfirst($field->getPhpVariableName()));
     }
 
+    protected function generateEnumStatements(Field $field): array
+    {
+        $statements = [];
+        $enumValues = $field->getEnumValues();
+        if (!empty($enumValues)) {
+            foreach ($enumValues as $enumValue) {
+                $constName    = SchemaNaming::getEnumConstName($field, $enumValue);
+                $statements[] = $this->builder->constant(
+                    $constName,
+                    $this->builder->val($enumValue)
+                );
+            }
+        }
+
+        return $statements;
+    }
+
     protected function generateConstraints(Field $root): array
     {
         $stmts = [];

src/Generator/RequestGenerator.php

@@ -36,6 +36,7 @@ protected function generateRequest(PhpFileCollection $fileRegistry, Operation $o
         $classBuilder = $this->builder
             ->class($className)
             ->implement('RequestInterface')
+            ->addStmts($this->generateEnums($request))
             ->addStmts($this->generateProperties($request))
             ->addStmt($this->generateConstructor($request))
             ->addStmt($this->generateGetContentType())
@@ -47,6 +48,20 @@ protected function generateRequest(PhpFileCollection $fileRegistry, Operation $o
         $this->registerFile($fileRegistry, $classBuilder, self::SUBDIRECTORY, self::NAMESPACE_SUBPATH);
     }
 
+    protected function generateEnums(Request $request): array
+    {
+        $statements = [];
+        foreach ($request->getFields() as $fields) {
+            foreach ($fields as $field) {
+                foreach ($this->generateEnumStatements($field) as $statement) {
+                    $statements[] = $statement;
+                }
+            }
+        }
+
+        return $statements;
+    }
+
     protected function generateProperties(Request $request): array
     {
         $statements = [];

src/Generator/SchemaGenerator.php

@@ -36,6 +36,7 @@ protected function generateSchema(Field $field, PhpFileCollection $fileRegistry)
         $classBuilder = $this->builder
             ->class($className)
             ->implement('SerializableInterface', 'JsonSerializable')
+            ->addStmts($this->generateEnumConsts($field))
             ->addStmts($this->generateProperties($field))
             ->addStmt($this->generateConstructor($field))
             ->addStmts($this->generateSetMethods($field))
@@ -46,6 +47,18 @@ protected function generateSchema(Field $field, PhpFileCollection $fileRegistry)
         $this->registerFile($fileRegistry, $classBuilder, self::SUBDIRECTORY, self::NAMESPACE_SUBPATH);
     }
 
+    protected function generateEnumConsts(Field $root): array
+    {
+        $statements = [];
+        foreach ($root->getObjectProperties() as $propertyField) {
+            foreach ($this->generateEnumStatements($propertyField) as $statement) {
+                $statements[] = $statement;
+            }
+        }
+
+        return $statements;
+    }
+
     protected function generateProperties(Field $root): array
     {
         $statements = [];

src/Input/Factory/FieldFactory.php

@@ -118,6 +118,11 @@ public function create(
                 $field->setArrayItem($arrayItem);
             } elseif (!empty($objectProperties)) {
                 $field->setObjectProperties($objectProperties);
+            } elseif (isset($schema->enum)) {
+                if (!FieldType::isSpecificationTypeString($type)) {
+                    throw new InvalidSpecificationException('Only string enum fields are currently supported');
+                }
+                $field->setEnumValues($schema->enum);
             }
 
             if (isset($schema->format)) {