Merge pull request #115 from Kurozora/user-settings

app/Helpers/CustomHelpers.php

@@ -1,8 +1,28 @@
 <?php
 
 // Create a deeplinked iOS URL
+use App\Helpers\Settings;
+
 if (!function_exists('ios_app_url')) {
     function ios_app_url($path) {
         return config('app.ios_app_protocol') . $path;
     }
 }
+
+/**
+ * The settings of the user.
+ *
+ * Provided both arguments to set a value. Provide only one to get a value.
+ * If none is provided, then the Settings object is returned.
+ *
+ * @param ?string $key
+ * @param mixed $value
+ * @return mixed
+ */
+function settings(?string $key = null, mixed $value = null): mixed
+{
+    /** @var Settings $settings */
+    $settings = app(Settings::class);
+
+    return $settings->settings($key, $value);
+}

app/Helpers/Settings.php

@@ -0,0 +1,160 @@
+<?php
+
+namespace App\Helpers;
+
+use App\Models\User;
+use Arr;
+use Exception;
+use JetBrains\PhpStorm\Pure;
+
+class Settings
+{
+    /**
+     * The User object.
+     *
+     * @var User
+     */
+    protected User $user;
+
+    /**
+     * The list of settings.
+     *
+     * @var array
+     */
+    protected array $settings = [];
+
+    /**
+     * Create a new settings instance.
+     *
+     * @param array $settings
+     * @param User  $user
+     */
+    public function __construct(array $settings, User $user)
+    {
+        $this->settings = $settings;
+        $this->user = $user;
+    }
+
+    /**
+     * Magic property access for settings.
+     *
+     * @param string $key
+     * @return mixed
+     * @throws Exception
+     */
+    public function __get(string $key): mixed
+    {
+        if ($this->has($key)) {
+            return $this->get($key);
+        }
+
+        throw new Exception("The $key setting does not exist.");
+    }
+
+    /**
+     * Create a new settings object for the given user.
+     *
+     * @param User $user
+     * @return Settings
+     */
+    #[Pure]
+    public static function create(User $user): Settings
+    {
+        return new Settings($user->settings, $user);
+    }
+
+    /**
+     * Retrieve an array of all settings.
+     *
+     * @return array
+     */
+    public function all(): array
+    {
+        return $this->settings;
+    }
+
+    /**
+     * Retrieve the given setting.
+     *
+     * @param string $key
+     * @return mixed
+     */
+    public function get(string $key): mixed
+    {
+        return Arr::get($this->settings, $key);
+    }
+
+    /**
+     * Create and persist a new setting.
+     *
+     * @param string $key
+     * @param mixed $value
+     * @return bool
+     */
+    public function set(string $key, mixed $value): bool
+    {
+        $this->settings[$key] = $value;
+
+        return $this->persist();
+    }
+
+    /**
+     * Determine if the given setting exists.
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function has(string $key): bool
+    {
+        return array_key_exists($key, $this->settings);
+    }
+
+    /**
+     * Merge the given attributes with the current settings without assigning any "new" settings.
+     *
+     * @param array $attributes
+     * @return bool
+     */
+    public function merge(array $attributes): bool
+    {
+        $this->settings = array_merge(
+            $this->settings,
+            Arr::only($attributes, array_keys($this->settings))
+        );
+
+        return $this->persist();
+    }
+
+    /**
+     * Persist the settings.
+     *
+     * @return bool
+     */
+    protected function persist(): bool
+    {
+        return $this->user->update(['settings' => $this->settings]);
+    }
+
+    /**
+     * The settings of the user.
+     *
+     * Provided both arguments to set a value. Provide only one to get a value.
+     * If none is provided, then the Settings object is returned.
+     *
+     * @param ?string $key
+     * @param mixed $value
+     * @return mixed
+     */
+    public function settings(?string $key = null, mixed $value = null): mixed
+    {
+        if (empty($key) && empty($value)) {
+            return $this;
+        }
+
+        if (empty($value)) {
+            return $this->get($key);
+        }
+
+        return $this->set($key, $value);
+    }
+}

