#158: ability to generate documentation for invokable controllers #159

yogyrton · 2025-01-17T09:19:54Z

DenTray

@yogyrton please cover new code by autotests

DenTray · 2025-01-22T02:57:30Z

src/Services/SwaggerService.php

@@ -644,7 +644,7 @@ public function getConcreteRequest()
        $explodedController = explode('@', $controller);

        $class = $explodedController[0];
-        $method = $explodedController[1];
+        $method = $explodedController[1] ?? '__invoke';


Suggested change

$method = $explodedController[1] ?? '__invoke';

$method = Arr::get($explodedController, 1, '__invoke');

sonarqubecloud · 2025-01-27T14:27:25Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

DenTray · 2025-01-29T14:53:30Z

src/Services/SwaggerService.php

@@ -644,7 +644,7 @@ public function getConcreteRequest()
        $explodedController = explode('@', $controller);

        $class = $explodedController[0];
-        $method = $explodedController[1];
+        $method = $explodedController[1] ?? '__invoke';


DenTray · 2025-01-29T15:00:33Z

tests/TestCase.php

-        return $request->setRouteResolver(function () use ($uri, $request, $controllerMethod, $routeConditions) {
+        return $request->setRouteResolver(function () use ($isInvokeController, $uri, $request, $controllerMethod, $routeConditions) {
+            $action = $isInvokeController
+                ? TestInvokableController::class . '@__invoke'


for invokable controller the action should be a controller name only

Suggested change

? TestInvokableController::class . '@__invoke'

? TestInvokableController::class

DenTray · 2025-01-29T15:01:58Z

tests/support/Mock/TestInvokableController.php

+
+class TestInvokableController
+{
+    public function __invoke(TestEmptyRequest $request)


could we use already existed mock request?

DenTray · 2025-01-29T15:04:19Z

tests/TestCase.php

+        $headers = [],
+        $routeConditions = [],
+        $controllerMethod = 'test',
+        $isInvokeController = false,


it's not good solution make it as argument, cause we already has the controllerMethod argument which will onflict with this one. Please implement separate method generateInvokableRequest simple helper

…invokable-controllers

sonarqubecloud · 2025-04-04T11:43:24Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

DenTray · 2025-04-08T14:31:35Z

tests/SwaggerServiceTest.php

+        $service = app(SwaggerService::class);
+
+        $request = $this->generateRequest(
+            type: 'get',
+            uri: 'users',
+            controllerMethod: '__invoke',
+        );
+
+        $response = $this->generateResponse('example_success_user_response.json', 200, [
+            'Content-type' => 'application/json',
+        ]);
+
+        $service->addData($request, $response);


Suggested change

$service = app(SwaggerService::class);

$request = $this->generateRequest(

type: 'get',

uri: 'users',

controllerMethod: '__invoke',

);

$response = $this->generateResponse('example_success_user_response.json', 200, [

'Content-type' => 'application/json',

]);

$service->addData($request, $response);

$request = $this->generateRequest(

type: 'get',

uri: 'users',

controllerMethod: '__invoke',

);

$response = $this->generateResponse('example_success_user_response.json', 200, [

'Content-type' => 'application/json',

]);

app(SwaggerService::class)->addData($request, $response);

DenTray · 2025-04-08T14:32:29Z

tests/TestCase.php

@@ -10,6 +10,7 @@
 use Orchestra\Testbench\TestCase as BaseTest;
 use RonasIT\AutoDoc\AutoDocServiceProvider;
 use RonasIT\AutoDoc\Tests\Support\Mock\TestController;
+use RonasIT\AutoDoc\Tests\Support\Mock\TestInvokableController;


DenTray · 2025-04-08T14:32:49Z

tests/TestCase.php

+        $type,
+        $uri,
+        $data = [],
+        $pathParams = [],
+        $headers = [],
+        $routeConditions = [],
+        $controllerMethod = 'test',


please add typehints

#158: ability to generate documentation for invokable controllers

52241f5

yogyrton assigned DenTray Jan 17, 2025

DenTray reviewed Jan 22, 2025

View reviewed changes

DenTray assigned yogyrton and unassigned DenTray Jan 22, 2025

test: increase coverage

6b1b86d

DenTray requested changes Jan 29, 2025

View reviewed changes

NikitaYakovlev added 3 commits April 4, 2025 14:48

Merge branch 'master' into 158-ability-to-generate-documentation-for-…

5fbb8aa

…invokable-controllers

chore: small code fix

01cbb22

chore: remove TestInvokableController

7e336ea

NikitaYakovlev assigned DenTray and unassigned yogyrton Apr 4, 2025

DenTray requested changes Apr 8, 2025

View reviewed changes

DenTray assigned yogyrton and unassigned DenTray Apr 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#158: ability to generate documentation for invokable controllers #159

#158: ability to generate documentation for invokable controllers #159

yogyrton commented Jan 17, 2025 •

edited

Loading

DenTray left a comment

DenTray Jan 22, 2025

DenTray Jan 29, 2025

sonarqubecloud bot commented Jan 27, 2025

DenTray Jan 29, 2025

DenTray Jan 29, 2025

DenTray Jan 29, 2025

DenTray Jan 29, 2025

sonarqubecloud bot commented Apr 4, 2025

DenTray Apr 8, 2025

DenTray Apr 8, 2025

DenTray Apr 8, 2025

	$method = $explodedController[1] ?? '__invoke';
	$method = Arr::get($explodedController, 1, '__invoke');

	? TestInvokableController::class . '@__invoke'
	? TestInvokableController::class

#158: ability to generate documentation for invokable controllers #159

Are you sure you want to change the base?

#158: ability to generate documentation for invokable controllers #159

Conversation

yogyrton commented Jan 17, 2025 • edited Loading

DenTray left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 27, 2025

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Apr 4, 2025

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yogyrton commented Jan 17, 2025 •

edited

Loading