Merge branch 'main' into feature/missing-setting-default-value

Author: gazben

.github/workflows/dependabot-auto-merge.yml

@@ -13,7 +13,7 @@ jobs:
 
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v2.2.0
+        uses: dependabot/fetch-metadata@v2.3.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
 

CHANGELOG.md

@@ -6,6 +6,23 @@ All notable changes to `laravel-settings` will be documented in this file
 
 - Make `spatie/data-transfer-object` dependency optional. (#160)
 
+## 3.4.1 - 2025-01-31
+
+### What's Changed
+
+* chore(deps): bump dependabot/fetch-metadata from 2.2.0 to 2.3.0 by @dependabot in https://github.com/spatie/laravel-settings/pull/309
+* Change out of date stubs in README by @GrandadEvans in https://github.com/spatie/laravel-settings/pull/310
+* Support Illuminate\Support\Carbon as cast by @Propaganistas in https://github.com/spatie/laravel-settings/pull/311
+* chore: fix typo by @danjohnson95 in https://github.com/spatie/laravel-settings/pull/306
+
+### New Contributors
+
+* @GrandadEvans made their first contribution in https://github.com/spatie/laravel-settings/pull/310
+* @Propaganistas made their first contribution in https://github.com/spatie/laravel-settings/pull/311
+* @danjohnson95 made their first contribution in https://github.com/spatie/laravel-settings/pull/306
+
+**Full Changelog**: https://github.com/spatie/laravel-settings/compare/3.4.0...3.4.1
+
 ## 3.4.0 - 2024-09-20
 
 ### What's Changed

README.md

@@ -1,6 +1,3 @@
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)
-
 # Store strongly typed application settings
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/laravel-settings.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-settings)
@@ -97,7 +94,7 @@ return [
 
     /*
      * Each settings class used in your application must be registered, you can
-     * add them (manually) here.
+     * put them (manually) here.
      */
     'settings' => [
 
@@ -109,7 +106,7 @@ return [
     'setting_class_path' => app_path('Settings'),
 
     /*
-     * In these directories settings migrations will be stored and ran when migrating. A settings 
+     * In these directories settings migrations will be stored and ran when migrating. A settings
      * migration created via the make:settings-migration command will be stored in the first path or
      * a custom defined path when running the command.
      */
@@ -118,7 +115,7 @@ return [
     ],
 
     /*
-     * When no repository is set for a settings class, the following repository
+     * When no repository was set for a settings class the following repository
      * will be used for loading and saving settings.
      */
     'default_repository' => 'database',
@@ -157,11 +154,12 @@ return [
         'enabled' => env('SETTINGS_CACHE_ENABLED', false),
         'store' => null,
         'prefix' => null,
+        'ttl' => null,
     ],
 
     /*
      * These global casts will be automatically used whenever a property within
-     * your settings class isn't the default PHP type.
+     * your settings class isn't a default PHP type.
      */
     'global_casts' => [
         DateTimeInterface::class => Spatie\LaravelSettings\SettingsCasts\DateTimeInterfaceCast::class,
@@ -240,7 +238,7 @@ This command will create a new file in `database/settings` where you can add the
 ```php
 use Spatie\LaravelSettings\Migrations\SettingsMigration;
 
-class CreateGeneralSettings extends SettingsMigration
+return new class extends SettingsMigration
 {
     public function up(): void
     {

src/Exceptions/MissingSettings.php

@@ -10,6 +10,6 @@ public static function create(string $settingsClass, array $missingProperties, s
     {
         $missing = implode(', ', $missingProperties);
 
-        return new self("Tried {$operation} settings '{$settingsClass}', and following properties were missing: {$missing}");
+        return new self("Tried {$operation} settings '{$settingsClass}', and the following properties were missing: {$missing}");
     }
 }

src/SettingsCasts/DateTimeInterfaceCast.php

@@ -8,6 +8,7 @@
 use DateTimeImmutable;
 use DateTimeInterface;
 use Exception;
+use Illuminate\Support\Carbon as IlluminateCarbon;
 
 class DateTimeInterfaceCast implements SettingsCast
 {
@@ -32,6 +33,10 @@ public function get($payload): ?DateTimeInterface
             return new CarbonImmutable($payload);
         }
 
+        if ($this->type === IlluminateCarbon::class) {
+            return new IlluminateCarbon($payload);
+        }
+
         if ($this->type === DateTimeImmutable::class) {
             return new DateTimeImmutable($payload);
         }

tests/SettingsTest.php

@@ -9,6 +9,7 @@
 use DateTimeZone;
 use ErrorException;
 use Illuminate\Database\Events\SchemaLoaded;
+use Illuminate\Support\Carbon as IlluminateCarbon;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\DB;
@@ -48,6 +49,7 @@
 it('will handle loading settings correctly', function () {
     $dateTime = new DateTimeImmutable('16-05-1994 12:00:00');
     $carbon = new Carbon('16-05-1994 12:00:00');
+    $illuminateCarbon = new IlluminateCarbon('20-05-1994 12:00:00');
 
     $this->migrator->inGroup('dummy', function (SettingsBlueprint $blueprint) use ($carbon, $dateTime): void {
         $blueprint->add('string', 'Ruben');
@@ -64,6 +66,7 @@
 
         $blueprint->add('date_time', $dateTime->format(DATE_ATOM));
         $blueprint->add('carbon', $carbon->toAtomString());
+        $blueprint->add('illuminate_carbon', $illuminateCarbon->toAtomString());
         $blueprint->add('nullable_date_time_zone', null);
     });
 
@@ -82,7 +85,8 @@
             DummyData::from(['name' => 'Adriaan']),
         ])
         ->date_time->toEqual($dateTime)
-        ->carbon->toEqual($carbon);
+        ->carbon->toEqual($carbon)
+        ->illuminate_carbon->toEqual($illuminateCarbon);
 });
 
 it('will fail loading when settings are missing', function () {
@@ -98,6 +102,7 @@
 it('can save settings', function () {
     $dateTime = new DateTimeImmutable('16-05-1994 12:00:00');
     $carbon = new Carbon('16-05-1994 12:00:00');
+    $illuminateCarbon = new IlluminateCarbon('20-05-1994 12:00:00');
     $dateTimeZone = new DateTimeZone('europe/brussels');
 
     $this->migrator->inGroup('dummy', function (SettingsBlueprint $blueprint) use ($dateTimeZone, $carbon, $dateTime): void {
@@ -118,6 +123,7 @@
         ]);
         $blueprint->add('date_time', $dateTime->format(DATE_ATOM));
         $blueprint->add('carbon', $carbon->toAtomString());
+        $blueprint->add('illuminate_carbon', $illuminateCarbon->toAtomString());
         $blueprint->add('nullable_date_time_zone', $dateTimeZone->getName());
     });
 
@@ -159,6 +165,7 @@
     expect($settings)
         ->date_time->toEqual($dateTime)
         ->carbon->toEqual($carbon)
+        ->illuminate_carbon->toEqual($illuminateCarbon)
         ->nullable_date_time_zone->toBeNull();
 });
 
@@ -174,6 +181,7 @@
         'dto' => DummyData::from(['name' => 'Rias']),
         'date_time' => new DateTimeImmutable(),
         'carbon' => Carbon::now(),
+        'illuminate_carbon' => IlluminateCarbon::now(),
     ]);
 
     $settings->save();