added support to withoutMiddleware in route-attribute (#11)

* added withouMiddleware route-attribute support (#10) * added documentation about on withoutMiddleware (#10)
digital-entropy · Oct 4, 2023 · 3dc7a20 · 3dc7a20
1 parent c9a88e8
commit 3dc7a20
Show file tree

Hide file tree

Showing 12 changed files with 62 additions and 7 deletions.
diff --git a/readme.md b/readme.md
@@ -328,13 +328,13 @@ Dentro\Yalr\Attributes\Middleware(string | array $middleware);
 
 #### Available Method Target
 ```php
-Dentro\Yalr\Attributes\Get(string $uri, ?string $name = null, array | string $middleware = []);
-Dentro\Yalr\Attributes\Post(string $uri, ?string $name = null, array | string $middleware = []);
-Dentro\Yalr\Attributes\Put(string $uri, ?string $name = null, array | string $middleware = []);
-Dentro\Yalr\Attributes\Patch(string $uri, ?string $name = null, array | string $middleware = []);
-Dentro\Yalr\Attributes\Delete(string $uri, ?string $name = null, array | string $middleware = []);
-Dentro\Yalr\Attributes\Options(string $uri, ?string $name = null, array | string $middleware = []);
-Dentro\Yalr\Attributes\Delete(string $uri, ?string $name = null, array | string $middleware = []);
+Dentro\Yalr\Attributes\Get(string $uri, ?string $name = null, array | string $middleware = [], array | string $withoutMiddleware = []);
+Dentro\Yalr\Attributes\Post(string $uri, ?string $name = null, array | string $middleware = [], array | string $withoutMiddleware = []);
+Dentro\Yalr\Attributes\Put(string $uri, ?string $name = null, array | string $middleware = [], array | string $withoutMiddleware = []);
+Dentro\Yalr\Attributes\Patch(string $uri, ?string $name = null, array | string $middleware = [], array | string $withoutMiddleware = []);
+Dentro\Yalr\Attributes\Delete(string $uri, ?string $name = null, array | string $middleware = [], array | string $withoutMiddleware = []);
+Dentro\Yalr\Attributes\Options(string $uri, ?string $name = null, array | string $middleware = [], array | string $withoutMiddleware = []);
+Dentro\Yalr\Attributes\Delete(string $uri, ?string $name = null, array | string $middleware = [], array | string $withoutMiddleware = []);
 ```
 
 #### Added To Configuration Route

diff --git a/src/Attributes/Any.php b/src/Attributes/Any.php
@@ -12,12 +12,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             method: Router::$verbs,
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware,
         );
     }
 }
diff --git a/src/Attributes/Delete.php b/src/Attributes/Delete.php
@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             method: 'DELETE',
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }
diff --git a/src/Attributes/Get.php b/src/Attributes/Get.php
@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             method: ['GET', 'HEAD'],
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }
diff --git a/src/Attributes/Options.php b/src/Attributes/Options.php
@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             method: 'OPTIONS',
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }
diff --git a/src/Attributes/Patch.php b/src/Attributes/Patch.php
@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             method: 'PATCH',
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }
diff --git a/src/Attributes/Post.php b/src/Attributes/Post.php
@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             method: 'POST',
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }
diff --git a/src/Attributes/Put.php b/src/Attributes/Put.php
@@ -11,12 +11,14 @@ public function __construct(
         string $uri,
         ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         parent::__construct(
             method: 'PUT',
             uri: $uri,
             name: $name,
             middleware: $middleware,
+            withoutMiddleware: $withoutMiddleware
         );
     }
 }
diff --git a/src/Attributes/Route.php b/src/Attributes/Route.php
@@ -9,13 +9,16 @@
 class Route implements RouteAttribute
 {
     public array $middleware;
+    public array $withoutMiddleware;
 
     public function __construct(
         public array | string $method,
         public string $uri,
         public ?string $name = null,
         array | string $middleware = [],
+        array | string $withoutMiddleware = [],
     ) {
         $this->middleware = Arr::wrap($middleware);
+        $this->withoutMiddleware = Arr::wrap($withoutMiddleware);
     }
 }
diff --git a/src/Attributes/WithoutMiddleware.php b/src/Attributes/WithoutMiddleware.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Dentro\Yalr\Attributes;
+
+use Attribute;
+use Illuminate\Support\Arr;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+class WithoutMiddleware implements RouteAttribute
+{
+    public array $withoutMiddleware = [];
+
+    public function __construct(string | array $middleware = [])
+    {
+        $this->withoutMiddleware = Arr::wrap($middleware);
+    }
+}
diff --git a/src/BaseRoute.php b/src/BaseRoute.php
@@ -38,6 +38,13 @@ abstract class BaseRoute implements Bindable, Registerable
      */
     protected array|string $middleware;
 
+    /**
+     * Middleware excluded in route.
+     *
+     * @var array|string
+     */
+    protected array|string $withoutMiddleware;
+
     /**
      * Route for specific domain.
      *
@@ -172,6 +179,10 @@ public function getRouteGroupOptions(): array
             $options['middleware'] = $this->middleware;
         }
 
+        if (isset($this->withoutMiddleware) && !empty($this->withoutMiddleware)) {
+            $options['withoutMiddleware'] = $this->withoutMiddleware;
+        }
+
         if (isset($this->domain) && !empty($this->domain)) {
             $options['domain'] = $this->domain;
         }

diff --git a/src/RouteAttributeRegistrar.php b/src/RouteAttributeRegistrar.php
@@ -2,6 +2,7 @@
 
 namespace Dentro\Yalr;
 
+use Dentro\Yalr\Attributes\WithoutMiddleware;
 use Illuminate\Routing\RouteRegistrar;
 use Dentro\Yalr\Attributes\Domain;
 use Dentro\Yalr\Attributes\Middleware;
@@ -46,6 +47,10 @@ public function registerClass(string $className): void
                         break;
                     case $attribute instanceof Middleware:
                         $carry['middleware'] = $attribute->middleware;
+                        break;
+                    case $attribute instanceof WithoutMiddleware:
+                        $carry['withoutMiddleware'] = $attribute->withoutMiddleware;
+                        break;
                 }
 
                 return $carry;
@@ -76,6 +81,7 @@ protected function registerMethod(ReflectionClass $class): void
                         $uri = $attributeInstance->uri;
                         $name = $attributeInstance->name;
                         $middleware = $attributeInstance->middleware;
+                        $withoutMiddleware = $attributeInstance->withoutMiddleware;
 
                         if (!empty($name)) {
                             $this->name($name);
@@ -85,6 +91,10 @@ protected function registerMethod(ReflectionClass $class): void
                             $this->middleware($middleware);
                         }
 
+                        if (!empty($withoutMiddleware)) {
+                            $this->withoutMiddleware($withoutMiddleware);
+                        }
+
                         $this->router->addRoute($httpMethods, $uri, $this->compileAction($action));
 
                         // reset attributes after registered