Merge pull request #2 from ensi-platform/configure-generators-with-option

Configure generators with option

Author: arrilot

README.md

@@ -69,7 +69,9 @@ Destination must be configured with array as namespace instead of string.
 E.g 
 
 ```php
- 'requests' => ["Controllers" => "Requests"],
+'requests' => [
+    'namespace' => ["Controllers" => "Requests"]
+],
 ```
 
 This means "Get handler (x-lg-handler) namespace and replace Controllers with Requests in it"  

config/openapi-server-generator.php

@@ -10,17 +10,23 @@
     /**
      * You can use as many yaml/json openapi entrypoints as you want.
      * Key = openapi entrypoint file with path.
-     * Value = one of
-     *  - string: fixed PSR-4 namespace where the result of generation should be placed.
-     *  - array: relative PSR-4 namespace. Base namespace is taken from `x-lg-handler` and selected parts are replaced.
+     * Value = list of entities and their generator params.
      */
     'api_docs_mappings' => [
         public_path('api-docs/v1/index.yaml') => [
             'controllers' => [],
-            'enums' => "App\\Http\\ApiV1\\OpenApiGenerated\\Enums\\",
-            'requests' => ["Controllers" => "Requests"],
-            'routes' => "App\\Http\\ApiV1\\OpenApiGenerated\\",
-            'pest_tests' => ["Controllers" => "Tests"],
+            'enums' => [
+                'namespace' => "App\\Http\\ApiV1\\OpenApiGenerated\\Enums\\",
+            ],
+            'requests' => [
+                'namespace' => ["Controllers" => "Requests"],
+            ],
+            'routes' => [
+                'namespace' => "App\\Http\\ApiV1\\OpenApiGenerated\\",
+            ],
+            'pest_tests' => [
+                'namespace' => ["Controllers" => "Tests"],
+            ],
         ],
     ],
 

src/Commands/GenerateServer.php

@@ -40,17 +40,17 @@ public function handle()
             return self::FAILURE;
         }
 
