Add Module.php file generator - WIP

Author: SOHELAHMED7

README.md

@@ -610,8 +610,8 @@ then the value for `comments` can be
 
 ### `x-route`
 
-To customize [route](https://www.yiiframework.com/doc/guide/2.0/en/runtime-routing) (controller ID/action ID) for a path, use custom key `x-route` with value `<controller ID>/<action ID>`. It can be used for non-crud paths. It must be used under HTTP method key but not
-directly under the `paths` key of OpenAPI spec. Example:
+To customize [route](https://www.yiiframework.com/doc/guide/2.0/en/runtime-routing) (controller ID/action ID) for a path, use custom key `x-route` with value `[<module ID>/<child module ID>/...]<controller ID>/<action ID>`. It can be used for non-crud paths. It must be used under HTTP method key but not
+directly under the `paths` key of OpenAPI spec. Providing `<controller ID>` and `<action ID>` is required. Example:
 
 ```yaml
 paths:
@@ -681,7 +681,6 @@ Generated URL rules config for above is (in `urls.rest.php` or pertinent file):
     'POST a1/b1' => 'abc/xyz',
     'a1/b1' => 'abc/options',
 ```
-`x-route` does not support [Yii Modules](https://www.yiiframework.com/doc/guide/2.0/en/structure-modules). // TODO support it
 
 `x-route` must not start with slash `/`. For example `x-route: /user/posts` is incorrect. It must start with [module ID](https://www.yiiframework.com/doc/guide/2.0/en/structure-modules) or [controller ID](https://www.yiiframework.com/doc/guide/2.0/en/structure-controllers#controller-ids)
 
@@ -690,14 +689,9 @@ Generated URL rules config for above is (in `urls.rest.php` or pertinent file):
 Route, path and namespace for controller/action will be resolved in following manner (from highest priority to lowest):
 
 - [`x-route`](#x-route)
-- [
-  `urlPrefixes`](https://github.com/php-openapi/yii2-openapi/blob/649743cf0a78743f550edcbd4e93fdffc55c76fd/src/lib/Config.php#L51)
-- [
-  `controllerNamespace`](https://github.com/php-openapi/yii2-openapi/blob/649743cf0a78743f550edcbd4e93fdffc55c76fd/src/lib/Config.php#L77)
-  of this lib
-- [
-  `controllerNamespace`](https://github.com/yiisoft/yii2/blob/16f50626e1aa81200f109c1a455a5c9b18acfdda/framework/base/Application.php#L93)
-  of Yii app
+- [`urlPrefixes`](https://github.com/php-openapi/yii2-openapi/blob/649743cf0a78743f550edcbd4e93fdffc55c76fd/src/lib/Config.php#L51)
+- [`controllerNamespace`](https://github.com/php-openapi/yii2-openapi/blob/649743cf0a78743f550edcbd4e93fdffc55c76fd/src/lib/Config.php#L77) of this lib
+- [`controllerNamespace`](https://github.com/yiisoft/yii2/blob/16f50626e1aa81200f109c1a455a5c9b18acfdda/framework/base/Application.php#L93) of Yii app
 
 ### `x-description-is-comment`
 

src/lib/generators/ControllersGenerator.php

@@ -62,7 +62,7 @@ public function generate():CodeFiles
              * @var RestAction|FractalAction $action
              **/
             $action = $actions[0];
-            if ($action->prefix && !empty($action->prefixSettings)) {
+            if (!empty($action->prefixSettings)) {
                 $controllerNamespace = trim($action->prefixSettings['namespace'], '\\');
                 $controllerPath = $action->prefixSettings['path']
                     ?? $this->config->getPathFromNamespace($controllerNamespace);

src/lib/generators/ModuleFileGenerator.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @copyright Copyright (c) 2018 Carsten Brandt <mail@cebe.cc> and contributors
+ * @license https://github.com/cebe/yii2-openapi/blob/master/LICENSE
+ */
+
+namespace cebe\yii2openapi\lib\generators;
+
+use cebe\yii2openapi\lib\CodeFiles;
+use cebe\yii2openapi\lib\Config;
+use cebe\yii2openapi\lib\items\FractalAction;
+use cebe\yii2openapi\lib\items\RestAction;
+use Laminas\Code\Generator\AbstractMemberGenerator;
+use Laminas\Code\Generator\ClassGenerator;
+use Laminas\Code\Generator\FileGenerator;
+use Laminas\Code\Generator\ParameterGenerator;
+use Laminas\Code\Generator\ValueGenerator;
+use Yii;
+use yii\gii\CodeFile;
+use yii\helpers\Inflector;
+
+class ModuleFileGenerator
+{
+    public function __construct()
+    {
+    }
+}

src/lib/items/FractalAction.php

@@ -97,7 +97,7 @@ private function templateFactory():FractalActionTemplates
 
     public function getRoute():string
     {
-        if ($this->prefix && !empty($this->prefixSettings)) {
+        if (!empty($this->prefixSettings)) {
             $prefix = $this->prefixSettings['module'] ?? $this->prefix;
             return trim($prefix, '/').'/'.$this->controllerId.'/'.$this->id;
         }

src/lib/items/OptionsRoutesTrait.php

@@ -11,7 +11,7 @@ trait OptionsRoutesTrait
 {
     public function getOptionsRoute():string
     {
-        if ($this->prefix && !empty($this->prefixSettings)) {
+        if (!empty($this->prefixSettings)) {
             if (isset($this->prefixSettings['module'])) {
                 $prefix = $this->prefixSettings['module'];
                 return static::finalOptionsRoute($prefix, $this->controllerId);

src/lib/items/RestAction.php

@@ -100,7 +100,7 @@ public function getRoute():string
             return $this->xRoute;
         }
 
-        if ($this->prefix && !empty($this->prefixSettings)) {
+        if (!empty($this->prefixSettings)) {
             $prefix = $this->prefixSettings['module'] ?? $this->prefix;
             return trim($prefix, '/') . '/' . $this->controllerId . '/' . $this->id;
         }

src/lib/items/RouteData.php

@@ -176,6 +176,8 @@ final class RouteData extends BaseObject
      */
     private $operation;
 
+    private $moduleList = [];
+
     public function __construct(
         string    $path,
         PathItem  $pathItem,
@@ -196,16 +198,20 @@ public function __construct(
             $parts = explode('/', $customRoute);
             array_pop($parts);
             array_pop($parts);
-            $this->prefix = implode('/', $parts); # add everything except controller ID and action ID
+            // $this->prefix = implode('/', $parts); # add everything (modules) except controller ID and action ID
 
-            $modulesPath = [];
+            $modulesPathSection = $modulesPath = [];
+            $container = '';
             foreach ($parts as $module) {
-                $modulesPath[] = 'modules/' . $module;
+                $modulesPathSection[$module] = 'modules/' . $module;
+                $container .= ($container !== '' ? '/' : '') . ('modules/' . $module);
+                $modulesPath[$module] = '@app/'.$container;
             }
+            $this->moduleList = $modulesPath;
 
             $this->prefixSettings = [
                 'namespace' => 'app\\' . implode('\\', $parts) . '\\controllers',
-                'path' => '@app/' . implode('/', $modulesPath) . '/controllers'
+                'path' => '@app/' . implode('/', $modulesPathSection) . '/controllers'
             ];
         }
 
@@ -471,4 +477,12 @@ public function isNonCrudAction():bool
     {
         return in_array($this->type, [self::TYPE_DEFAULT, self::TYPE_RESOURCE_OPERATION]);
     }
+
+    /**
+     * Returns list of modules this action is part of
+     */
+    public function listModules(): array
+    {
+        return $this->moduleList;
+    }
 }

tests/specs/issue_fix/14_nested_module_in_x_route/index.php

@@ -4,6 +4,7 @@
     'openApiPath' => '@specs/issue_fix/14_nested_module_in_x_route/index.yml',
     'generateUrls' => true,
     'generateModels' => true,
+    // 'useJsonApi' => true, // TODO for FractalAction
     'excludeModels' => [
         'Error',
     ],