feat: update users key to roles in core.php config file (#356)

mckenziearts · web-flow · commit 34109d83551b · 2025-11-17T10:35:20.000+01:00
* feat: update users key to roles in core.php config file

* fix: unit test
diff --git a/packages/admin/resources/views/livewire/pages/settings/team/role.blade.php b/packages/admin/resources/views/livewire/pages/settings/team/role.blade.php
@@ -52,7 +52,7 @@
         <div x-show="currentTab === 'role'">
             <x-shopper::container>
                 <div class="w-full space-y-6 lg:max-w-4xl">
-                    @if (config('shopper.core.users.admin_role') === $role->name)
+                    @if (config('shopper.core.roles.admin') === $role->name)
                         <div class="rounded-md bg-info-500 bg-opacity-10 p-4">
                             <div class="flex">
                                 <div class="shrink-0">
diff --git a/packages/admin/resources/views/livewire/slide-overs/create-team-member.blade.php b/packages/admin/resources/views/livewire/slide-overs/create-team-member.blade.php
@@ -5,6 +5,6 @@
         class="mt-6"
         icon="untitledui-alert-triangle"
         :title="__('shopper::words.attention_needed')"
-        :message="__('shopper::words.attention_description', ['role' => config('shopper.core.users.admin_role')])"
+        :message="__('shopper::words.attention_description', ['role' => config('shopper.core.roles.admin')])"
     />
 </x-shopper::form-slider-over>
diff --git a/packages/admin/src/Console/UserCommand.php b/packages/admin/src/Console/UserCommand.php
@@ -74,7 +74,7 @@ protected function createUser(): void
         try {
             $user = tap((new $model)->forceFill($userData))->save(); // @phpstan-ignore-line
 
-            $user->assignRole(config('shopper.core.users.admin_role'));
+            $user->assignRole(config('shopper.core.roles.admin'));
         } catch (Exception | QueryException $e) {
             $this->error($e->getMessage());
         }
diff --git a/packages/admin/src/Livewire/Components/Settings/Team/UsersRole.php b/packages/admin/src/Livewire/Components/Settings/Team/UsersRole.php
@@ -52,7 +52,7 @@ public function table(Table $table): Table
                     ->label(__('shopper::forms.label.access'))
                     ->color('gray')
                     ->formatStateUsing(
-                        fn ($record) => $record->hasRole(config('shopper.core.users.admin_role'))
+                        fn ($record) => $record->hasRole(config('shopper.core.roles.admin'))
                         ? __('shopper::words.full')
                         : __('shopper::words.limited')
                     ),
diff --git a/packages/admin/src/Livewire/Pages/Customers/Create.php b/packages/admin/src/Livewire/Pages/Customers/Create.php
@@ -148,7 +148,7 @@ public function store(): void
             ['email_verified_at' => now()->toDateTimeString()],
         ));
 
-        $customer->assignRole(config('shopper.core.users.default_role'));
+        $customer->assignRole(config('shopper.core.roles.user'));
 
         $customer->addresses()->create($address);
 
diff --git a/packages/admin/src/Livewire/Pages/Settings/Team/Index.php b/packages/admin/src/Livewire/Pages/Settings/Team/Index.php
@@ -47,7 +47,7 @@ public function table(Table $table): Table
                     ->label(__('shopper::forms.label.access'))
                     ->color('gray')
                     ->formatStateUsing(
-                        fn ($record) => $record->hasRole(config('shopper.core.users.admin_role'))
+                        fn ($record) => $record->hasRole(config('shopper.core.roles.admin'))
                         ? __('shopper::words.full')
                         : __('shopper::words.limited')
                     ),
@@ -66,7 +66,7 @@ public function render(): View
         return view('shopper::livewire.pages.settings.team.index', [
             'roles' => Role::query()
                 ->with('users')
-                ->where('name', '<>', config('shopper.core.users.default_role'))
+                ->where('name', '<>', config('shopper.core.roles.user'))
                 ->orderBy('created_at')
                 ->get(),
         ])
diff --git a/packages/admin/src/Livewire/SlideOvers/CreateTeamMember.php b/packages/admin/src/Livewire/SlideOvers/CreateTeamMember.php
@@ -83,7 +83,7 @@ public function form(Form $form): Form
                             ->label(__('shopper::pages/settings/staff.choose_role'))
                             ->options(
                                 Role::query()
-                                    ->where('name', '<>', config('shopper.core.users.default_role'))
+                                    ->where('name', '<>', config('shopper.core.roles.user'))
                                     ->pluck('display_name', 'id')
                             )
                             ->required(),
diff --git a/packages/core/config/core.php b/packages/core/config/core.php
@@ -6,7 +6,7 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Admin & User Role
+    | Roles
     |--------------------------------------------------------------------------
     |
     | User configuration to manage user access using spatie/laravel-permission.
@@ -15,10 +15,10 @@
     |
     */
 
