Merge pull request #12 from ensi-platform/task-81891

#81891 FormRequests in controllers

Author: MsNatali

src/Generators/ControllersGenerator.php

@@ -23,6 +23,10 @@ private function extractControllers(SpecObjectInterface $specObject): array
         $paths = $openApiData->paths ?: [];
         foreach ($paths as $routes) {
             foreach ($routes as $method => $route) {
+                $requestName = null;
+                $requestClassName = null;
+                $methodWithRequest = in_array(strtoupper($method), $this->methodsWithRequests);
+
                 if (!empty($route->{'x-lg-skip-controller-generation'})) {
                     continue;
                 }
@@ -42,12 +46,21 @@ private function extractControllers(SpecObjectInterface $specObject): array
                         'className' => $handler->class,
                         'namespace' => $handler->namespace,
                         'actions' => [],
+                        'requestsNamespaces' => [],
                     ];
                 }
 
+                if ($methodWithRequest && empty($route->{'x-lg-skip-request-generation'})) {
+                    $requestClassName = $route->{'x-lg-request-class-name'} ?? ucfirst($route->operationId) . 'Request';
+                    $requestName = lcfirst($requestClassName);
+                    $controllers[$fqcn]['requestsNamespaces'][] = $this->getReplacedNamespace($handler->namespace, 'Controllers', 'Requests') . '\\' .  ucfirst($requestClassName);
+                } elseif ($methodWithRequest) {
+                    $controllers[$fqcn]['requestsNamespaces'][] = 'Illuminate\Http\Request';
+                }
+
                 $controllers[$fqcn]['actions'][] = [
                     'name' => $handler->method ?: '__invoke',
-                    'parameters' => array_merge($this->extractPathParameters($route), $this->getActionExtraParameters($method)),
+                    'parameters' => array_merge($this->extractPathParameters($route), $this->getActionExtraParameters($methodWithRequest, $requestName, $requestClassName)),
                 ];
             }
         }
@@ -65,11 +78,16 @@ private function extractPathParameters(stdClass $route): array
         ], $oasRoutePath);
     }
 
-    private function getActionExtraParameters(string $method): array
+    private function getActionExtraParameters(bool $methodWithRequest, $requestName = null, $requestClassName = null): array
     {
-        return in_array(strtoupper($method), $this->methodsWithRequests)
-            ? [['name' => 'request', 'type' => 'Request']]
-            : [];
+        if ($methodWithRequest) {
+            return [[
+                'name' => $requestName ?? 'request',
+                'type' => $requestClassName ?? 'Request',
+            ]];
+        }
+
+        return [];
     }
 
     private function createControllersFiles(array $controllers, string $template): void
@@ -104,6 +122,7 @@ public function {$methodName}({$paramsString})
                     '{{ namespace }}' => $namespace,
                     '{{ className }}' => $className,
                     '{{ methods }}' => $methodsString,
+                    '{{ requestsNamespaces }}' => $this->formatRequestNamespaces($controller['requestsNamespaces']),
                 ])
             );
         }
@@ -113,4 +132,12 @@ private function formatActionParamsAsString(array $params): string
     {
         return implode(', ', array_map(fn (array $param) => $param['type'] . " $" . $param['name'], $params));
     }
+
+    protected function formatRequestNamespaces(array $namespaces): string
+    {
+        $namespaces = array_unique($namespaces);
+        sort($namespaces);
+
+        return implode("\n", array_map(fn (string $namespaces) => "use {$namespaces};", $namespaces));
+    }
 }

templates/Controller.template

@@ -2,10 +2,9 @@
 
 namespace {{ namespace }};
 
-use App\Http\Controllers\Controller;
-use Illuminate\Http\Request;
+{{ requestsNamespaces }}
 
-class {{ className }} extends Controller
+class {{ className }}
 {
 {{ methods }}
 }

tests/GenerateServerTest.php

@@ -6,6 +6,8 @@
 use Illuminate\Support\Facades\Config;
 use function Pest\Laravel\artisan;
 use function PHPUnit\Framework\assertEqualsCanonicalizing;
+use function PHPUnit\Framework\assertNotTrue;
+use function PHPUnit\Framework\assertStringContainsString;
 
 test("Command GenerateServer success", function () {
     /** @var TestCase $this */
@@ -50,3 +52,59 @@
         $this->makeFilePath('/app/Http/ApiV1/OpenApiGenerated/Enums/TestStringEnum.php'),
     ], $putFiles);
 });
+
+test("Correct requests in controller methods", function () {
+    /** @var TestCase $this */
+    $mapping = Config::get('openapi-server-generator.api_docs_mappings');
+    $mappingValue = current($mapping);
+    $mapping = [$this->makeFilePath(__DIR__ . '/resources/index.yaml') => $mappingValue];
+    Config::set('openapi-server-generator.api_docs_mappings', $mapping);
+
+    $filesystem = $this->mock(Filesystem::class);
+    $filesystem->shouldReceive('exists')->andReturn(false);
+    $filesystem->shouldReceive('get')->withArgs(function ($path) {
+        return (bool)strstr($path, '.template');
+    })->andReturnUsing(function ($path) {
+        return file_get_contents($path);
+    });
+    $filesystem->shouldReceive('cleanDirectory', 'ensureDirectoryExists');
+    $resourceController = null;
+    $withoutResponsesController = null;
+    $filesystem->shouldReceive('put')->withArgs(function ($path, $content) use (&$resourceController, &$withoutResponsesController) {
+        if (str_contains($path, 'ResourcesController.php')) {
+            $resourceController = $content;
+        }
+
+        if (str_contains($path, 'WithoutResponsesController.php')) {
+            $withoutResponsesController = $content;
+        }
+
+        return true;
+    });
+
+    artisan(GenerateServer::class);
+
+    assertNotTrue(is_null($resourceController), 'ResourceController exist');
+    assertStringContainsString(
+        'use App\Http\Requests\TestFooRenameRequest',
+        $resourceController,
+        'ResourceController import'
+    );
+    assertStringContainsString(
+        'TestFullGenerateRequest $testFullGenerateRequest',
+        $resourceController,
+        'ResourceController function parameter'
+    );
+
+    assertNotTrue(is_null($withoutResponsesController), 'WithoutResponsesController exist');
+    assertStringContainsString(
+        'use Illuminate\Http\Request',
+        $withoutResponsesController,
+        'WithoutResponsesController import'
+    );
+    assertStringContainsString(
+        'Request $request',
+        $withoutResponsesController,
+        'WithoutResponsesController function parameter'
+    );
+});