Merge pull request #30 from LWlook/main

Exclude method "middleware" from discovered routes

src/PendingRouteTransformers/RejectDefaultControllerMethodRoutes.php

@@ -30,10 +30,16 @@ public function transform(Collection $pendingRoutes): Collection
         return $pendingRoutes->each(function (PendingRoute $pendingRoute) {
             $pendingRoute->actions = $pendingRoute
                 ->actions
-                ->reject(fn (PendingRouteAction $pendingRouteAction) => in_array(
-                    $pendingRouteAction->method->class,
-                    $this->rejectMethodsInClasses
-                ));
+                ->reject(function (PendingRouteAction $pendingRouteAction) {
+                    if($pendingRouteAction->method->name == "middleware" && is_subclass_of($pendingRouteAction->method->class, "Illuminate\\Routing\\Controllers\\HasMiddleware")){
+                        return true;
+                    }
+
+                    return in_array(
+                        $pendingRouteAction->method->class,
+                        $this->rejectMethodsInClasses
+                    );
+                });
         });
     }
 }

tests/RouteDiscoveryTest.php

@@ -8,6 +8,8 @@
 use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\Domain\DomainController;
 use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\DoNotDiscoverController\DoNotDiscoverThisMethodController;
 use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\DoNotDiscoverMethod\DoNotDiscoverMethodController;
+use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\DoNotDiscoverMiddleware\DiscoverMiddlewareIfNotLaravelMethodController;
+use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\DoNotDiscoverMiddleware\DoNotDiscoverMiddlewareController;
 use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\Invokable\InvokableController;
 use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\Middleware\MiddlewareOnControllerController;
 use Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\Middleware\MiddlewareOnMethodController;
@@ -360,7 +362,6 @@
         );
 });
 
-
 it('can override the http method', function () {
     $this
         ->routeRegistrar
@@ -447,6 +448,34 @@
         );
 });
 
+it('can avoid discovering the laravel middleware method', function () {
+    if(!interface_exists('Illuminate\Routing\Controllers\HasMiddleware')) {
+        $this->markTestSkipped("Laravel 9 or up is required to run this test.");
+    }
+
+    $this
+        ->routeRegistrar
+        ->registerDirectory(controllersPath('DoNotDiscoverMiddleware'));
+
+    $this
+        ->assertRegisteredRoutesCount(3)
+        ->assertRouteRegistered(
+            DoNotDiscoverMiddlewareController::class,
+            controllerMethod: 'method',
+            uri: 'do-not-discover-middleware/method',
+        )
+        ->assertRouteRegistered(
+            DiscoverMiddlewareIfNotLaravelMethodController::class,
+            controllerMethod: 'method',
+            uri: 'discover-middleware-if-not-laravel-method/method',
+        )
+        ->assertRouteRegistered(
+            DiscoverMiddlewareIfNotLaravelMethodController::class,
+            controllerMethod: 'middleware',
+            uri: 'discover-middleware-if-not-laravel-method/middleware',
+        );
+});
+
 it('can avoid discovering a controller', function () {
     $this
         ->routeRegistrar
@@ -550,7 +579,7 @@
     $this->assertRegisteredRoutesCount(3);
 
     $registeredUris = collect(app()->router->getRoutes())
-        ->map(fn (Route $route) => $route->uri)
+        ->map(fn(Route $route) => $route->uri)
         ->toArray();
 
     expect($registeredUris)->toEqual([

tests/Support/TestClasses/Controllers/DoNotDiscoverMiddleware/DiscoverMiddlewareIfNotLaravelMethodController.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\DoNotDiscoverMiddleware;
+
+class DiscoverMiddlewareIfNotLaravelMethodController
+{
+    public static function middleware(): array {
+        return [];
+    }
+
+    public function method()
+    {
+    }
+
+}

tests/Support/TestClasses/Controllers/DoNotDiscoverMiddleware/DoNotDiscoverMiddlewareController.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spatie\RouteDiscovery\Tests\Support\TestClasses\Controllers\DoNotDiscoverMiddleware;
+
+use Illuminate\Routing\Controllers\HasMiddleware;
+
+class DoNotDiscoverMiddlewareController implements HasMiddleware
+{
+    public static function middleware(): array {
+        return [];
+    }
+
+    public function method()
+    {
+    }
+
+}