preparing beta release

Author: matteoc99

README.md

@@ -103,7 +103,7 @@ 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, as well as time/datetime/date and timestamp which get
+> The default caster supports all major primitives, enums, objects, as well as time/datetime/date and timestamp which get
 > converted
 > with `Carbon/Carbon`
 
@@ -157,7 +157,7 @@ public function up(): void
         ->updateOrCreate()
 
     // or with casting
-    PreferenceBuilder::init(Preferences::LANGUAGE, Cast::BACKED_ENUM)
+    PreferenceBuilder::init(Preferences::LANGUAGE, Cast::ENUM)
     ->withDefaultValue(Language::EN)
     ->create()
 
@@ -275,7 +275,9 @@ class User extends \Illuminate\Foundation\Auth\User implements PreferenceableMod
 
 ### Available Casts
 
-INT, FLOAT, STRING, BOOL, ARRAY, TIME, DATE, DATETIME, TIMESTAMP, BACKED_ENUM
+INT, FLOAT, STRING, BOOL,
+ARRAY, TIME, DATE, DATETIME,
+TIMESTAMP, BACKED_ENUM, ENUM, OBJECT
 
 ### Custom Caster
 
@@ -320,21 +322,25 @@ enum MyCast: string implements CastableEnum
 
 > rules need to implement `ValidationRule`
 
-> additionally, if your rule requires parameter, extend `DataRule`
-> which then will provide the parameters via `getData()` as an array of params
-
 ```php
-class MyRule extends DataRule
+class MyRule implements ValidationRule
 {
 
+    protected array $data;
+
+    public function __construct(...$data)
+    {
+        $this->data = $data;
+    }
+
     public function message()
     {
-        return sprintf("Wrong Timezone, one of: %s expected", implode(", ",$this->getData()));
+        return sprintf("Wrong Timezone, one of: %s expected", implode(", ",$this->data));
     }
 
     public function validate(string $attribute, mixed $value, Closure $fail): void
     {
-        if(!Str::startsWith($value, $this->getData())){
+        if(!Str::startsWith($value, $this->data)){
             $fail($this->message());
         }
     }
@@ -366,10 +372,10 @@ which can all be accessed via the route name: {prefix}.{scope}.{group}.{index/ge
 
 #### URI Parameters
 
-`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_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   
 
 ### Example
 
@@ -448,6 +454,7 @@ in the config file
 - Switch from `HasValidation` to `ValidationRule`
 - Signature changes on the trait: group got removed and name now requires a `PreferenceGroup`
 - Builder: setting group got removed and name now expects a `PreferenceGroup` enum
+- `DataRule` has been removed, add a constructor to get you own, tailored, params
 
 ## Test
 

routes/api.php

@@ -6,18 +6,17 @@
 use Matteoc99\LaravelPreference\Utils\ConfigHelper;
 
 
-$prefix = ConfigHelper::getRoutePrefix();
 $scopes = ConfigHelper::getScopes();
 $groups = ConfigHelper::getGroups();
 
 $middlewares = array_merge([PreferenceMiddleware::class], ConfigHelper::getGlobalMiddlewares());
 