-        foreach ($this->config['api_docs_mappings'] as $sourcePath => $toNamespaces) {
+        foreach ($this->config['api_docs_mappings'] as $sourcePath => $optionsPerEntity) {
             $this->info("Generating [" . implode(', ', $this->enabledEntities) . "] for specification file \"$sourcePath\"");
-            if (self::FAILURE === $this->handleMapping($sourcePath, $toNamespaces)) {
+            if (self::FAILURE === $this->handleMapping($sourcePath, $optionsPerEntity)) {
                 return self::FAILURE;
             }
         }
 
         return self::SUCCESS;
     }
 
-    public function handleMapping(string $sourcePath, array $toNamespaces)
+    public function handleMapping(string $sourcePath, array $optionsPerEntity)
     {
         $specObject = $this->parseSpec($sourcePath);
 
@@ -59,14 +59,14 @@ public function handleMapping(string $sourcePath, array $toNamespaces)
                 continue;
             }
 
-            if (!isset($toNamespaces[$entity])) {
-                $this->error("Namespace for entity \"$entity\" is not set in \"api_docs_mappings\" config for source \"$sourcePath\"");
+            if (!isset($optionsPerEntity[$entity])) {
+                $this->error("Options for entity \"$entity\" are not set in \"api_docs_mappings\" config for source \"$sourcePath\"");
 
                 return self::FAILURE;
             }
 
             $this->infoIfVerbose("Generating files for entity \"$entity\" using generator \"$generatorClass\"");
-            resolve($generatorClass)->generate($specObject, $toNamespaces[$entity]);
+            resolve($generatorClass)->setOptions($optionsPerEntity[$entity])->generate($specObject);
         }
 
         return self::SUCCESS;

src/Generators/BaseGenerator.php

@@ -11,6 +11,8 @@
 
 class BaseGenerator
 {
+    protected array $options = [];
+
     public function __construct(
         protected Filesystem $filesystem,
         protected TemplatesManager $templatesManager,
@@ -20,6 +22,13 @@ public function __construct(
     ) {
     }
 
+    public function setOptions(array $options): static
+    {
+        $this->options = $options;
+
+        return $this;
+    }
+
     protected function replacePlaceholders(string $content, array $placeholders): string
     {
         return str_replace(array_keys($placeholders), array_values($placeholders), $content);

src/Generators/ControllersGenerator.php

@@ -9,7 +9,7 @@ class ControllersGenerator extends BaseGenerator implements GeneratorInterface
 {
     private array $methodsWithRequests = ['PATCH', 'POST', 'PUT', 'DELETE'];
 
-    public function generate(SpecObjectInterface $specObject, string|array $namespaceData): void
+    public function generate(SpecObjectInterface $specObject): void
     {
         $controllers = $this->extractControllers($specObject);
         $this->createControllersFiles($controllers, $this->templatesManager->getTemplate('Controller.template'));

src/Generators/EnumsGenerator.php

@@ -9,10 +9,11 @@
 
 class EnumsGenerator extends BaseGenerator implements GeneratorInterface
 {
-    public function generate(SpecObjectInterface $specObject, string|array $namespaceData): void
+    public function generate(SpecObjectInterface $specObject): void
     {
+        $namespaceData = $this->options['namespace'] ?? null;
         if (!is_string($namespaceData)) {
-            throw new InvalidArgumentException("EnumsGenerator supports only strings as namespaceData");
+            throw new InvalidArgumentException("EnumsGenerator must be configured with string as 'namespace'");
         }
 
         $namespace = rtrim($namespaceData, "\\");

src/Generators/GeneratorInterface.php

@@ -6,5 +6,7 @@
 
 interface GeneratorInterface
 {
-    public function generate(SpecObjectInterface $specObject, string|array $namespaceData): void;
+    public function generate(SpecObjectInterface $specObject): void;
+
+    public function setOptions(array $options): static;
 }

src/Generators/RequestsGenerator.php

@@ -9,10 +9,11 @@ class RequestsGenerator extends BaseGenerator implements GeneratorInterface
 {
     private array $methods = ['PATCH', 'POST', 'PUT', 'DELETE'];
 
-    public function generate(SpecObjectInterface $specObject, string|array $namespaceData): void
+    public function generate(SpecObjectInterface $specObject): void
     {
+        $namespaceData = $this->options['namespace'] ?? null;
         if (!is_array($namespaceData)) {
-            throw new InvalidArgumentException("RequestsGenerator supports only arrays as namespaceData");
+            throw new InvalidArgumentException("RequestsGenerator must be configured with array as 'namespace'");
         }
 
         $requests = $this->extractRequests($specObject, $namespaceData);

src/Generators/RoutesGenerator.php

@@ -7,10 +7,11 @@
 
 class RoutesGenerator extends BaseGenerator implements GeneratorInterface
 {
-    public function generate(SpecObjectInterface $specObject, string|array $namespaceData): void
+    public function generate(SpecObjectInterface $specObject): void
     {
+        $namespaceData = $this->options['namespace'] ?? null;
         if (!is_string($namespaceData)) {
-            throw new InvalidArgumentException("RoutesGenerator supports only strings as namespaceData");
+            throw new InvalidArgumentException("RoutesGenerator must be configured with string as 'namespace'");
         }
 
         $namespace = rtrim($namespaceData, "\\");

src/Generators/TestsGenerator.php

@@ -14,10 +14,11 @@ abstract protected function convertRoutesToImportsString(array $routes): string;
 
     abstract protected function getTemplateName(): string;
 
-    public function generate(SpecObjectInterface $specObject, string|array $namespaceData): void
+    public function generate(SpecObjectInterface $specObject): void
     {
+        $namespaceData = $this->options['namespace'] ?? null;
         if (!is_array($namespaceData)) {
-            throw new InvalidArgumentException("TestsGenerator supports only arrays as namespaceData");
+            throw new InvalidArgumentException("TestsGenerator must be configured with array as 'namespace'");
         }
 
         $openApiData = $specObject->getSerializableData();