Add observables to laratrust events

santigarcor · Sep 25, 2017 · 2c0ee36 · 2c0ee36
1 parent 6342410
commit 2c0ee36
Show file tree

Hide file tree

Showing 6 changed files with 167 additions and 93 deletions.
diff --git a/src/Traits/LaratrustHasEvents.php b/src/Traits/LaratrustHasEvents.php
@@ -4,6 +4,32 @@
 
 trait LaratrustHasEvents
 {
+    /**
+     * Register an observer to the Laratrust events.
+     *
+     * @param  object|string  $class
+     * @return void
+     */
+    public static function laratrustObserve($class)
+    {
+        $observables = [
+            'roleAttached',
+            'roleDetached',
+            'permissionAttached',
+            'permissionDetached',
+            'roleSynced',
+            'permissionSynced',
+        ];
+
+        $className = is_string($class) ? $class : get_class($class);
+
+        foreach ($observables as $event) {
+            if (method_exists($class, $event)) {
+                static::registerLaratrustEvent(\Illuminate\Support\Str::snake($event, '.'), $className.'@'.$event);
+            }
+        }
+    }
+
     /**
      * Fire the given event for the model.
      *

diff --git a/src/Traits/LaratrustPermissionTrait.php b/src/Traits/LaratrustPermissionTrait.php
@@ -17,6 +17,34 @@ trait LaratrustPermissionTrait
 {
     use LaratrustDynamicUserRelationsCalls;
 
+    /**
+     * Boots the permission model and attaches event listener to
+     * remove the many-to-many records when trying to delete.
+     * Will NOT delete any records if the permission model uses soft deletes.
+     *
+     * @return void|bool
+     */
+    public static function bootLaratrustPermissionTrait()
+    {
+        static::deleting(function ($permission) {
+            if (!method_exists(Config::get('laratrust.models.permission'), 'bootSoftDeletes')) {
+                $permission->roles()->sync([]);
+            }
+        });
+
+        static::deleting(function ($permission) {
+            if (method_exists($permission, 'bootSoftDeletes') && $permission->forceDeleting) {
+                return;
+            }
+
+            $permission->roles()->sync([]);
+
+            foreach (array_keys(Config::get('laratrust.user_models')) as $key) {
+                $permission->$key()->sync([]);
+            }
+        });
+    }
+
     /**
      * Many-to-Many relations with role model.
      *
@@ -48,32 +76,4 @@ public function getMorphByUserRelation($relationship)
             Config::get('laratrust.foreign_keys.user')
         );
     }
-
-    /**
-     * Boots the permission model and attaches event listener to
-     * remove the many-to-many records when trying to delete.
-     * Will NOT delete any records if the permission model uses soft deletes.
-     *
-     * @return void|bool
-     */
-    public static function bootLaratrustPermissionTrait()
-    {
-        static::deleting(function ($permission) {
-            if (!method_exists(Config::get('laratrust.models.permission'), 'bootSoftDeletes')) {
-                $permission->roles()->sync([]);
-            }
-        });
-
-        static::deleting(function ($permission) {
-            if (method_exists($permission, 'bootSoftDeletes') && $permission->forceDeleting) {
-                return;
-            }
-
-            $permission->roles()->sync([]);
-
-            foreach (array_keys(Config::get('laratrust.user_models')) as $key) {
-                $permission->$key()->sync([]);
-            }
-        });
-    }
 }
diff --git a/src/Traits/LaratrustRoleTrait.php b/src/Traits/LaratrustRoleTrait.php
@@ -19,6 +19,40 @@ trait LaratrustRoleTrait
     use LaratrustDynamicUserRelationsCalls;
     use LaratrustHasEvents;
 
