Merge branch 'serious-angel-main'

Author: rubenvanassche

.gitignore

@@ -8,3 +8,4 @@ coverage
 .php_cs.cache
 .php-cs-fixer.cache
 .phpunit.cache
+/.claude/

README.md

@@ -588,6 +588,17 @@ class DateSettings extends Settings
 
 The package will automatically find the cast and will use it to transform the types between the settings class and repository.
 
+#### Available casts
+
+The package comes with a few built-in casts:
+
+- `DateTimeInterfaceCast` for objects implementing `DateTimeInterface` (`DateTime`, `DateTimeImmutable`, `Carbon`, `CarbonImmutable`)
+- `DateTimeZoneCast` for `DateTimeZone` objects
+- `DataCast` for `Spatie\LaravelData\Data` objects
+- `DataArrayCast` for arrays of `Spatie\LaravelData\Data` objects
+- `EnumCast` for native PHP enums
+- `CollectionCast` for `Illuminate\Support\Collection` objects
+
 #### Typing properties
 
 There are quite a few options to type properties. You could type them in PHP:

src/SettingsCasts/ArrayDataCast.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Spatie\LaravelSettings\SettingsCasts;
+
+use Spatie\LaravelData\Data;
+
+class ArrayDataCast implements SettingsCast
+{
+    protected DataCast $cast;
+
+    public function __construct(?string $type, bool|string $validate = false)
+    {
+        $this->cast = new DataCast($type, $validate);
+    }
+
+    /**
+     * @param array<array> $payload
+     *
+     * @return Data[]
+     */
+    public function get($payload): array
+    {
+        return array_map(
+            fn ($data) => $this->cast->get($data),
+            $payload
+        );
+    }
+
+    /**
+     * @param array<array|Data> $payload
+     *
+     * @return array<array>
+     */
+    public function set($payload): array
+    {
+        return array_map(
+            fn ($data) => $this->cast->set($data),
+            $payload
+        );
+    }
+}

src/SettingsCasts/DataCast.php

@@ -3,20 +3,29 @@
 namespace Spatie\LaravelSettings\SettingsCasts;
 
 use Exception;
+use Spatie\LaravelData\Contracts\BaseData;
 use Spatie\LaravelData\Data;
 
 class DataCast implements SettingsCast
 {
     protected string $type;
 
-    public function __construct(?string $type)
+    protected bool $validate;
+
+    public function __construct(?string $type, string|bool $validate = false)
     {
         $this->type = $this->ensureDataTypeExists($type);
+
+        $this->validate = is_string($validate)
+            ? in_array($validate, ['true', '1'], true)
+            : $validate;
     }
 
     public function get($payload): Data
     {
-        return $this->type::from($payload);
+        return $this->validate
+            ? $this->type::validateAndCreate($payload)
+            : $this->type::from($payload);
     }
 
     /**
@@ -39,6 +48,10 @@ protected function ensureDataTypeExists(?string $type): string
             throw new Exception("Cannot create a data cast for `{$type}` because the data does not exist");
         }
 
+        if (! class_implements($type, BaseData::class)) {
+            throw new Exception("Cannot create a data cast for `$type` because the class does not implement data");
+        }
+
         return $type;
     }
 }

tests/SettingsCasts/ArrayDataCastTest.php

@@ -0,0 +1,98 @@
+<?php
+
+use Spatie\LaravelSettings\Migrations\SettingsBlueprint;
+use Spatie\LaravelSettings\Migrations\SettingsMigrator;
+use Spatie\LaravelSettings\Settings;
+use Spatie\LaravelSettings\SettingsCasts\ArrayDataCast;
+use Spatie\LaravelSettings\Tests\TestClasses\DummyData;
+
+it('can save and retrieve an array of data objects', function () {
+    $settingsClass = new class extends Settings {
+        /** @var DummyData[] */
+        public array $users;
+
+        public static function group(): string
+        {
+            return 'test_array_data';
+        }
+
+        public static function casts(): array
+        {
+            return [
+                'users' => ArrayDataCast::class . ':' . DummyData::class,
+            ];
+        }
+    };
+
+    resolve(SettingsMigrator::class)->inGroup('test_array_data', function (SettingsBlueprint $blueprint): void {
+        $blueprint->add('users', [
+            ['name' => 'Freek'],
+            ['name' => 'Ruben'],
+        ]);
+    });
+
+    $settings = resolve($settingsClass::class);
+
+    expect($settings->users)
+        ->toBeArray()
+        ->toHaveCount(2);
+
+    expect($settings->users[0])
+        ->toBeInstanceOf(DummyData::class)
+        ->name->toBe('Freek');
+
+    expect($settings->users[1])
+        ->toBeInstanceOf(DummyData::class)
+        ->name->toBe('Ruben');
+
+    $settings->users = [
+        DummyData::from(['name' => 'Brent']),
+        DummyData::from(['name' => 'Rias']),
+    ];
+
+    $settings->save();
+
+    $this->assertDatabaseHasSetting('test_array_data.users', [
+        ['name' => 'Brent'],
+        ['name' => 'Rias'],
+    ]);
+});
+
+it('can save an array of data objects with validation', function () {
+    $settingsClass = new class extends Settings {
+        /** @var DummyData[] */
+        public array $users;
+
+        public static function group(): string
+        {
+            return 'test_array_data_validated';
+        }
+
+        public static function casts(): array
+        {
+            return [
+                'users' => ArrayDataCast::class . ':' . DummyData::class . ',true',
+            ];
+        }
+    };
+
+    resolve(SettingsMigrator::class)->inGroup('test_array_data_validated', function (SettingsBlueprint $blueprint): void {
+        $blueprint->add('users', [
+            ['name' => 'Freek'],
+        ]);
+    });
+
+    $settings = resolve($settingsClass::class);
+
+    $settings->users = [
+        DummyData::from(['name' => 'Brent']),
+        DummyData::from(['name' => 'Rias']),
+    ];
+
+    $settings->save();
+
+    $this->assertDatabaseHasSetting('test_array_data_validated.users', [
+        ['name' => 'Brent'],
+        ['name' => 'Rias'],
+    ]);
+});