Added Events PermissionAttached, PermissionDetached, `RoleAttache…

…d` and `RoleDetached`
spatie · Oct 28, 2024 · 93ef4a0 · 93ef4a0
1 parent 7483792
commit 93ef4a0
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 21 deletions.
diff --git a/src/Events/PermissionAttached.php b/src/Events/PermissionAttached.php
@@ -15,6 +15,6 @@ class PermissionAttached
     use InteractsWithSockets;
     use SerializesModels;
 
-    public function __construct(public Model $model)
+    public function __construct(public Model $model, public array $permissionIds)
     {}
 }
diff --git a/src/Events/PermissionDetached.php b/src/Events/PermissionDetached.php
@@ -8,13 +8,19 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Collection;
+use Spatie\Permission\Contracts\Permission;
 
 class PermissionDetached
 {
     use Dispatchable;
     use InteractsWithSockets;
     use SerializesModels;
 
-    public function __construct(public Model $model)
+    /**
+     * @param Model $model
+     * @param Permission|Permission[]|Collection $permission
+     */
+    public function __construct(public Model $model, public mixed $permission)
     {}
 }
diff --git a/src/Events/RoleAttached.php b/src/Events/RoleAttached.php
@@ -15,6 +15,6 @@ class RoleAttached
     use InteractsWithSockets;
     use SerializesModels;
 
-    public function __construct(public Model $model)
+    public function __construct(public Model $model, public array $roleIds)
     {}
 }
diff --git a/src/Events/RoleDetached.php b/src/Events/RoleDetached.php
@@ -8,13 +8,14 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\SerializesModels;
+use Spatie\Permission\Contracts\Role;
 
 class RoleDetached
 {
     use Dispatchable;
     use InteractsWithSockets;
     use SerializesModels;
 
-    public function __construct(public Model $model)
+    public function __construct(public Model $model, public Role $role)
     {}
 }
diff --git a/src/Traits/HasPermissions.php b/src/Traits/HasPermissions.php
@@ -424,7 +424,7 @@ function ($object) use ($permissions, $model, $teamPivot, &$saved) {
             $this->forgetCachedPermissions();
         }
 
-        event(new PermissionAttached($this->getModel()));
+        event(new PermissionAttached($this->getModel(), $permissions));
 
         $this->forgetWildcardPermissionIndex();
 
@@ -463,13 +463,15 @@ public function syncPermissions(...$permissions)
      */
     public function revokePermissionTo($permission)
     {
-        $this->permissions()->detach($this->getStoredPermission($permission));
+        $storedPermission = $this->getStoredPermission($permission);
+
+        $this->permissions()->detach($storedPermission);
 
         if (is_a($this, Role::class)) {
             $this->forgetCachedPermissions();
         }
 
-        event(new PermissionDetached($this->getModel()));
+        event(new PermissionDetached($this->getModel(), $storedPermission));
 
         $this->forgetWildcardPermissionIndex();
 

diff --git a/src/Traits/HasRoles.php b/src/Traits/HasRoles.php
@@ -181,7 +181,7 @@ function ($object) use ($roles, $model, $teamPivot, &$saved) {
             $this->forgetCachedPermissions();
         }
 
-        event(new RoleAttached($this->getModel()));
+        event(new RoleAttached($this->getModel(), $roles));
 
         return $this;
     }
@@ -193,15 +193,17 @@ function ($object) use ($roles, $model, $teamPivot, &$saved) {
      */
     public function removeRole($role)
     {
-        $this->roles()->detach($this->getStoredRole($role));
+        $storedRole = $this->getStoredRole($role);
+
+        $this->roles()->detach($storedRole);
 
         $this->unsetRelation('roles');
 
         if (is_a($this, Permission::class)) {
             $this->forgetCachedPermissions();
         }
 
-        event(new RoleDetached($this->getModel()));
+        event(new RoleDetached($this->getModel(), $storedRole));
 
         return $this;
     }

diff --git a/tests/HasPermissionsTest.php b/tests/HasPermissionsTest.php
@@ -775,10 +775,17 @@ public function it_fires_an_event_when_a_permission_is_added()
     {
         Event::fake();
 
-        $this->testUser->givePermissionTo('edit-news');
+        $this->testUser->givePermissionTo(['edit-articles', 'edit-news']);
+
+        $ids = app(Permission::class)::whereIn('name', ['edit-articles', 'edit-news'])
+            ->pluck($this->testUserPermission->getKeyName())
+            ->toArray();
 
-        Event::assertDispatched(PermissionAttached::class, function ($event) {
-            return $event->model instanceof User && $event->model->hasPermissionTo('edit-news');
+        Event::assertDispatched(PermissionAttached::class, function ($event) use ($ids) {
+            return $event->model instanceof User
+                && $event->model->hasPermissionTo('edit-news')
+                && $event->model->hasPermissionTo('edit-articles')
+                && $ids === $event->permissionIds;
         });
     }
 
@@ -787,12 +794,17 @@ public function it_fires_an_event_when_a_permission_is_removed()
     {
         Event::fake();
 
-        $this->testUser->givePermissionTo('edit-news');
+        $permissions = app(Permission::class)::whereIn('name', ['edit-articles', 'edit-news'])->get();
+
+        $this->testUser->givePermissionTo($permissions);
 
-        $this->testUser->revokePermissionTo('edit-news');
+        $this->testUser->revokePermissionTo($permissions);
 
-        Event::assertDispatched(PermissionDetached::class, function ($event) {
-            return $event->model instanceof User && !$event->model->hasPermissionTo('edit-news');
+        Event::assertDispatched(PermissionDetached::class, function ($event) use ($permissions) {
+            return $event->model instanceof User
+                && !$event->model->hasPermissionTo('edit-news')
+                && !$event->model->hasPermissionTo('edit-articles')
+                && $event->permission === $permissions;
         });
     }
 }
diff --git a/tests/HasRolesTest.php b/tests/HasRolesTest.php
@@ -865,10 +865,17 @@ public function it_fires_an_event_when_a_role_is_added()
     {
         Event::fake();
 
-        $this->testUser->assignRole('testRole');
+        $this->testUser->assignRole(['testRole', 'testRole2']);
+
+        $roleIds = app(Role::class)::whereIn('name', ['testRole', 'testRole2'])
+            ->pluck($this->testUserRole->getKeyName())
+            ->toArray();
 
-        Event::assertDispatched(RoleAttached::class, function ($event) {
-            return $event->model instanceof User && $event->model->hasRole('testRole');
+        Event::assertDispatched(RoleAttached::class, function ($event) use ($roleIds) {
+            return $event->model instanceof User
+                && $event->model->hasRole('testRole')
+                && $event->model->hasRole('testRole2')
+                && $event->roleIds === $roleIds;
         });
     }
 
@@ -882,7 +889,9 @@ public function it_fires_an_event_when_a_role_is_removed()
         $this->testUser->removeRole('testRole');
 
         Event::assertDispatched(RoleDetached::class, function ($event) {
-            return $event->model instanceof User && !$event->model->hasRole('testRole');
+            return $event->model instanceof User
+                && !$event->model->hasRole('testRole')
+                && $event->role->name === 'testRole';
         });
     }
 }