Add support to disable darkmode routes (#1310)

* [routes]: Add support to disable darkmode routes * [test]: Fix code style
jeroennoten · Oct 10, 2024 · 9ce9ef6 · 9ce9ef6
1 parent 9282c7b
commit 9ce9ef6
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 4 deletions.
diff --git a/config/adminlte.php b/config/adminlte.php
@@ -264,6 +264,7 @@
     'password_reset_url' => 'password/reset',
     'password_email_url' => 'password/email',
     'profile_url' => false,
+    'disable_darkmode_routes' => false,
 
     /*
     |--------------------------------------------------------------------------

diff --git a/routes/web.php b/routes/web.php
@@ -18,5 +18,7 @@
 // Dark Mode routes.
 //-----------------------------------------------------------------------------
 
-Route::post('/darkmode/toggle', [DarkModeController::class, 'toggle'])
-    ->name('darkmode.toggle');
+if (! config('adminlte.disable_darkmode_routes', false)) {
+    Route::post('/darkmode/toggle', [DarkModeController::class, 'toggle'])
+        ->name('darkmode.toggle');
+}
diff --git a/tests/ServiceProviderTest.php b/tests/ServiceProviderTest.php
@@ -1,6 +1,7 @@
 <?php
 
 use JeroenNoten\LaravelAdminLte\AdminLte;
+use JeroenNoten\LaravelAdminLte\AdminLteServiceProvider;
 
 class ServiceProviderTest extends TestCase
 {
@@ -112,10 +113,39 @@ public function testBootLoadComponents()
         $this->assertTrue(isset($aliases['adminlte-modal']));
     }
 
-    public function testBootLoadRoutes()
+    public function testBootLoadDarkModeRoutes()
     {
-        // Assert the package routes names are registered.
+        // Disable dark mode routes and check.
+
+        config(['adminlte.disable_darkmode_routes' => true]);
+        $this->clearRoutesAndReRegisterProvider();
+
+        $this->assertFalse(Route::has('adminlte.darkmode.toggle'));
+
+        // Enable dark mode routes and check again.
+
+        config(['adminlte.disable_darkmode_routes' => false]);
+        $this->clearRoutesAndReRegisterProvider();
 
         $this->assertTrue(Route::has('adminlte.darkmode.toggle'));
     }
+
+    /**
+     * Clear routes and re-register the service provider.
+     */
+    protected function clearRoutesAndReRegisterProvider()
+    {
+        // Clear the current route collection.
+
+        Route::setRoutes(new \Illuminate\Routing\RouteCollection());
+
+        // Unregister and register the provider again.
+
+        $provider = $this->app->register(AdminLteServiceProvider::class);
+        $provider->boot();
+
+        // Refresh route names after loading routes again.
+
+        Route::getRoutes()->refreshNameLookups();
+    }
 }