app/Http/Controllers/Auth/SignInWithAppleController.php

@@ -144,10 +144,13 @@ protected function signUpUser(JWTPayload $payload): ?User
     {
         return User::create(
             [
-                'email'                     => $payload->get('email'),
-                'siwa_id'                   => $payload->get('sub'),
-                'password'                  => User::hashPass(Str::random(30)),
-                'username_change_available' => true,
+                'email'     => $payload->get('email'),
+                'siwa_id'   => $payload->get('sub'),
+                'password'  => User::hashPass(Str::random(30)),
+                'settings'  => [
+                    'can_change_username'   => true,
+                    'tv_rating'             => -1
+                ],
             ]
         );
     }

app/Http/Controllers/MeController.php

@@ -67,7 +67,7 @@ public function updateProfile(UpdateProfileRequest $request): JsonResponse
 
         // Update username
         if ($request->has('username')) {
-            if (!$user->username_change_available)
+            if (!settings('can_change_username'))
                 throw new AuthorizationException('The request wasn’t accepted due to not being allowed to change the username.');
 
             $user->username = $data['username'];

app/Http/Controllers/RegistrationController.php

@@ -29,7 +29,11 @@ public function signUp(SignUpRequest $request): JsonResponse
         $newUser = User::create([
             'username'  => $data['username'],
             'email'     => $data['email'],
-            'password'  => User::hashPass($data['password'])
+            'password'  => User::hashPass($data['password']),
+            'settings'  => [
+                'can_change_username'   => false,
+                'tv_rating'             => -1,
+            ],
         ]);
 
         if ($request->hasFile('profileImage') &&

app/Http/Resources/UserResourceBasic.php

@@ -91,7 +91,7 @@ protected function getPrivateDetails(): array
 
         return [
             'private' => [
-                'usernameChangeAvailable' => $user->username_change_available,
+                'settings' => $user->settings,
             ]
         ];
     }

app/Models/User.php

@@ -103,7 +103,7 @@ class User extends Authenticatable implements HasMedia, MustVerifyEmail, Reacter
      * @var array
      */
     protected $casts = [
-        'username_change_available' => 'boolean',
+        'settings' => 'json'
     ];
 
     /**

app/Providers/AppServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace App\Providers;
 
+use App\Helpers\Settings;
+use Auth;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\DB;
@@ -32,7 +34,7 @@ public function boot()
             else Config::set(self::$queryCountConfigKey, $currentConfigValue + 1);
         });
 
-        /**
+        /*
          * Set the default pagination views.
          *
          * Options: default, simple-default, tailwind, simple-tailwind
@@ -48,6 +50,11 @@ public function boot()
      */
     public function register()
     {
-        //
+        // Register the user settings helper class.
+        $this->app->singleton(Settings::class, function() {
+            $user = Auth::user();
+
+            return new Settings($user->settings, $user);
+        });
     }
 }

config/app.php

@@ -37,7 +37,7 @@
     | the framework needs to place the application's version in a notification
     | or any other location as required by the application or its packages.
     */
