Merge remote-tracking branch 'origin/master' into create-add-item-to-return-array

Author: artengin

.github/actions/php-laravel-setup/action.yml

@@ -0,0 +1,11 @@
+name: Tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  run-tests:
+    uses: ronasit/github-actions/.github/workflows/tests.yml@main

.github/workflows/run-tests-with-coverage.yml

@@ -78,20 +78,16 @@ new PHPFileBuilder(app_path('Http/Controllers/UserController.php'))
             $service->delete($id);
             return response()->noContent();
         ',
-        params: new MethodParams(
-            new MethodParam(name: 'request', type: 'DeleteRequest'),
-            new MethodParam(name: 'service', type: 'Service'),
-            new MethodParam(name: 'id', type: 'int'),
+        params: new MethodParamsList(
+            new MethodParamDTO(name: 'request', type: 'DeleteRequest'),
+            new MethodParamDTO(name: 'service', type: 'UserService'),
+            new MethodParamDTO(name: 'id', type: 'int'),
         ),
         returnType: 'Response',
     )
     ->save();
 ```
 
-Each `MethodParam` accepts: `name`, `type` (e.g. `'int'`, `'?string'`, `'MyClass'`), `default` (`DefaultValue::None` to omit), `variadic`, `byRef`.
-
-`addMethod` also supports `static: true` and `returnsByRef: true` (for methods that return by reference, e.g. `public function &items(): array`).
-
 ## Special Laravel structure builders
 
 ### Bootstrap app

.github/workflows/tests.yml

@@ -5,13 +5,13 @@
 use PhpParser\Error;
 use PhpParser\NodeVisitor\CloningVisitor;
 use PhpParser\ParserFactory;
+use RonasIT\Larabuilder\DTO\MethodParamsList;
 use RonasIT\Larabuilder\Enums\AccessModifierEnum;
 use RonasIT\Larabuilder\Enums\DefaultValue;
 use RonasIT\Larabuilder\Enums\InsertPositionEnum;
 use RonasIT\Larabuilder\Exceptions\InvalidPHPFileException;
 use RonasIT\Larabuilder\NodeTraverser;
 use RonasIT\Larabuilder\Printer;
-use RonasIT\Larabuilder\ValueOptions\MethodParams;
 use RonasIT\Larabuilder\Visitors\AddImports;
 use RonasIT\Larabuilder\Visitors\AddTraits;
 use RonasIT\Larabuilder\Visitors\MethodVisitors\AddItemToReturnArray;
@@ -85,13 +85,13 @@ public function addTraits(array $traits): self
     public function addMethod(
         string $name,
         string $code,
-        MethodParams $params = new MethodParams(),
+        MethodParamsList $params = new MethodParamsList(),
         ?string $returnType = null,
         AccessModifierEnum $accessModifier = AccessModifierEnum::Public,
-        bool $static = false,
-        bool $returnsByRef = false,
+        bool $isStatic = false,
+        bool $isReturnsByRef = false,
     ): self {
-        $this->traverser->addVisitor(new AddMethod($name, $code, $params, $returnType, $accessModifier, $static, $returnsByRef));
+        $this->traverser->addVisitor(new AddMethod($name, $code, $params, $returnType, $accessModifier, $isStatic, $isReturnsByRef));
 
         return $this;
     }

README.md

@@ -0,0 +1,17 @@
+<?php
+
+namespace RonasIT\Larabuilder\DTO;
+
+use RonasIT\Larabuilder\Enums\DefaultValue;
+
+readonly class MethodParamDTO
+{
+    public function __construct(
+        public string $name,
+        public ?string $type = null,
+        public mixed $default = DefaultValue::None,
+        public bool $isVariadic = false,
+        public bool $isReference = false,
+    ) {
+    }
+}

src/Builders/PHPFileBuilder.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace RonasIT\Larabuilder\DTO;
+
+use Illuminate\Contracts\Support\Arrayable;
+
+/** @implements Arrayable<int, MethodParamDTO> */
+class MethodParamsList implements Arrayable
+{
+    protected array $params;
+
+    public function __construct(MethodParamDTO ...$params)
+    {
+        $this->params = $params;
+    }
+
+    public function toArray(): array
+    {
+        return $this->params;
+    }
+}

src/DTO/MethodParamDTO.php

@@ -9,25 +9,25 @@
 use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\ClassMethod;
 use RonasIT\Larabuilder\Contracts\InsertNodeContract;
+use RonasIT\Larabuilder\DTO\MethodParamDTO;
+use RonasIT\Larabuilder\DTO\MethodParamsList;
 use RonasIT\Larabuilder\Enums\AccessModifierEnum;
 use RonasIT\Larabuilder\Enums\DefaultValue;
 use RonasIT\Larabuilder\Exceptions\NodeAlreadyExistsException;
 use RonasIT\Larabuilder\Nodes\PreformattedCode;
-use RonasIT\Larabuilder\ValueOptions\MethodParam;
-use RonasIT\Larabuilder\ValueOptions\MethodParams;
 
-class AddMethod extends AbstractMethodVisitor implements InsertNodeContract
+class AddMethod extends BaseMethodVisitor implements InsertNodeContract
 {
     protected PreformattedCode $code;
 
     public function __construct(
         protected string $name,
         string $code,
-        protected MethodParams $params,
+        protected MethodParamsList $paramsList,
         protected ?string $returnType = null,
-        protected ?AccessModifierEnum $accessModifier = null,
-        protected bool $static = false,
-        protected bool $returnsByRef = false,
+        protected AccessModifierEnum $accessModifier = AccessModifierEnum::Public,
+        protected bool $isStatic = false,
+        protected bool $isReturnsByRef = false,
     ) {
         $this->code = new PreformattedCode($code);
     }
@@ -45,29 +45,29 @@ protected function modify(Node $node): Node
 
     public function getInsertableNode(): Node
     {
-        $flags = ($this->accessModifier ?? AccessModifierEnum::Public)->value;
+        $flags = $this->accessModifier->value;
 
-        if ($this->static) {
+        if ($this->isStatic) {
             $flags |= Modifiers::STATIC;
         }
 
         return new ClassMethod($this->name, [
             'flags' => $flags,
-            'byRef' => $this->returnsByRef,
+            'byRef' => $this->isReturnsByRef,
             'params' => $this->buildParams(),
-            'returnType' => $this->returnType !== null ? BuilderHelpers::normalizeType($this->returnType) : null,
+            'returnType' => (!is_null($this->returnType)) ? BuilderHelpers::normalizeType($this->returnType) : null,
             'stmts' => [$this->code],
         ]);
     }
 
     protected function buildParams(): array
     {
-        return array_map(fn (MethodParam $param) => new Param(
+        return array_map(fn (MethodParamDTO $param) => new Param(
             var: new Variable($param->name),
-            default: $param->default !== DefaultValue::None ? BuilderHelpers::normalizeValue($param->default) : null,
-            type: $param->type !== null ? BuilderHelpers::normalizeType($param->type) : null,
-            byRef: $param->byRef,
-            variadic: $param->variadic,
-        ), $this->params->params);
+            default: ($param->default !== DefaultValue::None) ? BuilderHelpers::normalizeValue($param->default) : null,
+            type: (!is_null($param->type)) ? BuilderHelpers::normalizeType($param->type) : null,
+            byRef: $param->isReference,
+            variadic: $param->isVariadic,
+        ), $this->paramsList->toArray());
     }
 }