Merge pull request #112 from DoclerLabs/php81

php 8.1 features

Author: vsouz4

CHANGELOG.md

@@ -4,6 +4,11 @@ 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).
 
+## [10.8.0] - 2024.05.17
+### Added
+- Readonly properties (php 8.1)
+- Enums (php 8.1)
+
 ## [10.7.1] - 2024.05.07
 ### Fixed
 - Missing DateTimeInterface import for php 8.1+

docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
   php:
     build:

example/PetStoreClient/README.md

@@ -41,28 +41,28 @@ $result  = $client->updatePet($request);
 
 ### pet
 Endpoints:
-- **updatePet** - Update an existing pet by Id 
-- **addPet** - Add a new pet to the store 
-- **findPetsByStatus** - Multiple status values can be provided with comma separated strings 
-- **findPetsByTags** - Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. 
-- **getPetById** - Returns a single pet 
+- **updatePet** - Update an existing pet by Id
+- **addPet** - Add a new pet to the store
+- **findPetsByStatus** - Multiple status values can be provided with comma separated strings
+- **findPetsByTags** - Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+- **getPetById** - Returns a single pet
 - **updatePetWithForm**
 - **deletePet**
 
 ### store
 Endpoints:
-- **getInventory** - Returns a map of status codes to quantities 
-- **placeOrder** - Place a new order in the store 
-- **getOrderById** - For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions 
-- **deleteOrder** - For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors 
+- **getInventory** - Returns a map of status codes to quantities
+- **placeOrder** - Place a new order in the store
+- **getOrderById** - For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
+- **deleteOrder** - For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
 
 ### user
 Endpoints:
-- **createUser** - This can only be done by the logged in user. 
-- **createUsersWithListInput** - Creates list of users with given input array 
+- **createUser** - This can only be done by the logged in user.
+- **createUsersWithListInput** - Creates list of users with given input array
 - **loginUser**
 - **logoutUser**
 - **getUserByName**
-- **updateUser** - This can only be done by the logged in user. 
-- **deleteUser** - This can only be done by the logged in user. 
+- **updateUser** - This can only be done by the logged in user.
+- **deleteUser** - This can only be done by the logged in user.
 

src/Ast/Builder/CodeBuilder.php

@@ -5,6 +5,7 @@
 namespace DoclerLabs\ApiClientGenerator\Ast\Builder;
 
 use DoclerLabs\ApiClientGenerator\Ast\PhpVersion;
+use DoclerLabs\ApiClientGenerator\Entity\FieldType;
 use DoclerLabs\ApiClientGenerator\Entity\ImportCollection;
 use InvalidArgumentException;
 use PhpParser\BuilderFactory;
@@ -16,6 +17,7 @@
 use PhpParser\Node\Expr\Array_;
 use PhpParser\Node\Expr\ArrayDimFetch;
 use PhpParser\Node\Expr\ArrayItem;
+use PhpParser\Node\Expr\ArrowFunction;
 use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Expr\BinaryOp;
 use PhpParser\Node\Expr\BinaryOp\BooleanAnd;
@@ -102,11 +104,29 @@ public function closure(
         return new Closure($subNodes);
     }
 
+    public function arrowFunction(Expr $expr, array $params, string $returnType, bool $isStatic = true): ArrowFunction
+    {
+        if (!empty($params)) {
+            $subNodes['params'] = $params;
+        }
+
+        $subNodes['expr']       = $expr;
+        $subNodes['returnType'] = $returnType;
+        $subNodes['static']     = $isStatic;
+
+        return new ArrowFunction($subNodes);
+    }
+
     public function class(string $name): ClassBuilder
     {
         return new ClassBuilder($name);
     }
 
