some changes

darkdarin · Jan 27, 2024 · b0c8f2f · b0c8f2f
1 parent 4957364
commit b0c8f2f
Show file tree

Hide file tree

Showing 18 changed files with 251 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,2 @@
 # php-entity-renderer
-Renderer helpers to make PHP code for classes, intefaces, traits and enums 
+Renderer helpers to make PHP code for classes, interfaces, traits and enums 
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "darkdarin/php-entity-renderer",
-    "description": "Renderer helpers to make PHP code for classes, intefaces, traits and enums",
+    "description": "Renderer helpers to make PHP code for classes, interfaces, traits and enums",
     "license": "BSD-3-Clause",
     "type": "package",
     "authors": [
@@ -19,23 +19,6 @@
     },
     "require-dev": {
         "laravel/pint": "^1.1",
-        "illuminate/support": "^10.0",
-        "hyperf/di": "~3.0.0",
         "roave/security-advisories": "dev-latest"
-    },
-    "extra": {
-        "laravel": {
-            "providers": [
-                "DarkDarin\\VkOrdSdk\\VkOrdSdkServiceProvider"
-            ]
-        },
-        "hyperf": {
-            "config": "DarkDarin\\VkOrdSdk\\ConfigProvider"
-        }
-    },
-    "config": {
-        "allow-plugins": {
-            "php-http/discovery": false
-        }
     }
 }
diff --git a/src/Contracts/TypeRendererInterface.php b/src/Contracts/TypeRendererInterface.php
@@ -4,4 +4,7 @@
 
 interface TypeRendererInterface extends EntityRendererInterface, DocBlockRendererInterface
 {
+    public function setNullable(bool $nullable = true): TypeRendererInterface;
+
+    public function isNullable(): bool;
 }
diff --git a/src/Renderers/AbstractEntityRenderer.php b/src/Renderers/AbstractEntityRenderer.php
@@ -52,7 +52,6 @@ public function render(EntityAliases $entityAliases): string
             $namespace = 'namespace ' . $namespace . ';' . PHP_EOL . PHP_EOL;
         }
 
-        $uses = $this->renderUses($entityAliases, $this->className);
         if (method_exists($this, 'renderDynamicProperties')) {
             $this->renderDynamicProperties($entityAliases, $this->docBlock);
         }
@@ -61,6 +60,8 @@ public function render(EntityAliases $entityAliases): string
         $header = $this->renderHeader($entityAliases);
         $body = IndentsHelper::indent($this->renderBody($entityAliases));
 
+        $uses = $this->renderUses($entityAliases, $this->className);
+
         return <<<PHP
 <?php
 