-Route::group(['middleware' => $middlewares, 'prefix' => $prefix], function () use ($groups, $scopes, $prefix) {
+Route::group(['middleware' => $middlewares, 'prefix' => ConfigHelper::getRoutePrefix(false)], function () use ($groups, $scopes) {
 
     foreach ($scopes as $scope) {
-        Route::group(['middleware' => ConfigHelper::getScopedMiddlewares($scope), 'prefix' => $scope], function () use ($scope, $prefix, $groups) {
+        Route::group(['middleware' => ConfigHelper::getScopedMiddlewares($scope), 'prefix' => $scope], function () use ($scope, $groups) {
             foreach ($groups as $group) {
-                $name = sprintf("%s%s.%s", $prefix, $scope, $group);
+                $name = sprintf("%s%s.%s", ConfigHelper::getRoutePrefix(), $scope, $group);
                 Route::group(['middleware' => ConfigHelper::getScopeGroupedMiddlewares($scope, $group)], function () use ($name, $group) {
                     Route::get("{scope_id}/$group", [PreferenceController::class, 'index'])
                         ->name($name . ".index");

src/Casts/EnumCaster.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Matteoc99\LaravelPreference\Casts;
+
+use Illuminate\Database\Eloquent\Model;
+
+class SerializingCaster
+{
+    public function get(?Model $model, string $key, mixed $value, array $attributes)
+    {
+        return unserialize($value);
+    }
+
+    public function set(?Model $model, string $key, mixed $value, array $attributes)
+    {
+        return serialize($value);
+    }
+}

src/Casts/RuleCaster.php

@@ -21,7 +21,6 @@ public function get(?Model $model, string $key, mixed $value, array $attributes)
             return $caster->castFromString($value);
         }
 
-        //default do nothing
         return $value;
 
     }

src/Casts/SerializingCaster.php

@@ -7,4 +7,6 @@
 interface PreferenceGroup extends BackedEnum
 {
 
+
+
 }

src/Casts/ValueCaster.php

@@ -9,7 +9,8 @@
 use Illuminate\Validation\ValidationException;
 use Matteoc99\LaravelPreference\Contracts\CastableEnum;
 use Matteoc99\LaravelPreference\Rules\InstanceOfRule;
-use Matteoc99\LaravelPreference\Utils\SerializeHelper;
+use Matteoc99\LaravelPreference\Rules\IsRule;
+use UnitEnum;
 
 
 enum Cast: string implements CastableEnum
@@ -25,6 +26,8 @@ enum Cast: string implements CastableEnum
     case TIMESTAMP = 'timestamp';
 
     case BACKED_ENUM = 'backed_enum';
+    case ENUM = 'enum';
+    case OBJECT = 'object';
 
     public function validation(): ValidationRule|array|string|null
     {
@@ -38,6 +41,8 @@ public function validation(): ValidationRule|array|string|null
             self::TIME => 'date_format:H:i',
             self::TIMESTAMP => 'date_format:U',
             self::BACKED_ENUM => new InstanceOfRule(BackedEnum::class),
+            self::ENUM => new InstanceOfRule(UnitEnum::class),
+            self::OBJECT => new IsRule(Type::OBJECT),
         };
     }
 
@@ -52,7 +57,7 @@ public function castFromString(string $value): mixed
             self::DATE, self::DATETIME => new Carbon($value),
             self::TIME => Carbon::now()->setTimeFromTimeString($value),
             self::TIMESTAMP => Carbon::createFromTimestamp($value),
-            self::BACKED_ENUM => SerializeHelper::deserializeEnum($value),
+            self::BACKED_ENUM, self::ENUM, self::OBJECT => unserialize($value),
         };
     }
 
@@ -70,7 +75,7 @@ public function castToString(mixed $value): string
             self::DATETIME => $value->toDateTimeString(),
             self::TIMESTAMP => $value->timestamp,
             self::TIME => $value->toTimeString(),
-            self::BACKED_ENUM => SerializeHelper::serializeEnum($value),
+            self::BACKED_ENUM, self::ENUM, self::OBJECT => serialize($value),
         };
     }
 
@@ -88,6 +93,8 @@ private function ensureType(mixed $value): mixed
             self::TIMESTAMP, self::DATETIME, self::DATE => $this->ensureCarbon($value),
             self::TIME => $this->ensureCarbon($value, 'setTimeFromTimeString'),
             self::BACKED_ENUM => $this->ensureBackedEnum($value),
+            self::ENUM => $this->ensureEnum($value),
+            self::OBJECT => $this->ensureObject($value),
             default => throw ValidationException::withMessages(["Unknown casting type"]),
         };
     }
@@ -128,4 +135,23 @@ private function ensureBackedEnum(mixed $value): BackedEnum
         }
         return $value;
     }
+
+    /**
+     * @throws ValidationException
+     */
+    private function ensureEnum(mixed $value): UnitEnum
+    {
+        if (!($value instanceof UnitEnum)) {
+            throw ValidationException::withMessages(["Wrong type for enum casting"]);
+        }
+        return $value;
+    }
+
+    private function ensureObject(mixed $value)
+    {
+        if (!is_object($value)) {
+            throw ValidationException::withMessages(["Wrong type for object casting"]);
+        }
+        return $value;
+    }
 }

src/Contracts/PreferenceGroup.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Matteoc99\LaravelPreference\Enums;
+
+enum Type
+{
+
+    case BOOL;
+    case INT;
+    case FLOAT;
+    case STRING;
+    case ARRAY;
+    case OBJECT;
+    case CALLABLE;
+    case ITERABLE;
+    case NULL;
+    case RESOURCE;
+
+}

src/Enums/Cast.php

@@ -5,7 +5,6 @@
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Database\Eloquent\Builder;
 use InvalidArgumentException;
-use Matteoc99\LaravelPreference\Casts\EnumCaster;
 use Matteoc99\LaravelPreference\Casts\RuleCaster;
 use Matteoc99\LaravelPreference\Casts\ValueCaster;
 use Matteoc99\LaravelPreference\Contracts\CastableEnum;
@@ -125,16 +124,15 @@ public static function initBulk(array $preferences): void
             SerializeHelper::conformNameAndGroup($preferenceData['name'], $preferenceData['group']);
 
             if (array_key_exists('rule', $preferenceData)) {
-                $ruleCaster             = new RuleCaster();
-                $preferenceData['rule'] = $ruleCaster->set(null, '', $preferenceData['rule'], []);
+                $preferenceData['rule'] = serialize($preferenceData['rule']);
             }
             if (array_key_exists('default_value', $preferenceData)) {
                 $valueCaster                     = new ValueCaster($preferenceData['cast']);
                 $preferenceData['default_value'] = $valueCaster->set(null, '', $preferenceData['default_value'], []);
             }
 
-            $enumCaster             = new EnumCaster();
-            $preferenceData['cast'] = $enumCaster->set(null, '', $preferenceData['cast'], []);
+
+            $preferenceData['cast'] = serialize($preferenceData['cast']);
 
             // Ensure Defaults
             $preferenceData = array_merge([

src/Enums/Type.php

@@ -4,8 +4,7 @@
 
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Support\Carbon;
-use Matteoc99\LaravelPreference\Casts\EnumCaster;
-use Matteoc99\LaravelPreference\Casts\RuleCaster;
+use Matteoc99\LaravelPreference\Casts\SerializingCaster;
 use Matteoc99\LaravelPreference\Casts\ValueCaster;
 use Matteoc99\LaravelPreference\Contracts\CastableEnum;
 
@@ -41,8 +40,8 @@ class Preference extends BaseModel
     protected $casts = [
         'created_at'    => 'datetime',
         'updated_at'    => 'datetime',
-        'cast'          => EnumCaster::class,
-        'rule'          => RuleCaster::class,
+        'cast'          => SerializingCaster::class,
+        'rule'          => SerializingCaster::class,
         'default_value' => ValueCaster::class,
     ];