Merge pull request #70 from DoclerLabs/fix-enum

add support for int enum
DoclerLabs · May 5, 2022 · 6110d16 · 6110d16
2 parents 8211257 + 9f5d28d
commit 6110d16
Show file tree

Hide file tree

Showing 9 changed files with 75 additions and 38 deletions.
diff --git a/CHANGELOG.md b/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).
 
+## [9.1.0] - 2022.05.05
+### Added
+- Added support for non string enums (no constant for enum value is generated in this case)
+
 ## [9.0.0] - 2022.02.24
 ### Changed
 - API Client Generation triggers a full regeneration of src folder.

diff --git a/Dockerfile b/Dockerfile
@@ -15,7 +15,8 @@ COPY --from=composer /usr/bin/composer /usr/bin/composer
 COPY composer.json /dependencies
 COPY composer.lock /dependencies
 
-RUN composer install
+RUN composer install \
+    && git config --global --add safe.directory /app
 
 FROM php:7.4-cli-alpine3.13
 

diff --git a/src/Generator/MutatorAccessorClassGeneratorAbstract.php b/src/Generator/MutatorAccessorClassGeneratorAbstract.php
@@ -105,11 +105,13 @@ protected function generateEnumStatements(Field $field): array
         $enumValues = $field->getEnumValues();
         if (!empty($enumValues)) {
             foreach ($enumValues as $enumValue) {
-                $constName    = SchemaNaming::getEnumConstName($field, $enumValue);
-                $statements[] = $this->builder->constant(
-                    $constName,
-                    $this->builder->val($enumValue)
-                );
+                if (is_string($enumValue)) {
+                    $constName    = SchemaNaming::getEnumConstName($field, $enumValue);
+                    $statements[] = $this->builder->constant(
+                        $constName,
+                        $this->builder->val($enumValue)
+                    );
+                }
             }
         }
 

diff --git a/src/Input/Factory/FieldFactory.php b/src/Input/Factory/FieldFactory.php
@@ -132,9 +132,6 @@ public function create(
             } 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);
             }
 

diff --git a/test/suite/functional/Generator/Schema/ItemPhp70.php b/test/suite/functional/Generator/Schema/ItemPhp70.php
@@ -73,6 +73,9 @@ class Item implements SerializableInterface, JsonSerializable
     /** @var string|null */
     private $optionalEnum;
 
+    /** @var int|null */
+    private $optionalIntEnum;
+
     /** @var DateTimeInterface|null */
     private $optionalDate;
 
@@ -179,6 +182,13 @@ public function setOptionalEnum(string $optionalEnum): self
         return $this;
     }
 
+    public function setOptionalIntEnum(int $optionalIntEnum): self
+    {
+        $this->optionalIntEnum = $optionalIntEnum;
+
+        return $this;
+    }
+
     public function setOptionalDate(DateTimeInterface $optionalDate): self
     {
         $this->optionalDate = $optionalDate;
@@ -447,6 +457,14 @@ public function getOptionalEnum()
         return $this->optionalEnum;
     }
 
+    /**
+     * @return int|null
+     */
+    public function getOptionalIntEnum()
+    {
+        return $this->optionalIntEnum;
+    }
+
     /**
      * @return DateTimeInterface|null
      */
@@ -577,6 +595,9 @@ public function toArray(): array
         if ($this->optionalEnum !== null) {
             $fields['optionalEnum'] = $this->optionalEnum;
         }
+        if ($this->optionalIntEnum !== null) {
+            $fields['optionalIntEnum'] = $this->optionalIntEnum;
+        }
         if ($this->optionalDate !== null) {
             $fields['optionalDate'] = $this->optionalDate->format(DATE_RFC3339);
         }

diff --git a/test/suite/functional/Generator/Schema/ItemPhp72.php b/test/suite/functional/Generator/Schema/ItemPhp72.php
@@ -73,6 +73,9 @@ class Item implements SerializableInterface, JsonSerializable
     /** @var string|null */
     private $optionalEnum;
 
+    /** @var int|null */
+    private $optionalIntEnum;
+
     /** @var DateTimeInterface|null */
     private $optionalDate;
 
@@ -172,6 +175,13 @@ public function setOptionalEnum(string $optionalEnum): self
         return $this;
     }
 
