Merge pull request spatie#2823 from Yi-pixel/route-macro-function-enums-support

Route macro functions add backed enum support

Author: drbyte

src/PermissionServiceProvider.php

@@ -149,13 +149,19 @@ protected function registerMacroHelpers(): void
         }
 
         Route::macro('role', function ($roles = []) {
+            $roles = Arr::wrap($roles);
+            $roles = array_map(fn ($role) => $role instanceof \BackedEnum ? $role->value : $role, $roles);
+
             /** @var Route $this */
-            return $this->middleware('role:'.implode('|', Arr::wrap($roles)));
+            return $this->middleware('role:'.implode('|', $roles));
         });
 
         Route::macro('permission', function ($permissions = []) {
+            $permissions = Arr::wrap($permissions);
+            $permissions = array_map(fn ($permission) => $permission instanceof \BackedEnum ? $permission->value : $permission, $permissions);
+
             /** @var Route $this */
-            return $this->middleware('permission:'.implode('|', Arr::wrap($permissions)));
+            return $this->middleware('permission:'.implode('|', $permissions));
         });
     }
 

tests/RouteTest.php

@@ -2,7 +2,9 @@
 
 namespace Spatie\Permission\Tests;
 
+use PHPUnit\Framework\Attributes\RequiresPhp;
 use PHPUnit\Framework\Attributes\Test;
+use Spatie\Permission\Tests\TestModels\TestRolePermissionsEnum;
 
 class RouteTest extends TestCase
 {
@@ -51,4 +53,66 @@ public function test_role_and_permission_function_together()
             $this->getLastRouteMiddlewareFromRouter($router)
         );
     }
+
+    /**
+     * @test
+     *
+     * @requires PHP 8.1.0
+     */
+    #[RequiresPhp('>= 8.1.0')]
+    #[Test]
+    public function test_role_function_with_backed_enum()
+    {
+        $router = $this->getRouter();
+
+        $router->get('role-test.enum', $this->getRouteResponse())
+            ->name('role.test.enum')
+            ->role(TestRolePermissionsEnum::USERMANAGER);
+
+        $this->assertEquals(['role:'.TestRolePermissionsEnum::USERMANAGER->value], $this->getLastRouteMiddlewareFromRouter($router));
+    }
+
+    /**
+     * @test
+     *
+     * @requires PHP 8.1.0
+     */
+    #[RequiresPhp('>= 8.1.0')]
+    #[Test]
+    public function test_permission_function_with_backed_enum()
+    {
+        $router = $this->getRouter();
+
+        $router->get('permission-test.enum', $this->getRouteResponse())
+            ->name('permission.test.enum')
+            ->permission(TestRolePermissionsEnum::WRITER);
+
+        $expected = ['permission:'.TestRolePermissionsEnum::WRITER->value];
+        $this->assertEquals($expected, $this->getLastRouteMiddlewareFromRouter($router));
+    }
+
+    /**
+     * @test
+     *
+     * @requires PHP 8.1.0
+     */
+    #[RequiresPhp('>= 8.1.0')]
+    #[Test]
+    public function test_role_and_permission_function_together_with_backed_enum()
+    {
+        $router = $this->getRouter();
+
+        $router->get('roles-permissions-test.enum', $this->getRouteResponse())
+            ->name('roles-permissions.test.enum')
+            ->role([TestRolePermissionsEnum::USERMANAGER, TestRolePermissionsEnum::ADMIN])
+            ->permission([TestRolePermissionsEnum::WRITER, TestRolePermissionsEnum::EDITOR]);
+
+        $this->assertEquals(
+            [
+                'role:'.TestRolePermissionsEnum::USERMANAGER->value.'|'.TestRolePermissionsEnum::ADMIN->value,
+                'permission:'.TestRolePermissionsEnum::WRITER->value.'|'.TestRolePermissionsEnum::EDITOR->value,
+            ],
+            $this->getLastRouteMiddlewareFromRouter($router)
+        );
+    }
 }