+    public function enum(string $name): EnumBuilder
+    {
+        return new EnumBuilder($name);
+    }
+
     public function array(array $items): Array_
     {
         $arrayItems = [];
@@ -141,14 +161,15 @@ public function localProperty(
         string $type,
         string $docType,
         bool $nullable = false,
-        Expr $default = null
+        Expr $default = null,
+        bool $readonly = false
     ): Property {
         $property = $this
             ->property($name)
             ->makePrivate();
 
         if (!empty($type) && $this->phpVersion->isPropertyTypeHintSupported()) {
-            if ($nullable) {
+            if ($nullable && $type !== FieldType::PHP_TYPE_MIXED) {
                 $property->setDefault(null);
                 $type = '?' . $type;
             }
@@ -163,6 +184,13 @@ public function localProperty(
             $property->setDefault($default);
         }
 
+        if (
+            $readonly
+            && $this->phpVersion->isReadonlyPropertySupported()
+        ) {
+            $property->makeReadonly();
+        }
+
         return $property->getNode();
     }
 
@@ -176,6 +204,11 @@ public function localNullsafePropertyFetch(string $propertyName): NullsafeProper
         return new NullsafePropertyFetch($this->var('this'), BuilderHelpers::normalizeIdentifierOrExpr($propertyName));
     }
 
+    public function nullsafePropertyFetch(Expr $var, string $propertyName): NullsafePropertyFetch
+    {
+        return new NullsafePropertyFetch($var, BuilderHelpers::normalizeIdentifierOrExpr($propertyName));
+    }
+
     public function localMethodCall(string $methodName, array $args = []): MethodCall
     {
         return $this->methodCall($this->var('this'), $methodName, $args);

src/Ast/Builder/EnumBuilder.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientGenerator\Ast\Builder;
+
+use PhpParser\Builder\Enum_;
+
+class EnumBuilder extends Enum_
+{
+    public function getName(): string
+    {
+        return $this->name;
+    }
+}

src/Ast/Builder/MethodBuilder.php

@@ -5,6 +5,7 @@
 namespace DoclerLabs\ApiClientGenerator\Ast\Builder;
 
 use DoclerLabs\ApiClientGenerator\Ast\PhpVersion;
+use DoclerLabs\ApiClientGenerator\Entity\FieldType;
 use PhpParser\Builder;
 use PhpParser\Builder\Method;
 use PhpParser\Comment\Doc;
@@ -73,7 +74,11 @@ public function setReturnType($type, $isNullable = false): self
         }
 
         if ($isNullable) {
-            if ($this->phpVersion->isNullableTypeHintSupported() && is_string($type)) {
+            if (
+                $this->phpVersion->isNullableTypeHintSupported()
+                && is_string($type)
+                && $type !== FieldType::PHP_TYPE_MIXED
+            ) {
                 return parent::setReturnType(sprintf('?%s', $type));
             }
 

src/Ast/PhpVersion.php

@@ -89,6 +89,16 @@ public function isMixedTypehintSupported(): bool
         return $this->isVersionGreaterThanOrEqualTo80();
     }
 
+    public function isEnumSupported(): bool
+    {
+        return $this->isVersionGreaterThanOrEqualTo81();
+    }
+
+    public function isReadonlyPropertySupported(): bool
+    {
+        return $this->isVersionGreaterThanOrEqualTo81();
+    }
+
     private function isVersionGreaterThanOrEqualTo71(): bool
     {
         return $this->phpVersion >= self::VERSION_PHP71;
@@ -103,4 +113,9 @@ private function isVersionGreaterThanOrEqualTo80(): bool
     {
         return $this->phpVersion >= self::VERSION_PHP80;
     }
+
+    private function isVersionGreaterThanOrEqualTo81(): bool
+    {
+        return $this->phpVersion >= self::VERSION_PHP81;
+    }
 }

src/Entity/Field.php

@@ -4,6 +4,7 @@
 
 namespace DoclerLabs\ApiClientGenerator\Entity;
 
+use DoclerLabs\ApiClientGenerator\Ast\PhpVersion;
 use DoclerLabs\ApiClientGenerator\Entity\Constraint\ConstraintCollection;
 use DoclerLabs\ApiClientGenerator\Naming\CaseCaster;
 use DoclerLabs\ApiClientGenerator\Naming\SchemaCollectionNaming;
@@ -30,6 +31,7 @@ class Field
     private mixed $discriminator = null;
 
     public function __construct(
+        private PhpVersion $phpVersion,
         private string $name,
         private FieldType $type,
         private ConstraintCollection $constraints,
@@ -152,6 +154,11 @@ public function isDate(): bool
         return $this->type->isString() && $isDateFormat;
     }
 
+    public function isEnum(): bool
+    {
+        return !empty($this->enumValues);
+    }
+
     public function isObject(): bool
     {
         return $this->type->isObject();
@@ -174,6 +181,13 @@ public function isArrayOfObjects(): bool
                && $this->getArrayItem()->isObject();
     }
 
+    public function isArrayOfEnums(): bool
+    {
+        return $this->isArray()
+               && $this->getArrayItem() !== null
+               && $this->getArrayItem()->isEnum();
+    }
+
     public function getDefault(): mixed
     {
         return $this->default;
@@ -220,12 +234,23 @@ public function getPhpClassName(): string
             return 'DateTimeInterface';
         }
 
+        if ($this->isEnum() && $this->phpVersion->isEnumSupported()) {
+            return $this->referenceName . (str_ends_with($this->referenceName, 'Enum') ? '' : 'Enum');
+        }
+
         throw new RuntimeException('Call of getPhpClassName on the non-composite field.');
     }
 
     public function getPhpTypeHint(): string
     {
-        if ($this->isComposite() || $this->isDate()) {
+        if (
+            $this->isComposite()
+            || $this->isDate()
+            || (
+                $this->isEnum()
+                && $this->phpVersion->isEnumSupported()
+            )
+        ) {
             return $this->getPhpClassName();
         }
 
@@ -240,7 +265,14 @@ public function getPhpDocType(bool $allowNullable = true): string
 
         $nullableSuffix = '';
         $arraySuffix    = '';
-        if ($this->isComposite() || $this->isDate()) {
+        if (
+            $this->isComposite()
+            || $this->isDate()
+            || (
+                $this->isEnum()
+                && $this->phpVersion->isEnumSupported()
+            )
+        ) {
             $typeHint = $this->getPhpClassName();
         } else {
             $typeHint = $this->type->toPhpType();

src/Generator/ClientGenerator.php

@@ -120,8 +120,8 @@ protected function generateProperties(): array
         }
 
         return [
-            $this->builder->localProperty('client', 'ClientInterface', 'ClientInterface'),
-            $this->builder->localProperty('container', 'ContainerInterface', 'ContainerInterface'),
+            $this->builder->localProperty('client', 'ClientInterface', 'ClientInterface', readonly: true),
+            $this->builder->localProperty('container', 'ContainerInterface', 'ContainerInterface', readonly: true),
         ];
     }
 
@@ -145,6 +145,11 @@ protected function generateConstructor(): ClassMethod
                 $parameter->makePrivate();
             }
         }
+        if ($this->phpVersion->isReadonlyPropertySupported()) {
+            foreach ($parameters as $parameter) {
+                $parameter->makeReadonly();
+            }
+        }
 
         $parameters = array_map(
             static fn (ParameterBuilder $parameter): ParameterNode => $parameter->getNode(),