Add Enum support for Role and WithoutRole scopes

Ref #2391

src/Traits/HasRoles.php

@@ -68,7 +68,7 @@ public function roles(): BelongsToMany
  /**
  * Scope the model query to certain roles only.
  *
- * @param string|int|array|Role|Collection $roles
+ * @param string|int|array|Role|Collection|\BackedEnum $roles
  * @param string $guard
  */
  public function scopeRole(Builder $query, $roles, $guard = null): Builder
@@ -82,6 +82,10 @@ public function scopeRole(Builder $query, $roles, $guard = null): Builder
  return $role;
  }
 
+ if ($role instanceof \BackedEnum) {
+ $role = $role->value;
+ }
+
  $method = is_int($role) || PermissionRegistrar::isUid($role) ? 'findById' : 'findByName';
 
  return $this->getRoleClass()::{$method}($role, $guard ?: $this->getDefaultGuardName());
@@ -98,7 +102,7 @@ public function scopeRole(Builder $query, $roles, $guard = null): Builder
  /**
  * Scope the model query to only those without certain roles.
  *
- * @param string|int|array|Role|Collection $roles
+ * @param string|int|array|Role|Collection|\BackedEnum $roles
  * @param string $guard
  */
  public function scopeWithoutRole(Builder $query, $roles, $guard = null): Builder
@@ -112,6 +116,10 @@ public function scopeWithoutRole(Builder $query, $roles, $guard = null): Builder
  return $role;
  }
 
+ if ($role instanceof \BackedEnum) {
+ $role = $role->value;
+ }
+
  $method = is_int($role) || PermissionRegistrar::isUid($role) ? 'findById' : 'findByName';
 
  return $this->getRoleClass()::{$method}($role, $guard ?: $this->getDefaultGuardName());
@@ -128,7 +136,7 @@ public function scopeWithoutRole(Builder $query, $roles, $guard = null): Builder
  /**
  * Returns roles ids as array keys
  *
- * @param array|string|int|Role|Collection $roles
+ * @param array|string|int|Role|Collection|\BackedEnum $roles
  */
  private function collectRoles(...$roles): array
  {

tests/HasRolesTest.php

@@ -70,6 +70,37 @@ public function it_can_assign_and_remove_a_role_using_enums()
  $this->assertFalse($this->testUser->hasRole($enum1));
  }
 
+ /**
+ * @test
+ *
+ * @requires PHP >= 8.1
+ */
+ public function it_can_scope_a_role_using_enums()
+ {
+ $enum1 = TestModels\TestRolePermissionsEnum::USERMANAGER;
+ $enum2 = TestModels\TestRolePermissionsEnum::WRITER;
+ $role1 = app(Role::class)->findOrCreate($enum1->value, 'web');
+ $role2 = app(Role::class)->findOrCreate($enum2->value, 'web');
+
+ User::all()->each(fn ($item) => $item->delete());
+ $user1 = User::create(['email' => '[email protected]']);
+ $user2 = User::create(['email' => '[email protected]']);
+ $user3 = User::create(['email' => '[email protected]']);
+
+ // assign only one user to a role
+ $user2->assignRole($enum1);
+ $this->assertTrue($user2->hasRole($enum1));
+ $this->assertFalse($user2->hasRole($enum2));
+
+ $scopedUsers1 = User::role($enum1)->get();
+ $scopedUsers2 = User::role($enum2)->get();
+ $scopedUsers3 = User::withoutRole($enum2)->get();
+
+ $this->assertEquals(1, $scopedUsers1->count());
+ $this->assertEquals(0, $scopedUsers2->count());
+ $this->assertEquals(3, $scopedUsers3->count());
+ }
+
  /** @test */
  public function it_can_assign_and_remove_a_role()
  {