Merge pull request #151 from mikield/main

Add WithoutMiddleware option to route

Author: freekmurze

src/Attributes/Any.php

@@ -12,12 +12,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             methods: Router::$verbs,
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }

src/Attributes/Delete.php

@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             methods: ['delete'],
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }

src/Attributes/Get.php

@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             methods: ['get'],
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }

src/Attributes/Patch.php

@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             methods: ['patch'],
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }

src/Attributes/Post.php

@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             methods: ['post'],
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }

src/Attributes/Put.php

@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             methods: ['put'],
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }

src/Attributes/Route.php

@@ -13,11 +13,14 @@ class Route implements RouteAttribute
 
     public array $middleware;
 
+    public array $withoutMiddleware;
+
     public function __construct(
         array | string $methods,
         public string $uri,
         public ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         $this->methods = array_map(
             static fn (string $verb) => in_array(
@@ -29,5 +32,6 @@ public function __construct(
             Arr::wrap($methods)
         );
         $this->middleware = Arr::wrap($middleware);
+        $this->withoutMiddleware = Arr::wrap($withoutMiddleware);
     }
 }

src/RouteRegistrar.php

@@ -116,19 +116,19 @@ protected function processAttributes(string $className): void
         $class = new ReflectionClass($className);
 
         $classRouteAttributes = new ClassRouteAttributes($class);
-        
+
         $groups = $classRouteAttributes->groups();
-        
+
         foreach ($groups as $group) {
             $router = $this->router;
             $router->group($group, fn () => $this->registerRoutes($class, $classRouteAttributes));
         }
-        
+
         if ($classRouteAttributes->resource()) {
             $this->registerResource($class, $classRouteAttributes);
         }
 
-       
+
     }
 
     protected function registerResource(ReflectionClass $class, ClassRouteAttributes $classRouteAttributes): void
@@ -174,6 +174,9 @@ protected function registerRoutes(ReflectionClass $class, ClassRouteAttributes $
 
                 $this->addMiddlewareToRoute($classRouteAttributes, $attributeClass, $route);
 
+                $this->addWithoutMiddlewareToRoute($classRouteAttributes, $attributeClass, $route);
+
+
                 $this->setWithTrashedIfAvailable($classRouteAttributes, $withTrashedAttribute, $route);
 
 
@@ -264,6 +267,18 @@ public function addMiddlewareToRoute(ClassRouteAttributes $classRouteAttributes,
         $route->middleware([...$this->middleware, ...$classMiddleware, ...$methodMiddleware]);
     }
 
+    /**
+     * @param ClassRouteAttributes $classRouteAttributes
+     * @param Route $attributeClass
+     * @param \Illuminate\Routing\Route $route
+     * @return void
+     */
+    private function addWithoutMiddlewareToRoute(ClassRouteAttributes $classRouteAttributes, Route $attributeClass, \Illuminate\Routing\Route $route): void
+    {
+        $methodWithoutMiddleware = $attributeClass->withoutMiddleware;
+        $route->withoutMiddleware($methodWithoutMiddleware);
+    }
+
     /**
      * @param ClassRouteAttributes $classRouteAttributes
      * @param mixed $defaultAttributes

tests/AttributeTests/FallbackAttributeTest.php

@@ -14,6 +14,12 @@ public function it_can_register_a_route_as_fallback()
 
         $this
             ->assertRegisteredRoutesCount(1)
-            ->assertRouteRegistered(FallbackTestController::class, 'myFallbackMethod', 'get', 'my-fallback-method', [], null, null, [], true);
+            ->assertRouteRegistered(
+                controller: FallbackTestController::class,
+                controllerMethod: 'myFallbackMethod',
+                httpMethods: 'get',
+                uri: 'my-fallback-method',
+                isFallback: true
+            );
     }
 }

tests/AttributeTests/WithoutMiddlewareAttributeTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Spatie\RouteAttributes\Tests\AttributeTests;
+
+use Spatie\RouteAttributes\Tests\TestCase;
+use Spatie\RouteAttributes\Tests\TestClasses\Controllers\WithoutMiddlewareTestController;
+use Spatie\RouteAttributes\Tests\TestClasses\Middleware\SkippedMiddleware;
+
+class WithoutMiddlewareAttributeTest extends TestCase
+{
+    /** @test */
+    public function it_can_skip_middleware_added_to_class()
+    {
+        $this->routeRegistrar->registerClass(WithoutMiddlewareTestController::class);
+
+
+        $this
+            ->assertRegisteredRoutesCount(1)
+            ->assertRouteRegistered(
+                WithoutMiddlewareTestController::class,
+                controllerMethod: 'withoutMiddleware',
+                uri: 'without-middleware',
+                withoutMiddleware: [SkippedMiddleware::class],
+            );
+    }
+}