-    'version' => '1.1.0',
+    'version' => '1.2.0-alpha.1',
 
     /*
     |--------------------------------------------------------------------------

database/factories/UserFactory.php

@@ -23,11 +23,15 @@ class UserFactory extends Factory
     public function definition()
     {
         return [
-            'username' => $this->faker->userName,
-            'email' => $this->faker->unique()->safeEmail,
-            'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
-            'biography' => $this->faker->paragraph(),
-            'remember_token' => Str::random(10),
+            'username'          => $this->faker->userName,
+            'email'             => $this->faker->unique()->safeEmail,
+            'password'          => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
+            'biography'         => $this->faker->paragraph(),
+            'remember_token'    => Str::random(10),
+            'settings'          => [
+                'can_change_username'   => false,
+                'tv_rating'             => -1
+            ],
         ];
     }
 }

database/migrations/2018_08_13_131512_create_users_table.php

@@ -24,10 +24,10 @@ public function up()
             $table->string('password')->nullable();
             $table->text('two_factor_secret')->nullable();
             $table->text('two_factor_recovery_codes')->nullable();
-            $table->text('biography')->nullable();
             $table->rememberToken();
+            $table->text('biography')->nullable();
+            $table->json('settings');
             $table->timestamp('last_mal_import_at')->nullable();
-            $table->boolean('username_change_available')->default(false);
             $table->timestamps();
         });
 

database/seeders/UserSeeder.php

@@ -19,17 +19,25 @@ public function run()
         $admins = [];
 
         $admins[] = User::create([
-            'username'              => 'Usopp',
-            'email'                 => '[email protected]',
-            'password'              => '$2y$10$LFvuPaQpn6kccakk4sRABef223GV0.NJUJ94Xr.TAvswkCKJBisVK',
-            'email_verified_at'     => now(),
+            'username'          => 'Usopp',
+            'email'             => '[email protected]',
+            'password'          => '$2y$10$LFvuPaQpn6kccakk4sRABef223GV0.NJUJ94Xr.TAvswkCKJBisVK',
+            'email_verified_at' => now(),
+            'settings'          => [
+                'can_change_username'   => false,
+                'tv_rating'             => -1,
+            ],
         ]);
 
         $admins[] = User::create([
-            'username'              => 'Kirito',
-            'email'                 => '[email protected]',
-            'password'              => '$2y$10$LFvuPaQpn6kccakk4sRABef223GV0.NJUJ94Xr.TAvswkCKJBisVK',
-            'email_verified_at'     => now(),
+            'username'          => 'Kirito',
+            'email'             => '[email protected]',
+            'password'          => '$2y$10$LFvuPaQpn6kccakk4sRABef223GV0.NJUJ94Xr.TAvswkCKJBisVK',
+            'email_verified_at' => now(),
+            'settings'          => [
+                'can_change_username'   => false,
+                'tv_rating'             => -1,
+            ],
         ]);
 
         foreach($admins as $admin) {
@@ -42,10 +50,14 @@ public function run()
          * password: KurozoraLovesApple4Ever!
          */
         User::create([
-            'username'              => 'JohnAppleseed',
-            'email'                 => '[email protected]',
-            'password'              => '$2y$10$/aVrkVAq4LT6FEEw3dNwguaM77MzoHB4.IpVoVxLLEKI4jyHuITii',
-            'email_verified_at'     => now(),
+            'username'          => 'JohnAppleseed',
+            'email'             => '[email protected]',
+            'password'          => '$2y$10$/aVrkVAq4LT6FEEw3dNwguaM77MzoHB4.IpVoVxLLEKI4jyHuITii',
+            'email_verified_at' => now(),
+            'settings'          => [
+                'can_change_username'   => false,
+                'tv_rating'             => -1,
+            ],
         ]);
 
         // 50 fake users

tests/API/SignInWithAppleTest.php

@@ -2,6 +2,7 @@
 
 namespace Tests\API;
 
+use App\Helpers\Settings;
 use App\Models\Session;
 use App\Models\User;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
@@ -34,9 +35,8 @@ function an_account_can_be_signed_up_via_siwa()
         $this->assertEquals(1, Session::count(), 'A session was not created.');
 
         // Check whether the user can change their username
-        /** @var User $user */
-        $user = User::first();
-        $this->assertTrue($user->username_change_available, 'The user does not have a username change available.');
+        $settings = Settings::create(User::first());
+        $this->assertTrue($settings->get('can_change_username'), 'The user cannot change their username when it should be possible.');
     }
 
     /**