-    'users' => [
-        'admin_role' => 'administrator',
-        'manager_role' => 'manager',
-        'default_role' => 'user',
+    'roles' => [
+        'admin' => 'administrator',
+        'manager' => 'manager',
+        'user' => 'user',
     ],
 
     /*
diff --git a/packages/core/database/seeders/Auth/PermissionRoleTableSeeder.php b/packages/core/database/seeders/Auth/PermissionRoleTableSeeder.php
@@ -16,7 +16,7 @@ public function run(): void
         Schema::disableForeignKeyConstraints();
 
         $administrator = Role::query()
-            ->where('name', config('shopper.core.users.admin_role'))
+            ->where('name', config('shopper.core.roles.admin'))
             ->firstOrFail();
 
         $permissions = Permission::all();
diff --git a/packages/core/database/seeders/Auth/RolesTableSeeder.php b/packages/core/database/seeders/Auth/RolesTableSeeder.php
@@ -15,21 +15,21 @@ public function run(): void
         Schema::disableForeignKeyConstraints();
 
         Role::create([
-            'name' => config('shopper.core.users.admin_role'),
+            'name' => config('shopper.core.roles.admin'),
             'display_name' => __('Administrator'),
             'description' => __('Site administrator with access to shop admin panel and developer tools.'),
             'can_be_removed' => false,
         ]);
 
         Role::create([
-            'name' => config('shopper.core.users.manager_role'),
+            'name' => config('shopper.core.roles.manager'),
             'display_name' => __('Manager'),
             'description' => __('Site manager with access to shop admin panel and publishing menus.'),
             'can_be_removed' => false,
         ]);
 
         Role::create([
-            'name' => config('shopper.core.users.default_role'),
+            'name' => config('shopper.core.roles.user'),
             'display_name' => __('User'),
             'description' => __('Site customer role with access on front site.'),
             'can_be_removed' => false,
diff --git a/packages/core/src/Models/Role.php b/packages/core/src/Models/Role.php
@@ -22,6 +22,6 @@ class Role extends Model
 
     public function isAdmin(): bool
     {
-        return $this->name === config('shopper.core.users.admin_role');
+        return $this->name === config('shopper.core.roles.admin');
     }
 }
diff --git a/packages/core/src/Models/User.php b/packages/core/src/Models/User.php
@@ -83,12 +83,12 @@ protected static function newFactory(): UserFactory
 
     public function isAdmin(): bool
     {
-        return $this->hasRole(config('shopper.core.users.admin_role'));
+        return $this->hasRole(config('shopper.core.roles.admin'));
     }
 
     public function isManager(): bool
     {
-        return $this->hasRole(config('shopper.core.users.manager_role'));
+        return $this->hasRole(config('shopper.core.roles.manager'));
     }
 
     public function isVerified(): bool
@@ -132,7 +132,7 @@ protected function rolesLabel(): Attribute
     public function scopeCustomers(Builder $query): Builder
     {
         return $query->whereHas('roles', function (Builder $query): void {
-            $query->where('name', config('shopper.core.users.default_role'));
+            $query->where('name', config('shopper.core.roles.user'));
         });
     }
 
@@ -144,8 +144,8 @@ public function scopeAdministrators(Builder $query): Builder
     {
         return $query->whereHas('roles', function (Builder $query): void {
             $query->whereIn('name', [
-                config('shopper.core.users.admin_role'),
-                config('shopper.core.users.manager_role'),
+                config('shopper.core.roles.admin'),
+                config('shopper.core.roles.manager'),
             ]);
         });
     }
diff --git a/tests/src/Admin/Auth/LoginTest.php b/tests/src/Admin/Auth/LoginTest.php
@@ -20,7 +20,7 @@
         $this->assertGuest();
 
         $userToAuthenticate = User::factory()->create();
-        $userToAuthenticate->assignRole(config('shopper.core.users.admin_role'));
+        $userToAuthenticate->assignRole(config('shopper.core.roles.admin'));
 
         Livewire::test(Login::class)
             ->set('email', $userToAuthenticate->email)
diff --git a/tests/src/TestCase.php b/tests/src/TestCase.php
@@ -92,8 +92,7 @@ protected function asAdmin(): TestCase
     protected function makeAdminUser(): User
     {
         $admin = User::factory()->create();
-
-        $admin->assignRole(config('shopper.core.users.admin_role'));
+        $admin->assignRole(config('shopper.core.roles.admin'));
 
         return $admin;
     }

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ protected function createUser(): void`
`74`	`74`	`try {`
`75`	`75`	`$user = tap((new $model)->forceFill($userData))->save(); // @phpstan-ignore-line`
`76`	`76`
`77`		`- $user->assignRole(config('shopper.core.users.admin_role'));`
	`77`	`+ $user->assignRole(config('shopper.core.roles.admin'));`
`78`	`78`	`} catch (Exception \| QueryException $e) {`
`79`	`79`	`$this->error($e->getMessage());`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public function form(Form $form): Form`
`83`	`83`	`->label(__('shopper::pages/settings/staff.choose_role'))`
`84`	`84`	`->options(`
`85`	`85`	`Role::query()`
`86`		`- ->where('name', '<>', config('shopper.core.users.default_role'))`
	`86`	`+ ->where('name', '<>', config('shopper.core.roles.user'))`
`87`	`87`	`->pluck('display_name', 'id')`
`88`	`88`	`)`
`89`	`89`	`->required(),`