feat:

 - change model table names
 - set/get/remove preferences via enum or model

Author: matteoc99

README.md

@@ -72,7 +72,9 @@ php artisan vendor:publish --tag="laravel-preference-config"
 ```php
   'db' => [
         'connection' => null, //string: the connection name to use 
-    ], // null -> use defaults
+        'preferences_table_name'      => 'preferences',
+        'user_preferences_table_name' => 'user_preferences',
+    ],
     'routes' => [
         'enabled'     => false, // set true to register routes, more on that later
         'middlewares' => [
@@ -92,6 +94,8 @@ php artisan vendor:publish --tag="laravel-preference-config"
     ]
 ```
 
+> Consider changing the base table names before running the migrations, if needed
+
 Run the migrations with:
 
 ```bash
@@ -103,9 +107,8 @@ php artisan migrate
 ### Concepts
 
 Each preference has at least a name and a caster. For additional validation you can add you custom Rule object
-> The default caster supports all major primitives, enums, objects, as well as time/datetime/date and timestamp which get
-> converted
-> with `Carbon/Carbon`
+> The default caster supports all major primitives, enums, objects, as well as time/datetime/date and timestamp which
+> get converted with `Carbon/Carbon`
 
 ### Define your preferences
 
@@ -375,7 +378,7 @@ which can all be accessed via the route name: {prefix}.{scope}.{group}.{index/ge
 `scope_id`: The unique identifier of the scope (e.g., a user's ID).  
 `preference`: The value of the specific preference enum  (e.g., General::LANGUAGE->value).   
 `group`: A mapping of group names to their corresponding Enum classes. See config below   
-`scope`: A mapping of scope names to their corresponding Eloquent model. See config below   
+`scope`: A mapping of scope names to their corresponding Eloquent model. See config below
 
 ### Example
 

config/user_preference.php

@@ -2,22 +2,24 @@
 
 return [
     'db'     => [
-        'connection' => null,
+        'connection'                  => null,
+        'preferences_table_name'      => 'preferences',
+        'user_preferences_table_name' => 'user_preferences',
     ],
     'routes' => [
         'enabled'     => false,
         'middlewares' => [
             'auth', // general middleware
-            'user'=> 'verified', // optional, scoped middleware
-            'user.general'=> 'verified' // optional, scoped & grouped middleware
+            'user'         => 'verified', // optional, scoped middleware
+            'user.general' => 'verified' // optional, scoped & grouped middleware
         ],
-        'prefix' => 'preferences',
+        'prefix'      => 'preferences',
         'groups'      => [
             //enum class list of preferences
             //'general'=>General::class
         ],
-        'scopes'=> [
-           // as many preferenceable models as you want
+        'scopes'      => [
+            // as many preferenceable models as you want
             'user' => \Illuminate\Auth\Authenticatable::class
         ]
     ]

database/migrations/2024_04_09_100000_add_preference_guards.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Matteoc99\LaravelPreference\Models\Preference;
+
+return new class extends Migration {
+
+    public function up()
+    {
+
+        $preferenceTable = (new Preference())->getTable();
+
+        Schema::table($preferenceTable, function (Blueprint $table) {
+            $table->json('guard')->nullable();
+        });
+    }
+
+    public function down()
+    {
+        $preferenceTable = (new Preference())->getTable();
+
+        Schema::table($preferenceTable, function (Blueprint $table) {
+            $table->dropColumn('guard');
+        });
+    }
+};

src/Contracts/PreferencePolicy.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Matteoc99\LaravelPreference\Contracts;
+
+use Illuminate\Contracts\Auth\Authenticatable;
+use Matteoc99\LaravelPreference\Models\Preference;
+
+interface PreferencePolicy
+{
+    public function index(Authenticatable $user, Preference $preference, mixed $value): bool;
+
+    public function get(Authenticatable $user, Preference $preference, mixed $value): bool;
+
+    public function update(Authenticatable $user, Preference $preference, mixed $value): bool;
+
+    public function delete(Authenticatable $user, Preference $preference, mixed $value): bool;
+}

src/Models/BaseModel.php

@@ -24,4 +24,10 @@ public function toArrayOnly(array $keys): array
         return Arr::only($this->attributesToArray(), $keys);
     }
 
+    public function getTable()
+    {
+        return ConfigHelper::getDbTableName(get_class($this), parent::getTable());
+    }
+
+
 }

src/Traits/HasPreferences.php

@@ -30,17 +30,19 @@ private function userPreferences(): MorphMany
     /**
      * Get a user's preference value or default if not set.
      *
-     * @param PreferenceGroup $name
-     * @param mixed|null      $default Default value if preference not set.
+     * @param PreferenceGroup|Preference $preference
+     * @param mixed|null                 $default Default value if preference not set.
      *
      * @return mixed
-     * @throws PreferenceNotFoundException|AuthorizationException
+     * @throws AuthorizationException
+     * @throws PreferenceNotFoundException
      */
-    public function getPreference(PreferenceGroup $name, mixed $default = null): mixed
+    public function getPreference(PreferenceGroup|Preference $preference, mixed $default = null): mixed
     {
+
         $this->authorize(PolicyAction::GET);
 
-        $preference = $this->validateAndRetrievePreference($name);
+        $preference = $this->validateAndRetrievePreference($preference);
 
         $userPreference = $this->userPreferences()->where('preference_id', $preference->id)->first();
 
@@ -50,17 +52,18 @@ public function getPreference(PreferenceGroup $name, mixed $default = null): mix
     /**
      * Set or update a user's preference value.
      *
-     * @param PreferenceGroup $name
-     * @param mixed           $value Value to set for the preference.
+     * @param PreferenceGroup|Preference $preference
+     * @param mixed                      $value Value to set for the preference.
      *
-     * @throws PreferenceNotFoundException|AuthorizationException|ValidationException
+     * @throws AuthorizationException
+     * @throws PreferenceNotFoundException
+     * @throws ValidationException
      */
-    public function setPreference(PreferenceGroup $name, mixed $value): void
+    public function setPreference(PreferenceGroup|Preference $preference, mixed $value): void
     {
         $this->authorize(PolicyAction::UPDATE);
 
-
-        $preference = $this->validateAndRetrievePreference($name);
+        $preference = $this->validateAndRetrievePreference($preference);
 
         $validator = Validator::make(['value' => $value], ['value' => $preference->getValidationRules()]);
 
@@ -74,16 +77,18 @@ public function setPreference(PreferenceGroup $name, mixed $value): void
     /**
      * Remove a user's preference.
      *
-     * @param PreferenceGroup $name
+     * @param PreferenceGroup|Preference $preference
      *
      * @return int Number of deleted records.
-     * @throws PreferenceNotFoundException|AuthorizationException
+     * @throws AuthorizationException
+     * @throws PreferenceNotFoundException
      */
-    public function removePreference(PreferenceGroup $name): int
+    public function removePreference(PreferenceGroup|Preference $preference): int
     {
         $this->authorize(PolicyAction::DELETE);
 
-        $preference = $this->validateAndRetrievePreference($name);
+        $preference = $this->validateAndRetrievePreference($preference);
+
 
         return $this->userPreferences()->where('preference_id', $preference->id)->delete();
     }
@@ -112,22 +117,27 @@ public function getPreferences(string $group = null): Collection
     /**
      * Validate existence of a preference and retrieve it.
      *
-     * @param PreferenceGroup $name Preference name.
+     * @param PreferenceGroup|Preference $preference Preference name.
      *
      * @return Preference
      * @throws PreferenceNotFoundException If preference not found.
      */
-    private function validateAndRetrievePreference(PreferenceGroup $name): Preference
+    private function validateAndRetrievePreference(PreferenceGroup|Preference $preference): Preference
     {
-        SerializeHelper::conformNameAndGroup($name, $group);
 
-        /**@var string $name * */
-        $preference = Preference::where('group', $group)->where('name', $name)->first();
+        if (!$preference instanceof Preference) {
+
+            SerializeHelper::conformNameAndGroup($preference, $group);
 
+            /**@var Preference $preference * */
+            $preference = Preference::where('group', $group)->where('name', $preference)->first();
+        }
         if (!$preference) {
-            throw new PreferenceNotFoundException("Preference not found: $name in group $group");
+            throw new PreferenceNotFoundException("Preference not found: $preference in group $group");
         }
 
+        //Todo Gate
+
         return $preference;
     }
 

src/Utils/ConfigHelper.php

@@ -3,6 +3,8 @@
 namespace Matteoc99\LaravelPreference\Utils;
 
 use Illuminate\Support\Facades\Config;
+use Matteoc99\LaravelPreference\Models\Preference;
+use Matteoc99\LaravelPreference\Models\UserPreference;
 
 class ConfigHelper
 {
@@ -12,6 +14,17 @@ public static function getDbConnection(): null|string
         return Config::get('user_preference.db.connection');
     }
 
+    public static function getDbTableName(string $class, string $default = ''): string
+    {
+        $config = match ($class) {
+            Preference::class => 'preferences_table_name',
+            UserPreference::class => 'user_preferences_table_name',
+            default => throw new \InvalidArgumentException("Unsupported class: $class"),
+        };
+
+        return Config::get("user_preference.db.$config", $default);
+    }
+
     public static function areRoutesEnabled(): bool
     {
         return Config::get('user_preference.routes.enabled', false);
@@ -26,12 +39,12 @@ public static function getRoutePrefix(bool $dotted = true): string
 
     public static function getGroup(string $groupName): string|null
     {
-        return Config::get("user_preference.routes.groups.{$groupName}");
+        return Config::get("user_preference.routes.groups.$groupName");
     }
 
     public static function getScope(string $scopeName): string|null
     {
-        return Config::get("user_preference.routes.scopes.{$scopeName}");
+        return Config::get("user_preference.routes.scopes.$scopeName");
     }
 
     public static function getGroups(): array

tests/MigrationTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Matteoc99\LaravelPreference\Tests;
+
+class MigrationTest extends TestCase
+{
+
+    /** @test */
+    public function migration_rollback_works()
+    {
+        for ($i = 0; $i < 10; $i++) {
+
+            $this->artisan('migrate:rollback', ['--database' => 'testbench'])->run();
+            $this->artisan('migrate', ['--database' => 'testbench'])->run();
+        }
+
+        $this->assertTrue($this->getSchema()->hasTable('custom_prefs'));
+        $this->assertCount(4, $this->getSchema()->getTables());
+    }
+}

tests/PreferenceBasicTest.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Validation\ValidationException;
 use Matteoc99\LaravelPreference\Factory\PreferenceBuilder;
+use Matteoc99\LaravelPreference\Models\Preference;
 use Matteoc99\LaravelPreference\Rules\InRule;
 use Matteoc99\LaravelPreference\Tests\TestSubjects\Enums\General;
 use Matteoc99\LaravelPreference\Tests\TestSubjects\Enums\OtherPreferences;
@@ -40,6 +41,20 @@ public function set_and_get_preference()
         $this->assertEquals('de', $preference);
     }
 
+    /** @test */
+    public function set_and_get_with_instance()
+    {
+        /**@var Preference $preference * */
+        $preference = Preference::query()->where('name', General::LANGUAGE->value)->first();
+        $this->testUser->setPreference($preference, 'it');
+
+        $result = $this->testUser->getPreference(General::LANGUAGE);
+
+        $this->assertEquals('it', $result);
+        $this->assertEquals($result, $this->testUser->getPreference($preference));
+    }
+
+
     /** @test */
     public function remove_preference()
     {
@@ -88,7 +103,7 @@ public function init_and_delete()
         PreferenceBuilder::init(VideoPreferences::QUALITY)->updateOrCreate();
         PreferenceBuilder::init(VideoPreferences::QUALITY)->updateOrCreate();
 
-        $this->assertDatabaseCount('preferences', 3);
+        $this->assertDatabaseCount((new Preference())->getTable(), 3);
 
         $this->testUser->setPreference(VideoPreferences::QUALITY, "144p");
 

tests/PreferenceBuilderBulkTest.php

@@ -45,9 +45,9 @@ public function init_bulk_correctly_creates_multiple_preferences()
 
         PreferenceBuilder::initBulk($preferences);
 
-        $this->assertDatabaseCount('preferences', 2);
-        $this->assertDatabaseHas('preferences', ['name' => General::LANGUAGE]);
-        $this->assertDatabaseHas('preferences', ['name' => VideoPreferences::LANGUAGE]);
+        $this->assertDatabaseCount((new Preference())->getTable(), 2);
+        $this->assertDatabaseHas((new Preference())->getTable(), ['name' => General::LANGUAGE]);
+        $this->assertDatabaseHas((new Preference())->getTable(), ['name' => VideoPreferences::LANGUAGE]);
     }
 
     /** @test */
@@ -66,8 +66,8 @@ public function delete_bulk_deletes_correct_preferences()
 
         PreferenceBuilder::deleteBulk($deletePreferences);
 
-        $this->assertDatabaseCount('preferences', 1);
-        $this->assertDatabaseHas('preferences', ['name' =>  VideoPreferences::LANGUAGE]);
+        $this->assertDatabaseCount((new Preference())->getTable(), 1);
+        $this->assertDatabaseHas((new Preference())->getTable(), ['name' =>  VideoPreferences::LANGUAGE]);
     }
 
     /** @test */
@@ -104,8 +104,8 @@ public function init_bulk_creates_new_and_updates_existing_preferences()
 
         PreferenceBuilder::initBulk($preferences);
 
-        $this->assertDatabaseCount('preferences', 2);
-        $this->assertDatabaseHas('preferences', ['name' => General::LANGUAGE]);
+        $this->assertDatabaseCount((new Preference())->getTable(), 2);
+        $this->assertDatabaseHas((new Preference())->getTable(), ['name' => General::LANGUAGE]);
 
         $found = Preference::query()->where('name', "=", General::LANGUAGE);
         $this->assertEquals(1, $found->count());
@@ -148,11 +148,11 @@ public function init_bulk_with_all_options()
         ];
 
         PreferenceBuilder::initBulk($preferences);
-        $this->assertDatabaseCount('preferences', 2);
+        $this->assertDatabaseCount((new Preference())->getTable(), 2);
         $this->assertEquals(true,$this->testUser->getPreference(General::LANGUAGE));
 
         PreferenceBuilder::deleteBulk($preferences);
-        $this->assertDatabaseCount('preferences', 0);
+        $this->assertDatabaseCount((new Preference())->getTable(), 0);
 
     }