+    /**
+     * Boots the role model and attaches event listener to
+     * remove the many-to-many records when trying to delete.
+     * Will NOT delete any records if the role model uses soft deletes.
+     *
+     * @return void|bool
+     */
+    public static function bootLaratrustRoleTrait()
+    {
+        $flushCache = function ($role) {
+            $role->flushCache();
+        };
+
+        // If the role doesn't use SoftDeletes.
+        if (method_exists(static::class, 'restored')) {
+            static::restored($flushCache);
+        }
+
+        static::deleted($flushCache);
+        static::saved($flushCache);
+
+        static::deleting(function ($role) {
+            if (method_exists($role, 'bootSoftDeletes') && $role->forceDeleting) {
+                return;
+            }
+
+            $role->permissions()->sync([]);
+
+            foreach (array_keys(Config::get('laratrust.user_models')) as $key) {
+                $role->$key()->sync([]);
+            }
+        });
+    }
+
     /**
      * Tries to return all the cached permissions of the role.
      * If it can't bring the permissions from the cache,
@@ -67,40 +101,6 @@ public function permissions()
         );
     }
 
-    /**
-     * Boots the role model and attaches event listener to
-     * remove the many-to-many records when trying to delete.
-     * Will NOT delete any records if the role model uses soft deletes.
-     *
-     * @return void|bool
-     */
-    public static function bootLaratrustRoleTrait()
-    {
-        $flushCache = function ($role) {
-            $role->flushCache();
-        };
-
-        // If the role doesn't use SoftDeletes.
-        if (method_exists(static::class, 'restored')) {
-            static::restored($flushCache);
-        }
-
-        static::deleted($flushCache);
-        static::saved($flushCache);
-
-        static::deleting(function ($role) {
-            if (method_exists($role, 'bootSoftDeletes') && $role->forceDeleting) {
-                return;
-            }
-
-            $role->permissions()->sync([]);
-
-            foreach (array_keys(Config::get('laratrust.user_models')) as $key) {
-                $role->$key()->sync([]);
-            }
-        });
-    }
-
     /**
      * Checks if the role has a permission by its name.
      *

diff --git a/src/Traits/LaratrustUserTrait.php b/src/Traits/LaratrustUserTrait.php
@@ -20,6 +20,37 @@ trait LaratrustUserTrait
 {
     use LaratrustHasEvents;
 
+    /**
+     * Boots the user model and attaches event listener to
+     * remove the many-to-many records when trying to delete.
+     * Will NOT delete any records if the user model uses soft deletes.
+     *
+     * @return void|bool
+     */
+    public static function bootLaratrustUserTrait()
+    {
+        $flushCache = function ($user) {
+            $user->flushCache();
+        };
+
+        // If the user doesn't use SoftDeletes.
+        if (method_exists(static::class, 'restored')) {
+            static::restored($flushCache);
+        }
+
+        static::deleted($flushCache);
+        static::saved($flushCache);
+
+        static::deleting(function ($user) {
+            if (method_exists($user, 'bootSoftDeletes') && !$user->forceDeleting) {
+                return;
+            }
+
+            $user->roles()->sync([]);
+            $user->permissions()->sync([]);
+        });
+    }
+
     /**
      * Tries to return all the cached roles of the user.
      * If it can't bring the roles from the cache,
@@ -96,37 +127,6 @@ public function permissions()
         return $permissions;
     }
 
-    /**
-     * Boots the user model and attaches event listener to
-     * remove the many-to-many records when trying to delete.
-     * Will NOT delete any records if the user model uses soft deletes.
-     *
-     * @return void|bool
-     */
-    public static function bootLaratrustUserTrait()
-    {
-        $flushCache = function ($user) {
-            $user->flushCache();
-        };
-
-        // If the user doesn't use SoftDeletes.
-        if (method_exists(static::class, 'restored')) {
-            static::restored($flushCache);
-        }
-
-        static::deleted($flushCache);
-        static::saved($flushCache);
-
-        static::deleting(function ($user) {
-            if (method_exists($user, 'bootSoftDeletes') && !$user->forceDeleting) {
-                return;
-            }
-
-            $user->roles()->sync([]);
-            $user->permissions()->sync([]);
-        });
-    }
-
     /**
      * Checks if the user has a role by its name.
      *

diff --git a/tests/LaratrustUserEventsTest.php b/tests/LaratrustUserEventsTest.php
@@ -138,4 +138,22 @@ public function testAnEventIsFiredWhenPermissionsAreSynced()
 
         $this->user->syncPermissions([]);
     }
+
+    public function testCanAddObservableClasses()
+    {
+        $events = [
+            'role.attached',
+            'role.detached',
+            'permission.attached',
+            'permission.detached',
+            'role.synced',
+            'permission.synced',
+        ];
+
+        User::laratrustObserve(\Laratrust\Tests\Models\UserObserver::class);
+
+        foreach ($events as $event) {
+            $this->assertTrue(User::getEventDispatcher()->hasListeners("laratrust.{$event}: " . User::class));
+        }
+    }
 }
diff --git a/tests/Models/UserObserver.php b/tests/Models/UserObserver.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Laratrust\Tests\Models;
+
+class UserObserver
+{
+    public function roleAttached($user, $thing, $team)
+    {
+    }
+
+    public function roleDetached($user, $thing, $team)
+    {
+    }
+
+    public function permissionAttached($user, $thing, $team)
+    {
+    }
+
+    public function permissionDetached($user, $thing, $team)
+    {
+    }
+
+    public function roleSynced($user, $thing, $team)
+    {
+    }
+
+    public function permissionSynced($user, $thing, $team)
+    {
+    }
+}