Refactor type hints and add LazySetting tests

Standardize type hints for nullable parameters and add comprehensive tests for key functionalities of the LazySetting class. This includes validation, cache behavior, and default value handling.

Author: CrazyBoy49z

src/LazySetting.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Log;
 use InvalidArgumentException;
+use JsonException;
 use Step2Dev\LazySetting\Models\Setting;
 use Throwable;
 
@@ -41,7 +42,7 @@ public static function getCacheKey(): string
         return config('lazy-setting.cache_prefix').'settings';
     }
 
-    public static function getCacheTtl(): int
+    public static function getCacheTtl(): int|null
     {
         return config('lazy-setting.cache_ttl');
     }
@@ -93,12 +94,12 @@ public function getKeyAndGroup(string $key): array
         return compact('key', 'group');
     }
 
-    public function get(string $key, mixed $default = null): ?string
+    public function get(string $key, mixed $default = null): string|null
     {
         return $this->getConfig($key)?->value ?? $default;
     }
 
-    public function getConfig(string $key): ?Setting
+    public function getConfig(string $key): Setting|null
     {
         try {
             ['group' => $group, 'key' => $key] = $this->getKeyAndGroup($key);
@@ -116,7 +117,7 @@ public function getConfig(string $key): ?Setting
     /**
      * @throws Throwable
      */
-    public function set(string $key, mixed $data, ?string $type = null): Setting
+    public function set(string $key, mixed $data, string|null $type = null): Setting
     {
         if ($setting = $this->getConfig($key)) {
             $this->update($setting, $data);
@@ -132,6 +133,9 @@ public function all(): Collection
         return $this->getSettings();
     }
 
+    /**
+     * @throws JsonException
+     */
     public function update(Setting $setting, mixed $data): Setting
     {
         $setting->update($this->formatData($data, $setting->type));
@@ -144,7 +148,7 @@ public function update(Setting $setting, mixed $data): Setting
     /**
      * @throws Throwable
      */
-    public function createIfNotExists(string $key, mixed $data, ?string $type = null): Setting
+    public function createIfNotExists(string $key, mixed $data, string|null $type = null): Setting
     {
         $setting = Setting::firstOrCreate($this->getKeyAndGroup($key), $this->formatData($data, $type));
 
@@ -169,7 +173,10 @@ public function getFieldType(string $type = ''): string
         };
     }
 
-    final protected function formatData(array|string $data, ?string $type = null, ?array $options = []): array
+    /**
+     * @throws JsonException
+     */
+    final protected function formatData(array|string $data, string|null $type = null, array|null $options = []): array
     {
         $type = $this->getFieldType($type);
         $result = compact('type');

tests/Feature/LazySettingTest.php

@@ -0,0 +1,40 @@
+<?php
+
+use Step2Dev\LazySetting\Facades\LazySetting;
+
+it('can get a setting', function () {
+    LazySetting::set('site_name', 'My Website');
+    $setting = LazySetting::get('site_name');
+    expect($setting)->toBe('My Website');
+});
+
+it('can set a new setting', function () {
+    LazySetting::set('site_description', 'Best website');
+    $setting = LazySetting::get('site_description');
+    expect($setting)->toBe('Best website');
+});
+
+it('can update an existing setting', function () {
+    LazySetting::set('site_name', 'Old Name');
+    LazySetting::set('site_name', 'New Name');
+    $setting = LazySetting::get('site_name');
+    expect($setting)->toBe('New Name');
+});
+
+it('returns default value if setting does not exist', function () {
+    $setting = LazySetting::get('non_existing_key', 'Default Value');
+    expect($setting)->toBe('Default Value');
+});
+
+it('validates the key and value when setting a setting', function () {
+    $this->expectException(InvalidArgumentException::class);
+    LazySetting::set('', 'Invalid Key');
+});
+
+it('clears the cache when setting a new value', function () {
+    LazySetting::set('cached_key', 'Cached Value');
+    $cachedValue = LazySetting::get('cached_key');
+    LazySetting::set('cached_key', 'New Value');
+    $newValue = LazySetting::get('cached_key');
+    expect($newValue)->toBe('New Value');
+});