From 73aa9b3db3707d949b29a723017898c5dc6794fc Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Mon, 2 Sep 2024 17:24:50 +0530 Subject: [PATCH 01/26] Add failing test --- .../index.php | 20 ++ .../index.yaml | 171 ++++++++++++++++++ tests/unit/IssueFixTest.php | 14 ++ 3 files changed, 205 insertions(+) create mode 100644 tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php create mode 100644 tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml diff --git a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php new file mode 100644 index 00000000..9598be42 --- /dev/null +++ b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php @@ -0,0 +1,20 @@ + '@specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml', + 'generateUrls' => true, + 'generateModels' => false, + 'excludeModels' => [ + 'Error', + ], + 'generateControllers' => true, + 'generateMigrations' => false, + 'useJsonApi' => true, + 'urlPrefixes' => [ + 'animals' => '', + '/info' => ['module' =>'petinfo','namespace' => '\app\modules\petinfo\controllers'], + '/fgh' => ['namespace' => '\app\modules\fgh\controllers'], + '/fgh2' => ['path' => '@app/modules/fgh2/controllers', 'namespace' => '\app\fgh2\controllers'], + '/api/v1' => ['path' => '@app/modules/api/v1/controllers', 'namespace' => '\app\api\v1\controllers'] + ] +]; diff --git a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml new file mode 100644 index 00000000..90983f0d --- /dev/null +++ b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml @@ -0,0 +1,171 @@ +openapi: "3.0.0" +info: + version: 1.0.0 + title: controller_namespace_issue_for_modules_in_urlprefixes + license: + name: MIT +servers: + - url: http://petstore.swagger.io/v1 +paths: + /api/v1/pets: + get: + summary: List all pets + operationId: listPets + tags: + - pets + parameters: + - name: limit + in: query + description: How many items to return at one time (max 100) + required: false + schema: + type: integer + format: int32 + responses: + '200': + description: A paged array of pets + headers: + x-next: + description: A link to the next page of responses + schema: + type: string + content: + application/json: + schema: + $ref: "#/components/schemas/Pets" + default: + description: unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + post: + summary: Create a pet + operationId: createPets + tags: + - pets + responses: + '201': + description: Null response + default: + description: unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /animals/pets/{id}: + parameters: + - name: id + in: path + required: true + description: The id of the pet to update + schema: + type: string + get: + summary: Info for a specific pet + operationId: showPetById + tags: + - pets + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: "#/components/schemas/Pet" + default: + description: unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + patch: + summary: update a specific pet + operationId: updatePetById + tags: + - pets + responses: + '200': + description: The updated pet + content: + application/json: + schema: + $ref: "#/components/schemas/Pet" + delete: + summary: delete a specific pet + operationId: deletePetById + tags: + - pets + responses: + '204': + description: successfully deleted pet + /petComments: + get: + description: list all pet comments + responses: + '200': + description: list of comments + /info/pet-details: + get: + description: list all pet details + responses: + '200': + description: list of details + /fgh/pet-detail2s: + get: + description: list all pet details + responses: + '200': + description: list of details + /fgh2/pet-detail2s: + get: + description: list all pet details + responses: + '200': + description: list of details + +components: + schemas: + Pet: + description: A Pet + required: + - id + - name + properties: + id: + type: integer + format: int64 + readOnly: True + name: + type: string + store: + $ref: '#/components/schemas/Store' + tag: + type: string + x-faker: "$faker->randomElement(['one', 'two', 'three', 'four'])" + Store: + description: A store's description + required: + - id + - name + properties: + id: + type: integer + format: int64 + readOnly: True + name: + type: string + Pets: + type: array + items: + $ref: "#/components/schemas/Pet" + Error: + required: + - code + - message + properties: + code: + type: integer + format: int32 + message: + type: string diff --git a/tests/unit/IssueFixTest.php b/tests/unit/IssueFixTest.php index b6c7abdb..850fae79 100644 --- a/tests/unit/IssueFixTest.php +++ b/tests/unit/IssueFixTest.php @@ -360,4 +360,18 @@ public function test158BugGiiapiGeneratedRulesEnumWithTrim() ]); $this->checkFiles($actualFiles, $expectedFiles); } + + // + public function testControllerNamespaceIssueForModulesInUrlPrefixes() + { + $testFile = Yii::getAlias("@specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php"); + $this->runGenerator($testFile); + $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ + 'recursive' => true, + ]); + $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/mysql"), [ + 'recursive' => true, + ]); + // $this->checkFiles($actualFiles, $expectedFiles); + } } From 0abba240158c2d72229bb28c10115e129fbc8dd5 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 07:20:44 +0530 Subject: [PATCH 02/26] Stub --- README.md | 15 +++++++- src/lib/generators/RestActionGenerator.php | 3 +- src/lib/items/OptionsRoutesTrait.php | 37 +++++++++++++++++++ .../index.php | 2 +- .../index.yaml | 1 + tests/unit/IssueFixTest.php | 12 +++--- 6 files changed, 60 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1ff3e2b4..9b6cf3f8 100644 --- a/README.md +++ b/README.md @@ -610,7 +610,7 @@ then the value for `comments` can be ### `x-route` -To customize route (controller ID/action ID) for a path, use custom key `x-route` with value `/`. It can be used for non-crud paths. It must be used under HTTP method key but not +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 `/`. 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: ```yaml @@ -681,7 +681,18 @@ 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). +`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) + +#### Route, path and namespace TODO + +Route, path and namespace for controller/action will be resolved in following manner (from highest priority to lowest): + + - `x-route` + - `urlPrefixes` + - `controllerNamespace` of this lib + - `controllerNamespace` of Yii app ### `x-description-is-comment` diff --git a/src/lib/generators/RestActionGenerator.php b/src/lib/generators/RestActionGenerator.php index b8d5998c..5ff89685 100644 --- a/src/lib/generators/RestActionGenerator.php +++ b/src/lib/generators/RestActionGenerator.php @@ -154,7 +154,8 @@ protected function prepareAction( : null, 'responseWrapper' => $responseWrapper, 'prefix' => $routeData->getPrefix(), - 'prefixSettings' => $routeData->getPrefixSettings() + 'prefixSettings' => $routeData->getPrefixSettings(), + 'xRoute' => $customRoute # TODO ], ]); } diff --git a/src/lib/items/OptionsRoutesTrait.php b/src/lib/items/OptionsRoutesTrait.php index df9e6714..3b69ce94 100644 --- a/src/lib/items/OptionsRoutesTrait.php +++ b/src/lib/items/OptionsRoutesTrait.php @@ -59,4 +59,41 @@ public static function finalOptionsRoute(string $prefix, string $controllerId): { return trim($prefix, '/') . '/' . $controllerId . '/options'; } + + public function getRouteInfo(): array + { + /** @var ?array $modules */ + $modules = $controllerId = $path = $namespace = null; + + if ($this->xRoute) { + $routeParts = explode('/', $this->xRoute); + $controllerId = $routeParts[count($routeParts)-2]; # last second part is controller ID +// $actionId = $routeParts[count($routeParts)-1]; + unset($routeParts[count($routeParts)-1], $routeParts[count($routeParts)-2]); + $modules = $routeParts; + } + + return [ + 'modules' => $modules, + 'controller_id' => $controllerId, +// 'action_id' => $actionId, + 'path' => $path, + 'namespace' => $namespace, + ]; + } + +// public function getRoute(): string +// { +// +// } +// +// public function getPath(): string +// { +// +// } +// +// public function getNamespace(): string +// { +// +// } } diff --git a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php index 9598be42..657a75fe 100644 --- a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php +++ b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php @@ -9,7 +9,7 @@ ], 'generateControllers' => true, 'generateMigrations' => false, - 'useJsonApi' => true, + 'useJsonApi' => true, # TODO run same tests with `false` 'urlPrefixes' => [ 'animals' => '', '/info' => ['module' =>'petinfo','namespace' => '\app\modules\petinfo\controllers'], diff --git a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml index 90983f0d..efb0c0c5 100644 --- a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml +++ b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml @@ -113,6 +113,7 @@ paths: description: list of details /fgh/pet-detail2s: get: +# x-route: f/l789898 description: list all pet details responses: '200': diff --git a/tests/unit/IssueFixTest.php b/tests/unit/IssueFixTest.php index dabe0b6a..d36e985f 100644 --- a/tests/unit/IssueFixTest.php +++ b/tests/unit/IssueFixTest.php @@ -549,12 +549,12 @@ public function testControllerNamespaceIssueForModulesInUrlPrefixes() { $testFile = Yii::getAlias("@specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php"); $this->runGenerator($testFile); - $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ - 'recursive' => true, - ]); - $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/mysql"), [ - 'recursive' => true, - ]); +// $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ +// 'recursive' => true, +// ]); +// $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/mysql"), [ +// 'recursive' => true, +// ]); // $this->checkFiles($actualFiles, $expectedFiles); } From 9701230bb98eeb8564801c630d330c23a606faec Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 08:10:55 +0530 Subject: [PATCH 03/26] Fix issue https://github.com/php-openapi/yii2-openapi/issues/39 --- src/lib/generators/ControllersGenerator.php | 12 ++++++++---- .../index.php | 3 ++- .../index.yaml | 6 ++++++ 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/src/lib/generators/ControllersGenerator.php b/src/lib/generators/ControllersGenerator.php index ea0c73c4..85ac6a94 100644 --- a/src/lib/generators/ControllersGenerator.php +++ b/src/lib/generators/ControllersGenerator.php @@ -18,7 +18,6 @@ use Laminas\Code\Generator\ValueGenerator; use Yii; use yii\gii\CodeFile; -use yii\helpers\ArrayHelper; use yii\helpers\Inflector; class ControllersGenerator @@ -38,7 +37,9 @@ class ControllersGenerator public function __construct(Config $config, array $actions = []) { $this->config = $config; - $this->controllers = ArrayHelper::index($actions, null, 'controllerId'); + foreach ($actions as $action) { + $this->controllers[$action->prefix . '/' . $action->controllerId][] = $action; + } $this->files = new CodeFiles([]); } @@ -54,7 +55,7 @@ public function generate():CodeFiles $path = $this->config->getPathFromNamespace($namespace); $templateName = $this->config->useJsonApi ? 'controller_jsonapi.php' : 'controller.php'; - foreach ($this->controllers as $controller => $actions) { + foreach ($this->controllers as $controllerWithPrefix => $actions) { $controllerNamespace = $namespace; $controllerPath = $path; /** @@ -66,7 +67,10 @@ public function generate():CodeFiles $controllerPath = $action->prefixSettings['path'] ?? $this->config->getPathFromNamespace($controllerNamespace); } - $className = Inflector::id2camel($controller) . 'Controller'; + + $routeParts = explode('/', $controllerWithPrefix); + + $className = Inflector::id2camel(end($routeParts)) . 'Controller'; $this->files->add(new CodeFile( Yii::getAlias($controllerPath . "/base/$className.php"), $this->config->render( diff --git a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php index 657a75fe..f1e3d21f 100644 --- a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php +++ b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.php @@ -15,6 +15,7 @@ '/info' => ['module' =>'petinfo','namespace' => '\app\modules\petinfo\controllers'], '/fgh' => ['namespace' => '\app\modules\fgh\controllers'], '/fgh2' => ['path' => '@app/modules/fgh2/controllers', 'namespace' => '\app\fgh2\controllers'], - '/api/v1' => ['path' => '@app/modules/api/v1/controllers', 'namespace' => '\app\api\v1\controllers'] + '/api/v1' => ['path' => '@app/modules/api/v1/controllers', 'namespace' => '\app\api\v1\controllers'], + 'theprefix' => ['module' => 'themodule', 'namespace' => '\app\modules\themodule\controllers'] ] ]; diff --git a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml index efb0c0c5..b22d58b6 100644 --- a/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml +++ b/tests/specs/issue_fix/controller_namespace_issue_for_modules_in_urlprefixes/index.yaml @@ -124,6 +124,12 @@ paths: responses: '200': description: list of details + /theprefix/ctrl: + get: + description: list all pet details + responses: + '200': + description: list of details components: schemas: From 0b106c556aea76a2964c5ed5e0ae75b063258d54 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 10:04:51 +0530 Subject: [PATCH 04/26] Fix test --- .../controllers/PetCommentController.php | 3 -- .../mysql/controllers/PetController.php | 12 +++++ .../mysql/controllers/base/PetController.php | 45 +++++++++++++++++++ .../api/v2/controllers/CommentController.php | 3 -- .../controllers/Pet2DetailController.php | 3 -- .../controllers/Pet3DetailController.php | 3 -- .../controllers/PetDetailController.php | 3 -- .../some/controllers/PetController.php | 3 -- .../some/controllers/base/PetController.php | 15 ------- 9 files changed, 57 insertions(+), 33 deletions(-) create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/base/PetController.php diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php index b71a5cb0..99f90a6d 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php @@ -4,7 +4,6 @@ class PetCommentController extends \app\controllers\base\PetCommentController { - public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -14,7 +13,5 @@ public function actionList() { //TODO implement actionList } - - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php new file mode 100644 index 00000000..fc1f5fe9 --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php @@ -0,0 +1,12 @@ + [ + 'class' => \yii\rest\ViewAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'delete' => [ + 'class' => \yii\rest\DeleteAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'update' => [ + 'class' => \yii\rest\UpdateAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'options' => [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php index 55b0bc54..2560cba9 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php @@ -4,7 +4,6 @@ class CommentController extends \app\some\controllers\base\CommentController { - public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -14,7 +13,5 @@ public function actionList() { //TODO implement actionList } - - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php index 550fa36d..f6d105bc 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php @@ -4,7 +4,6 @@ class Pet2DetailController extends \app\modules\forum\controllers\base\Pet2DetailController { - public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -14,7 +13,5 @@ public function actionList() { //TODO implement actionList } - - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php index 9fbebaf9..ed9d4011 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php @@ -4,7 +4,6 @@ class Pet3DetailController extends \app\forum2\controllers\base\Pet3DetailController { - public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -14,7 +13,5 @@ public function actionList() { //TODO implement actionList } - - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php index 8f574d21..01db83bd 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php @@ -4,7 +4,6 @@ class PetDetailController extends \app\modules\petinfo\controllers\base\PetDetailController { - public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -14,7 +13,5 @@ public function actionList() { //TODO implement actionList } - - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php index 729402bc..4fde68be 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php @@ -4,12 +4,9 @@ class PetController extends \app\api\v1\controllers\base\PetController { - public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess } - - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/base/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/base/PetController.php index 8aef1714..29f56fe5 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/base/PetController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/base/PetController.php @@ -17,21 +17,6 @@ public function actions() 'modelClass' => \app\models\Pet::class, 'checkAccess' => [$this, 'checkAccess'], ], - 'view' => [ - 'class' => \yii\rest\ViewAction::class, - 'modelClass' => \app\models\Pet::class, - 'checkAccess' => [$this, 'checkAccess'], - ], - 'delete' => [ - 'class' => \yii\rest\DeleteAction::class, - 'modelClass' => \app\models\Pet::class, - 'checkAccess' => [$this, 'checkAccess'], - ], - 'update' => [ - 'class' => \yii\rest\UpdateAction::class, - 'modelClass' => \app\models\Pet::class, - 'checkAccess' => [$this, 'checkAccess'], - ], 'options' => [ 'class' => \yii\rest\OptionsAction::class, ], From 697af0ea8d284dea28fd85927ce62c809102eb25 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 10:05:11 +0530 Subject: [PATCH 05/26] Fix error in test --- TODO.taskpaper | 6 ++++++ src/lib/generators/RestActionGenerator.php | 1 - .../index.php | 2 +- tests/unit/IssueFixTest.php | 16 ++++++++++++---- 4 files changed, 19 insertions(+), 6 deletions(-) create mode 100644 TODO.taskpaper diff --git a/TODO.taskpaper b/TODO.taskpaper new file mode 100644 index 00000000..616cfd3a --- /dev/null +++ b/TODO.taskpaper @@ -0,0 +1,6 @@ +TODO.taskpaper + + ☐ fix failing tests + ☐ resolve all TODOs + ☐ resolve all sub tasks of issue - Support for Yii Modules in x-route and pertinent places #14 + ☐ delete this file diff --git a/src/lib/generators/RestActionGenerator.php b/src/lib/generators/RestActionGenerator.php index 5ff89685..6d831319 100644 --- a/src/lib/generators/RestActionGenerator.php +++ b/src/lib/generators/RestActionGenerator.php @@ -155,7 +155,6 @@ protected function prepareAction( 'responseWrapper' => $responseWrapper, 'prefix' => $routeData->getPrefix(), 'prefixSettings' => $routeData->getPrefixSettings(), - 'xRoute' => $customRoute # TODO ], ]); } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php index f4e7c94b..3c4da05f 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php @@ -9,7 +9,7 @@ ], 'generateControllers' => true, 'generateMigrations' => false, - 'useJsonApi' => false, + 'useJsonApi' => true, 'urlPrefixes' => [ 'animals' => '', '/info' => ['module' => 'petinfo', 'namespace' => '\app\modules\petinfo\controllers'], diff --git a/tests/unit/IssueFixTest.php b/tests/unit/IssueFixTest.php index d36e985f..7af5480d 100644 --- a/tests/unit/IssueFixTest.php +++ b/tests/unit/IssueFixTest.php @@ -917,10 +917,18 @@ public function test35ResolveTodoReCheckOptionsRouteInFractalAction() // https://github.com/php-openapi/yii2-openapi/issues/35 public function test35ResolveTodoReCheckOptionsRouteInRestAction() { - $testFile = Yii::getAlias("@specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php"); - $content = str_replace("'useJsonApi' => true,", "'useJsonApi' => false,", file_get_contents($testFile)); - file_put_contents($testFile, $content); - $this->runGenerator($testFile); + $config = require_once Yii::getAlias("@specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php"); +// $content = str_replace("'useJsonApi' => true,", "'useJsonApi' => false,", file_get_contents($testFile)); +// file_put_contents($testFile, $content); # TODO this is erroneous + + $config['useJsonApi'] = false; + + $tmpConfigFile = Yii::getAlias("@runtime") . "/tmp-config-35.php"; + file_put_contents($tmpConfigFile, 'runGenerator($tmpConfigFile); $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ 'recursive' => true, ]); From 8240cfb89ec8c09484f9624c2cd1135e838da67e Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 10:06:24 +0530 Subject: [PATCH 06/26] Complete test - follow up of 0b106c556aea76a2964c5ed5e0ae75b063258d54 --- .../mysql/controllers/PetCommentController.php | 3 +++ .../mysql/controllers/PetController.php | 3 +++ .../mysql/modules/api/v2/controllers/CommentController.php | 3 +++ .../mysql/modules/forum/controllers/Pet2DetailController.php | 3 +++ .../mysql/modules/forum2/controllers/Pet3DetailController.php | 3 +++ .../mysql/modules/petinfo/controllers/PetDetailController.php | 3 +++ .../mysql/modules/some/controllers/PetController.php | 3 +++ 7 files changed, 21 insertions(+) diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php index 99f90a6d..b71a5cb0 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php @@ -4,6 +4,7 @@ class PetCommentController extends \app\controllers\base\PetCommentController { + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -13,5 +14,7 @@ public function actionList() { //TODO implement actionList } + + } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php index fc1f5fe9..926d8eea 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php @@ -4,9 +4,12 @@ class PetController extends \app\controllers\base\PetController { + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess } + + } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php index 2560cba9..55b0bc54 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php @@ -4,6 +4,7 @@ class CommentController extends \app\some\controllers\base\CommentController { + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -13,5 +14,7 @@ public function actionList() { //TODO implement actionList } + + } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php index f6d105bc..550fa36d 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum/controllers/Pet2DetailController.php @@ -4,6 +4,7 @@ class Pet2DetailController extends \app\modules\forum\controllers\base\Pet2DetailController { + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -13,5 +14,7 @@ public function actionList() { //TODO implement actionList } + + } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php index ed9d4011..9fbebaf9 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/forum2/controllers/Pet3DetailController.php @@ -4,6 +4,7 @@ class Pet3DetailController extends \app\forum2\controllers\base\Pet3DetailController { + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -13,5 +14,7 @@ public function actionList() { //TODO implement actionList } + + } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php index 01db83bd..8f574d21 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/petinfo/controllers/PetDetailController.php @@ -4,6 +4,7 @@ class PetDetailController extends \app\modules\petinfo\controllers\base\PetDetailController { + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess @@ -13,5 +14,7 @@ public function actionList() { //TODO implement actionList } + + } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php index 4fde68be..729402bc 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/some/controllers/PetController.php @@ -4,9 +4,12 @@ class PetController extends \app\api\v1\controllers\base\PetController { + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess } + + } From 76600807da1c826b5c5ac2235dd824feda8dfc3d Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 15:38:06 +0530 Subject: [PATCH 07/26] Fix error in test --- tests/unit/IssueFixTest.php | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/tests/unit/IssueFixTest.php b/tests/unit/IssueFixTest.php index 7af5480d..813dc8cc 100644 --- a/tests/unit/IssueFixTest.php +++ b/tests/unit/IssueFixTest.php @@ -917,17 +917,12 @@ public function test35ResolveTodoReCheckOptionsRouteInFractalAction() // https://github.com/php-openapi/yii2-openapi/issues/35 public function test35ResolveTodoReCheckOptionsRouteInRestAction() { - $config = require_once Yii::getAlias("@specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php"); -// $content = str_replace("'useJsonApi' => true,", "'useJsonApi' => false,", file_get_contents($testFile)); -// file_put_contents($testFile, $content); # TODO this is erroneous - + $config = []; + $config = require Yii::getAlias("@specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/index.php"); $config['useJsonApi'] = false; - $tmpConfigFile = Yii::getAlias("@runtime") . "/tmp-config-35.php"; file_put_contents($tmpConfigFile, 'runGenerator($tmpConfigFile); $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ 'recursive' => true, From f60960c631db0787d2d4ee45b8fbf00e46993846 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 15:56:49 +0530 Subject: [PATCH 08/26] Fix failing test --- .../controllers/PetController.php | 15 +++++++ .../controllers/base/PetController.php | 45 +++++++++++++++++++ .../api/v1/controllers/base/PetController.php | 15 ------- 3 files changed, 60 insertions(+), 15 deletions(-) create mode 100644 tests/specs/petstore_urlprefixes/controllers/PetController.php create mode 100644 tests/specs/petstore_urlprefixes/controllers/base/PetController.php diff --git a/tests/specs/petstore_urlprefixes/controllers/PetController.php b/tests/specs/petstore_urlprefixes/controllers/PetController.php new file mode 100644 index 00000000..926d8eea --- /dev/null +++ b/tests/specs/petstore_urlprefixes/controllers/PetController.php @@ -0,0 +1,15 @@ + [ + 'class' => \yii\rest\ViewAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'delete' => [ + 'class' => \yii\rest\DeleteAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'update' => [ + 'class' => \yii\rest\UpdateAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'options' => [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + +} diff --git a/tests/specs/petstore_urlprefixes/modules/api/v1/controllers/base/PetController.php b/tests/specs/petstore_urlprefixes/modules/api/v1/controllers/base/PetController.php index 8aef1714..29f56fe5 100644 --- a/tests/specs/petstore_urlprefixes/modules/api/v1/controllers/base/PetController.php +++ b/tests/specs/petstore_urlprefixes/modules/api/v1/controllers/base/PetController.php @@ -17,21 +17,6 @@ public function actions() 'modelClass' => \app\models\Pet::class, 'checkAccess' => [$this, 'checkAccess'], ], - 'view' => [ - 'class' => \yii\rest\ViewAction::class, - 'modelClass' => \app\models\Pet::class, - 'checkAccess' => [$this, 'checkAccess'], - ], - 'delete' => [ - 'class' => \yii\rest\DeleteAction::class, - 'modelClass' => \app\models\Pet::class, - 'checkAccess' => [$this, 'checkAccess'], - ], - 'update' => [ - 'class' => \yii\rest\UpdateAction::class, - 'modelClass' => \app\models\Pet::class, - 'checkAccess' => [$this, 'checkAccess'], - ], 'options' => [ 'class' => \yii\rest\OptionsAction::class, ], From e824afbfd2cf9cc8a3a0fc2f6ba20e36286a940a Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 16:10:02 +0530 Subject: [PATCH 09/26] Fix another test --- .../controllers/PetCommentController.php | 6 ++++ .../mysql/controllers/PetController.php | 6 ++++ .../controllers/base/PetCommentController.php | 7 +++-- .../mysql/controllers/base/PetController.php | 30 ++++++++++++------- .../api/v2/controllers/CommentController.php | 6 ++++ .../v2/controllers/base/CommentController.php | 7 +++-- .../controllers/Pet2DetailController.php | 6 ++++ .../controllers/base/Pet2DetailController.php | 7 +++-- .../controllers/Pet3DetailController.php | 6 ++++ .../controllers/base/Pet3DetailController.php | 7 +++-- .../controllers/PetDetailController.php | 6 ++++ .../controllers/base/PetDetailController.php | 7 +++-- .../some/controllers/PetController.php | 6 ++++ .../some/controllers/base/PetController.php | 24 ++++++++++----- .../mysql/transformers/PetTransformer.php | 10 +++++++ .../mysql/transformers/StoreTransformer.php | 10 +++++++ .../transformers/base/PetTransformer.php | 27 +++++++++++++++++ .../transformers/base/StoreTransformer.php | 16 ++++++++++ 18 files changed, 162 insertions(+), 32 deletions(-) create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/PetTransformer.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/StoreTransformer.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/base/PetTransformer.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/base/StoreTransformer.php diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php index b71a5cb0..560e0858 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetCommentController.php @@ -5,6 +5,12 @@ class PetCommentController extends \app\controllers\base\PetCommentController { + public function actions() + { + $actions = parent::actions(); + return $actions; + } + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php index 926d8eea..a0a80b74 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/PetController.php @@ -5,6 +5,12 @@ class PetController extends \app\controllers\base\PetController { + public function actions() + { + $actions = parent::actions(); + return $actions; + } + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/base/PetCommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/base/PetCommentController.php index 8d207154..3ae0eae2 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/base/PetCommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/controllers/base/PetCommentController.php @@ -1,8 +1,10 @@ [ - 'class' => \yii\rest\ViewAction::class, - 'modelClass' => \app\models\Pet::class, + 'class' => \insolita\fractal\actions\ViewAction::class, 'checkAccess' => [$this, 'checkAccess'], + 'transformer' => \app\transformers\PetTransformer::class, + 'modelClass' => \app\models\Pet::class, + 'resourceKey' => 'pets', + 'findModel' => null ], 'delete' => [ - 'class' => \yii\rest\DeleteAction::class, - 'modelClass' => \app\models\Pet::class, + 'class' => \insolita\fractal\actions\DeleteAction::class, 'checkAccess' => [$this, 'checkAccess'], - ], - 'update' => [ - 'class' => \yii\rest\UpdateAction::class, 'modelClass' => \app\models\Pet::class, + 'findModel' => null + ], + 'update' => [ + 'class' => \insolita\fractal\actions\UpdateAction::class, 'checkAccess' => [$this, 'checkAccess'], + 'transformer' => \app\transformers\PetTransformer::class, + 'modelClass' => \app\models\Pet::class, + 'resourceKey' => 'pets', + 'findModel' => null, + 'allowedRelations'=>[], + 'scenario' => 'default' ], 'options' => [ 'class' => \yii\rest\OptionsAction::class, @@ -41,5 +52,4 @@ public function actions() * @throws \yii\web\ForbiddenHttpException if the user does not have access */ abstract public function checkAccess($action, $model = null, $params = []); - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php index 55b0bc54..c0c562ad 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/CommentController.php @@ -5,6 +5,12 @@ class CommentController extends \app\some\controllers\base\CommentController { + public function actions() + { + $actions = parent::actions(); + return $actions; + } + public function checkAccess($action, $model = null, $params = []) { //TODO implement checkAccess diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/base/CommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/base/CommentController.php index f567c765..c173a6b2 100644 --- a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/base/CommentController.php +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/modules/api/v2/controllers/base/CommentController.php @@ -1,8 +1,10 @@ [ - 'class' => \yii\rest\IndexAction::class, - 'modelClass' => \app\models\Pet::class, + 'class' => \insolita\fractal\actions\ListAction::class, 'checkAccess' => [$this, 'checkAccess'], + 'transformer' => \app\transformers\PetTransformer::class, + 'modelClass' => \app\models\Pet::class, + 'resourceKey' => 'pets', + 'dataFilter' => null, + 'prepareDataProvider' => null ], 'create' => [ - 'class' => \yii\rest\CreateAction::class, - 'modelClass' => \app\models\Pet::class, + 'class' => \insolita\fractal\actions\CreateAction::class, 'checkAccess' => [$this, 'checkAccess'], + 'transformer' => \app\transformers\PetTransformer::class, + 'modelClass' => \app\models\Pet::class, + 'resourceKey' => 'pets', + 'allowedRelations'=>[], + 'viewRoute' => 'view', + 'scenario' => 'default' ], 'options' => [ 'class' => \yii\rest\OptionsAction::class, @@ -36,5 +47,4 @@ public function actions() * @throws \yii\web\ForbiddenHttpException if the user does not have access */ abstract public function checkAccess($action, $model = null, $params = []); - } diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/PetTransformer.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/PetTransformer.php new file mode 100644 index 00000000..997cd425 --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/PetTransformer.php @@ -0,0 +1,10 @@ +getAttributes(); + } + + public function includeStore(Pet $model) + { + $relation = $model->store; + if ($relation === null) { + return $this->null(); + } + $transformer = new StoreTransformer(); + return $this->item($relation, $transformer, 'stores'); + } +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/base/StoreTransformer.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/base/StoreTransformer.php new file mode 100644 index 00000000..7bca97a8 --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql/transformers/base/StoreTransformer.php @@ -0,0 +1,16 @@ +getAttributes(); + } +} From 7649d0fdfb18e5ede292603bbea9aaa0f7f2e2a5 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 21 Mar 2025 16:19:54 +0530 Subject: [PATCH 10/26] Fix another test 2 --- src/lib/generators/RestActionGenerator.php | 2 +- src/lib/items/OptionsRoutesTrait.php | 43 +++++++++--------- .../mysql/config/urls.rest.php | 25 +++++++++++ .../controllers/PetCommentController.php | 20 +++++++++ .../mysql/controllers/PetController.php | 15 +++++++ .../controllers/base/PetCommentController.php | 32 +++++++++++++ .../mysql/controllers/base/PetController.php | 45 +++++++++++++++++++ .../api/v2/controllers/CommentController.php | 20 +++++++++ .../v2/controllers/base/CommentController.php | 32 +++++++++++++ .../controllers/Pet2DetailController.php | 20 +++++++++ .../controllers/base/Pet2DetailController.php | 32 +++++++++++++ .../controllers/Pet3DetailController.php | 20 +++++++++ .../controllers/base/Pet3DetailController.php | 32 +++++++++++++ .../controllers/PetDetailController.php | 20 +++++++++ .../controllers/base/PetDetailController.php | 32 +++++++++++++ .../some/controllers/PetController.php | 15 +++++++ .../some/controllers/base/PetController.php | 40 +++++++++++++++++ tests/unit/IssueFixTest.php | 2 +- 18 files changed, 424 insertions(+), 23 deletions(-) create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/config/urls.rest.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/PetCommentController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/PetController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/base/PetCommentController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/base/PetController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/api/v2/controllers/CommentController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/api/v2/controllers/base/CommentController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum/controllers/Pet2DetailController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum/controllers/base/Pet2DetailController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum2/controllers/Pet3DetailController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum2/controllers/base/Pet3DetailController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/controllers/PetDetailController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/controllers/base/PetDetailController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/some/controllers/PetController.php create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/some/controllers/base/PetController.php diff --git a/src/lib/generators/RestActionGenerator.php b/src/lib/generators/RestActionGenerator.php index 6d831319..b8d5998c 100644 --- a/src/lib/generators/RestActionGenerator.php +++ b/src/lib/generators/RestActionGenerator.php @@ -154,7 +154,7 @@ protected function prepareAction( : null, 'responseWrapper' => $responseWrapper, 'prefix' => $routeData->getPrefix(), - 'prefixSettings' => $routeData->getPrefixSettings(), + 'prefixSettings' => $routeData->getPrefixSettings() ], ]); } diff --git a/src/lib/items/OptionsRoutesTrait.php b/src/lib/items/OptionsRoutesTrait.php index 3b69ce94..d676f78d 100644 --- a/src/lib/items/OptionsRoutesTrait.php +++ b/src/lib/items/OptionsRoutesTrait.php @@ -60,27 +60,28 @@ public static function finalOptionsRoute(string $prefix, string $controllerId): return trim($prefix, '/') . '/' . $controllerId . '/options'; } - public function getRouteInfo(): array - { - /** @var ?array $modules */ - $modules = $controllerId = $path = $namespace = null; - - if ($this->xRoute) { - $routeParts = explode('/', $this->xRoute); - $controllerId = $routeParts[count($routeParts)-2]; # last second part is controller ID -// $actionId = $routeParts[count($routeParts)-1]; - unset($routeParts[count($routeParts)-1], $routeParts[count($routeParts)-2]); - $modules = $routeParts; - } - - return [ - 'modules' => $modules, - 'controller_id' => $controllerId, -// 'action_id' => $actionId, - 'path' => $path, - 'namespace' => $namespace, - ]; - } +// TODO remove +// public function getRouteInfo(): array +// { +// /** @var ?array $modules */ +// $modules = $controllerId = $path = $namespace = null; +// +// if ($this->xRoute) { +// $routeParts = explode('/', $this->xRoute); +// $controllerId = $routeParts[count($routeParts)-2]; # last second part is controller ID +//// $actionId = $routeParts[count($routeParts)-1]; +// unset($routeParts[count($routeParts)-1], $routeParts[count($routeParts)-2]); +// $modules = $routeParts; +// } +// +// return [ +// 'modules' => $modules, +// 'controller_id' => $controllerId, +//// 'action_id' => $actionId, +// 'path' => $path, +// 'namespace' => $namespace, +// ]; +// } // public function getRoute(): string // { diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/config/urls.rest.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/config/urls.rest.php new file mode 100644 index 00000000..fb1998ac --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/config/urls.rest.php @@ -0,0 +1,25 @@ + 'api/v1/pet/list', + 'POST api/v1/pets' => 'api/v1/pet/create', + 'GET animals/pets/' => 'pet/view', + 'DELETE animals/pets/' => 'pet/delete', + 'PATCH animals/pets/' => 'pet/update', + 'GET petComments' => 'pet-comment/list', + 'GET info/pet-details' => 'petinfo/pet-detail/list', + 'GET forum/pet2-details' => 'forum/pet2-detail/list', + 'GET forum2/pet3-details' => 'forum2/pet3-detail/list', + 'GET api/v2/comments' => 'api/v2/comment/list', + 'api/v1/pets' => 'some/pet/options', + 'animals/pets/' => 'pet/options', + 'petComments' => 'pet-comment/options', + 'info/pet-details' => 'petinfo/pet-detail/options', + 'forum/pet2-details' => 'forum/pet2-detail/options', + 'forum2/pet3-details' => 'forum2/pet3-detail/options', + 'api/v2/comments' => 'api/v2/comment/options', +]; diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/PetCommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/PetCommentController.php new file mode 100644 index 00000000..b71a5cb0 --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/PetCommentController.php @@ -0,0 +1,20 @@ + [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + + abstract public function actionList(); + +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/base/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/base/PetController.php new file mode 100644 index 00000000..9f6daa3e --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/controllers/base/PetController.php @@ -0,0 +1,45 @@ + [ + 'class' => \yii\rest\ViewAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'delete' => [ + 'class' => \yii\rest\DeleteAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'update' => [ + 'class' => \yii\rest\UpdateAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'options' => [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/api/v2/controllers/CommentController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/api/v2/controllers/CommentController.php new file mode 100644 index 00000000..55b0bc54 --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/api/v2/controllers/CommentController.php @@ -0,0 +1,20 @@ + [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + + abstract public function actionList(); + +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum/controllers/Pet2DetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum/controllers/Pet2DetailController.php new file mode 100644 index 00000000..550fa36d --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum/controllers/Pet2DetailController.php @@ -0,0 +1,20 @@ + [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + + abstract public function actionList(); + +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum2/controllers/Pet3DetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum2/controllers/Pet3DetailController.php new file mode 100644 index 00000000..9fbebaf9 --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/forum2/controllers/Pet3DetailController.php @@ -0,0 +1,20 @@ + [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + + abstract public function actionList(); + +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/controllers/PetDetailController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/controllers/PetDetailController.php new file mode 100644 index 00000000..8f574d21 --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/controllers/PetDetailController.php @@ -0,0 +1,20 @@ + [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + + abstract public function actionList(); + +} diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/some/controllers/PetController.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/some/controllers/PetController.php new file mode 100644 index 00000000..729402bc --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/some/controllers/PetController.php @@ -0,0 +1,15 @@ + [ + 'class' => \yii\rest\IndexAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'create' => [ + 'class' => \yii\rest\CreateAction::class, + 'modelClass' => \app\models\Pet::class, + 'checkAccess' => [$this, 'checkAccess'], + ], + 'options' => [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + +} diff --git a/tests/unit/IssueFixTest.php b/tests/unit/IssueFixTest.php index 813dc8cc..3d95827a 100644 --- a/tests/unit/IssueFixTest.php +++ b/tests/unit/IssueFixTest.php @@ -927,7 +927,7 @@ public function test35ResolveTodoReCheckOptionsRouteInRestAction() $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ 'recursive' => true, ]); - $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/35_resolve_todo_re_check_options_route_in_fractal_action/mysql"), [ + $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql"), [ 'recursive' => true, ]); $this->checkFiles($actualFiles, $expectedFiles); From 232627acc394f65db0db4728a1ce249ab8972a46 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Mon, 24 Mar 2025 18:22:05 +0530 Subject: [PATCH 11/26] Implement nested modules in `x-route` - WIP --- README.md | 13 ++++-- TODO.taskpaper | 3 +- src/lib/generators/RestActionGenerator.php | 11 +++-- src/lib/items/RestAction.php | 10 +++++ src/lib/items/RouteData.php | 43 ++++++++++++++++++- .../14_nested_module_in_x_route/index.php | 13 ++++++ .../14_nested_module_in_x_route/index.yml | 14 ++++++ tests/unit/issues/Issue14Test.php | 25 +++++++++++ 8 files changed, 121 insertions(+), 11 deletions(-) create mode 100644 tests/specs/issue_fix/14_nested_module_in_x_route/index.php create mode 100644 tests/specs/issue_fix/14_nested_module_in_x_route/index.yml create mode 100644 tests/unit/issues/Issue14Test.php diff --git a/README.md b/README.md index 9b6cf3f8..5a95db76 100644 --- a/README.md +++ b/README.md @@ -689,10 +689,15 @@ 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` - - `urlPrefixes` - - `controllerNamespace` of this lib - - `controllerNamespace` of Yii app +- [`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 ### `x-description-is-comment` diff --git a/TODO.taskpaper b/TODO.taskpaper index 616cfd3a..cfb02859 100644 --- a/TODO.taskpaper +++ b/TODO.taskpaper @@ -1,6 +1,7 @@ TODO.taskpaper - ☐ fix failing tests + ✔ fix failing tests @done (25-03-21 16:20) ☐ resolve all TODOs ☐ resolve all sub tasks of issue - Support for Yii Modules in x-route and pertinent places #14 + ☐ Implement code generation for nested module in `x-route` and other pertinent place ☐ delete this file diff --git a/src/lib/generators/RestActionGenerator.php b/src/lib/generators/RestActionGenerator.php index b8d5998c..014ac84a 100644 --- a/src/lib/generators/RestActionGenerator.php +++ b/src/lib/generators/RestActionGenerator.php @@ -71,8 +71,8 @@ protected function resolvePath(string $path, PathItem $pathItem):array { $actions = []; - $routeData = Yii::createObject(RouteData::class, [$pathItem, $path, $this->config->urlPrefixes]); foreach ($pathItem->getOperations() as $method => $operation) { + $routeData = Yii::createObject(RouteData::class, [$path, $pathItem, $method, $operation, $this->config->urlPrefixes]); $customRoute = null; if (isset($operation->{CustomSpecAttr::ROUTE})) { # https://github.com/cebe/yii2-openapi/issues/144 $customRoute = $operation->{CustomSpecAttr::ROUTE}; @@ -130,14 +130,16 @@ protected function prepareAction( ? Inflector::camel2id($this->config->controllerModelMap[$modelClass]) : Inflector::camel2id($modelClass); } elseif (!empty($customRoute)) { - $controllerId = explode('/', $customRoute)[0]; + $parts = explode('/', $customRoute); + $controllerId = $parts[count($parts) - 2]; } else { $controllerId = $routeData->controller; } $action = Inflector::camel2id($routeData->action); if (!empty($customRoute)) { $actionType = ''; - $action = explode('/', $customRoute)[1]; + $parts = explode('/', $customRoute); + $action = $parts[count($parts) - 1]; } return Yii::createObject(RestAction::class, [ [ @@ -154,7 +156,8 @@ protected function prepareAction( : null, 'responseWrapper' => $responseWrapper, 'prefix' => $routeData->getPrefix(), - 'prefixSettings' => $routeData->getPrefixSettings() + 'prefixSettings' => $routeData->getPrefixSettings(), + 'xRoute' => $customRoute ], ]); } diff --git a/src/lib/items/RestAction.php b/src/lib/items/RestAction.php index c1f8da90..16c29856 100644 --- a/src/lib/items/RestAction.php +++ b/src/lib/items/RestAction.php @@ -70,6 +70,11 @@ final class RestAction extends BaseObject */ public $responseWrapper; + /** + * @var ?string + */ + public $xRoute; + /** * @var bool * @see $isDuplicate @@ -91,10 +96,15 @@ final class RestAction extends BaseObject public function getRoute():string { + if ($this->xRoute) { + return $this->xRoute; + } + if ($this->prefix && !empty($this->prefixSettings)) { $prefix = $this->prefixSettings['module'] ?? $this->prefix; return trim($prefix, '/') . '/' . $this->controllerId . '/' . $this->id; } + return $this->controllerId . '/' . $this->id; } diff --git a/src/lib/items/RouteData.php b/src/lib/items/RouteData.php index e50ab37a..1ab0ea4b 100644 --- a/src/lib/items/RouteData.php +++ b/src/lib/items/RouteData.php @@ -7,7 +7,9 @@ namespace cebe\yii2openapi\lib\items; +use cebe\openapi\spec\Operation; use cebe\openapi\spec\PathItem; +use cebe\yii2openapi\lib\CustomSpecAttr; use yii\base\BaseObject; use yii\base\InvalidCallException; use yii\helpers\ArrayHelper; @@ -164,12 +166,49 @@ final class RouteData extends BaseObject */ private $urlPrefixes; - public function __construct(PathItem $pathItem, string $path, array $urlPrefixes = [], $config = []) - { + /** + * @var string + */ + private $method; + + /** + * @var Operation + */ + private $operation; + + public function __construct( + string $path, + PathItem $pathItem, + string $method, + Operation $operation, + array $urlPrefixes = [], + $config = [] + ) { $this->path = $this->unprefixedPath = $path; $this->parts = explode('/', trim($path, '/')); $this->pathItem = $pathItem; + $this->method = $method; + $this->operation = $operation; $this->urlPrefixes = $urlPrefixes; + + if (isset($operation->{CustomSpecAttr::ROUTE})) { # https://github.com/cebe/yii2-openapi/issues/144 + $customRoute = $operation->{CustomSpecAttr::ROUTE}; + $parts = explode('/', $customRoute); + array_pop($parts); + array_pop($parts); + $this->prefix = implode('/', $parts); # add everything except controller ID and action ID + + $modulesPath = []; + foreach ($parts as $module) { + $modulesPath[] = 'modules/' . $module; + } + + $this->prefixSettings = [ + 'namespace' => 'app\\' . implode('\\', $parts) . '\\controllers', + 'path' => 'app/' . implode('/', $modulesPath) . '/controllers' + ]; + } + parent::__construct($config); } diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/index.php b/tests/specs/issue_fix/14_nested_module_in_x_route/index.php new file mode 100644 index 00000000..a9990a13 --- /dev/null +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/index.php @@ -0,0 +1,13 @@ + '@specs/issue_fix/14_nested_module_in_x_route/index.yml', + 'generateUrls' => true, + 'generateModels' => true, + 'excludeModels' => [ + 'Error', + ], + 'generateControllers' => true, + 'generateMigrations' => false, + 'generateModelFaker' => false, +]; diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/index.yml b/tests/specs/issue_fix/14_nested_module_in_x_route/index.yml new file mode 100644 index 00000000..48fdf126 --- /dev/null +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/index.yml @@ -0,0 +1,14 @@ +openapi: "3.0.0" +info: + version: 1.0.0 + title: Issue14Test testNestedModuleInXRoute \#14 + +paths: + /: + get: + x-route: fruit/mango/alphonso/view + summary: List + operationId: list + responses: + '200': + description: The information diff --git a/tests/unit/issues/Issue14Test.php b/tests/unit/issues/Issue14Test.php new file mode 100644 index 00000000..e398cdf3 --- /dev/null +++ b/tests/unit/issues/Issue14Test.php @@ -0,0 +1,25 @@ +runGenerator($testFile); + // $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ + // 'recursive' => true, + // ]); + // $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/mysql"), [ + // 'recursive' => true, + // ]); + // $this->checkFiles($actualFiles, $expectedFiles); + } +} From 5d2d63c6e197ee71ea5b572c9f08e31704dca4cf Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Mon, 24 Mar 2025 18:24:04 +0530 Subject: [PATCH 12/26] Fix bug in module path --- src/lib/items/RouteData.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/items/RouteData.php b/src/lib/items/RouteData.php index 1ab0ea4b..7e8d13e4 100644 --- a/src/lib/items/RouteData.php +++ b/src/lib/items/RouteData.php @@ -205,7 +205,7 @@ public function __construct( $this->prefixSettings = [ 'namespace' => 'app\\' . implode('\\', $parts) . '\\controllers', - 'path' => 'app/' . implode('/', $modulesPath) . '/controllers' + 'path' => '@app/' . implode('/', $modulesPath) . '/controllers' ]; } From 17a40fa7dd15da971a635d15d4ed7b18337769d8 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Tue, 25 Mar 2025 17:20:00 +0530 Subject: [PATCH 13/26] Add Module.php file generator - WIP --- README.md | 16 ++++------- src/lib/generators/ControllersGenerator.php | 2 +- src/lib/generators/ModuleFileGenerator.php | 28 +++++++++++++++++++ src/lib/items/FractalAction.php | 2 +- src/lib/items/OptionsRoutesTrait.php | 2 +- src/lib/items/RestAction.php | 2 +- src/lib/items/RouteData.php | 22 ++++++++++++--- .../14_nested_module_in_x_route/index.php | 1 + 8 files changed, 56 insertions(+), 19 deletions(-) create mode 100644 src/lib/generators/ModuleFileGenerator.php diff --git a/README.md b/README.md index 5a95db76..c2a0317f 100644 --- a/README.md +++ b/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 `/`. 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 `[//...]/`. 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 `` and `` 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` diff --git a/src/lib/generators/ControllersGenerator.php b/src/lib/generators/ControllersGenerator.php index 85ac6a94..06637fe4 100644 --- a/src/lib/generators/ControllersGenerator.php +++ b/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); diff --git a/src/lib/generators/ModuleFileGenerator.php b/src/lib/generators/ModuleFileGenerator.php new file mode 100644 index 00000000..7692f159 --- /dev/null +++ b/src/lib/generators/ModuleFileGenerator.php @@ -0,0 +1,28 @@ + 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() + { + } +} diff --git a/src/lib/items/FractalAction.php b/src/lib/items/FractalAction.php index d95d7d6d..4b0dcec0 100644 --- a/src/lib/items/FractalAction.php +++ b/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; } diff --git a/src/lib/items/OptionsRoutesTrait.php b/src/lib/items/OptionsRoutesTrait.php index d676f78d..5f1c64ca 100644 --- a/src/lib/items/OptionsRoutesTrait.php +++ b/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); diff --git a/src/lib/items/RestAction.php b/src/lib/items/RestAction.php index 16c29856..bac51845 100644 --- a/src/lib/items/RestAction.php +++ b/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; } diff --git a/src/lib/items/RouteData.php b/src/lib/items/RouteData.php index 7e8d13e4..e578c9c5 100644 --- a/src/lib/items/RouteData.php +++ b/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; + } } diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/index.php b/tests/specs/issue_fix/14_nested_module_in_x_route/index.php index a9990a13..cfb578e0 100644 --- a/tests/specs/issue_fix/14_nested_module_in_x_route/index.php +++ b/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', ], From 1bc56b8814086e5e113bdfee358c453df2cedb8e Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Tue, 25 Mar 2025 18:09:38 +0530 Subject: [PATCH 14/26] Fix failing tests --- src/lib/items/RouteData.php | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/lib/items/RouteData.php b/src/lib/items/RouteData.php index e578c9c5..1b929c19 100644 --- a/src/lib/items/RouteData.php +++ b/src/lib/items/RouteData.php @@ -209,10 +209,12 @@ public function __construct( } $this->moduleList = $modulesPath; - $this->prefixSettings = [ - 'namespace' => 'app\\' . implode('\\', $parts) . '\\controllers', - 'path' => '@app/' . implode('/', $modulesPathSection) . '/controllers' - ]; + if ($parts) { + $this->prefixSettings = [ + 'namespace' => 'app\\' . implode('\\', $parts) . '\\controllers', + 'path' => '@app/' . implode('/', $modulesPathSection) . '/controllers' + ]; + } } parent::__construct($config); From d0f86cef695ecd4e1b5c630b3046c5726e42c8de Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Wed, 26 Mar 2025 11:33:48 +0530 Subject: [PATCH 15/26] Support for nested modules --- src/lib/generators/ControllersGenerator.php | 46 +++++++++++++++++++++ src/lib/generators/RestActionGenerator.php | 3 +- src/lib/items/RestAction.php | 5 +++ src/lib/items/RouteData.php | 11 ++--- 4 files changed, 59 insertions(+), 6 deletions(-) diff --git a/src/lib/generators/ControllersGenerator.php b/src/lib/generators/ControllersGenerator.php index 06637fe4..86c52d25 100644 --- a/src/lib/generators/ControllersGenerator.php +++ b/src/lib/generators/ControllersGenerator.php @@ -90,6 +90,18 @@ public function generate():CodeFiles $classFileGenerator->generate() )); } + + foreach ($action->modulesList as $moduleId => $moduleDetail) { + // only generate Module.php file if they do not exist, do not override + if (!file_exists(Yii::getAlias($moduleDetail['path'] . "/Module.php"))) { + // $moduleNamespace = str_replace('\controllers', '', $action->prefixSettings['namespace']); + $moduleFileGenerator = $this->makeModuleFile('Module', $moduleDetail['namespace'], $moduleId, $action); + $this->files->add(new CodeFile( + Yii::getAlias($moduleDetail['path'] . "/Module.php"), + $moduleFileGenerator->generate() + )); + } + } } return $this->files; } @@ -160,4 +172,38 @@ protected function makeCustomController( $classFileGenerator->setClasses([$reflection]); return $classFileGenerator; } + + /** + * @param RestAction|FractalAction $action + */ + public function makeModuleFile(string $class, string $namespace, $moduleId, $action): FileGenerator + { + $file = new FileGenerator; + $reflection = new ClassGenerator( + $class, + $namespace, + null, + 'yii\base\Module' + ); + + $moduleIds = array_keys($action->modulesList); + $position = array_search($moduleId, $moduleIds); + $childModuleId = $childModuleCode = null; + if (array_key_exists($position + 1, $moduleIds)) { # if `true`, child module exists + $childModuleId = $moduleIds[$position + 1]; + $childModuleNamespace = $action->modulesList[$childModuleId]['namespace']; + $childModuleCode = <<modules = [ + '{$childModuleId}' => [ + // you should consider using a shorter namespace here! + 'class' => \\{$childModuleNamespace}\Module::class, + ], +]; +PHP; + } + + $reflection->addMethod('init', [], AbstractMemberGenerator::FLAG_PUBLIC, 'parent::init();' . PHP_EOL . $childModuleCode); + $file->setClasses([$reflection]); + return $file; + } } diff --git a/src/lib/generators/RestActionGenerator.php b/src/lib/generators/RestActionGenerator.php index 014ac84a..751e7568 100644 --- a/src/lib/generators/RestActionGenerator.php +++ b/src/lib/generators/RestActionGenerator.php @@ -157,7 +157,8 @@ protected function prepareAction( 'responseWrapper' => $responseWrapper, 'prefix' => $routeData->getPrefix(), 'prefixSettings' => $routeData->getPrefixSettings(), - 'xRoute' => $customRoute + 'xRoute' => $customRoute, + 'modulesList' => $routeData->listModules() ], ]); } diff --git a/src/lib/items/RestAction.php b/src/lib/items/RestAction.php index bac51845..c79c478e 100644 --- a/src/lib/items/RestAction.php +++ b/src/lib/items/RestAction.php @@ -75,6 +75,11 @@ final class RestAction extends BaseObject */ public $xRoute; + /** + * @var array list of module this action is part of. 'key' is module ID and 'value' is path where Module.php file must be generated + */ + public $modulesList = []; + /** * @var bool * @see $isDuplicate diff --git a/src/lib/items/RouteData.php b/src/lib/items/RouteData.php index 1b929c19..a49285cc 100644 --- a/src/lib/items/RouteData.php +++ b/src/lib/items/RouteData.php @@ -201,11 +201,12 @@ public function __construct( // $this->prefix = implode('/', $parts); # add everything (modules) except controller ID and action ID $modulesPathSection = $modulesPath = []; - $container = ''; - foreach ($parts as $module) { - $modulesPathSection[$module] = 'modules/' . $module; - $container .= ($container !== '' ? '/' : '') . ('modules/' . $module); - $modulesPath[$module] = '@app/'.$container; + $container = $modulesNamespaceSection = ''; + foreach ($parts as $moduleId) { + $modulesPathSection[$moduleId] = 'modules/' . $moduleId; + $container .= ($container !== '' ? '/' : '') . ('modules/' . $moduleId); + $modulesNamespaceSection .= ($modulesNamespaceSection ? '\\' : '') . ($moduleId); + $modulesPath[$moduleId] = ['path' => '@app/' . $container, 'namespace' => 'app\\' . $modulesNamespaceSection]; } $this->moduleList = $modulesPath; From e571d2ca36954f7a711bd957d7c180af5bb1f127 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Wed, 26 Mar 2025 11:49:54 +0530 Subject: [PATCH 16/26] Refactor + fix failing test --- TODO.taskpaper | 4 ++-- ...{OptionsRoutesTrait.php => ActionHelperTrait.php} | 12 +++++++++++- src/lib/items/FractalAction.php | 2 +- src/lib/items/RestAction.php | 12 +----------- 4 files changed, 15 insertions(+), 15 deletions(-) rename src/lib/items/{OptionsRoutesTrait.php => ActionHelperTrait.php} (92%) diff --git a/TODO.taskpaper b/TODO.taskpaper index cfb02859..4f843597 100644 --- a/TODO.taskpaper +++ b/TODO.taskpaper @@ -1,7 +1,7 @@ TODO.taskpaper ✔ fix failing tests @done (25-03-21 16:20) - ☐ resolve all TODOs + ✔ Implement code generation for nested module in `x-route` and other pertinent place @done (25-03-26 11:38) ☐ resolve all sub tasks of issue - Support for Yii Modules in x-route and pertinent places #14 - ☐ Implement code generation for nested module in `x-route` and other pertinent place + ☐ resolve all TODOs ☐ delete this file diff --git a/src/lib/items/OptionsRoutesTrait.php b/src/lib/items/ActionHelperTrait.php similarity index 92% rename from src/lib/items/OptionsRoutesTrait.php rename to src/lib/items/ActionHelperTrait.php index 5f1c64ca..07dabeda 100644 --- a/src/lib/items/OptionsRoutesTrait.php +++ b/src/lib/items/ActionHelperTrait.php @@ -7,8 +7,18 @@ namespace cebe\yii2openapi\lib\items; -trait OptionsRoutesTrait +trait ActionHelperTrait { + /** + * @var ?string + */ + public $xRoute; + + /** + * @var array list of module this action is part of. 'key' is module ID and 'value' is path where Module.php file must be generated + */ + public $modulesList = []; + public function getOptionsRoute():string { if (!empty($this->prefixSettings)) { diff --git a/src/lib/items/FractalAction.php b/src/lib/items/FractalAction.php index 4b0dcec0..80ee0820 100644 --- a/src/lib/items/FractalAction.php +++ b/src/lib/items/FractalAction.php @@ -32,7 +32,7 @@ */ final class FractalAction extends BaseObject { - use OptionsRoutesTrait; + use ActionHelperTrait; /**@var string* */ public $id; diff --git a/src/lib/items/RestAction.php b/src/lib/items/RestAction.php index c79c478e..69fc1be6 100644 --- a/src/lib/items/RestAction.php +++ b/src/lib/items/RestAction.php @@ -31,7 +31,7 @@ */ final class RestAction extends BaseObject { - use OptionsRoutesTrait; + use ActionHelperTrait; /**@var string* */ public $id; @@ -70,16 +70,6 @@ final class RestAction extends BaseObject */ public $responseWrapper; - /** - * @var ?string - */ - public $xRoute; - - /** - * @var array list of module this action is part of. 'key' is module ID and 'value' is path where Module.php file must be generated - */ - public $modulesList = []; - /** * @var bool * @see $isDuplicate From 424a6c128c1b6782bc54bd7839716ac62a171fa7 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Wed, 26 Mar 2025 11:50:53 +0530 Subject: [PATCH 17/26] Cleanup --- src/lib/items/ActionHelperTrait.php | 38 ----------------------------- 1 file changed, 38 deletions(-) diff --git a/src/lib/items/ActionHelperTrait.php b/src/lib/items/ActionHelperTrait.php index 07dabeda..913ee8ec 100644 --- a/src/lib/items/ActionHelperTrait.php +++ b/src/lib/items/ActionHelperTrait.php @@ -69,42 +69,4 @@ public static function finalOptionsRoute(string $prefix, string $controllerId): { return trim($prefix, '/') . '/' . $controllerId . '/options'; } - -// TODO remove -// public function getRouteInfo(): array -// { -// /** @var ?array $modules */ -// $modules = $controllerId = $path = $namespace = null; -// -// if ($this->xRoute) { -// $routeParts = explode('/', $this->xRoute); -// $controllerId = $routeParts[count($routeParts)-2]; # last second part is controller ID -//// $actionId = $routeParts[count($routeParts)-1]; -// unset($routeParts[count($routeParts)-1], $routeParts[count($routeParts)-2]); -// $modules = $routeParts; -// } -// -// return [ -// 'modules' => $modules, -// 'controller_id' => $controllerId, -//// 'action_id' => $actionId, -// 'path' => $path, -// 'namespace' => $namespace, -// ]; -// } - -// public function getRoute(): string -// { -// -// } -// -// public function getPath(): string -// { -// -// } -// -// public function getNamespace(): string -// { -// -// } } From 3720768982a23515ca3e92dd536fcb3279ab561a Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Wed, 26 Mar 2025 16:43:34 +0530 Subject: [PATCH 18/26] Refactor + complete the test --- src/lib/items/ActionHelperTrait.php | 11 ++----- .../mysql/config/urls.rest.php | 10 ++++++ .../mysql/modules/fruit/Module.php | 21 ++++++++++++ .../modules/fruit/modules/mango/Module.php | 15 +++++++++ .../mango/controllers/AlphonsoController.php | 20 ++++++++++++ .../controllers/base/AlphonsoController.php | 32 +++++++++++++++++++ tests/unit/issues/Issue14Test.php | 15 ++++----- 7 files changed, 108 insertions(+), 16 deletions(-) create mode 100644 tests/specs/issue_fix/14_nested_module_in_x_route/mysql/config/urls.rest.php create mode 100644 tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php create mode 100644 tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/modules/mango/Module.php create mode 100644 tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/modules/mango/controllers/AlphonsoController.php create mode 100644 tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/modules/mango/controllers/base/AlphonsoController.php diff --git a/src/lib/items/ActionHelperTrait.php b/src/lib/items/ActionHelperTrait.php index 913ee8ec..73a1bb74 100644 --- a/src/lib/items/ActionHelperTrait.php +++ b/src/lib/items/ActionHelperTrait.php @@ -9,15 +9,10 @@ trait ActionHelperTrait { - /** - * @var ?string - */ - public $xRoute; + public ?string $xRoute; - /** - * @var array list of module this action is part of. 'key' is module ID and 'value' is path where Module.php file must be generated - */ - public $modulesList = []; + # list of module this action is part of. 'key' is module ID and 'value' is path where Module.php file must be generated + public array $modulesList = []; public function getOptionsRoute():string { diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/config/urls.rest.php b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/config/urls.rest.php new file mode 100644 index 00000000..68246c5a --- /dev/null +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/config/urls.rest.php @@ -0,0 +1,10 @@ + 'fruit/mango/alphonso/view', + '' => 'fruit/alphonso/options', +]; diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php new file mode 100644 index 00000000..e05022e9 --- /dev/null +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php @@ -0,0 +1,21 @@ +modules = [ + 'mango' => [ + // you should consider using a shorter namespace here! + 'class' => \app\fruit\mango\Module::class, + ], + ]; + } + + +} + diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/modules/mango/Module.php b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/modules/mango/Module.php new file mode 100644 index 00000000..e0e13d8f --- /dev/null +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/modules/mango/Module.php @@ -0,0 +1,15 @@ + [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + + abstract public function actionView(); + +} diff --git a/tests/unit/issues/Issue14Test.php b/tests/unit/issues/Issue14Test.php index e398cdf3..414c796f 100644 --- a/tests/unit/issues/Issue14Test.php +++ b/tests/unit/issues/Issue14Test.php @@ -4,7 +4,6 @@ use tests\DbTestCase; use Yii; -use yii\base\InvalidArgumentException; use yii\helpers\FileHelper; # https://github.com/php-openapi/yii2-openapi/issues/14 @@ -14,12 +13,12 @@ public function testNestedModuleInXRoute() { $testFile = Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/index.php"); $this->runGenerator($testFile); - // $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ - // 'recursive' => true, - // ]); - // $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/mysql"), [ - // 'recursive' => true, - // ]); - // $this->checkFiles($actualFiles, $expectedFiles); + $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ + 'recursive' => true, + ]); + $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/mysql"), [ + 'recursive' => true, + ]); + $this->checkFiles($actualFiles, $expectedFiles); } } From c567892cfe7bdac6ff16d9f466c176748af62edf Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Thu, 27 Mar 2025 16:25:13 +0530 Subject: [PATCH 19/26] Fix failing test --- tests/unit/RestActionGeneratorTest.php | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/tests/unit/RestActionGeneratorTest.php b/tests/unit/RestActionGeneratorTest.php index 7fb792d6..2422faf8 100644 --- a/tests/unit/RestActionGeneratorTest.php +++ b/tests/unit/RestActionGeneratorTest.php @@ -475,6 +475,7 @@ public function dataProviderWithNamingMap():array 'params' => [], 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', + 'xRoute' => null, 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], ]), new RestAction([ @@ -487,6 +488,7 @@ public function dataProviderWithNamingMap():array 'params' => ['id' => ['type' => 'integer']], 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', + 'xRoute' => null, 'responseWrapper' => ['item' => 'post', 'list' => null, 'type' => 'object'], ]), new RestAction([ @@ -501,6 +503,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', + 'xRoute' => null, 'responseWrapper' => ['item' => 'category', 'list' => null, 'type' => 'object'], ]), new RestAction([ @@ -515,6 +518,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', + 'xRoute' => null, 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], ]), new RestAction([ @@ -529,6 +533,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', + 'xRoute' => null, 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], ]), new RestAction([ @@ -543,6 +548,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', + 'xRoute' => null, 'responseWrapper' => null, ]), new RestAction([ @@ -558,6 +564,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', + 'xRoute' => null, 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], ]), new RestAction([ @@ -573,6 +580,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', + 'xRoute' => null, 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], ]), new RestAction([ @@ -588,6 +596,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', + 'xRoute' => null, 'responseWrapper' => null, ]), new RestAction([ @@ -603,6 +612,7 @@ public function dataProviderWithNamingMap():array ], 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', + 'xRoute' => null, 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], ]), ], From 452aa579e8a77b2b4d8b3df7b99768c37bac6971 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Thu, 27 Mar 2025 16:45:24 +0530 Subject: [PATCH 20/26] Fix failing test --- src/lib/generators/ControllersGenerator.php | 3 +-- src/lib/generators/ModuleFileGenerator.php | 28 --------------------- tests/unit/RestActionGeneratorTest.php | 24 ++++++++++++++++++ 3 files changed, 25 insertions(+), 30 deletions(-) delete mode 100644 src/lib/generators/ModuleFileGenerator.php diff --git a/src/lib/generators/ControllersGenerator.php b/src/lib/generators/ControllersGenerator.php index 86c52d25..a0fc3826 100644 --- a/src/lib/generators/ControllersGenerator.php +++ b/src/lib/generators/ControllersGenerator.php @@ -91,10 +91,10 @@ public function generate():CodeFiles )); } + // generate Module.php file for modules foreach ($action->modulesList as $moduleId => $moduleDetail) { // only generate Module.php file if they do not exist, do not override if (!file_exists(Yii::getAlias($moduleDetail['path'] . "/Module.php"))) { - // $moduleNamespace = str_replace('\controllers', '', $action->prefixSettings['namespace']); $moduleFileGenerator = $this->makeModuleFile('Module', $moduleDetail['namespace'], $moduleId, $action); $this->files->add(new CodeFile( Yii::getAlias($moduleDetail['path'] . "/Module.php"), @@ -195,7 +195,6 @@ public function makeModuleFile(string $class, string $namespace, $moduleId, $act $childModuleCode = <<modules = [ '{$childModuleId}' => [ - // you should consider using a shorter namespace here! 'class' => \\{$childModuleNamespace}\Module::class, ], ]; diff --git a/src/lib/generators/ModuleFileGenerator.php b/src/lib/generators/ModuleFileGenerator.php deleted file mode 100644 index 7692f159..00000000 --- a/src/lib/generators/ModuleFileGenerator.php +++ /dev/null @@ -1,28 +0,0 @@ - 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() - { - } -} diff --git a/tests/unit/RestActionGeneratorTest.php b/tests/unit/RestActionGeneratorTest.php index 2422faf8..605939d2 100644 --- a/tests/unit/RestActionGeneratorTest.php +++ b/tests/unit/RestActionGeneratorTest.php @@ -106,6 +106,7 @@ public function dataProvider():array 'prefix' => '', 'prefixSettings' => [], 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'view', @@ -118,6 +119,7 @@ public function dataProvider():array 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', 'responseWrapper' => ['item' => 'post', 'list' => null, 'type' => 'object'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'view-related-category', @@ -132,6 +134,7 @@ public function dataProvider():array 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', 'responseWrapper' => ['item' => 'category', 'list' => null, 'type' => 'object'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'list-related-comments', @@ -146,6 +149,7 @@ public function dataProvider():array 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'list-for-post', @@ -160,6 +164,7 @@ public function dataProvider():array 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'create-for-post', @@ -174,6 +179,7 @@ public function dataProvider():array 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', 'responseWrapper' => null, + 'xRoute' => null, ]), new RestAction([ 'id' => 'view-for-category', @@ -189,6 +195,7 @@ public function dataProvider():array 'modelName' => 'Post', 'modelFqn' => 'app\models\Post', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'view-for-post', @@ -204,6 +211,7 @@ public function dataProvider():array 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'delete-for-post', @@ -219,6 +227,7 @@ public function dataProvider():array 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', 'responseWrapper' => null, + 'xRoute' => null, ]), new RestAction([ 'id' => 'update-for-post', @@ -234,6 +243,7 @@ public function dataProvider():array 'modelName' => 'Comment', 'modelFqn' => 'app\models\Comment', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], + 'xRoute' => null, ]), ], ], @@ -252,6 +262,7 @@ public function dataProvider():array 'modelName' => 'Pet', 'modelFqn' => 'app\mymodels\Pet', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'create', @@ -264,6 +275,7 @@ public function dataProvider():array 'modelName' => 'Pet', 'modelFqn' => 'app\mymodels\Pet', 'responseWrapper' => null, + 'xRoute' => null, ]), new RestAction([ 'id' => 'view', @@ -276,6 +288,7 @@ public function dataProvider():array 'modelName' => 'Pet', 'modelFqn' => 'app\mymodels\Pet', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'delete', @@ -288,6 +301,7 @@ public function dataProvider():array 'modelName' => 'Pet', 'modelFqn' => 'app\mymodels\Pet', 'responseWrapper' => null, + 'xRoute' => null, ]), new RestAction([ 'id' => 'update', @@ -300,6 +314,7 @@ public function dataProvider():array 'modelName' => 'Pet', 'modelFqn' => 'app\mymodels\Pet', 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], + 'xRoute' => null, ]), new RestAction([ 'id' => 'list', @@ -312,6 +327,7 @@ public function dataProvider():array 'modelName' => null, 'modelFqn' => null, 'responseWrapper' => null, + 'xRoute' => null, ]), new RestAction([ 'id' => 'list', @@ -324,6 +340,7 @@ public function dataProvider():array 'modelName' => null, 'modelFqn' => null, 'responseWrapper' => null, + 'xRoute' => null, ]), ], ], @@ -362,6 +379,7 @@ public function dataProviderWithUrlPrefixes():array 'namespace' => '\app\api\v1\controllers', ], 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], + 'xRoute' => null ]), new RestAction([ 'id' => 'create', @@ -379,6 +397,7 @@ public function dataProviderWithUrlPrefixes():array 'namespace' => '\app\api\v1\controllers', ], 'responseWrapper' => null, + 'xRoute' => null ]), new RestAction([ 'id' => 'view', @@ -393,6 +412,7 @@ public function dataProviderWithUrlPrefixes():array 'prefix' => 'animals', 'prefixSettings' => [], 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], + 'xRoute' => null ]), new RestAction([ 'id' => 'delete', @@ -407,6 +427,7 @@ public function dataProviderWithUrlPrefixes():array 'prefix' => 'animals', 'prefixSettings' => [], 'responseWrapper' => null, + 'xRoute' => null ]), new RestAction([ 'id' => 'update', @@ -421,6 +442,7 @@ public function dataProviderWithUrlPrefixes():array 'prefix' => 'animals', 'prefixSettings' => [], 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], + 'xRoute' => null ]), new RestAction([ 'id' => 'list', @@ -433,6 +455,7 @@ public function dataProviderWithUrlPrefixes():array 'modelName' => null, 'modelFqn' => null, 'responseWrapper' => null, + 'xRoute' => null ]), new RestAction([ 'id' => 'list', @@ -451,6 +474,7 @@ public function dataProviderWithUrlPrefixes():array 'namespace' => '\app\modules\petinfo\controllers', ], 'responseWrapper' => null, + 'xRoute' => null ]), ], ], From 4df4cea6d101c6ea21bdb447f1b7c925efc056ef Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Thu, 27 Mar 2025 16:46:07 +0530 Subject: [PATCH 21/26] Fix failing test 2 --- .../14_nested_module_in_x_route/mysql/modules/fruit/Module.php | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php index e05022e9..f29b749c 100644 --- a/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/mysql/modules/fruit/Module.php @@ -10,7 +10,6 @@ public function init() parent::init(); $this->modules = [ 'mango' => [ - // you should consider using a shorter namespace here! 'class' => \app\fruit\mango\Module::class, ], ]; From ef2536ad86a5a189fe201a2b1dcce8940e1cc5c8 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Thu, 27 Mar 2025 17:28:53 +0530 Subject: [PATCH 22/26] Generate Module.php file for `urlPrefixes.module` config - WIP --- src/lib/items/RouteData.php | 8 ++++++++ .../14_module_config_in_url_prefixes/index.php | 17 +++++++++++++++++ .../14_module_config_in_url_prefixes/index.yml | 13 +++++++++++++ tests/unit/issues/Issue14Test.php | 13 +++++++++++++ 4 files changed, 51 insertions(+) create mode 100644 tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php create mode 100644 tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml diff --git a/src/lib/items/RouteData.php b/src/lib/items/RouteData.php index a49285cc..8f36f481 100644 --- a/src/lib/items/RouteData.php +++ b/src/lib/items/RouteData.php @@ -322,6 +322,14 @@ protected function detectUrlPattern():void $this->unprefixedPath = '/' . trim(str_replace($prefix, '', $this->path), '/'); $this->parts = explode('/', trim($this->unprefixedPath, '/')); $this->prefixSettings = is_array($rule) ? $rule : []; + + $modulesPath = []; + if(isset($rule['module'])) { +// var_dump($rule['module'], $prefix); + $modulesPath[$modulesPath] = ['path' => '@app/TODO' , 'namespace' => 'app\\TODO' . ]; + + } + $this->moduleList = [...$this->moduleList, ...$modulesPath]; } foreach (self::$patternMap as $type => $pattern) { if (preg_match($pattern, $this->unprefixedPath, $matches)) { diff --git a/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php new file mode 100644 index 00000000..ed65ccfc --- /dev/null +++ b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php @@ -0,0 +1,17 @@ + '@specs/issue_fix/14_module_config_in_url_prefixes/index.yml', + 'generateUrls' => true, + 'generateModels' => false, + // 'useJsonApi' => true, // TODO for FractalAction + 'excludeModels' => [ + 'Error', + ], + 'generateControllers' => true, + 'generateMigrations' => false, + 'generateModelFaker' => false, + 'urlPrefixes' => [ + 'hi' => ['module' => 'greet', 'namespace' => 'app\greet'], + ] +]; diff --git a/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml new file mode 100644 index 00000000..8505042e --- /dev/null +++ b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml @@ -0,0 +1,13 @@ +openapi: "3.0.0" +info: + version: 1.0.0 + title: Issue14Test 14_module_config_in_url_prefixes \#14 + +paths: + /hi: + get: + summary: List + operationId: list + responses: + '200': + description: The information diff --git a/tests/unit/issues/Issue14Test.php b/tests/unit/issues/Issue14Test.php index 414c796f..a87cf412 100644 --- a/tests/unit/issues/Issue14Test.php +++ b/tests/unit/issues/Issue14Test.php @@ -21,4 +21,17 @@ public function testNestedModuleInXRoute() ]); $this->checkFiles($actualFiles, $expectedFiles); } + + public function testModuleConfigInUrlPrefixes() + { + $testFile = Yii::getAlias("@specs/issue_fix/14_module_config_in_url_prefixes/index.php"); + $this->runGenerator($testFile); +// $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ +// 'recursive' => true, +// ]); +// $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/mysql"), [ +// 'recursive' => true, +// ]); +// $this->checkFiles($actualFiles, $expectedFiles); + } } From 417bfc4fa228d911b602d0a7d8e246d1a7525316 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 28 Mar 2025 10:19:21 +0530 Subject: [PATCH 23/26] Implement Module.php file generation for `urlPrefixes.module` config + fix issues + fix failing tests + refactor --- src/lib/Config.php | 2 +- src/lib/generators/ControllersGenerator.php | 4 +-- src/lib/generators/ModelsGenerator.php | 4 +-- src/lib/generators/TransformersGenerator.php | 2 +- src/lib/items/RouteData.php | 17 ++++++++---- .../mysql/modules/petinfo/Module.php | 15 +++++++++++ .../modules/petinfo/Module.php | 15 +++++++++++ tests/unit/RestActionGeneratorTest.php | 26 ++++++++++++++----- 8 files changed, 67 insertions(+), 18 deletions(-) create mode 100644 tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/Module.php create mode 100644 tests/specs/petstore_urlprefixes/modules/petinfo/Module.php diff --git a/src/lib/Config.php b/src/lib/Config.php index a2531046..ef79bf3c 100644 --- a/src/lib/Config.php +++ b/src/lib/Config.php @@ -183,7 +183,7 @@ public function getOpenApi():OpenApi return $this->openApi; } - public function getPathFromNamespace(string $namespace):string + public static function getPathFromNamespace(string $namespace): string { return Yii::getAlias('@' . str_replace('\\', '/', ltrim($namespace, '\\'))); } diff --git a/src/lib/generators/ControllersGenerator.php b/src/lib/generators/ControllersGenerator.php index a0fc3826..335b7f26 100644 --- a/src/lib/generators/ControllersGenerator.php +++ b/src/lib/generators/ControllersGenerator.php @@ -52,7 +52,7 @@ public function generate():CodeFiles return new CodeFiles([]); } $namespace = $this->config->controllerNamespace ?? Yii::$app->controllerNamespace; - $path = $this->config->getPathFromNamespace($namespace); + $path = Config::getPathFromNamespace($namespace); $templateName = $this->config->useJsonApi ? 'controller_jsonapi.php' : 'controller.php'; foreach ($this->controllers as $controllerWithPrefix => $actions) { @@ -65,7 +65,7 @@ public function generate():CodeFiles if (!empty($action->prefixSettings)) { $controllerNamespace = trim($action->prefixSettings['namespace'], '\\'); $controllerPath = $action->prefixSettings['path'] - ?? $this->config->getPathFromNamespace($controllerNamespace); + ?? Config::getPathFromNamespace($controllerNamespace); } $routeParts = explode('/', $controllerWithPrefix); diff --git a/src/lib/generators/ModelsGenerator.php b/src/lib/generators/ModelsGenerator.php index d2672ff9..2bdbe06f 100644 --- a/src/lib/generators/ModelsGenerator.php +++ b/src/lib/generators/ModelsGenerator.php @@ -46,8 +46,8 @@ public function generate():CodeFiles if (!$this->config->generateModels) { return $this->files; } - $modelPath = $this->config->getPathFromNamespace($this->config->modelNamespace); - $fakerPath = $this->config->getPathFromNamespace($this->config->fakerNamespace); + $modelPath = Config::getPathFromNamespace($this->config->modelNamespace); + $fakerPath = Config::getPathFromNamespace($this->config->fakerNamespace); if ($this->config->generateModelFaker) { $this->files->add(new CodeFile( Yii::getAlias("$fakerPath/BaseModelFaker.php"), diff --git a/src/lib/generators/TransformersGenerator.php b/src/lib/generators/TransformersGenerator.php index 3865ead9..d25aacf5 100644 --- a/src/lib/generators/TransformersGenerator.php +++ b/src/lib/generators/TransformersGenerator.php @@ -48,7 +48,7 @@ public function generate():CodeFiles if (!$this->config->generateControllers || !$this->config->useJsonApi) { return $this->files; } - $transformerPath = $this->config->getPathFromNamespace($this->config->transformerNamespace); + $transformerPath = Config::getPathFromNamespace($this->config->transformerNamespace); foreach ($this->models as $model) { $transformer = Yii::createObject(Transformer::class, [ $model, diff --git a/src/lib/items/RouteData.php b/src/lib/items/RouteData.php index 8f36f481..f0561f06 100644 --- a/src/lib/items/RouteData.php +++ b/src/lib/items/RouteData.php @@ -9,6 +9,7 @@ use cebe\openapi\spec\Operation; use cebe\openapi\spec\PathItem; +use cebe\yii2openapi\lib\Config; use cebe\yii2openapi\lib\CustomSpecAttr; use yii\base\BaseObject; use yii\base\InvalidCallException; @@ -324,12 +325,18 @@ protected function detectUrlPattern():void $this->prefixSettings = is_array($rule) ? $rule : []; $modulesPath = []; - if(isset($rule['module'])) { -// var_dump($rule['module'], $prefix); - $modulesPath[$modulesPath] = ['path' => '@app/TODO' , 'namespace' => 'app\\TODO' . ]; - + if (isset($rule['module'])) { + $modPath = $rule['path'] ?? Config::getPathFromNamespace($rule['namespace']); + if (str_ends_with($modPath, '/controllers')) { + $modPath = substr($modPath, 0, -12); + } + $modNs = $rule['namespace']; + if (str_ends_with($modNs, '\controllers')) { + $modNs = substr($modNs, 0, -12); + } + $modulesPath[$rule['module']] = ['path' => $modPath, 'namespace' => $modNs]; } - $this->moduleList = [...$this->moduleList, ...$modulesPath]; + $this->moduleList = array_merge($this->moduleList, $modulesPath); } foreach (self::$patternMap as $type => $pattern) { if (preg_match($pattern, $this->unprefixedPath, $matches)) { diff --git a/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/Module.php b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/Module.php new file mode 100644 index 00000000..de8f770b --- /dev/null +++ b/tests/specs/issue_fix/35_resolve_todo_re_check_options_route_in_rest_action/mysql/modules/petinfo/Module.php @@ -0,0 +1,15 @@ + '\app\api\v1\controllers', ], 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'array'], - 'xRoute' => null + 'xRoute' => null, + 'modulesList' => [] ]), new RestAction([ 'id' => 'create', @@ -397,7 +398,8 @@ public function dataProviderWithUrlPrefixes():array 'namespace' => '\app\api\v1\controllers', ], 'responseWrapper' => null, - 'xRoute' => null + 'xRoute' => null, + 'modulesList' => [] ]), new RestAction([ 'id' => 'view', @@ -412,7 +414,8 @@ public function dataProviderWithUrlPrefixes():array 'prefix' => 'animals', 'prefixSettings' => [], 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], - 'xRoute' => null + 'xRoute' => null, + 'modulesList' => [] ]), new RestAction([ 'id' => 'delete', @@ -427,7 +430,8 @@ public function dataProviderWithUrlPrefixes():array 'prefix' => 'animals', 'prefixSettings' => [], 'responseWrapper' => null, - 'xRoute' => null + 'xRoute' => null, + 'modulesList' => [] ]), new RestAction([ 'id' => 'update', @@ -442,7 +446,8 @@ public function dataProviderWithUrlPrefixes():array 'prefix' => 'animals', 'prefixSettings' => [], 'responseWrapper' => ['item' => '', 'list' => '', 'type' => 'object'], - 'xRoute' => null + 'xRoute' => null, + 'modulesList' => [] ]), new RestAction([ 'id' => 'list', @@ -455,7 +460,8 @@ public function dataProviderWithUrlPrefixes():array 'modelName' => null, 'modelFqn' => null, 'responseWrapper' => null, - 'xRoute' => null + 'xRoute' => null, + 'modulesList' => [] ]), new RestAction([ 'id' => 'list', @@ -474,7 +480,13 @@ public function dataProviderWithUrlPrefixes():array 'namespace' => '\app\modules\petinfo\controllers', ], 'responseWrapper' => null, - 'xRoute' => null + 'xRoute' => null, + 'modulesList' => [ + 'pet-info' => [ + 'path' => '@app/modules/petinfo', + 'namespace' => '\app\modules\petinfo', + ] + ] ]), ], ], From 963c7e29e1dfe34c7e998ae50b8bbf47696cfec7 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 28 Mar 2025 15:25:52 +0530 Subject: [PATCH 24/26] Implement Module.php file generation for `urlPrefixes.module` config + fix issues + fix failing tests + refactor + complete the test --- .../mysql/config/urls.rest.php | 10 ++++++ .../mysql/greet/DefaultController.php | 20 ++++++++++++ .../mysql/greet/Module.php | 15 +++++++++ .../mysql/greet/base/DefaultController.php | 32 +++++++++++++++++++ tests/unit/issues/Issue14Test.php | 14 ++++---- 5 files changed, 84 insertions(+), 7 deletions(-) create mode 100644 tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/config/urls.rest.php create mode 100644 tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/greet/DefaultController.php create mode 100644 tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/greet/Module.php create mode 100644 tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/greet/base/DefaultController.php diff --git a/tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/config/urls.rest.php b/tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/config/urls.rest.php new file mode 100644 index 00000000..a516a8be --- /dev/null +++ b/tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/config/urls.rest.php @@ -0,0 +1,10 @@ + 'greet/default/', + 'hi/' => 'greet/default/options', +]; diff --git a/tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/greet/DefaultController.php b/tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/greet/DefaultController.php new file mode 100644 index 00000000..b3ad5997 --- /dev/null +++ b/tests/specs/issue_fix/14_module_config_in_url_prefixes/mysql/greet/DefaultController.php @@ -0,0 +1,20 @@ + [ + 'class' => \yii\rest\OptionsAction::class, + ], + ]; + } + + /** + * Checks the privilege of the current user. + * + * This method checks whether the current user has the privilege + * to run the specified action against the specified data model. + * If the user does not have access, a [[ForbiddenHttpException]] should be thrown. + * + * @param string $action the ID of the action to be executed + * @param object $model the model to be accessed. If null, it means no specific model is being accessed. + * @param array $params additional parameters + * @throws \yii\web\ForbiddenHttpException if the user does not have access + */ + abstract public function checkAccess($action, $model = null, $params = []); + + abstract public function action(); + +} diff --git a/tests/unit/issues/Issue14Test.php b/tests/unit/issues/Issue14Test.php index a87cf412..388124c8 100644 --- a/tests/unit/issues/Issue14Test.php +++ b/tests/unit/issues/Issue14Test.php @@ -26,12 +26,12 @@ public function testModuleConfigInUrlPrefixes() { $testFile = Yii::getAlias("@specs/issue_fix/14_module_config_in_url_prefixes/index.php"); $this->runGenerator($testFile); -// $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ -// 'recursive' => true, -// ]); -// $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/mysql"), [ -// 'recursive' => true, -// ]); -// $this->checkFiles($actualFiles, $expectedFiles); + $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ + 'recursive' => true, + ]); + $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_module_config_in_url_prefixes/mysql"), [ + 'recursive' => true, + ]); + $this->checkFiles($actualFiles, $expectedFiles); } } From db9a018d8fd04430dc8b3fa7a3d2ca178f0b6330 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Sat, 29 Mar 2025 08:34:12 +0530 Subject: [PATCH 25/26] Implement for `FractalAction` --- src/lib/generators/JsonActionGenerator.php | 14 +++- src/lib/items/ActionHelperTrait.php | 19 ++++- src/lib/items/FractalAction.php | 4 + src/lib/items/RestAction.php | 19 ----- .../index.php | 3 +- .../index.yml | 83 +++++++++++++++++++ tests/unit/issues/Issue14Test.php | 41 ++++++++- 7 files changed, 159 insertions(+), 24 deletions(-) diff --git a/src/lib/generators/JsonActionGenerator.php b/src/lib/generators/JsonActionGenerator.php index 3cc2de2a..51583fae 100644 --- a/src/lib/generators/JsonActionGenerator.php +++ b/src/lib/generators/JsonActionGenerator.php @@ -74,12 +74,20 @@ protected function prepareAction( } } + $actionId = $routeData->isNonCrudAction() ? trim("{$actionType}-{$routeData->action}", '-') + : "$actionType{$routeData->action}"; + if (!empty($customRoute)) { + // $actionType = ''; + $parts = explode('/', $customRoute); + $controllerId = $parts[count($parts) - 2]; + $actionId = $parts[count($parts) - 1]; + } + return Yii::createObject(FractalAction::class, [ [ 'singularResourceKey' => $this->config->singularResourceKeys, 'type' => $routeData->type, - 'id' => $routeData->isNonCrudAction() ? trim("{$actionType}-{$routeData->action}", '-') - : "$actionType{$routeData->action}", + 'id' => $actionId, 'controllerId' => $controllerId, 'urlPath' => $routeData->path, 'requestMethod' => strtoupper($method), @@ -96,6 +104,8 @@ protected function prepareAction( 'expectedRelations' => $expectedRelations, 'prefix' => $routeData->getPrefix(), 'prefixSettings' => $routeData->getPrefixSettings(), + 'xRoute' => $customRoute, + 'modulesList' => $routeData->listModules() ], ]); } diff --git a/src/lib/items/ActionHelperTrait.php b/src/lib/items/ActionHelperTrait.php index 73a1bb74..95536acc 100644 --- a/src/lib/items/ActionHelperTrait.php +++ b/src/lib/items/ActionHelperTrait.php @@ -9,11 +9,28 @@ trait ActionHelperTrait { - public ?string $xRoute; + public ?string $xRoute = null; # list of module this action is part of. 'key' is module ID and 'value' is path where Module.php file must be generated public array $modulesList = []; + /** + * @see $isDuplicate + * https://github.com/cebe/yii2-openapi/issues/84 + * see `x-route` in README.md + * Used for generating only one action for paths like: `GET /calendar/domains` and `GET /calendar/domains/{id}` given that they have same `x-route`. + * If duplicates routes have same params then `false`, else action is generated with no (0) params `true` + */ + public bool $zeroParams = false; + + /** + * https://github.com/cebe/yii2-openapi/issues/84 + * Generate only one action for paths like: `GET /calendar/domains` and `GET /calendar/domains/{id}` given that they have same `x-route`. + * @see $zeroParams + * see `x-route` in README.md + */ + public bool $isDuplicate = false; + public function getOptionsRoute():string { if (!empty($this->prefixSettings)) { diff --git a/src/lib/items/FractalAction.php b/src/lib/items/FractalAction.php index 80ee0820..c3461a5d 100644 --- a/src/lib/items/FractalAction.php +++ b/src/lib/items/FractalAction.php @@ -97,6 +97,10 @@ private function templateFactory():FractalActionTemplates public function getRoute():string { + if ($this->xRoute) { + return $this->xRoute; + } + if (!empty($this->prefixSettings)) { $prefix = $this->prefixSettings['module'] ?? $this->prefix; return trim($prefix, '/').'/'.$this->controllerId.'/'.$this->id; diff --git a/src/lib/items/RestAction.php b/src/lib/items/RestAction.php index 69fc1be6..4c5f4fca 100644 --- a/src/lib/items/RestAction.php +++ b/src/lib/items/RestAction.php @@ -70,25 +70,6 @@ final class RestAction extends BaseObject */ public $responseWrapper; - /** - * @var bool - * @see $isDuplicate - * https://github.com/cebe/yii2-openapi/issues/84 - * see `x-route` in README.md - * Used for generating only one action for paths like: `GET /calendar/domains` and `GET /calendar/domains/{id}` given that they have same `x-route`. - * If duplicates routes have same params then `false`, else action is generated with no (0) params `true` - */ - public $zeroParams = false; - - /** - * @var bool - * https://github.com/cebe/yii2-openapi/issues/84 - * Generate only one action for paths like: `GET /calendar/domains` and `GET /calendar/domains/{id}` given that they have same `x-route`. - * @see $zeroParams - * see `x-route` in README.md - */ - public $isDuplicate = false; - public function getRoute():string { if ($this->xRoute) { diff --git a/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php index ed65ccfc..1ca88e35 100644 --- a/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php +++ b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.php @@ -3,7 +3,7 @@ return [ 'openApiPath' => '@specs/issue_fix/14_module_config_in_url_prefixes/index.yml', 'generateUrls' => true, - 'generateModels' => false, + 'generateModels' => true, // 'useJsonApi' => true, // TODO for FractalAction 'excludeModels' => [ 'Error', @@ -13,5 +13,6 @@ 'generateModelFaker' => false, 'urlPrefixes' => [ 'hi' => ['module' => 'greet', 'namespace' => 'app\greet'], + 'abc' => ['module' => 'abc', 'namespace' => 'app\abc'], ] ]; diff --git a/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml index 8505042e..8a20f1bd 100644 --- a/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml +++ b/tests/specs/issue_fix/14_module_config_in_url_prefixes/index.yml @@ -11,3 +11,86 @@ paths: responses: '200': description: The information + /bye: + get: + summary: List + operationId: list + responses: + '200': + description: The information + post: + summary: List + operationId: list + responses: + '200': + description: The information + '/abc/task/{id}': + parameters: + - name: id + in: path + description: ID of the task. + required: true + schema: + type: integer + get: + operationId: getTask + summary: Get a Task by ID + description: Returns a single task by its unique ID. + responses: + '200': + $ref: '#/components/responses/Task' + '403': + description: Response if the currently authenticated user has no access to this task. + '404': + description: Response if the task does not exist. + tags: + - Tasks + +components: + schemas: + _TaskResource: + type: object + properties: + id: + type: integer + example: 1 + type: + type: string + enum: + - tasks + attributes: + $ref: '#/components/schemas/Task' + relationships: + type: object + JSONAPI_links: + type: object + example: + self: 'https://api.example.com/...' + additionalProperties: + oneOf: + - type: string + - type: object + properties: + href: + type: string + meta: + type: object + Task: + type: object + properties: + id: + type: integer + title: + type: string + responses: + Task: + description: Task + content: + application/vnd.api+json: + schema: + type: object + properties: + data: + $ref: '#/components/schemas/_TaskResource' + links: + $ref: '#/components/schemas/JSONAPI_links' diff --git a/tests/unit/issues/Issue14Test.php b/tests/unit/issues/Issue14Test.php index 388124c8..04537366 100644 --- a/tests/unit/issues/Issue14Test.php +++ b/tests/unit/issues/Issue14Test.php @@ -22,7 +22,26 @@ public function testNestedModuleInXRoute() $this->checkFiles($actualFiles, $expectedFiles); } - public function testModuleConfigInUrlPrefixes() + public function testNestedModuleInXRouteFractalAction() + { + $config = []; + $config = require Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/index.php"); + $config['useJsonApi'] = true; + $tmpConfigFile = Yii::getAlias("@runtime") . "/tmp-config-35.php"; + file_put_contents($tmpConfigFile, 'runGenerator($testFile); + // $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ + // 'recursive' => true, + // ]); + // $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/mysql"), [ + // 'recursive' => true, + // ]); + // $this->checkFiles($actualFiles, $expectedFiles); + } + + public function testModuleConfigInUrlPrefixes() # RestAction { $testFile = Yii::getAlias("@specs/issue_fix/14_module_config_in_url_prefixes/index.php"); $this->runGenerator($testFile); @@ -34,4 +53,24 @@ public function testModuleConfigInUrlPrefixes() ]); $this->checkFiles($actualFiles, $expectedFiles); } + + public function testModuleConfigInUrlPrefixesFractalAction() + { + $config = []; + $config = require Yii::getAlias("@specs/issue_fix/14_module_config_in_url_prefixes/index.php"); + $config['useJsonApi'] = true; + $tmpConfigFile = Yii::getAlias("@runtime") . "/tmp-config-35.php"; + file_put_contents($tmpConfigFile, 'runGenerator($testFile); + // $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [ + // 'recursive' => true, + // ]); + // $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/14_module_config_in_url_prefixes/mysql"), [ + // 'recursive' => true, + // ]); + // $this->checkFiles($actualFiles, $expectedFiles); + } } From fe97ab4e56a148c9dfaaa084edf0e125648c82ef Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Sat, 29 Mar 2025 18:11:18 +0530 Subject: [PATCH 26/26] Implement for `FractalAction` - WIP --- src/lib/generators/ControllersGenerator.php | 6 +- .../14_nested_module_in_x_route/index.php | 4 + .../14_nested_module_in_x_route/index.yml | 74 ++++++++++++++++++- tests/unit/issues/Issue14Test.php | 2 +- 4 files changed, 83 insertions(+), 3 deletions(-) diff --git a/src/lib/generators/ControllersGenerator.php b/src/lib/generators/ControllersGenerator.php index 335b7f26..b10cf734 100644 --- a/src/lib/generators/ControllersGenerator.php +++ b/src/lib/generators/ControllersGenerator.php @@ -38,7 +38,11 @@ public function __construct(Config $config, array $actions = []) { $this->config = $config; foreach ($actions as $action) { - $this->controllers[$action->prefix . '/' . $action->controllerId][] = $action; + $r = $action->getRoute(); + $r = explode('/', $r); + array_pop($r); + array_pop($r); + $this->controllers[implode('/', $r) . '/' . $action->controllerId][] = $action; } $this->files = new CodeFiles([]); } diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/index.php b/tests/specs/issue_fix/14_nested_module_in_x_route/index.php index cfb578e0..e8395909 100644 --- a/tests/specs/issue_fix/14_nested_module_in_x_route/index.php +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/index.php @@ -11,4 +11,8 @@ 'generateControllers' => true, 'generateMigrations' => false, 'generateModelFaker' => false, + // 'urlPrefixes' => [ + // 'hi' => ['module' => 'greet', 'namespace' => 'app\greet'], + // 'abc' => ['module' => 'abc', 'namespace' => 'app\abc'], + // ] ]; diff --git a/tests/specs/issue_fix/14_nested_module_in_x_route/index.yml b/tests/specs/issue_fix/14_nested_module_in_x_route/index.yml index 48fdf126..81aea95f 100644 --- a/tests/specs/issue_fix/14_nested_module_in_x_route/index.yml +++ b/tests/specs/issue_fix/14_nested_module_in_x_route/index.yml @@ -11,4 +11,76 @@ paths: operationId: list responses: '200': - description: The information + $ref: '#/components/responses/Task' + + '/task/{id}': + parameters: + - name: id + in: path + description: ID of the task. + required: true + schema: + type: integer + get: + x-route: fruit2/mango/alphonso/view + operationId: getTask + summary: Get a Task by ID + description: Returns a single task by its unique ID. + responses: + '200': + $ref: '#/components/responses/Task' + '403': + description: Response if the currently authenticated user has no access to this task. + '404': + description: Response if the task does not exist. + tags: + - Tasks + +components: + schemas: + _TaskResource: + type: object + properties: + id: + type: integer + example: 1 + type: + type: string + enum: + - tasks + attributes: + $ref: '#/components/schemas/Task' + relationships: + type: object + JSONAPI_links: + type: object + example: + self: 'https://api.example.com/...' + additionalProperties: + oneOf: + - type: string + - type: object + properties: + href: + type: string + meta: + type: object + Task: + type: object + properties: + id: + type: integer + title: + type: string + responses: + Task: + description: Task + content: + application/vnd.api+json: + schema: + type: object + properties: + data: + $ref: '#/components/schemas/_TaskResource' + links: + $ref: '#/components/schemas/JSONAPI_links' diff --git a/tests/unit/issues/Issue14Test.php b/tests/unit/issues/Issue14Test.php index 04537366..17d755eb 100644 --- a/tests/unit/issues/Issue14Test.php +++ b/tests/unit/issues/Issue14Test.php @@ -9,7 +9,7 @@ # https://github.com/php-openapi/yii2-openapi/issues/14 class Issue14Test extends DbTestCase { - public function testNestedModuleInXRoute() + public function testNestedModuleInXRoute() # RestAction { $testFile = Yii::getAlias("@specs/issue_fix/14_nested_module_in_x_route/index.php"); $this->runGenerator($testFile);