Middleware: support enums in role/permission middleware (#2813)

* Allow middleware to handle enum based permission or role

---------

Co-authored-by: Chris Brown <[email protected]>

Author: marklawntalk

src/Middleware/PermissionMiddleware.php

@@ -28,9 +28,7 @@ public function handle($request, Closure $next, $permission, $guard = null)
             throw UnauthorizedException::missingTraitHasRoles($user);
         }
 
-        $permissions = is_array($permission)
-            ? $permission
-            : explode('|', $permission);
+        $permissions = explode('|', self::parsePermissionsToString($permission));
 
         if (! $user->canAny($permissions)) {
             throw UnauthorizedException::forPermissions($permissions);
@@ -42,15 +40,42 @@ public function handle($request, Closure $next, $permission, $guard = null)
     /**
      * Specify the permission and guard for the middleware.
      *
-     * @param  array|string  $permission
+     * @param  array|string|\BackedEnum  $permission
      * @param  string|null  $guard
      * @return string
      */
     public static function using($permission, $guard = null)
     {
-        $permissionString = is_string($permission) ? $permission : implode('|', $permission);
+        // Convert Enum to its value if an Enum is passed
+        if ($permission instanceof \BackedEnum) {
+            $permission = $permission->value;
+        }
+
+        $permissionString = self::parsePermissionsToString($permission);
+
         $args = is_null($guard) ? $permissionString : "$permissionString,$guard";
 
         return static::class.':'.$args;
     }
+
+    /**
+     * Convert array or string of permissions to string representation.
+     *
+     * @return string
+     */
+    protected static function parsePermissionsToString(array|string|\BackedEnum $permission)
+    {
+        // Convert Enum to its value if an Enum is passed
+        if ($permission instanceof \BackedEnum) {
+            $permission = $permission->value;
+        }
+
+        if (is_array($permission)) {
+            $permission = array_map(fn ($r) => $r instanceof \BackedEnum ? $r->value : $r, $permission);
+
+            return implode('|', $permission);
+        }
+
+        return (string) $permission;
+    }
 }

src/Middleware/RoleMiddleware.php

@@ -28,9 +28,7 @@ public function handle($request, Closure $next, $role, $guard = null)
             throw UnauthorizedException::missingTraitHasRoles($user);
         }
 
-        $roles = is_array($role)
-            ? $role
-            : explode('|', $role);
+        $roles = explode('|', self::parseRolesToString($role));
 
         if (! $user->hasAnyRole($roles)) {
             throw UnauthorizedException::forRoles($roles);
@@ -42,15 +40,37 @@ public function handle($request, Closure $next, $role, $guard = null)
     /**
      * Specify the role and guard for the middleware.
      *
-     * @param  array|string  $role
+     * @param  array|string|\BackedEnum  $role
      * @param  string|null  $guard
      * @return string
      */
     public static function using($role, $guard = null)
     {
-        $roleString = is_string($role) ? $role : implode('|', $role);
+        $roleString = self::parseRolesToString($role);
+
         $args = is_null($guard) ? $roleString : "$roleString,$guard";
 
         return static::class.':'.$args;
     }
+
+    /**
+     * Convert array or string of roles to string representation.
+     *
+     * @return string
+     */
+    protected static function parseRolesToString(array|string|\BackedEnum $role)
+    {
+        // Convert Enum to its value if an Enum is passed
+        if ($role instanceof \BackedEnum) {
+            $role = $role->value;
+        }
+
+        if (is_array($role)) {
+            $role = array_map(fn ($r) => $r instanceof \BackedEnum ? $r->value : $r, $role);
+
+            return implode('|', $role);
+        }
+
+        return (string) $role;
+    }
 }

tests/PermissionMiddlewareTest.php

@@ -434,4 +434,55 @@ public function the_middleware_can_be_created_with_static_using_method()
             PermissionMiddleware::using(['edit-articles', 'edit-news'])
         );
     }
