[Feature] Pass Laravel router instance to routing callbacks

The Laravel router instance is now passed through to the resources,
relationships and actions callbacks as the second function
argument.

Closes #9

Author: lindyhopchris

CHANGELOG.md

@@ -25,6 +25,8 @@ All notable changes to this project will be documented in this file. This projec
   can be used to specify the named server the response should use to encode the JSON:API document. This has to be used
   when returning responses from routes that have not run the JSON:API middleware (i.e. there is no default server
   available via the service container).
+- [#9](https://github.com/laravel-json-api/laravel/issues/9) The Laravel route registrar is now passed through to
+  the `resources`, `relationships` and `actions` callbacks as the second function argument.
 
 ### Changed
 

src/Routing/PendingServerRegistration.php

@@ -145,7 +145,7 @@ public function resources(\Closure $callback): void
             $callback(new ResourceRegistrar(
                 $this->router,
                 $this->server
-            ));
+            ), $this->router);
         });
     }
 }

src/Routing/ResourceRegistrar.php

@@ -99,7 +99,7 @@ public function relationships(
         $this->router->group($attributes, function () use ($registrar, $callback, $routes) {
             $relationships = new Relationships($registrar);
 
-            $callback($relationships);
+            $callback($relationships, $this->router);
 
             foreach ($relationships->register() as $route) {
                 $routes->add($route);
@@ -140,7 +140,7 @@ public function actions(
         );
 
         $this->router->group($attributes, function () use ($actions, $callback) {
-            $callback($actions);
+            $callback($actions, $this->router);
         });
 
         return $routes;

tests/lib/Integration/Routing/ActionsTest.php

@@ -19,6 +19,7 @@
 
 namespace LaravelJsonApi\Laravel\Tests\Integration\Routing;
 
+use Illuminate\Contracts\Routing\Registrar;
 use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
 
 class ActionsTest extends TestCase
@@ -54,7 +55,8 @@ public function testBase(string $method): void
                 ->prefix('v1')
                 ->namespace('Api\\V1')
                 ->resources(function ($server) use ($func) {
-                    $server->resource('posts')->actions(function ($actions) use ($func) {
+                    $server->resource('posts')->actions(function ($actions, $routes) use ($func) {
+                        $this->assertInstanceOf(Registrar::class, $routes);
                         $actions->{$func}('foo-bar');
                     });
                 });

tests/lib/Integration/Routing/HasManyTest.php

@@ -19,6 +19,7 @@
 
 namespace LaravelJsonApi\Laravel\Tests\Integration\Routing;
 
+use Illuminate\Contracts\Routing\Registrar;
 use LaravelJsonApi\Core\Support\Arr;
 use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
 
@@ -79,7 +80,8 @@ public function test(string $method, string $uri, string $action, string $name):
 
         $this->defaultApiRoutesWithNamespace(function () {
             JsonApiRoute::server('v1')->prefix('v1')->namespace('Api\\V1')->resources(function ($server) {
-                $server->resource('posts')->relationships(function ($relations) {
+                $server->resource('posts')->relationships(function ($relations, $routes) {
+                    $this->assertInstanceOf(Registrar::class, $routes);
                     $relations->hasMany('tags');
                 });
             });

tests/lib/Integration/Routing/HasOneTest.php

@@ -19,6 +19,7 @@
 
 namespace LaravelJsonApi\Laravel\Tests\Integration\Routing;
 
+use Illuminate\Contracts\Routing\Registrar;
 use LaravelJsonApi\Core\Support\Arr;
 use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
 
@@ -67,7 +68,8 @@ public function test(string $method, string $uri, string $action, string $name):
 
         $this->defaultApiRoutesWithNamespace(function () {
             JsonApiRoute::server('v1')->prefix('v1')->namespace('Api\\V1')->resources(function ($server) {
-                $server->resource('posts')->relationships(function ($relations) {
+                $server->resource('posts')->relationships(function ($relations, $routes) {
+                    $this->assertInstanceOf(Registrar::class, $routes);
                     $relations->hasOne('author');
                 });
             });

tests/lib/Integration/Routing/ResourceTest.php

@@ -20,6 +20,7 @@
 namespace LaravelJsonApi\Laravel\Tests\Integration\Routing;
 
 use App\Http\Controllers\Api\V1\PostController;
+use Illuminate\Contracts\Routing\Registrar;
 use LaravelJsonApi\Core\Support\Arr;
 use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
 
@@ -53,7 +54,8 @@ public function test(string $method, string $uri, string $action, bool $id): voi
         $this->createSchema($server, 'posts', '\d+');
 
         $this->defaultApiRoutesWithNamespace(function () {
-            JsonApiRoute::server('v1')->prefix('v1')->namespace('Api\\V1')->resources(function ($server) {
+            JsonApiRoute::server('v1')->prefix('v1')->namespace('Api\\V1')->resources(function ($server, $routes) {
+                $this->assertInstanceOf(Registrar::class, $routes);
                 $server->resource('posts');
             });
         });