Version 2

- Add default_migrations boolean to configure whether to run default migrations or not
- Reference models via the config
- Split migration files
- Fix tests
- Update readme
- Add upgrade guide
- Optimise role check

Author: JonathanLouw

README.md

@@ -15,6 +15,18 @@ $ composer require codinglabsau/laravel-roles
 ```
 
 ## Usage
+
+### Publish Assets
+```
+php artisan vendor:publish --provider="Codinglabs\Roles\RolesServiceProvider"
+```
+##### Or Publish Specific Assets
+```
+php artisan vendor:publish --tag="roles-config"
+php artisan vendor:publish --tag="roles-migrations"
+```
+### Migrations
+You will need to ensure that you have published the migrations and run `php artisan migrate`.
 ### Add the trait
 Add the `HasRoles` trait to your user model:
 
@@ -139,9 +151,31 @@ Vue.mixin({
   }
 })
 ```
-```vue
-// SomeComponent.vue
+```html
+<!-- SomeComponent.vue -->
 <div v-if="hasRole('manager')">I am a manager</div>
+```
+## Configuration
+
+```
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Models
+    |--------------------------------------------------------------------------
+    |
+    | You may replace the models here with your own if you need to use a custom
+    | model.
+    |
+    */
+
+    'models' => [
+        'role' => \Codinglabs\Roles\Role::class
+    ]
+];
+
 ```
 
 ## Contributing

composer.json

@@ -12,7 +12,7 @@
     "homepage": "https://github.com/codinglabsau/laravel-roles",
     "keywords": ["Laravel", "Roles"],
     "require": {
-        "php" : "^7.2",
+        "php" : "^7.3",
         "illuminate/support": "^6.0|^7.0|^8.0"
     },
     "require-dev": {

config/roles.php

@@ -1,5 +1,17 @@
 <?php
 
 return [
-    //
-];
+    /*
+    |--------------------------------------------------------------------------
+    | Models
+    |--------------------------------------------------------------------------
+    |
+    | You may replace the models here with your own if you need to use a custom
+    | model.
+    |
+    */
+
+    'models' => [
+        'role' => \Codinglabs\Roles\Role::class
+    ]
+];

database/migrations/2020_03_16_055656_create_roles_table.php

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateRolesTable extends Migration
+{
+    public function up()
+    {
+        Schema::create('roles', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('name');
+            $table->timestamps();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('roles');
+    }
+}

…2020_03_16_055658_create_roles_table.php …_03_16_055657_create_role_user_table.phpdatabase/migrations/2020_03_16_055658_create_roles_table.php renamed to database/migrations/2020_03_16_055657_create_role_user_table.php database/migrations/2020_03_16_055658_create_roles_table.php renamed to database/migrations/2020_03_16_055657_create_role_user_table.php

@@ -4,16 +4,10 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-class CreateRolesTable extends Migration
+class CreateRoleUserTable extends Migration
 {
     public function up()
     {
-        Schema::create('roles', function (Blueprint $table) {
-            $table->increments('id');
-            $table->string('name');
-            $table->timestamps();
-        });
-
         Schema::create('role_user', function (Blueprint $table) {
             $table->increments('id');
             $table->integer('role_id')->unsigned();
@@ -27,6 +21,5 @@ public function up()
     public function down()
     {
         Schema::dropIfExists('role_user');
-        Schema::dropIfExists('roles');
     }
 }

src/HasRoles.php

@@ -8,16 +8,16 @@ trait HasRoles
 {
     public function roles(): BelongsToMany
     {
-        return $this->belongsToMany(Role::class)
+        return $this->belongsToMany(config('roles.models.role'))
             ->withTimestamps();
     }
 
     public function hasRole($role): bool
     {
         if (is_array($role)) {
-            return $this->roles()->whereIn('name', $role)->exists();
+            return $this->roles->whereIn('name', $role)->isNotEmpty();
         }
 
-        return $this->roles()->where('name', $role)->exists();
+        return $this->roles->where('name', $role)->isNotEmpty();
     }
 }

src/RolesServiceProvider.php

@@ -11,13 +11,11 @@ public function boot()
     {
         $this->publishes([
             __DIR__.'/../config/roles.php' => config_path('roles.php'),
-        ]);
+        ], 'roles-config');
 
         $this->publishes([
             __DIR__.'/../database/migrations/' => database_path('migrations')
-        ], 'migrations');
-
-         $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
+        ], 'roles-migrations');
 
         Gate::define('role', function ($user, ...$roles) {
             return $user->hasRole($roles);

tests/RolesTest.php

@@ -9,7 +9,7 @@
 use Codinglabs\Roles\RolesServiceProvider;
 use Illuminate\Foundation\Auth\User as AuthUser;
 
-class MigrateWithLaravelTest extends TestCase
+class RolesTest extends TestCase
 {
     /** @var User */
     protected $user;
@@ -18,6 +18,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
+        $this->artisan('vendor:publish', ['--tag' => 'roles-migrations'])->run();
         $this->artisan('migrate', ['--database' => 'testbench'])->run();
         $this->loadLaravelMigrations(['--database' => 'testbench']);
 

upgrade.md

@@ -0,0 +1,18 @@
+# Upgrade Guide v1 to v2
+
+### Migrations
+###### Impact: High
+Migrations will no longer be automatically ran by the packages service provider, the migrations will now need to be published using this command:
+```
+php artisan publish --tag="roles-migrations"
+```
+If you haven't already migrated the tables then run `php artisan migrate` to ensure the tables are created.
+
+### Configuration
+###### Impact: Low
+The config file has been updated to now include the option to define what class is used for the Role model. So if you ever need to customise the role model you can make your own and reference it in the config. 
+
+If you wish to customise the model used for roles then you must publish the config using this command:
+```
+php artisan publish --tag="roles-config"
+```