+
+    /**
+     * @test
+     *
+     * @requires PHP >= 8.1
+     */
+    #[RequiresPhp('>= 8.1')]
+    #[Test]
+    public function the_middleware_can_handle_enum_based_permissions_with_static_using_method()
+    {
+        $this->assertSame(
+            'Spatie\Permission\Middleware\PermissionMiddleware:view articles',
+            PermissionMiddleware::using(TestModels\TestRolePermissionsEnum::VIEWARTICLES)
+        );
+        $this->assertEquals(
+            'Spatie\Permission\Middleware\PermissionMiddleware:view articles,my-guard',
+            PermissionMiddleware::using(TestModels\TestRolePermissionsEnum::VIEWARTICLES, 'my-guard')
+        );
+        $this->assertEquals(
+            'Spatie\Permission\Middleware\PermissionMiddleware:view articles|edit articles',
+            PermissionMiddleware::using([TestModels\TestRolePermissionsEnum::VIEWARTICLES, TestModels\TestRolePermissionsEnum::EDITARTICLES])
+        );
+    }
+
+    /**
+     * @test
+     *
+     * @requires PHP >= 8.1
+     */
+    #[RequiresPhp('>= 8.1')]
+    #[Test]
+    public function the_middleware_can_handle_enum_based_permissions_with_handle_method()
+    {
+        app(Permission::class)->create(['name' => TestModels\TestRolePermissionsEnum::VIEWARTICLES->value]);
+        app(Permission::class)->create(['name' => TestModels\TestRolePermissionsEnum::EDITARTICLES->value]);
+
+        Auth::login($this->testUser);
+        $this->testUser->givePermissionTo(TestModels\TestRolePermissionsEnum::VIEWARTICLES);
+        
+        $this->assertEquals(
+            200,
+            $this->runMiddleware($this->permissionMiddleware, TestModels\TestRolePermissionsEnum::VIEWARTICLES)
+        );
+
+        $this->testUser->givePermissionTo(TestModels\TestRolePermissionsEnum::EDITARTICLES);
+        
+        $this->assertEquals(
+            200,
+            $this->runMiddleware($this->permissionMiddleware, [TestModels\TestRolePermissionsEnum::VIEWARTICLES, TestModels\TestRolePermissionsEnum::EDITARTICLES])
+        );
+    }
 }

tests/RoleMiddlewareTest.php

@@ -9,6 +9,7 @@
 use InvalidArgumentException;
 use Laravel\Passport\Passport;
 use PHPUnit\Framework\Attributes\Test;
+use Spatie\Permission\Contracts\Role;
 use Spatie\Permission\Exceptions\UnauthorizedException;
 use Spatie\Permission\Middleware\RoleMiddleware;
 use Spatie\Permission\Tests\TestModels\UserWithoutHasRoles;
@@ -366,4 +367,55 @@ public function the_middleware_can_be_created_with_static_using_method()
             RoleMiddleware::using(['testAdminRole', 'anotherRole'])
         );
     }
+
+    /**
+     * @test
+     *
+     * @requires PHP >= 8.1
+     */
+    #[RequiresPhp('>= 8.1')]
+    #[Test]
+    public function the_middleware_can_handle_enum_based_roles_with_static_using_method()
+    {
+        $this->assertSame(
+            'Spatie\Permission\Middleware\RoleMiddleware:writer',
+            RoleMiddleware::using(TestModels\TestRolePermissionsEnum::WRITER)
+        );
+        $this->assertEquals(
+            'Spatie\Permission\Middleware\RoleMiddleware:writer,my-guard',
+            RoleMiddleware::using(TestModels\TestRolePermissionsEnum::WRITER, 'my-guard')
+        );
+        $this->assertEquals(
+            'Spatie\Permission\Middleware\RoleMiddleware:writer|editor',
+            RoleMiddleware::using([TestModels\TestRolePermissionsEnum::WRITER, TestModels\TestRolePermissionsEnum::EDITOR])
+        );
+    }
+
+     /**
+      * @test
+      *
+      * @requires PHP >= 8.1
+      */
+     #[RequiresPhp('>= 8.1')]
+     #[Test]
+     public function the_middleware_can_handle_enum_based_roles_with_handle_method()
+     {
+         app(Role::class)->create(['name' => TestModels\TestRolePermissionsEnum::WRITER->value]);
+         app(Role::class)->create(['name' => TestModels\TestRolePermissionsEnum::EDITOR->value]);
+
+         Auth::login($this->testUser);
+         $this->testUser->assignRole(TestModels\TestRolePermissionsEnum::WRITER);
+
+         $this->assertEquals(
+             200,
+             $this->runMiddleware($this->roleMiddleware, TestModels\TestRolePermissionsEnum::WRITER)
+         );
+
+         $this->testUser->assignRole(TestModels\TestRolePermissionsEnum::EDITOR);
+
+         $this->assertEquals(
+             200,
+             $this->runMiddleware($this->roleMiddleware, [TestModels\TestRolePermissionsEnum::WRITER, TestModels\TestRolePermissionsEnum::EDITOR])
+         );
+     }
 }