+    public function setOptionalIntEnum(int $optionalIntEnum): self
+    {
+        $this->optionalIntEnum = $optionalIntEnum;
+
+        return $this;
+    }
+
     public function setOptionalDate(DateTimeInterface $optionalDate): self
     {
         $this->optionalDate = $optionalDate;
@@ -422,6 +432,11 @@ public function getOptionalEnum(): ?string
         return $this->optionalEnum;
     }
 
+    public function getOptionalIntEnum(): ?int
+    {
+        return $this->optionalIntEnum;
+    }
+
     public function getOptionalDate(): ?DateTimeInterface
     {
         return $this->optionalDate;
@@ -522,6 +537,9 @@ public function toArray(): array
         if ($this->optionalEnum !== null) {
             $fields['optionalEnum'] = $this->optionalEnum;
         }
+        if ($this->optionalIntEnum !== null) {
+            $fields['optionalIntEnum'] = $this->optionalIntEnum;
+        }
         if ($this->optionalDate !== null) {
             $fields['optionalDate'] = $this->optionalDate->format(DATE_RFC3339);
         }

diff --git a/test/suite/functional/Generator/Schema/ItemPhp74.php b/test/suite/functional/Generator/Schema/ItemPhp74.php
@@ -58,6 +58,8 @@ class Item implements SerializableInterface, JsonSerializable
 
     private ?string $optionalEnum = null;
 
+    private ?int $optionalIntEnum = null;
+
     private ?DateTimeInterface $optionalDate = null;
 
     private ?float $optionalFloat = null;
@@ -144,6 +146,13 @@ public function setOptionalEnum(string $optionalEnum): self
         return $this;
     }
 
+    public function setOptionalIntEnum(int $optionalIntEnum): self
+    {
+        $this->optionalIntEnum = $optionalIntEnum;
+
+        return $this;
+    }
+
     public function setOptionalDate(DateTimeInterface $optionalDate): self
     {
         $this->optionalDate = $optionalDate;
@@ -394,6 +403,11 @@ public function getOptionalEnum(): ?string
         return $this->optionalEnum;
     }
 
+    public function getOptionalIntEnum(): ?int
+    {
+        return $this->optionalIntEnum;
+    }
+
     public function getOptionalDate(): ?DateTimeInterface
     {
         return $this->optionalDate;
@@ -494,6 +508,9 @@ public function toArray(): array
         if ($this->optionalEnum !== null) {
             $fields['optionalEnum'] = $this->optionalEnum;
         }
+        if ($this->optionalIntEnum !== null) {
+            $fields['optionalIntEnum'] = $this->optionalIntEnum;
+        }
         if ($this->optionalDate !== null) {
             $fields['optionalDate'] = $this->optionalDate->format(DATE_RFC3339);
         }

diff --git a/test/suite/functional/Generator/Schema/item.yaml b/test/suite/functional/Generator/Schema/item.yaml
@@ -82,6 +82,12 @@ components:
           enum:
             - 'one option'
             - 'another option'
+        optionalIntEnum:
+          type: integer
+          enum:
+            - 0
+            - 1
+            - 2
         optionalDate:
           type: string
           format: 'date-time'

diff --git a/test/suite/functional/Input/ParserTest.php b/test/suite/functional/Input/ParserTest.php
@@ -264,35 +264,6 @@ public function invalidSpecificationProvider()
                     ],
                 ],
             ],
-            'Only string enum supported'                      => [
-                [
-                    'openapi' => '3.0.0',
-                    'info'    => [
-                        'title'   => 'Sample API',
-                        'version' => '1.0.0',
-                    ],
-                    'paths'   => [
-                        '/users' => [
-                            'get' => [
-                                'operationId' => 'getUsers',
-                                'responses'   => [
-                                    '200' => [
-                                        'description' => 'OK',
-                                        'content'     => [
-                                            'application/json' => [
-                                                'schema' => [
-                                                    'type' => 'integer',
-                                                    'enum' => [4, 5, 6],
-                                                ],
-                                            ],
-                                        ],
-                                    ],
-                                ],
-                            ],
-                        ],
-                    ],
-                ],
-            ],
             'Invalid field name'                              => [
                 [
                     'openapi' => '3.0.0',