Add compatiblity with Laravel 5.5 (#433)

* make compatible with laravel 5.5

* Replaced created and updated event by saved event

* Remove pivot entries on model delete

* Minor cleanup

* Updated deps for Laravel 5.4

* Apply fixes from StyleCI

* Update README.md (#428)

* prepare for release

* prepare for release

Author: freekmurze

.travis.yml

@@ -3,6 +3,7 @@ language: php
 php:
   - 7.0
   - 7.1
+  - 7.2
 
 env:
   matrix:

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to `laravel-permission` will be documented in this file
 
+## 2.5.0 - 2017-08-30
+- add compatiblity with Laravel 5.5
+
 ## 2.4.2 - 2017-08-11
 - automatically detach roles and permissions when a user gets deleted
 

README.md

@@ -48,7 +48,7 @@ You can install the package via composer:
 composer require spatie/laravel-permission
 ```
 
-Now add the service provider in `config/app.php` file:
+In Laravel 5.5 the service provider will automatically get registered. In older versions of the framework just add the service provider in `config/app.php` file:
 
 ```php
 'providers' => [

composer.json

@@ -20,15 +20,15 @@
     ],
     "require": {
         "php" : ">=7.0",
-        "illuminate/auth": "~5.4.0",
-        "illuminate/container": "~5.4.0",
-        "illuminate/contracts": "~5.4.0",
-        "illuminate/database": "~5.4.0"
+        "illuminate/auth": "~5.4.0|~5.5.0",
+        "illuminate/container": "~5.4.0|~5.5.0",
+        "illuminate/contracts": "~5.4.0|~5.5.0",
+        "illuminate/database": "~5.4.0|~5.5.0"
     },
     "require-dev": {
         "monolog/monolog": "^1.22",
-        "orchestra/testbench": "~3.4.2",
-        "phpunit/phpunit" : "^6.0"
+        "orchestra/testbench": "~3.4.2|~3.5.0",
+        "phpunit/phpunit" : "^6.2"
     },
     "autoload": {
         "psr-4": {

phpunit.xml.dist

@@ -19,11 +19,4 @@
             <directory suffix=".php">src/</directory>
         </whitelist>
     </filter>
-    <logging>
-        <log type="tap" target="build/report.tap"/>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
 </phpunit>

src/Contracts/Role.php

@@ -21,14 +21,14 @@ public function permissions(): BelongsToMany;
      *
      * @return \Spatie\Permission\Contracts\Role
      *
-     * @throws RoleDoesNotExist
+     * @throws \Spatie\Permission\Exceptions\RoleDoesNotExist
      */
     public static function findByName(string $name, $guardName): Role;
 
     /**
      * Determine if the user may perform the given permission.
      *
-     * @param string|Permission $permission
+     * @param string|\Spatie\Permission\Contracts\Permission $permission
      *
      * @return bool
      */

src/PermissionRegistrar.php

@@ -33,7 +33,7 @@ public function __construct(Gate $gate, Repository $cache, Log $logger)
     public function registerPermissions(): bool
     {
         try {
-            $this->getPermissions()->map(function ($permission) {
+            $this->getPermissions()->map(function (Permission $permission) {
                 $this->gate->define($permission->name, function ($user) use ($permission) {
                     return $user->hasPermissionTo($permission);
                 });

src/Traits/HasPermissions.php

@@ -89,7 +89,7 @@ protected function getStoredPermission($permissions): Permission
     /**
      * @param \Spatie\Permission\Contracts\Permission|\Spatie\Permission\Contracts\Role $roleOrPermission
      *
-     * @throws \Spatie\Permission\Exceptions\GuardMismatch
+     * @throws \Spatie\Permission\Exceptions\GuardDoesNotMatch
      */
     protected function ensureModelSharesGuard($roleOrPermission)
     {

src/Traits/HasRoles.php

@@ -52,7 +52,7 @@ public function permissions(): MorphToMany
      * Scope the model query to certain roles only.
      *
      * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param string|array|Role|\Illuminate\Support\Collection $roles
+     * @param string|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection $roles
      *
      * @return \Illuminate\Database\Eloquent\Builder
      */
@@ -122,7 +122,7 @@ public function removeRole($role)
     /**
      * Remove all current roles and set the given ones.
      *
-     * @param array ...$roles
+     * @param array|\Spatie\Permission\Contracts\Role|string ...$roles
      *
      * @return $this
      */

src/Traits/RefreshesPermissionCache.php

@@ -2,18 +2,17 @@
 
 namespace Spatie\Permission\Traits;
 
-use Illuminate\Database\Eloquent\Model;
 use Spatie\Permission\PermissionRegistrar;
 
 trait RefreshesPermissionCache
 {
     public static function bootRefreshesPermissionCache()
     {
-        static::saved(function (Model $model) {
+        static::saved(function () {
             app(PermissionRegistrar::class)->forgetCachedPermissions();
         });
 
-        static::deleted(function (Model $model) {
+        static::deleted(function () {
             app(PermissionRegistrar::class)->forgetCachedPermissions();
         });
     }

tests/HasRolesTest.php

@@ -139,6 +139,23 @@ public function it_throws_an_exception_when_syncing_a_role_from_another_guard()
         $this->testUser->syncRoles('testRole', $this->testAdminRole);
     }
 
+    /** @test */
+    public function it_deletes_pivot_table_entries_when_deleting_models()
+    {
+        $user = User::create(['email' => '[email protected]']);
+
+        $user->assignRole('testRole');
+        $user->givePermissionTo('edit-articles');
+
+        $this->assertDatabaseHas('model_has_permissions', ['model_id' => $user->id]);
+        $this->assertDatabaseHas('model_has_roles', ['model_id' => $user->id]);
+
+        $user->delete();
+
+        $this->assertDatabaseMissing('model_has_permissions', ['model_id' => $user->id]);
+        $this->assertDatabaseMissing('model_has_roles', ['model_id' => $user->id]);
+    }
+
     /** @test */
     public function it_can_scope_users_using_a_string()
     {