Add support for nested resource controllers (#725)

nicodevs · web-flow · commit eedca26c68ce · 2025-01-03T06:49:06.000-05:00
diff --git a/src/Generators/ControllerGenerator.php b/src/Generators/ControllerGenerator.php
@@ -82,16 +82,21 @@ protected function buildMethods(Controller $controller): string
 
         foreach ($controller->methods() as $name => $statements) {
             $method = str_replace('{{ method }}', $name, $template);
+            $search = '(Request $request';
 
             if (in_array($name, ['edit', 'update', 'show', 'destroy'])) {
                 $reference = $this->fullyQualifyModelReference($controller->namespace(), $controllerModelName);
                 $variable = '$' . Str::camel($controllerModelName);
 
-                $search = '(Request $request';
                 $method = str_replace($search, $search . ', ' . $controllerModelName . ' ' . $variable, $method);
                 $this->addImport($controller, $reference);
             }
 
+            if ($parent = $controller->parent()) {
+                $method = str_replace($search, $search . ', ' . $parent . ' $' . Str::camel($parent), $method);
+                $this->addImport($controller, $this->fullyQualifyModelReference($controller->namespace(), $parent));
+            }
+
             $body = '';
             $using_validation = false;
 
@@ -181,6 +186,17 @@ protected function buildMethods(Controller $controller): string
                     $this->addImport($controller, 'Inertia\Inertia');
                 }
 
+                if (
+                    $controller->parent() &&
+                    ($statement instanceof QueryStatement || $statement instanceof EloquentStatement || $statement instanceof ResourceStatement)
+                ) {
+                    $body = str_replace(
+                        ['::all', Str::singular($controller->prefix()) . '::'],
+                        ['::get', '$' . Str::lower($controller->parent()) . '->' . Str::plural(Str::lower($controller->prefix())) . '()->'],
+                        $body
+                    );
+                }
+
                 $body .= PHP_EOL;
             }
 
diff --git a/src/Generators/PestTestGenerator.php b/src/Generators/PestTestGenerator.php
@@ -115,6 +115,11 @@ protected function buildTestCases(Controller $controller): string
                 $setup['data'][] = sprintf('$%s = %s::factory()->create();', $variable, $model);
             }
 