diff --git a/src/Renderers/AttributeRenderer.php b/src/Renderers/AttributeRenderer.php
@@ -8,6 +8,9 @@
 
 class AttributeRenderer implements EntityRendererInterface
 {
+    /**
+     * @param list<ValueRenderer>|array<string, ValueRenderer> $arguments
+     */
     public function __construct(
         private readonly string $className,
         private readonly array $arguments = [],
@@ -27,20 +30,22 @@ public function getArguments(): array
     public function render(EntityAliases $entityAliases): string
     {
         $alias = $entityAliases->addAlias($this->className);
-        $arguments = $this->renderArguments();
+        $arguments = $this->renderArguments($entityAliases);
 
         return sprintf('#[%s%s]', $alias, $arguments);
     }
 
-    protected function renderArguments(): string
+    protected function renderArguments(EntityAliases $entityAliases): string
     {
         if (empty($this->arguments)) {
             return '';
         }
 
         $argumentList = [];
         foreach ($this->arguments as $name => $value) {
-            $argumentList[] = is_string($name) ? $name . ': ' . $value : $value;
+            $argumentList[] = is_string($name) ? $name . ': ' . $value->render($entityAliases) : $value->render(
+                $entityAliases
+            );
         }
         $arguments = '(' . implode(', ', $argumentList) . ')';
         if (strlen($arguments) > 80) {

diff --git a/src/Renderers/ConstantRenderer.php b/src/Renderers/ConstantRenderer.php
@@ -14,7 +14,7 @@ class ConstantRenderer implements EntityRendererInterface
 
     public function __construct(
         private readonly string $name,
-        private readonly string $value,
+        private readonly ValueRenderer $value,
     ) {
         $this->docBlock = new DocBlockRenderer();
     }
@@ -26,7 +26,7 @@ public function render(EntityAliases $entityAliases): string
             $modifiers .= ' ';
         }
 
-        $result = $modifiers . 'const ' . $this->name . ' = ' . $this->value . ';';
+        $result = $modifiers . 'const ' . $this->name . ' = ' . $this->value->render($entityAliases) . ';';
         $docBlock = $this->docBlock->render($entityAliases);
 
         return $docBlock . $result;

diff --git a/src/Renderers/EnumCaseRenderer.php b/src/Renderers/EnumCaseRenderer.php
@@ -13,7 +13,7 @@ class EnumCaseRenderer implements EntityRendererInterface
 
     public function __construct(
         private readonly string $name,
-        private readonly string $value,
+        private readonly ValueRenderer $value,
     ) {
         $this->docBlock = new DocBlockRenderer();
     }
@@ -29,6 +29,6 @@ public function setDescription(string $description): self
     public function render(EntityAliases $entityAliases): string
     {
         $docBlock = $this->docBlock->render($entityAliases);
-        return $docBlock . 'case ' . $this->name . ' = ' . $this->value . ';';
+        return $docBlock . 'case ' . $this->name . ' = ' . $this->value->render($entityAliases) . ';';
     }
 }
diff --git a/src/Renderers/EnumRenderer.php b/src/Renderers/EnumRenderer.php
@@ -49,10 +49,11 @@ protected function renderHeader(EntityAliases $entityAliases): string
         $result = [];
 
         $result[] = 'enum';
-        $result[] = $this->getBaseClassName();
 
         if ($this->type !== null) {
-            $result[] = ': ' . $this->type->value;
+            $result[] = $this->getBaseClassName() . ': ' . $this->type->value;
+        } else {
+            $result[] = $this->getBaseClassName();
         }
 
         if (!empty($this->implements)) {

diff --git a/src/Renderers/MethodRenderer.php b/src/Renderers/MethodRenderer.php
@@ -23,7 +23,7 @@ class MethodRenderer implements EntityRendererInterface
 
     /** @var list<ParameterRenderer> */
     private array $parameters = [];
-    private TypeRendererInterface $returnType = BuiltinTypeRenderer::Mixed;
+    private ?TypeRendererInterface $returnType = null;
     private ?string $methodBody = null;
 
     public function __construct(
@@ -95,7 +95,9 @@ protected function renderDocBlock(EntityAliases $entityAliases): string
             $this->docBlock->addLine($line);
         }
 
-        $this->docBlock->addLine('@return ' . $this->returnType->renderDocBlock($entityAliases));
+        if ($this->returnType !== null) {
+            $this->docBlock->addLine('@return ' . $this->returnType->renderDocBlock($entityAliases));
+        }
 
         return $this->docBlock->render($entityAliases);
     }
@@ -111,11 +113,11 @@ protected function renderMethod(EntityAliases $entityAliases, string $methodBody
         $result[] = 'function';
         $result[] = $this->name;
 
-        $signature = $this->renderSignatureInline($entityAliases, $methodBody, $withoutBody);
+        $signature = $this->renderSignatureInline($entityAliases);
         $method = $withoutBody ? ';' : PHP_EOL . '{' . $methodBody . '}';
 
         if (strlen($signature) > 80) {
-            $signature = $this->renderSignatureColumn($entityAliases, $methodBody, $withoutBody);
+            $signature = $this->renderSignatureColumn($entityAliases);
             $method = $withoutBody ? ';' : ' {' . $methodBody . '}';
         }
 
@@ -130,8 +132,9 @@ protected function renderSignatureInline(EntityAliases $entityAliases,): string
         }
 
         $signature = implode(', ', $parameters);
-        $returnType = $this->returnType->render($entityAliases);
-        return '(' . $signature . '): ' . $returnType;
+        $returnType = $this->returnType !== null ? ': ' . $this->returnType->render($entityAliases) : '';
+
+        return '(' . $signature . ')' . $returnType;
     }
 
     protected function renderSignatureColumn(EntityAliases $entityAliases): string
@@ -142,8 +145,9 @@ protected function renderSignatureColumn(EntityAliases $entityAliases): string
         }
 
         $signature = IndentsHelper::indent(implode(',' . PHP_EOL, $parameters));
-        $returnType = $this->returnType->render($entityAliases);
-        return '(' . PHP_EOL . $signature . PHP_EOL . '): ' . $returnType;
+        $returnType = $this->returnType !== null ? ': ' . $this->returnType->render($entityAliases) : '';
+
+        return '(' . PHP_EOL . $signature . PHP_EOL . ')' . $returnType;
     }
 
     protected function renderBody(): string

diff --git a/src/Renderers/ParameterRenderer.php b/src/Renderers/ParameterRenderer.php
@@ -17,7 +17,7 @@ class ParameterRenderer implements EntityRendererInterface, DocBlockRendererInte
     use HasModifierVisibility;
 
     private ?string $description = null;
-    private ?string $default = null;
+    private ?ValueRenderer $default = null;
 
     public function __construct(
         private readonly string $name,
@@ -45,12 +45,12 @@ public function getDescription(): ?string
         return $this->description;
     }
 
-    public function setDefault(string $default): void
+    public function setDefault(ValueRenderer $default): void
     {
         $this->default = $default;
     }
 
