refactor: Streamlined tests to Pest style

feat: Added command tests
feat: Added type tests
fix: Return typing

Author: nea

src/Facades/Setting.php

@@ -3,13 +3,14 @@
 namespace ElipZis\Setting\Facades;
 
 use ElipZis\Setting\Repositories\SettingRepository;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Support\Facades\Facade;
 
 /**
  * @method static \ElipZis\Setting\Models\Setting|bool get(string $key)
  * @method static mixed getValue(string $key, mixed $default = null, mixed $devValue = null)
  * @method static \ElipZis\Setting\Models\Setting set(string $key, mixed $value, string $type = null)
- * @method static array all()
+ * @method static Collection|\Illuminate\Support\Collection all()
  * @method static void storeConfig(?string $filename = null, mixed $data = null)
  *
  * @see SettingRepository

src/Repositories/SettingRepository.php

@@ -7,6 +7,7 @@
 use Illuminate\Config\Repository;
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Storage;
@@ -39,7 +40,7 @@ public function storeConfig(?string $filename = null, mixed $data = null)
     /**
      * Return all settings from the database, keyed by the setting key
      *
-     * @return mixed[string]
+     * @return Collection|\Illuminate\Support\Collection
      */
     public function all()
     {

tests/Commands/SyncSettingsCommandTest.php

@@ -0,0 +1,31 @@
+<?php
+
+use ElipZis\Setting\Commands\SyncSettingsCommand;
+use ElipZis\Setting\Models\Setting;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Storage;
+use function Pest\Laravel\artisan;
+
+uses(RefreshDatabase::class);
+
+beforeEach(function () {
+    Setting::factory()->count(10)->create();
+});
+
+it('throws no exceptions when running', function () {
+    artisan(SyncSettingsCommand::class)->assertSuccessful();
+});
+
+it('exports the settings to the disc', function () {
+    artisan(SyncSettingsCommand::class)->assertSuccessful();
+    expect(Storage::exists('settings.json'))->toBeTrue();
+});
+
+it('has the correct settings written to the disc', function () {
+    artisan(SyncSettingsCommand::class)->assertSuccessful();
+    $settingsStr = Storage::get('settings.json');
+    expect($settingsStr)->not()->toBeNull();
+    expect($settingsStr)->toBeString();
+    $settings = json_decode($settingsStr, true, 512, JSON_THROW_ON_ERROR);
+    expect($settings)->toBeArray();
+});

tests/Facades/SettingTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Carbon\Carbon;
 use ElipZis\Setting\Facades\Setting;
 use ElipZis\Setting\Models\Setting as Model;
 use Illuminate\Foundation\Testing\RefreshDatabase;
@@ -12,31 +13,47 @@
 
 it('has many settings', function () {
     $settings = Setting::all();
-    $this->assertNotEmpty($settings);
-    $this->assertGreaterThanOrEqual(1, count($settings));
-
-    $this->assertIsString($settings->keys()->first());
-    $this->assertNotNull($settings->first());
+    expect($settings)->isNotEmpty()->toBeGreaterThanOrEqual(1);
+    expect($settings->keys()->first())->toBeString();
+    expect($settings->first())->not()->toBeNull();
 });
 
-it('can return a setting', function () {
+it('can set and return a setting', function () {
     $setting = Setting::get('simple.setting');
-    $this->assertNull($setting);
+    expect($setting)->toBeNull();
 
     Setting::set('simple.setting', 1);
     $setting = Setting::get('simple.setting');
-    $this->assertNotNull($setting);
-    $this->assertEquals(1, $setting->value);
+    expect($setting)->not()->toBeNull();
+    expect($setting->value)->toBe(1);
 });
 
-it('can return a setting value', function () {
+it('can set and return a setting value', function () {
     $setting = Setting::getValue('simple.setting.value');
-    $this->assertNull($setting);
+    expect($setting)->toBeNull();
     $setting = Setting::getValue('simple.setting.value', 1);
-    $this->assertEquals(1, $setting);
+    expect($setting)->toBe(1);
 
     Setting::set('simple.setting.value', 2);
     $setting = Setting::getValue('simple.setting.value');
-    expect($setting)->not()->toBeNull();
-    expect($setting)->toBe(2);
+    expect($setting)->not()->toBeNull()->toBe(2);
+});
+
+it('can set an array and return it', function () {
+    Setting::set('simple.setting.array', ['key' => 'value']);
+    $setting = Setting::getValue('simple.setting.array');
+    expect($setting)->not()->toBeNull()->toBeArray()->toBe(['key' => 'value']);
+});
+
+it('can set a date and return it', function () {
+    $now = Carbon::now();
+    Setting::set('simple.setting.datetime', $now);
+    $setting = Setting::getValue('simple.setting.datetime');
+    expect($setting)->not()->toBeNull()->toBeInstanceOf(Carbon::class);
+});
+
+it('can set a string and return it', function () {
+    Setting::set('simple.setting.string', 'string');
+    $setting = Setting::getValue('simple.setting.string');
+    expect($setting)->not()->toBeNull()->toBeString();
 });