+            if ($parent = $controller->parent()) {
+                $this->addImport($controller, $modelNamespace . '\\' . $parent);
+                $setup['data'][] = sprintf('$%s = %s::factory()->create();', Str::camel($parent), $parent);
+            }
+
             foreach ($statements as $statement) {
                 if ($statement instanceof SendStatement) {
                     if ($statement->isNotification()) {
@@ -496,6 +501,22 @@ protected function buildTestCases(Controller $controller): string
             }
             $call .= ')';
 
+            if ($controller->parent()) {
+                $parent = Str::camel($controller->parent());
+                $variable = Str::camel($context);
+                $binding = sprintf(', $%s)', $variable);
+                $params = sprintf("'%s' => $%s", $parent, $parent);
+
+                if (Str::contains($call, $binding)) {
+                    $params .= sprintf(", '%s' => $%s", $variable, $variable);
+                    $search = $binding;
+                } else {
+                    $search = ')';
+                }
+
+                $call = str_replace($search, sprintf(', [%s])', $params), $call);
+            }
+
             if ($request_data) {
                 $call .= ', [';
                 $call .= PHP_EOL;
diff --git a/src/Generators/PhpUnitTestGenerator.php b/src/Generators/PhpUnitTestGenerator.php
@@ -114,6 +114,11 @@ protected function buildTestCases(Controller $controller): string
                 $setup['data'][] = sprintf('$%s = %s::factory()->create();', $variable, $model);
             }
 
+            if ($parent = $controller->parent()) {
+                $this->addImport($controller, $modelNamespace . '\\' . $parent);
+                $setup['data'][] = sprintf('$%s = %s::factory()->create();', Str::camel($parent), $parent);
+            }
+
             foreach ($statements as $statement) {
                 if ($statement instanceof SendStatement) {
                     if ($statement->isNotification()) {
@@ -486,6 +491,22 @@ protected function buildTestCases(Controller $controller): string
             }
             $call .= ')';
 
+            if ($controller->parent()) {
+                $parent = Str::camel($controller->parent());
+                $variable = Str::camel($context);
+                $binding = sprintf(', $%s)', $variable);
+                $params = sprintf("'%s' => $%s", $parent, $parent);
+
+                if (Str::contains($call, $binding)) {
+                    $params .= sprintf(", '%s' => $%s", $variable, $variable);
+                    $search = $binding;
+                } else {
+                    $search = ')';
+                }
+
+                $call = str_replace($search, sprintf(', [%s])', $params), $call);
+            }
+
             if ($request_data) {
                 $call .= ', [';
                 $call .= PHP_EOL;
diff --git a/src/Generators/RouteGenerator.php b/src/Generators/RouteGenerator.php
@@ -45,6 +45,12 @@ protected function buildRoutes(Controller $controller): string
         $className = $this->getClassName($controller);
         $slug = config('blueprint.singular_routes') ? Str::kebab($controller->prefix()) : Str::plural(Str::kebab($controller->prefix()));
 
+        if ($controller->parent()) {
+            $parentSlug = config('blueprint.singular_routes') ? Str::kebab($controller->parent()) : Str::plural(Str::kebab($controller->parent()));
+            $parentBinding = '/{' . Str::kebab($controller->parent()) . '}/';
+            $slug = $parentSlug . $parentBinding . $slug;
+        }
+
         foreach (array_diff($methods, Controller::$resourceMethods) as $method) {
             $routes .= $this->buildRouteLine($className, $slug, $method);
             $routes .= PHP_EOL;
diff --git a/src/Lexers/ControllerLexer.php b/src/Lexers/ControllerLexer.php
@@ -74,6 +74,10 @@ public function analyze(array $tokens): array
                     $registry['policies'][] = $policy;
                 }
 
+                if (isset($definition['meta']['parent'])) {
+                    $controller->setParent($definition['meta']['parent']);
+                }
+
                 unset($definition['meta']);
             }
 
diff --git a/src/Models/Controller.php b/src/Models/Controller.php
@@ -21,6 +21,8 @@ class Controller implements BlueprintModel
 
     private bool $apiResource = false;
 
+    private ?string $parent = null;
+
     public function __construct(string $name)
     {
         $this->name = class_basename($name);
@@ -103,4 +105,14 @@ public function isApiResource(): bool
     {
         return $this->apiResource;
     }
+
+    public function setParent(string $parent): void
+    {
+        $this->parent = Str::studly(Str::singular($parent));
+    }
+
+    public function parent(): ?string
+    {
+        return $this->parent;
+    }
 }
diff --git a/tests/Feature/Generators/ControllerGeneratorTest.php b/tests/Feature/Generators/ControllerGeneratorTest.php
@@ -273,6 +273,7 @@ public static function controllerTreeDataProvider(): array
             ['drafts/inertia-render.yaml', 'app/Http/Controllers/CustomerController.php', 'controllers/inertia-render.php'],
             ['drafts/save-without-validation.yaml', 'app/Http/Controllers/PostController.php', 'controllers/save-without-validation.php'],
             ['drafts/api-resource-pagination.yaml', 'app/Http/Controllers/PostController.php', 'controllers/api-resource-pagination.php'],
+            ['drafts/api-resource-nested.yaml', 'app/Http/Controllers/CommentController.php', 'controllers/api-resource-nested.php'],
             ['drafts/api-routes-example.yaml', 'app/Http/Controllers/Api/CertificateController.php', 'controllers/api-routes-example.php'],
             ['drafts/invokable-controller.yaml', 'app/Http/Controllers/ReportController.php', 'controllers/invokable-controller.php'],
             ['drafts/invokable-controller-shorthand.yaml', 'app/Http/Controllers/ReportController.php', 'controllers/invokable-controller-shorthand.php'],
diff --git a/tests/Feature/Generators/PestTestGeneratorTest.php b/tests/Feature/Generators/PestTestGeneratorTest.php
@@ -225,6 +225,7 @@ public static function controllerTreeDataProvider(): array
             ['drafts/model-reference-validate.yaml', 'tests/Feature/Http/Controllers/CertificateControllerTest.php', 'tests/pest/api-shorthand-validation.php'],
             ['drafts/controllers-only-no-context.yaml', 'tests/Feature/Http/Controllers/ReportControllerTest.php', 'tests/pest/controllers-only-no-context.php'],
             ['drafts/date-formats.yaml', 'tests/Feature/Http/Controllers/DateControllerTest.php', 'tests/pest/date-formats.php'],
+            ['drafts/api-resource-nested.yaml', 'tests/Feature/Http/Controllers/CommentControllerTest.php', 'tests/pest/api-resource-nested.php'],
             ['drafts/call-to-a-member-function-columns-on-null.yaml', [
                 'tests/Feature/Http/Controllers/SubscriptionControllerTest.php',
                 'tests/Feature/Http/Controllers/TelegramControllerTest.php',
diff --git a/tests/Feature/Generators/PhpUnitTestGeneratorTest.php b/tests/Feature/Generators/PhpUnitTestGeneratorTest.php
@@ -226,6 +226,7 @@ public static function controllerTreeDataProvider(): array
             ['drafts/controllers-only-no-context.yaml', 'tests/Feature/Http/Controllers/ReportControllerTest.php', 'tests/phpunit/controllers-only-no-context.php'],
             ['drafts/date-formats.yaml', 'tests/Feature/Http/Controllers/DateControllerTest.php', 'tests/phpunit/date-formats.php'],
             ['drafts/test-relationships.yaml', 'tests/Feature/Http/Controllers/ConferenceControllerTest.php', 'tests/phpunit/test-relationships.php'],
+            ['drafts/api-resource-nested.yaml', 'tests/Feature/Http/Controllers/CommentControllerTest.php', 'tests/phpunit/api-resource-nested.php'],
             ['drafts/call-to-a-member-function-columns-on-null.yaml', [
                 'tests/Feature/Http/Controllers/SubscriptionControllerTest.php',
                 'tests/Feature/Http/Controllers/TelegramControllerTest.php',
diff --git a/tests/Feature/Generators/RouteGeneratorTest.php b/tests/Feature/Generators/RouteGeneratorTest.php
@@ -119,6 +119,7 @@ public static function controllerTreeDataProvider(): array
             ['drafts/respond-statements.yaml', 'routes/respond-statements.php'],
             ['drafts/invokable-controller.yaml', 'routes/invokable-controller.php'],
             ['drafts/invokable-controller-shorthand.yaml', 'routes/invokable-controller.php'],
+            ['drafts/controller-nested.yaml', 'routes/nested-controller.php'],
         ];
     }
 }
diff --git a/tests/Feature/Lexers/ControllerLexerTest.php b/tests/Feature/Lexers/ControllerLexerTest.php
@@ -486,4 +486,30 @@ public function it_returns_an_authorized_controller_with_specific_policies(): vo
         $this->assertInstanceOf(Policy::class, $controller->policy());
         $this->assertEquals(['viewAny', 'view'], $controller->policy()->methods());
     }
+
+    #[Test]
+    public function it_returns_a_nested_controller(): void
+    {
+        $tokens = [
+            'controllers' => [
+                'Comment' => [
+                    'resource' => 'api',
+                    'meta' => [
+                        'parent' => 'post',
+                    ],
+                ],
+            ],
+        ];
+
+        $this->statementLexer->shouldReceive('analyze');
+
+        $actual = $this->subject->analyze($tokens);
+
+        $this->assertCount(1, $actual['controllers']);
+
+        $controller = $actual['controllers']['Comment'];
+        $this->assertEquals('CommentController', $controller->className());
+        $this->assertCount(5, $controller->methods());
+        $this->assertEquals($controller->parent(), 'Post');
+    }
 }
diff --git a/tests/fixtures/controllers/api-resource-nested.php b/tests/fixtures/controllers/api-resource-nested.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Http\Requests\CommentStoreRequest;
+use App\Http\Requests\CommentUpdateRequest;
+use App\Http\Resources\CommentCollection;
+use App\Http\Resources\CommentResource;
+use App\Models\Comment;
+use App\Models\Post;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+
+class CommentController extends Controller
+{
+    public function index(Request $request, Post $post): CommentCollection
+    {
+        $comments = $post->comments()->get();
+
+        return new CommentCollection($comments);
+    }
+
+    public function store(CommentStoreRequest $request, Post $post): CommentResource
+    {
+        $comment = $post->comments()->create($request->validated());
+
+        return new CommentResource($comment);
+    }
+
+    public function show(Request $request, Post $post, Comment $comment): CommentResource
+    {
+        return new CommentResource($comment);
+    }
+
+    public function update(CommentUpdateRequest $request, Post $post, Comment $comment): CommentResource
+    {
+        $comment->update($request->validated());
+
+        return new CommentResource($comment);
+    }
+
+    public function destroy(Request $request, Post $post, Comment $comment): Response
+    {
+        $comment->delete();
+
+        return response()->noContent();
+    }
+}
diff --git a/tests/fixtures/drafts/api-resource-nested.yaml b/tests/fixtures/drafts/api-resource-nested.yaml
@@ -0,0 +1,16 @@
+models:
+  Post:
+    title: string
+    body: text
+    relationships:
+      hasMany: comment
+      belongsTo: user
+  Comment:
+    body: text
+    relationships:
+      belongsTo: post, user
+controllers:
+  Comment:
+    resource: api
+    meta:
+      parent: post
diff --git a/tests/fixtures/drafts/controller-nested.yaml b/tests/fixtures/drafts/controller-nested.yaml
@@ -0,0 +1,5 @@
+controllers:
+  Comment:
+    resource: web
+    meta:
+      parent: post
diff --git a/tests/fixtures/routes/nested-controller.php b/tests/fixtures/routes/nested-controller.php
@@ -0,0 +1,3 @@
+
+
+Route::resource('posts/{post}/comments', App\Http\Controllers\CommentController::class);
diff --git a/tests/fixtures/tests/pest/api-resource-nested.php b/tests/fixtures/tests/pest/api-resource-nested.php
diff --git a/tests/fixtures/tests/phpunit/api-resource-nested.php b/tests/fixtures/tests/phpunit/api-resource-nested.php

Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,10 @@ public function analyze(array $tokens): array`
`74`	`74`	`$registry['policies'][] = $policy;`
`75`	`75`	`}`
`76`	`76`
	`77`	`+ if (isset($definition['meta']['parent'])) {`
	`78`	`+ $controller->setParent($definition['meta']['parent']);`
	`79`	`+ }`
	`80`	`+`
`77`	`81`	`unset($definition['meta']);`
`78`	`82`	`}`
`79`	`83`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ class Controller implements BlueprintModel`
`21`	`21`
`22`	`22`	`private bool $apiResource = false;`
`23`	`23`
	`24`	`+ private ?string $parent = null;`
	`25`	`+`
`24`	`26`	`public function __construct(string $name)`
`25`	`27`	`{`
`26`	`28`	`$this->name = class_basename($name);`
`@@ -103,4 +105,14 @@ public function isApiResource(): bool`
`103`	`105`	`{`
`104`	`106`	`return $this->apiResource;`
`105`	`107`	`}`
	`108`	`+`
	`109`	`+ public function setParent(string $parent): void`
	`110`	`+ {`
	`111`	`+ $this->parent = Str::studly(Str::singular($parent));`
	`112`	`+ }`
	`113`	`+`
	`114`	`+ public function parent(): ?string`
	`115`	`+ {`
	`116`	`+ return $this->parent;`
	`117`	`+ }`
`106`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,7 @@ public static function controllerTreeDataProvider(): array`
`119`	`119`	`['drafts/respond-statements.yaml', 'routes/respond-statements.php'],`
`120`	`120`	`['drafts/invokable-controller.yaml', 'routes/invokable-controller.php'],`
`121`	`121`	`['drafts/invokable-controller-shorthand.yaml', 'routes/invokable-controller.php'],`
	`122`	`+ ['drafts/controller-nested.yaml', 'routes/nested-controller.php'],`
`122`	`123`	`];`
`123`	`124`	`}`
`124`	`125`	`}`