Use Environment enum

SebKay · SebKay · commit 047b21f72625 · 2025-01-02T08:52:21.000Z
diff --git a/app/Enums/Environment.php b/app/Enums/Environment.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Enums;
+
+use Illuminate\Support\Collection;
+
+enum Environment: string
+{
+    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);
+    }
+}
diff --git a/app/Filament/Pages/Auth/Login.php b/app/Filament/Pages/Auth/Login.php
@@ -2,6 +2,7 @@
 
 namespace App\Filament\Pages\Auth;
 
+use App\Enums\Environment;
 use Filament\Pages\Auth\Login as BasePage;
 
 class Login extends BasePage
@@ -10,7 +11,7 @@ public function mount(): void
     {
         parent::mount();
 
-        if (\app()->environment('local')) {
+        if (\app()->environment(Environment::LOCAL->value)) {
             $this->form->fill([
                 'email' => \config('app.seed.users.super.email'),
                 'password' => \config('app.seed.users.super.password'),
diff --git a/app/Http/Controllers/LoginController.php b/app/Http/Controllers/LoginController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\Environment;
 use App\Http\Requests\Login\LoginStoreRequest;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
@@ -10,7 +11,7 @@ class LoginController extends Controller
 {
     public function show(Request $request)
     {
-        return inertia('Login/Show', app()->environment('local', 'testing') ? [
+        return inertia('Login/Show', app()->environment([Environment::LOCAL->value, Environment::TESTING->value]) ? [
             'email' => config('app.seed.users.super.email'),
             'password' => config('app.seed.users.super.password'),
             'remember' => true,
diff --git a/app/Http/Controllers/RegisterController.php b/app/Http/Controllers/RegisterController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\Environment;
 use App\Enums\Role;
 use App\Http\Requests\Register\RegisterStoreRequest;
 use App\Models\User;
@@ -11,7 +12,7 @@ class RegisterController extends Controller
 {
     public function show()
     {
-        return inertia('Register/Show', app()->environment('local', 'testing') ? [
+        return inertia('Register/Show', app()->environment([Environment::LOCAL->value, Environment::TESTING->value]) ? [
             'first_name' => 'Jim',
             'last_name' => 'Gordon',
             'email' => 'test@test.com',
diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
@@ -2,6 +2,7 @@
 
 namespace App\Providers;
 
+use App\Enums\Environment;
 use App\Models\User;
 use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Support\Facades\Vite;
@@ -22,7 +23,7 @@ class AppServiceProvider extends ServiceProvider
 {
     public function register(): void
     {
-        if ($this->app->environment('local')) {
+        if ($this->app->environment(Environment::LOCAL->value)) {
             $this->app->register(\Laravel\Telescope\TelescopeServiceProvider::class);
             $this->app->register(TelescopeServiceProvider::class);
         }
diff --git a/app/Providers/Filament/AdminPanelProvider.php b/app/Providers/Filament/AdminPanelProvider.php
@@ -3,6 +3,7 @@
 namespace App\Providers\Filament;
 
 use Althinect\FilamentSpatieRolesPermissions\FilamentSpatieRolesPermissionsPlugin;
+use App\Enums\Environment;
 use App\Enums\Role;
 use Filament\Http\Middleware\Authenticate;
 use Filament\Http\Middleware\DisableBladeIconComponents;
@@ -42,16 +43,16 @@ public function panel(Panel $panel): Panel
             ->plugins([
                 FilamentSpatieRolesPermissionsPlugin::make(),
                 EnvironmentIndicatorPlugin::make()
-                    ->visible(fn () => \auth()->user()?->hasRole(Role::SUPER_ADMIN) && \app()->environment() !== 'production')
+                    ->visible(fn () => \auth()->user()?->hasRole(Role::SUPER_ADMIN) && \app()->environment() !== Environment::PRODUCTION->value)
                     ->showBorder(false)
                     ->color(fn () => match (app()->environment()) {
-                        'production' => Color::Green,
-                        'staging' => Color::Blue,
-                        'local' => Color::Red,
+                        Environment::PRODUCTION->value => Color::Green,
+                        Environment::STAGING->value => Color::Blue,
+                        Environment::LOCAL->value => Color::Red,
                         default => Color::Gray,
                     }),
                 DebuggerPlugin::make()
-                    ->authorize(fn () => \auth()->user()?->hasRole(Role::SUPER_ADMIN) && \app()->environment() !== 'production'),
+                    ->authorize(fn () => \auth()->user()?->hasRole(Role::SUPER_ADMIN) && \app()->environment() !== Environment::PRODUCTION->value),
             ])
             ->middleware([
                 EncryptCookies::class,
diff --git a/app/Providers/TelescopeServiceProvider.php b/app/Providers/TelescopeServiceProvider.php
@@ -2,6 +2,7 @@
 
 namespace App\Providers;
 
+use App\Enums\Environment;
 use Illuminate\Support\Facades\Gate;
 use Laravel\Telescope\IncomingEntry;
 use Laravel\Telescope\Telescope;
@@ -18,7 +19,7 @@ public function register(): void
 
         $this->hideSensitiveRequestDetails();
 
-        $isLocal = $this->app->environment('local');
+        $isLocal = $this->app->environment(Environment::LOCAL->value);
 
         Telescope::filter(function (IncomingEntry $entry) use ($isLocal) {
             return $isLocal ||
@@ -35,7 +36,7 @@ public function register(): void
      */
     protected function hideSensitiveRequestDetails(): void
     {
-        if ($this->app->environment('local')) {
+        if ($this->app->environment(Environment::LOCAL->value)) {
             return;
         }
 
diff --git a/config/app.php b/config/app.php
@@ -1,5 +1,7 @@
 <?php
 
+use App\Enums\Environment;
+
 return [
 
     'seed' => [
@@ -43,7 +45,7 @@
     |
     */
 
-    'env' => env('APP_ENV', 'production'),
+    'env' => env('APP_ENV', Environment::PRODUCTION->value),
 
     /*
     |--------------------------------------------------------------------------
diff --git a/config/horizon.php b/config/horizon.php
@@ -1,5 +1,6 @@
 <?php
 
+use App\Enums\Environment;
 use Illuminate\Support\Str;
 
 return [
@@ -198,23 +199,23 @@
     ],
 
     'environments' => [
-        'production' => [
+        Environment::PRODUCTION->value => [
             'supervisor-1' => [
                 'maxProcesses' => 10,
                 'balanceMaxShift' => 1,
                 'balanceCooldown' => 3,
             ],
         ],
 
-        'staging' => [
+        Environment::STAGING->value => [
             'supervisor-1' => [
                 'maxProcesses' => 5,
                 'balanceMaxShift' => 1,
                 'balanceCooldown' => 3,
             ],
         ],
 
-        'local' => [
+        Environment::LOCAL->value => [
             'supervisor-1' => [
                 'maxProcesses' => 3,
             ],
diff --git a/config/permission.php b/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
diff --git a/routes/console.php b/routes/console.php
@@ -1,6 +1,7 @@
 <?php
 
+use App\Enums\Environment;
 use Illuminate\Support\Facades\Schedule;
 
 Schedule::command('horizon:snapshot')->everyFiveMinutes();
-Schedule::command(\Spatie\Health\Commands\RunHealthChecksCommand::class)->everyMinute()->environments('production');
+Schedule::command(\Spatie\Health\Commands\RunHealthChecksCommand::class)->everyMinute()->environments(Environment::PRODUCTION->value);
diff --git a/tests/Feature/Controllers/AccountControllerTest.php b/tests/Feature/Controllers/AccountControllerTest.php
@@ -83,9 +83,9 @@
 
 describe('Guests', function () {
     test("Can't access the edit page", function () {
-        get(route('account.edit'))
-            ->assertRedirectToRoute('login');
-    });
+    get(route('account.edit'))
+    ->assertRedirectToRoute('login');
+        });
 
     test("Can't update details", function () {
         patch(route('account.update'))
diff --git a/tests/Feature/Controllers/DashboardControllerTest.php b/tests/Feature/Controllers/DashboardControllerTest.php
@@ -22,7 +22,7 @@
 
 describe('Guests', function () {
     test("Can't access the home page", function () {
-        get(route('home'))
-            ->assertRedirectToRoute('login');
-    });
+    get(route('home'))
+    ->assertRedirectToRoute('login');
+        });
 });
diff --git a/tests/Feature/Controllers/EmailVerificationControllerTest.php b/tests/Feature/Controllers/EmailVerificationControllerTest.php
@@ -54,7 +54,7 @@
 
 describe('Guests', function () {
     test("Can't access the verification page", function () {
-        get(route('verification.notice'))
-            ->assertRedirectToRoute('login');
-    });
+    get(route('verification.notice'))
+    ->assertRedirectToRoute('login');
+        });
 });
diff --git a/tests/Feature/Controllers/LoginControllerTest.php b/tests/Feature/Controllers/LoginControllerTest.php
@@ -1,5 +1,6 @@
 <?php
 
+use App\Enums\Environment;
 use App\Models\User;
 use Inertia\Testing\AssertableInertia as Assert;
 
@@ -23,20 +24,20 @@
 
 describe('Guests', function () {
     test('Can access the login page', function () {
-        get(route('login'))
-            ->assertOk()
-            ->assertInertia(
-                fn (Assert $page) => $page
-                    ->component('Login/Show')
-                    ->where('email', config('app.seed.users.super.email'))
-                    ->where('password', config('app.seed.users.super.password'))
-                    ->where('remember', true)
-                    ->where('redirect', '')
-            );
-    });
+    get(route('login'))
+    ->assertOk()
+    ->assertInertia(
+        fn (Assert $page) => $page
+            ->component('Login/Show')
+            ->where('email', config('app.seed.users.super.email'))
+            ->where('password', config('app.seed.users.super.password'))
+            ->where('remember', true)
+            ->where('redirect', '')
+    );
+        });
 
     test('Props are not passed to the show page in production', function () {
-        app()->instance('env', 'production');
+        app()->instance('env', Environment::PRODUCTION->value);
 
         get(route('login'))
             ->assertOk()
diff --git a/tests/Feature/Controllers/RegisterControllerTest.php b/tests/Feature/Controllers/RegisterControllerTest.php
@@ -1,5 +1,6 @@
 <?php
 
+use App\Enums\Environment;
 use App\Enums\Role;
 use App\Models\User;
 use Inertia\Testing\AssertableInertia as Assert;
@@ -24,20 +25,20 @@
 
 describe('Guests', function () {
     test('Can access the register page', function () {
-        get(route('register'))
-            ->assertOk()
-            ->assertInertia(
-                fn (Assert $page) => $page
-                    ->component('Register/Show')
-                    ->has('first_name')
-                    ->has('last_name')
-                    ->has('email')
-                    ->has('password')
-            );
-    });
+    get(route('register'))
+    ->assertOk()
+    ->assertInertia(
+        fn (Assert $page) => $page
+            ->component('Register/Show')
+            ->has('first_name')
+            ->has('last_name')
+            ->has('email')
+            ->has('password')
+    );
+        });
 
     test('Props are not passed to the show page in production', function () {
-        app()->instance('env', 'production');
+        app()->instance('env', Environment::PRODUCTION->value);
 
         get(route('register'))
             ->assertOk()
diff --git a/tests/Feature/Controllers/ResetPasswordControllerTest.php b/tests/Feature/Controllers/ResetPasswordControllerTest.php
@@ -14,13 +14,13 @@
 mutates(\App\Http\Controllers\ResetPasswordController::class);
 
 test('The forgot password page can be accessed', function () {
-    get(route('password'))
-        ->assertOk()
-        ->assertInertia(
-            fn (Assert $page) => $page
-                ->component('ResetPassword/Show')
-        );
-});
+get(route('password'))
+->assertOk()
+->assertInertia(
+    fn (Assert $page) => $page
+        ->component('ResetPassword/Show')
+);
+    });
 
 test('A password reset email can be requested', function () {
     Notification::fake();

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace App\Http\Controllers;`
`4`	`4`
	`5`	`+use App\Enums\Environment;`
`5`	`6`	`use App\Http\Requests\Login\LoginStoreRequest;`
`6`	`7`	`use Illuminate\Http\Request;`
`7`	`8`	`use Illuminate\Validation\ValidationException;`
`@@ -10,7 +11,7 @@ class LoginController extends Controller`
`10`	`11`	`{`
`11`	`12`	`public function show(Request $request)`
`12`	`13`	`{`
`13`		`- return inertia('Login/Show', app()->environment('local', 'testing') ? [`
	`14`	`+ return inertia('Login/Show', app()->environment([Environment::LOCAL->value, Environment::TESTING->value]) ? [`
`14`	`15`	`'email' => config('app.seed.users.super.email'),`
`15`	`16`	`'password' => config('app.seed.users.super.password'),`
`16`	`17`	`'remember' => true,`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace App\Providers;`
`4`	`4`
	`5`	`+use App\Enums\Environment;`
`5`	`6`	`use App\Models\User;`
`6`	`7`	`use Illuminate\Http\Resources\Json\JsonResource;`
`7`	`8`	`use Illuminate\Support\Facades\Vite;`
`@@ -22,7 +23,7 @@ class AppServiceProvider extends ServiceProvider`
`22`	`23`	`{`
`23`	`24`	`public function register(): void`
`24`	`25`	`{`
`25`		`- if ($this->app->environment('local')) {`
	`26`	`+ if ($this->app->environment(Environment::LOCAL->value)) {`
`26`	`27`	`$this->app->register(\Laravel\Telescope\TelescopeServiceProvider::class);`
`27`	`28`	`$this->app->register(TelescopeServiceProvider::class);`
`28`	`29`	`}`