-    public function getDefault(): ?string
+    public function getDefault(): ?ValueRenderer
     {
         return $this->default;
     }
@@ -67,9 +67,25 @@ public function renderDocBlock(EntityAliases $entityAliases): string
 
     public function render(EntityAliases $entityAliases, bool $inline = false): string
     {
-        $result = $this->type->render($entityAliases) . ' $' . $this->name;
+        $attributes = $this->renderAttributes($entityAliases, $inline);
+
+        $modifiers = $this->renderModifiers();
+        if (!empty($modifiers)) {
+            $result[] = $modifiers;
+        }
+
+        $result[] = $this->type->render($entityAliases);
+        $result[] = '$' . $this->name;
+
         if ($this->default !== null) {
-            $result .= ' = ' . $this->default;
+            $result[] = '=';
+            $result[] = $this->default->render($entityAliases);
+        }
+
+        $result = implode(' ', $result);
+
+        if (!empty($attributes)) {
+            return $inline ? $attributes . ' ' . $result : $attributes . PHP_EOL . $result;
         }
 
         return $result;

diff --git a/src/Renderers/PropertyRenderer.php b/src/Renderers/PropertyRenderer.php
@@ -21,7 +21,7 @@ class PropertyRenderer implements EntityRendererInterface, DocBlockRendererInter
     use HasModifierVisibility;
 
     private ?string $description = null;
-    private ?string $default = null;
+    private ?ValueRenderer $default = null;
 
     public function __construct(
         private readonly string $name,
@@ -51,12 +51,12 @@ public function getDescription(): ?string
         return $this->description;
     }
 
-    public function setDefault(string $default): void
+    public function setDefault(ValueRenderer $default): void
     {
         $this->default = $default;
     }
 
-    public function getDefault(): ?string
+    public function getDefault(): ?ValueRenderer
     {
         return $this->default;
     }
@@ -87,6 +87,11 @@ public function render(EntityAliases $entityAliases): string
         $result[] = $this->type->render($entityAliases);
         $result[] = '$' . $this->name;
 
+        if ($this->default !== null) {
+            $result [] = '=';
+            $result [] = $this->default->render($entityAliases);
+        }
+
         return $docBlock . implode(' ', $result) . ';';
     }
 }
diff --git a/src/Renderers/Types/ArrayTypeRenderer.php b/src/Renderers/Types/ArrayTypeRenderer.php
@@ -33,4 +33,18 @@ public function render(EntityAliases $entityAliases): string
     {
         return 'array';
     }
+
+    public function setNullable(bool $nullable = true): TypeRendererInterface
+    {
+        if ($nullable) {
+            return new NullableTypeRenderer($this);
+        }
+
+        return $this;
+    }
+
+    public function isNullable(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/Renderers/Types/BuiltinTypeRenderer.php b/src/Renderers/Types/BuiltinTypeRenderer.php
@@ -30,4 +30,21 @@ public function render(EntityAliases $entityAliases): string
     {
         return $this->value;
     }
+
+    public function setNullable(bool $nullable = true): TypeRendererInterface
+    {
+        if (!$nullable) {
+            return $this;
+        }
+
+        return match ($this) {
+            self::Never, self::Void, self::Null, self::Mixed => $this,
+            default => new NullableTypeRenderer($this),
+        };
+    }
+
+    public function isNullable(): bool
+    {
+        return $this === self::Null || $this === self::Mixed;
+    }
 }
diff --git a/src/Renderers/Types/ClassTypeRenderer.php b/src/Renderers/Types/ClassTypeRenderer.php
@@ -21,4 +21,18 @@ public function render(EntityAliases $entityAliases): string
     {
         return $entityAliases->addAlias($this->className);
     }
+
+    public function setNullable(bool $nullable = true): TypeRendererInterface
+    {
+        if ($nullable) {
+            return new NullableTypeRenderer($this);
+        }
+
+        return $this;
+    }
+
+    public function isNullable(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/Renderers/Types/IntersectTypeRenderer.php b/src/Renderers/Types/IntersectTypeRenderer.php
@@ -7,10 +7,10 @@
 
 readonly class IntersectTypeRenderer implements TypeRendererInterface
 {
-    /** @var list<TypeRendererInterface> */
+    /** @var list<ClassTypeRenderer> */
     public array $types;
 
-    public function __construct(TypeRendererInterface ...$types)
+    public function __construct(ClassTypeRenderer | (UnionTypeRenderer & TypeRendererInterface) ...$types)
     {
         $this->types = $types;
     }
@@ -30,4 +30,14 @@ public function render(EntityAliases $entityAliases): string
             )
         );
     }
+
+    public function setNullable(bool $nullable = true): TypeRendererInterface
+    {
+        return $this;
+    }
+
+    public function isNullable(): bool
+    {
+        return false;
+    }
 }