Enum trait (#116)

* Create Enum.php

* Use enum

* Move enum to concern sub directory

* Use specific enum values in migrations

Fixes issues where you add new enum values later but migrations have already been run

Author: SebKay

app/Enums/Concerns/Enum.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Enums\Concerns;
+
+use Illuminate\Support\Collection;
+
+trait Enum
+{
+    public static function values(): Collection
+    {
+        return collect(self::cases())->map(fn ($case): string => $case->value);
+    }
+
+    public static function only(array $cases, bool $asArray = false): Collection
+    {
+        return collect(self::cases())->filter(fn ($case) => in_array($case, $cases))->map(fn ($case) => $asArray ? $case->value : $case);
+    }
+}

app/Enums/Environment.php

@@ -2,17 +2,14 @@
 
 namespace App\Enums;
 
-use Illuminate\Support\Collection;
+use App\Enums\Concerns\Enum;
 
 enum Environment: string
 {
+    use Enum;
+
     case LOCAL = 'local';
     case TESTING = 'testing';
     case PRODUCTION = 'production';
     case STAGING = 'staging';
-
-    public static function values(): Collection
-    {
-        return collect(self::cases())->map(fn ($case): string => $case->value);
-    }
 }

app/Enums/Permission.php

@@ -2,18 +2,17 @@
 
 namespace App\Enums;
 
+use App\Enums\Concerns\Enum;
+
 enum Permission: string
 {
+    use Enum;
+
     case ACCESS_ADMIN = 'access-filament';
 
     case CREATE_POSTS = 'create-posts';
     case VIEW_POSTS = 'view-posts';
     case EDIT_POSTS = 'edit-posts';
     case UPDATE_POSTS = 'update-posts';
     case DELETE_POSTS = 'delete-posts';
-
-    public static function values(): array
-    {
-        return collect(self::cases())->map(fn ($case): string => $case->value)->toArray();
-    }
 }

app/Enums/Queue.php

@@ -2,15 +2,12 @@
 
 namespace App\Enums;
 
-use Illuminate\Support\Collection;
+use App\Enums\Concerns\Enum;
 
 enum Queue: string
 {
+    use Enum;
+
     case DEFAULT = 'default';
     case MAIL = 'mail';
-
-    public static function values(): Collection
-    {
-        return collect(self::cases())->map(fn ($case): string => $case->value);
-    }
 }

app/Enums/Role.php

@@ -2,14 +2,13 @@
 
 namespace App\Enums;
 
+use App\Enums\Concerns\Enum;
+
 enum Role: string
 {
+    use Enum;
+
     case SUPER_ADMIN = 'super-admin';
     case ADMIN = 'admin';
     case USER = 'user';
-
-    public static function values(): array
-    {
-        return collect(self::cases())->map(fn ($case): string => $case->value)->toArray();
-    }
 }

app/Filament/Resources/Users/Tables/UsersTable.php

@@ -62,7 +62,7 @@ public static function configure(Table $table): Table
                 SelectFilter::make('roles')
                     ->label('Roles')
                     ->relationship('roles', 'name')
-                    ->options(Role::values())
+                    ->options(Role::values()->all())
                     ->multiple()
                     ->preload(),
             ])

database/factories/UserFactory.php

@@ -5,6 +5,7 @@
 use App\Enums\Role;
 use App\Models\User;
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Str;
 
 /**
@@ -19,7 +20,7 @@ public function definition()
             'last_name' => \fake()->lastName(),
             'email' => \fake()->unique()->safeEmail(),
             'email_verified_at' => \now(),
-            'password' => '12345',
+            'password' => Hash::make(config('seed.users.super.password')),
             'remember_token' => Str::random(10),
         ];
     }
@@ -35,8 +36,8 @@ public function superAdmin(?string $email = null)
     {
         return $this
             ->state(fn (array $attributes) => [
-                'email' => \config('seed.users.super.email'),
-                'password' => \config('seed.users.super.password'),
+                'email' => config('seed.users.super.email'),
+                'password' => Hash::make(config('seed.users.super.password')),
             ])
             ->afterCreating(function (User $user) {
                 $user->assignRole(Role::SUPER_ADMIN);
@@ -47,8 +48,8 @@ public function admin()
     {
         return $this
             ->state(fn (array $attributes) => [
-                'email' => \config('seed.users.admin.email'),
-                'password' => \config('seed.users.admin.password'),
+                'email' => config('seed.users.admin.email'),
+                'password' => Hash::make(config('seed.users.admin.password')),
             ])
             ->afterCreating(function (User $user) {
                 $user->assignRole(Role::ADMIN);
@@ -59,8 +60,8 @@ public function user()
     {
         return $this
             ->state(fn (array $attributes) => [
-                'email' => \config('seed.users.user.email'),
-                'password' => \config('seed.users.user.password'),
+                'email' => config('seed.users.user.email'),
+                'password' => Hash::make(config('seed.users.user.password')),
             ])
             ->afterCreating(function (User $user) {
                 $user->assignRole(Role::USER);

database/migrations/0001_01_01_000007_create_permission_tables.php

@@ -24,7 +24,14 @@ public function up(): void
 
         Schema::create($tableNames['permissions'], function (Blueprint $table) {
             $table->bigIncrements('id'); // permission id
-            $table->enum('name', Permission::values());
+            $table->enum('name', Permission::only([
+                Permission::ACCESS_ADMIN,
+                Permission::CREATE_POSTS,
+                Permission::VIEW_POSTS,
+                Permission::EDIT_POSTS,
+                Permission::UPDATE_POSTS,
+                Permission::DELETE_POSTS,
+            ], true)->all());
             $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
             $table->timestamps();
 
@@ -37,7 +44,11 @@ public function up(): void
                 $table->unsignedBigInteger($columnNames['team_foreign_key'])->nullable();
                 $table->index($columnNames['team_foreign_key'], 'roles_team_foreign_key_index');
             }
-            $table->enum('name', Role::values());
+            $table->enum('name', Role::only([
+                Role::SUPER_ADMIN,
+                Role::ADMIN,
+                Role::USER,
+            ], true)->all());
             $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
             $table->timestamps();
             if ($teams || config('permission.testing')) {