- Upgraded to Laravel Permissions 7.2

Author: dash8x

.github/workflows/run-tests.yml

@@ -16,27 +16,16 @@ jobs:
             fail-fast: true
             matrix:
                 os: [ ubuntu-latest ]
-                php: [ 8.4, 8.3, 8.2, 8.1 ]
-                laravel: [ 12.*, 11.*, 10.*, 9.* ]
+                php: [ 8.4, 8.3 ]
+                laravel: [ 13.*, 12.* ]
                 stability: [ prefer-lowest, prefer-stable ]
                 include:
+                    -   laravel: 13.*
+                        testbench: 11.*
+                        carbon: ^3.8.4
                     -   laravel: 12.*
                         testbench: 10.*
                         carbon: ^3.8.4
-                    -   laravel: 11.*
-                        testbench: 9.*
-                        carbon: ^2.63
-                    -   laravel: 10.*
-                        testbench: 8.*
-                        carbon: ^2.63
-                    -   laravel: 9.*
-                        testbench: 7.*
-                        carbon: ^2.63
-                exclude:
-                    -   laravel: 12.*
-                        php: 8.1
-                    -   laravel: 11.*
-                        php: 8.1
 
         name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 

composer.json

@@ -10,15 +10,15 @@
         }
     ],
     "require": {
-        "php": "^8.1",
-        "illuminate/support": "^9.0 || ^10.0 || ^11.0 || ^12.0",
-        "spatie/laravel-permission": "^6.3",
-        "javaabu/helpers": "^1.59",
-        "javaabu/activitylog": "^1.4"
+        "php": "^8.3",
+        "illuminate/support": "^12.0 || ^13.0",
+        "spatie/laravel-permission": "^7.2",
+        "javaabu/helpers": "^1.70",
+        "javaabu/activitylog": "^1.5"
     },
     "require-dev": {
-        "orchestra/testbench": "^7.0 || ^8.0 || ^9.0 || ^10.0",
-        "phpunit/phpunit": "^9.5 || ^10.5 || ^11.5.3"
+        "orchestra/testbench": "^10.0 || ^11.0",
+        "phpunit/phpunit": "^12.5.8 || ^13.0.3"
     },
     "autoload": {
         "psr-4": {
@@ -34,7 +34,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "1.0-dev"
+            "dev-main": "2.0-dev"
         },
         "laravel": {
             "providers": [

config/permission.php

@@ -75,8 +75,8 @@
         /*
          * Change this if you want to name the related pivots other than defaults
          */
-        'role_pivot_key' => null, //default 'role_id',
-        'permission_pivot_key' => null, //default 'permission_id',
+        'role_pivot_key' => null, // default 'role_id',
+        'permission_pivot_key' => null, // default 'permission_id',
 
         /*
          * Change this if you want to name the related model primary key other than
@@ -172,7 +172,7 @@
      * The class to use for interpreting wildcard permissions.
      * If you need to modify delimiters, override the class and specify its name here.
      */
-    // 'permission.wildcard_permission' => Spatie\Permission\WildcardPermission::class,
+    // 'wildcard_permission' => Spatie\Permission\WildcardPermission::class,
 
     /* Cache-specific settings */
 

database/migrations/2024_03_06_181813_create_permission_tables.php

@@ -1,8 +1,8 @@
 <?php
 
-use Illuminate\Support\Facades\Schema;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
 
 return new class extends Migration
 {
@@ -17,17 +17,16 @@ public function up(): void
         $pivotRole = $columnNames['role_pivot_key'] ?? 'role_id';
         $pivotPermission = $columnNames['permission_pivot_key'] ?? 'permission_id';
 
-        if (empty($tableNames)) {
-            throw new \Exception('Error: config/permission.php not loaded. Run [php artisan config:clear] and try again.');
-        }
-        if ($teams && empty($columnNames['team_foreign_key'] ?? null)) {
-            throw new \Exception('Error: team_foreign_key on config/permission.php not loaded. Run [php artisan config:clear] and try again.');
-        }
-
-        Schema::create($tableNames['permissions'], function (Blueprint $table) {
-            $table->bigIncrements('id'); // permission id
-            $table->string('name');       // For MySQL 8.0 use string('name', 125);
-            $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
+        throw_if(empty($tableNames), 'Error: config/permission.php not loaded. Run [php artisan config:clear] and try again.');
+        throw_if($teams && empty($columnNames['team_foreign_key'] ?? null), 'Error: team_foreign_key on config/permission.php not loaded. Run [php artisan config:clear] and try again.');
+
+        /**
+         * See `docs/prerequisites.md` for suggested lengths on 'name' and 'guard_name' if "1071 Specified key was too long" errors are encountered.
+         */
+        Schema::create($tableNames['permissions'], static function (Blueprint $table) {
+            $table->id(); // permission id
+            $table->string('name');
+            $table->string('guard_name');
             $table->timestamps();
 
             $table->unique(['name', 'guard_name']);
@@ -37,14 +36,17 @@ public function up(): void
             $table->string('model')->index()->nullable();
         });
 
-        Schema::create($tableNames['roles'], function (Blueprint $table) use ($teams, $columnNames) {
-            $table->bigIncrements('id'); // role id
+        /**
+         * See `docs/prerequisites.md` for suggested lengths on 'name' and 'guard_name' if "1071 Specified key was too long" errors are encountered.
+         */
+        Schema::create($tableNames['roles'], static function (Blueprint $table) use ($teams, $columnNames) {
+            $table->id(); // role id
             if ($teams || config('permission.testing')) { // permission.testing is a fix for sqlite testing
                 $table->unsignedBigInteger($columnNames['team_foreign_key'])->nullable();
                 $table->index($columnNames['team_foreign_key'], 'roles_team_foreign_key_index');
             }
-            $table->string('name');       // For MySQL 8.0 use string('name', 125);
-            $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
+            $table->string('name');
+            $table->string('guard_name');
             $table->timestamps();
             if ($teams || config('permission.testing')) {
                 $table->unique([$columnNames['team_foreign_key'], 'name', 'guard_name']);
@@ -56,7 +58,7 @@ public function up(): void
             $table->string('description')->nullable();
         });
 
-        Schema::create($tableNames['model_has_permissions'], function (Blueprint $table) use ($tableNames, $columnNames, $pivotPermission, $teams) {
+        Schema::create($tableNames['model_has_permissions'], static function (Blueprint $table) use ($tableNames, $columnNames, $pivotPermission, $teams) {
             $table->unsignedBigInteger($pivotPermission);
 
             $table->string('model_type');
@@ -66,7 +68,7 @@ public function up(): void
             $table->foreign($pivotPermission)
                 ->references('id') // permission id
                 ->on($tableNames['permissions'])
-                ->onDelete('cascade');
+                ->cascadeOnDelete();
             if ($teams) {
                 $table->unsignedBigInteger($columnNames['team_foreign_key']);
                 $table->index($columnNames['team_foreign_key'], 'model_has_permissions_team_foreign_key_index');
@@ -77,10 +79,9 @@ public function up(): void
                 $table->primary([$pivotPermission, $columnNames['model_morph_key'], 'model_type'],
                     'model_has_permissions_permission_model_type_primary');
             }
-
         });
 
-        Schema::create($tableNames['model_has_roles'], function (Blueprint $table) use ($tableNames, $columnNames, $pivotRole, $teams) {
+        Schema::create($tableNames['model_has_roles'], static function (Blueprint $table) use ($tableNames, $columnNames, $pivotRole, $teams) {
             $table->unsignedBigInteger($pivotRole);
 
             $table->string('model_type');
@@ -90,7 +91,7 @@ public function up(): void
             $table->foreign($pivotRole)
                 ->references('id') // role id
                 ->on($tableNames['roles'])
-                ->onDelete('cascade');
+                ->cascadeOnDelete();
             if ($teams) {
                 $table->unsignedBigInteger($columnNames['team_foreign_key']);
                 $table->index($columnNames['team_foreign_key'], 'model_has_roles_team_foreign_key_index');
@@ -103,19 +104,19 @@ public function up(): void
             }
         });
 
-        Schema::create($tableNames['role_has_permissions'], function (Blueprint $table) use ($tableNames, $pivotRole, $pivotPermission) {
+        Schema::create($tableNames['role_has_permissions'], static function (Blueprint $table) use ($tableNames, $pivotRole, $pivotPermission) {
             $table->unsignedBigInteger($pivotPermission);
             $table->unsignedBigInteger($pivotRole);
 
             $table->foreign($pivotPermission)
                 ->references('id') // permission id
                 ->on($tableNames['permissions'])
-                ->onDelete('cascade');
+                ->cascadeOnDelete();
 
             $table->foreign($pivotRole)
                 ->references('id') // role id
                 ->on($tableNames['roles'])
-                ->onDelete('cascade');
+                ->cascadeOnDelete();
 
             $table->primary([$pivotPermission, $pivotRole], 'role_has_permissions_permission_id_role_id_primary');
         });
@@ -132,14 +133,12 @@ public function down(): void
     {
         $tableNames = config('permission.table_names');
 
-        if (empty($tableNames)) {
-            throw new \Exception('Error: config/permission.php not found and defaults could not be merged. Please publish the package configuration before proceeding, or drop the tables manually.');
-        }
+        throw_if(empty($tableNames), 'Error: config/permission.php not found and defaults could not be merged. Please publish the package configuration before proceeding, or drop the tables manually.');
 
-        Schema::drop($tableNames['role_has_permissions']);
-        Schema::drop($tableNames['model_has_roles']);
-        Schema::drop($tableNames['model_has_permissions']);
-        Schema::drop($tableNames['roles']);
-        Schema::drop($tableNames['permissions']);
+        Schema::dropIfExists($tableNames['role_has_permissions']);
+        Schema::dropIfExists($tableNames['model_has_roles']);
+        Schema::dropIfExists($tableNames['model_has_permissions']);
+        Schema::dropIfExists($tableNames['roles']);
+        Schema::dropIfExists($tableNames['permissions']);
     }
 };

database/migrations/2024_03_06_181814_add_teams_fields.php

@@ -1,9 +1,9 @@
 <?php
 
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
-use Illuminate\Database\Schema\Blueprint;
-use Illuminate\Database\Migrations\Migration;
 
 return new class extends Migration
 {
@@ -21,12 +21,9 @@ public function up(): void
         if (! $teams) {
             return;
         }
-        if (empty($tableNames)) {
-            throw new \Exception('Error: config/permission.php not loaded. Run [php artisan config:clear] and try again.');
-        }
-        if (empty($columnNames['team_foreign_key'] ?? null)) {
-            throw new \Exception('Error: team_foreign_key on config/permission.php not loaded. Run [php artisan config:clear] and try again.');
-        }
+
+        throw_if(empty($tableNames), 'Error: config/permission.php not loaded. Run [php artisan config:clear] and try again.');
+        throw_if(empty($columnNames['team_foreign_key'] ?? null), 'Error: team_foreign_key on config/permission.php not loaded. Run [php artisan config:clear] and try again.');
 
         if (! Schema::hasColumn($tableNames['roles'], $columnNames['team_foreign_key'])) {
             Schema::table($tableNames['roles'], function (Blueprint $table) use ($columnNames) {
@@ -52,7 +49,9 @@ public function up(): void
                     'model_has_permissions_permission_model_type_primary');
                 if (DB::getDriverName() !== 'sqlite') {
                     $table->foreign($pivotPermission)
-                        ->references('id')->on($tableNames['permissions'])->onDelete('cascade');
+                        ->references('id')
+                        ->on($tableNames['permissions'])
+                        ->cascadeOnDelete();
                 }
             });
         }
@@ -71,7 +70,9 @@ public function up(): void
                     'model_has_roles_role_model_type_primary');
                 if (DB::getDriverName() !== 'sqlite') {
                     $table->foreign($pivotRole)
-                        ->references('id')->on($tableNames['roles'])->onDelete('cascade');
+                        ->references('id')
+                        ->on($tableNames['roles'])
+                        ->cascadeOnDelete();
                 }
             });
         }
@@ -84,8 +85,5 @@ public function up(): void
     /**
      * Reverse the migrations.
      */
-    public function down(): void
-    {
-
-    }
+    public function down(): void {}
 };

docs/metadata.json

@@ -1,5 +1,5 @@
 {
     "name": "Permissions",
     "description": "Modifications brought upon spatie/laravel-permissions",
-    "version": "1"
+    "version": "2"
 }

tests/Feature/HasRolesTest.php

@@ -11,6 +11,7 @@
 use Javaabu\Permissions\Tests\Models\User;
 use Javaabu\Permissions\Tests\Policies\UserPolicy;
 use Javaabu\Permissions\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class HasRolesTest extends TestCase
 {
@@ -23,7 +24,7 @@ public function setUp(): void
         $this->runMigrations();
     }
 
-    /** @test */
+    #[Test]
     public function it_skips_fake_roles_when_setting_user_roles(): void
     {
         Gate::policy(User::class, UserPolicy::class);
@@ -41,7 +42,7 @@ public function it_skips_fake_roles_when_setting_user_roles(): void
         ]);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_assign_a_single_role(): void
     {
         Gate::policy(User::class, UserPolicy::class);
@@ -68,7 +69,7 @@ public function it_can_assign_a_single_role(): void
         ]);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_assign_multiple_roles(): void
     {
         Gate::policy(User::class, UserPolicy::class);
@@ -111,7 +112,7 @@ public function it_can_assign_multiple_roles(): void
         ]);
     }
 
-    /** @test */
+    #[Test]
     function an_event_is_emitted_when_the_user_role_is_updated()
     {
         Event::fake();
@@ -144,7 +145,7 @@ function an_event_is_emitted_when_the_user_role_is_updated()
         });
     }
 
-    /** @test */
+    #[Test]
     function it_logs_the_new_and_old_roles_when_a_user_role_is_updated()
     {
         Gate::policy(User::class, UserPolicy::class);

tests/Feature/PermissionsTest.php

@@ -7,6 +7,7 @@
 use Javaabu\Permissions\Models\Role;
 use Javaabu\Permissions\Tests\Models\User;
 use Javaabu\Permissions\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class PermissionsTest extends TestCase
 {
@@ -19,7 +20,7 @@ public function setUp(): void
         $this->runMigrations();
     }
 
-    /** @test */
+    #[Test]
     public function it_can_check_if_a_user_has_a_permission(): void
     {
         $user = new User(['name' => 'Test User', 'email' => 'test@example.com']);