Add preference for theme (#2473)

* add user preference for theme

* fix coalesce expression

* fix css selectors

* Run php-cs-fixer

* fix node build

* remove global install of node-gyp

---------

Co-authored-by: emmachughes <emmachughes@users.noreply.github.com>

sourcecode/hub/Dockerfile

@@ -44,8 +44,6 @@ FROM node:16-alpine AS frontend
 
 WORKDIR /app
 
-RUN npm i -g npm node-gyp
-
 COPY package.json package-lock.json ./
 RUN npm ci
 

sourcecode/hub/app/Configuration/Themes.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Configuration;
+
+final readonly class Themes
+{
+    /**
+     * @return array<string>
+     */
+    public function all(): array
+    {
+        return [
+            'edlib',
+            'light',
+            'dark',
+        ];
+    }
+
+    public function getName(string $theme, string $locale): string|null
+    {
+        return match ($theme) {
+            'edlib' => 'Edlib',
+            'light' => match ($locale) {
+                'nb', 'no' => 'Bootstrap lys',
+                default => 'Bootstrap Light',
+            },
+            'dark' => match ($locale) {
+                'nb', 'no' => 'Bootstrap mørk',
+                default => 'Bootstrap Dark',
+            },
+            default => null,
+        };
+    }
+
+    public function getDefault(): string
+    {
+        return 'edlib';
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function getTranslatedMap(string $locale): array
+    {
+        return array_combine($this->all(), array_map(
+            fn (string $key) => $this->getName($key, $locale) ?? $key,
+            $this->all(),
+        ));
+    }
+}

sourcecode/hub/app/Http/Controllers/UserController.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers;
 
 use App\Configuration\Locales;
+use App\Configuration\Themes;
 use App\Http\Requests\SavePreferencesRequest;
 use App\Http\Requests\StoreUserRequest;
 use App\Http\Requests\UpdateUserRequest;
@@ -44,10 +45,11 @@ public function store(StoreUserRequest $request): RedirectResponse
         return to_route('home');
     }
 
-    public function preferences(Locales $locales): View
+    public function preferences(Locales $locales, Themes $themes): View
     {
         return view('user.preferences', [
             'locales' => $locales->getTranslatedMap(app()->getLocale()),
+            'themes' => $themes->getTranslatedMap(app()->getLocale()),
             'user' => $this->getUser(),
         ]);
     }

sourcecode/hub/app/Http/Requests/SavePreferencesRequest.php

@@ -5,6 +5,7 @@
 namespace App\Http\Requests;
 
 use App\Configuration\Locales;
+use App\Configuration\Themes;
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
@@ -17,15 +18,20 @@ protected function prepareForValidation(): void
         if (!$parameters->has('debug_mode')) {
             $parameters->set('debug_mode', false);
         }
+
+        if (!$parameters->get('theme')) {
+            $parameters->set('theme', null);
+        }
     }
 
     /**
      * @return mixed[]
      */
-    public function rules(Locales $locales): array
+    public function rules(Locales $locales, Themes $themes): array
     {
         return [
             'locale' => ['required', Rule::in($locales->all())],
+            'theme' => ['sometimes', 'nullable', Rule::in($themes->all())],
             'debug_mode' => ['required', 'boolean'],
         ];
     }

sourcecode/hub/app/Models/User.php

@@ -27,6 +27,7 @@ class User extends Model implements AuthenticatableContract
         'email',
         'google_id',
         'facebook_id',
+        'theme',
     ];
 
     protected $hidden = [

sourcecode/hub/database/migrations/2023_08_31_080000_add_user_theme_setting.php

@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class () extends Migration {
+    public function up(): void
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->string('theme')->nullable();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->dropColumn('theme');
+        });
+    }
+};

sourcecode/hub/lang/en/messages.php

@@ -64,4 +64,6 @@
     'disconnect-google' => 'Disconnect from Google',
     'disconnect-facebook' => 'Disconnect from Facebook',
     'alert-password-empty' => 'To disconnect social login providers, you must first set a password on your account',
+    'theme' => 'Theme',
+    'default' => 'Default',
 ];

sourcecode/hub/lang/nb/messages.php

@@ -40,4 +40,6 @@
     'debug-mode-form-help' => 'Feilsøkingsmodus vil avsløre tekniske detaljer som kan være behjelpelige under feilsøking eller utvikling av innholdstyper.',
     'version-history' => 'Versjonshistorikk',
     'published' => 'Publisert',
+    'theme' => 'Tema',
+    'default' => 'Standard',
 ];