getting ready for v1

changed single mode delete syntax

Author: matteoc99

README.md

@@ -64,10 +64,7 @@ php artisan migrate
      */
     public function down(): void
     {
-        PreferenceBuilder::init("language")
-        // optional if there  is only one language preference
-        ->withGroup('general')
-        ->delete();
+        PreferenceBuilder::delete("language");
     }
 ```
 #### Bulk mode
@@ -135,7 +132,7 @@ public function getPreference(string $name, string $group = 'general', mixed $de
     $user->getPreference('language'); // 'de' as string
 
     $user->setPreference('language',"fr"); 
-    // ValidationException because of the rule: ->withRule(new InRule(["en","it","de"]))
+    // ValidationException because of the rule: ->withRule(new InRule("en","it","de"))
     $user->setPreference('language',2); 
     // ValidationException because of the cast: Cast::STRING
 

composer.json

@@ -21,7 +21,8 @@
   },
   "scripts" : {
     "analyse" : "vendor/bin/phpstan analyse",
-    "test" : "vendor/bin/phpunit"
+    "test" : "vendor/bin/phpunit",
+    "coverage" : " php -d xdebug.mode=coverage vendor/bin/phpunit ./tests --coverage-clover='reports/coverage/coverage.xml' --coverage-html='reports/coverage'"
   },
   "minimum-stability": "dev",
   "prefer-stable": true,

src/Casts/EnumCaster.php

@@ -35,6 +35,10 @@ protected function deserializeEnum($value)
 
     public function set(?Model $model, string $key, mixed $value, array $attributes)
     {
+        if (empty($value)) {
+            return null;
+        }
+
         return json_encode($this->serializeEnum($value));
     }
 

src/Factory/PreferenceBuilder.php

@@ -26,6 +26,17 @@ public static function init(string $name, CastableEnum $cast = Cast::STRING): st
         return $builder->withName($name)->withCast($cast)->withGroup('general');
     }
 
+    public static function delete(string $name, string $group = 'general'): int
+    {
+        $query = Preference::query()->where('name', $name);
+
+        if ($query->count() > 1) {
+            $query->where('group', $group);
+        }
+
+        return $query->delete();
+    }
+
     private function withCast(CastableEnum $cast): static
     {
         $this->preference->cast = $cast;
@@ -74,17 +85,6 @@ public function updateOrCreate(): Preference
         return $this->preference;
     }
 
-    public function delete(): int
-    {
-        $query = Preference::query()->where('name', $this->preference->name);
-
-        if ($query->count() > 1) {
-            $query->where('group', $this->preference->group);
-        }
-
-        return $query->delete();
-    }
-
     public static function initBulk(array $preferences)
     {
         if (empty($preferences)) {
@@ -112,17 +112,17 @@ public static function initBulk(array $preferences)
 
             //cast values for DB
 
-            if(array_key_exists('rule',$preferenceData)){
-                $ruleCaster = new RuleCaster();
-                $preferenceData['rule'] = $ruleCaster->set(null,'',$preferenceData['rule'],[]);
+            if (array_key_exists('rule', $preferenceData)) {
+                $ruleCaster             = new RuleCaster();
+                $preferenceData['rule'] = $ruleCaster->set(null, '', $preferenceData['rule'], []);
             }
-            if(array_key_exists('default_value',$preferenceData)){
-                $valueCaster = new ValueCaster($preferenceData['cast']);
-                $preferenceData['default_value'] = $valueCaster->set(null,'',$preferenceData['default_value'],[]);
+            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'],[]);
+            $enumCaster             = new EnumCaster();
+            $preferenceData['cast'] = $enumCaster->set(null, '', $preferenceData['cast'], []);
 
             // Ensure Defaults
             $preferenceData = array_merge([

src/Models/Preference.php

@@ -18,7 +18,7 @@
  * @property string             $group
  * @property string             $name
  * @property string|null        $description
- * @property CastableEnum       $cast
+ * @property CastableEnum|null  $cast
  * @property HasValidation|null $rule
  * @property mixed              $default_value
  * @property Carbon             $created_at

tests/Casts/ValueCasterTest.php

@@ -16,6 +16,10 @@ public function test_get()
     {
         $caster = new ValueCaster();
 
+        $this->dummyPref->cast = Cast::BOOL;
+        $result                = $caster->get($this->dummyPref, '', false, []);
+        $this->assertFalse($result);
+
         // With Int Cast
         $this->dummyPref->cast = Cast::INT;
         $result                = $caster->get($this->dummyPref, '', '123', []);
@@ -61,6 +65,12 @@ public function test_get()
         $this->assertInstanceOf(\Carbon\Carbon::class, $result);
         $this->assertEquals($timestamp, $result->getTimestamp());
 
+
+        $this->dummyPref->cast = null;
+        $val                   = 12345;
+        $result                = $caster->get($this->dummyPref, '', $val, []);
+        $this->assertEquals($val, $result);
+
     }
 
     /** @test */
@@ -101,6 +111,11 @@ public function test_set()
         $result                = $caster->set($this->dummyPref, '', $timestamp, []);
         $this->assertEquals((string)$timestamp, $result);
 
+
+        $this->dummyPref->cast = null;
+        $val                   = 12345;
+        $result                = $caster->set($this->dummyPref, '', $val, []);
+        $this->assertEquals($val, $result);
     }
 
 }

tests/PreferenceBasicTest.php

@@ -7,7 +7,7 @@
 use Illuminate\Validation\ValidationException;
 use Matteoc99\LaravelPreference\Factory\PreferenceBuilder;
 use Matteoc99\LaravelPreference\Rules\InRule;
-use Matteoc99\LaravelPreference\Tests\Models\User;
+use function PHPUnit\Framework\assertEquals;
 
 class PreferenceBasicTest extends TestCase
 {
@@ -25,8 +25,7 @@ public function setUp(): void
 
     public function tearDown(): void
     {
-        PreferenceBuilder::init("language")
-            ->delete();
+        PreferenceBuilder::delete("language");
 
         parent::tearDown();
     }
@@ -79,5 +78,24 @@ public function preference_validation_cast()
         $this->testUser->setPreference('language', 2);
     }
 
+    /** @test */
+    public function init_and_delete()
+    {
+        PreferenceBuilder::init("video")
+            ->withDescription("video quality")
+            ->create();
+        PreferenceBuilder::init("video")
+            ->withGroup('test')
+            ->withDescription("video quality")
+            ->create();
+
+        $this->testUser->setPreference('video', "144p", 'test');
+
+        PreferenceBuilder::delete('video');
+
+        $this->assertEquals('144p',$this->testUser->getPreference('video','test'));
+
+    }
+
 
 }

tests/PreferenceBuilderBulkTest.php

@@ -108,7 +108,7 @@ public function init_bulk_creates_new_and_updates_existing_preferences()
         $this->assertDatabaseCount('preferences', 2);
         $this->assertDatabaseHas('preferences', ['name' => 'new_pref']);
 
-        $found = Preference::query()->where('name',"=",'existing_pref');
+        $found = Preference::query()->where('name', "=", 'existing_pref');
         $this->assertEquals(1, $found->count());
         $this->assertEquals(Cast::INT, $found->first()->cast);
     }
@@ -140,4 +140,21 @@ public function init_bulk_handles_mixed_valid_and_invalid_preferences()
         PreferenceBuilder::initBulk($preferences);
     }
 
+    /** @test */
+
+    public function init_bulk_with_all_options()
+    {
+        $preferences = [
+            ['name' => 'pref2', 'cast' => Cast::BOOL, 'default_value' => 2, 'rule' => new LowerThanRule(5), 'description' => 'volume'],
+            ['name' => 'pref2', 'group' => 'test', 'cast' => Cast::BOOL, 'default_value' => 2, 'rule' => new LowerThanRule(5), 'description' => 'volume']
+        ];
+
+        PreferenceBuilder::initBulk($preferences);
+        $this->assertDatabaseCount('preferences', 2);
+
+        PreferenceBuilder::deleteBulk($preferences);
+        $this->assertDatabaseCount('preferences', 0);
+
+    }
+
 }

tests/PreferenceCastTest.php

@@ -36,10 +36,10 @@ public function setUp(): void
 
     public function tearDown(): void
     {
-        PreferenceBuilder::init("volume")->delete();
-        PreferenceBuilder::init("receive_emails")->delete();
-        PreferenceBuilder::init("birthday")->delete();
-        PreferenceBuilder::init("timezone")->delete();
+        PreferenceBuilder::delete("volume");
+        PreferenceBuilder::delete("receive_emails");
+        PreferenceBuilder::delete("birthday");
+        PreferenceBuilder::delete("timezone");
 
         parent::tearDown();
     }
@@ -55,6 +55,7 @@ public function user_can_set_and_get_integer_preference_with_custom_rule()
         $this->expectException(ValidationException::class);
         $this->testUser->setPreference('volume', 6);
     }
+
     /** @test */
     public function user_can_set_and_get_boolean_preference()
     {