fix: ensure nested bags are cast correctly with Eloquent

fixes #70
dshafik · Jan 24, 2025 · 057344c · 057344c
1 parent efd21cd
commit 057344c
Show file tree

Hide file tree

Showing 6 changed files with 174 additions and 3 deletions.
diff --git a/src/Bag/Eloquent/Casts/AsBag.php b/src/Bag/Eloquent/Casts/AsBag.php
@@ -44,6 +44,10 @@ public function set(Model $model, string $key, mixed $value, array $attributes):
             return null;
         }
 
+        if (is_array($value)) {
+            return [$key => json_encode($value)];
+        }
+
         return [$key => json_encode($value->getRaw())];
     }
 }
diff --git a/tests/Feature/Concerns/WithEloquentCastingTest.php b/tests/Feature/Concerns/WithEloquentCastingTest.php
@@ -11,7 +11,9 @@
 use Tests\Fixtures\Models\CastedModel;
 use Tests\Fixtures\Models\CastedModelLegacy;
 use Tests\Fixtures\Values\BagWithCollection;
+use Tests\Fixtures\Values\CastedModelValues;
 use Tests\Fixtures\Values\HiddenParametersBag;
+use Tests\Fixtures\Values\OptionalPropertiesBag;
 use Tests\Fixtures\Values\TestBag;
 
 covers(WithEloquentCasting::class, AsBag::class, AsBagCollection::class);
@@ -158,6 +160,74 @@
             ->and($model->hidden_bag->age)->toBe(40)
             ->and($model->hidden_bag->email)->toBe('[email protected]');
     });
+
+    test('it stores bags with toArray on Laravel 11+', function () {
+        $model = CastedModel::create(CastedModelValues::from(
+            [
+                'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+            ]
+        )->toArray());
+
+        expect($model->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->bag->name)->toBe('Davey Shafik')
+            ->and($model->bag->age)->toBe(40)
+            ->and($model->bag->email)->toBe('[email protected]');
+
+        assertDatabaseHas('testing', ['bag' => '{"name":"Davey Shafik","age":40,"email":"[email protected]"}']);
+    });
+
+    test('it stores nested bags with toArray on Laravel 11+', function () {
+        $model = CastedModel::create(CastedModelValues::from(
+            [
+                'optionalsBag' => OptionalPropertiesBag::from([
+                    'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+                ]),
+            ]
+        )->toArray());
+
+        expect($model->optionals_bag)
+            ->toBeInstanceOf(OptionalPropertiesBag::class)
+            ->and($model->optionals_bag->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->optionals_bag->bag->name)->toBe('Davey Shafik')
+            ->and($model->optionals_bag->bag->age)->toBe(40)
+            ->and($model->optionals_bag->bag->email)->toBe('[email protected]');
+
+        assertDatabaseHas('testing', ['optionals_bag' => '{"name":null,"age":null,"email":null,"bag":{"name":"Davey Shafik","age":40,"email":"[email protected]"}}']);
+    });
+
+    test('it retrieves bags stored with toArray on Laravel 11+', function () {
+        CastedModel::create(CastedModelValues::from(
+            [
+                'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+            ]
+        )->toArray());
+
+        $model = CastedModel::first();
+
+        expect($model->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->bag->name)->toBe('Davey Shafik')
+            ->and($model->bag->age)->toBe(40)
+            ->and($model->bag->email)->toBe('[email protected]');
+    });
+
+    test('it retrieves nested bags stored with toArray on Laravel 11+', function () {
+        CastedModel::create(CastedModelValues::from(
+            [
+                'optionalsBag' => OptionalPropertiesBag::from([
+                    'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+                ]),
+            ]
+        )->toArray());
+
+        $model = CastedModel::first();
+
+        expect($model->optionals_bag)
+            ->toBeInstanceOf(OptionalPropertiesBag::class)
+            ->and($model->optionals_bag->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->optionals_bag->bag->name)->toBe('Davey Shafik')
+            ->and($model->optionals_bag->bag->age)->toBe(40)
+            ->and($model->optionals_bag->bag->email)->toBe('[email protected]');
+    });
 })->skip(fn () => !version_compare(Application::VERSION, '11.0.0', '>='), 'Requires Laravel 11+');
 
 describe('Laravel 10+', function () {
@@ -302,4 +372,72 @@
             ->and($model->hidden_bag->age)->toBe(40)
             ->and($model->hidden_bag->email)->toBe('[email protected]');
     });
+
+    test('it stores bags with toArray on Laravel 10+', function () {
+        $model = CastedModelLegacy::create(CastedModelValues::from(
+            [
+                'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+            ]
+        )->toArray());
+
+        expect($model->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->bag->name)->toBe('Davey Shafik')
+            ->and($model->bag->age)->toBe(40)
+            ->and($model->bag->email)->toBe('[email protected]');
+
+        assertDatabaseHas('testing', ['bag' => '{"name":"Davey Shafik","age":40,"email":"[email protected]"}']);
+    });
+
+    test('it stores nested bags with toArray on Laravel 10+', function () {
+        $model = CastedModelLegacy::create(CastedModelValues::from(
+            [
+                'optionalsBag' => OptionalPropertiesBag::from([
+                    'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+                ]),
+            ]
+        )->toArray());
+
+        expect($model->optionals_bag)
+            ->toBeInstanceOf(OptionalPropertiesBag::class)
+            ->and($model->optionals_bag->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->optionals_bag->bag->name)->toBe('Davey Shafik')
+            ->and($model->optionals_bag->bag->age)->toBe(40)
+            ->and($model->optionals_bag->bag->email)->toBe('[email protected]');
+
+        assertDatabaseHas('testing', ['optionals_bag' => '{"name":null,"age":null,"email":null,"bag":{"name":"Davey Shafik","age":40,"email":"[email protected]"}}']);
+    });
+
+    test('it retrieves bags stored with toArray on Laravel 10+', function () {
+        CastedModelLegacy::create(CastedModelValues::from(
+            [
+                'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+            ]
+        )->toArray());
+
+        $model = CastedModelLegacy::first();
+
+        expect($model->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->bag->name)->toBe('Davey Shafik')
+            ->and($model->bag->age)->toBe(40)
+            ->and($model->bag->email)->toBe('[email protected]');
+    });
+
+    test('it retrieves nested bags stored with toArray on Laravel 10+', function () {
+        CastedModelLegacy::create(CastedModelValues::from(
+            [
+                'optionalsBag' => OptionalPropertiesBag::from([
+                    'bag' => TestBag::from(['name' => 'Davey Shafik', 'age' => 40, 'email' => '[email protected]'])
+                ]),
+            ]
+        )->toArray());
+
+        $model = CastedModelLegacy::first();
+
+        expect($model->optionals_bag)
+            ->toBeInstanceOf(OptionalPropertiesBag::class)
+            ->and($model->optionals_bag->bag)->toBeInstanceOf(TestBag::class)
+            ->and($model->optionals_bag->bag->name)->toBe('Davey Shafik')
+            ->and($model->optionals_bag->bag->age)->toBe(40)
+            ->and($model->optionals_bag->bag->email)->toBe('[email protected]');
+    });
 });
diff --git a/tests/Fixtures/Models/CastedModel.php b/tests/Fixtures/Models/CastedModel.php
@@ -9,25 +9,28 @@
 use Tests\Fixtures\Collections\BagWithCollectionCollection;
 use Tests\Fixtures\Values\BagWithCollection;
 use Tests\Fixtures\Values\HiddenParametersBag;
+use Tests\Fixtures\Values\OptionalPropertiesBag;
 use Tests\Fixtures\Values\TestBag;
 
 /**
  * @property int $id
  * @property TestBag $bag
+ * @property OptionalPropertiesBag $optionals_bag
  * @property HiddenParametersBag $hidden_bag
- * @property Collection $collection
+ * @property Collection<TestBag> $collection
  * @property BagWithCollectionCollection $custom_collection
  */
 class CastedModel extends Model
 {
     protected $table = 'testing';
 
-    protected $fillable = ['bag', 'hidden_bag', 'collection', 'custom_collection'];
+    protected $fillable = ['bag', 'optionals_bag', 'hidden_bag', 'collection', 'custom_collection'];
 
     protected function casts()
     {
         return [
             'bag' => TestBag::class,
+            'optionals_bag' => OptionalPropertiesBag::class,
             'hidden_bag' => HiddenParametersBag::class,
             'collection' => TestBag::castAsCollection(),
             'custom_collection' => BagWithCollection::castAsCollection(),

diff --git a/tests/Fixtures/Models/CastedModelLegacy.php b/tests/Fixtures/Models/CastedModelLegacy.php
@@ -10,11 +10,13 @@
 use Tests\Fixtures\Collections\BagWithCollectionCollection;
 use Tests\Fixtures\Values\BagWithCollection;
 use Tests\Fixtures\Values\HiddenParametersBag;
+use Tests\Fixtures\Values\OptionalPropertiesBag;
 use Tests\Fixtures\Values\TestBag;
 
 /**
  * @property int $id
  * @property TestBag $bag
+ * @property OptionalPropertiesBag $optionals_bag
  * @property HiddenParametersBag $hidden_bag
  * @property Collection $collection
  * @property BagWithCollectionCollection $custom_collection
@@ -23,10 +25,11 @@ class CastedModelLegacy extends Model
 {
     protected $table = 'testing';
 
-    protected $fillable = ['bag', 'hidden_bag', 'collection', 'custom_collection'];
+    protected $fillable = ['bag', 'optionals_bag', 'hidden_bag', 'collection', 'custom_collection'];
 
     protected $casts = [
         'bag' => TestBag::class,
+        'optionals_bag' => OptionalPropertiesBag::class,
         'hidden_bag' => HiddenParametersBag::class,
         'collection' => AsBagCollection::class . ':' . TestBag::class,
         'custom_collection' => AsBagCollection::class . ':' . BagWithCollection::class,

diff --git a/tests/Fixtures/Values/CastedModelValues.php b/tests/Fixtures/Values/CastedModelValues.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Values;
+
+use Bag\Attributes\MapName;
+use Bag\Bag;
+use Bag\Mappers\SnakeCase;
+
+#[MapName(SnakeCase::class, SnakeCase::class)]
+readonly class CastedModelValues extends Bag
+{
+    public function __construct(
+        public ?string $name = null,
+        public ?int $age = null,
+        public ?string $email = null,
+        public ?TestBag $bag = null,
+        public ?OptionalPropertiesBag $optionalsBag = null,
+    ) {
+    }
+}
diff --git a/workbench/database/migrations/0001_01_01_000000_create_testing_table.php b/workbench/database/migrations/0001_01_01_000000_create_testing_table.php
@@ -18,6 +18,7 @@ public function up(): void
             $table->json('collection')->nullable();
             $table->json('custom_collection')->nullable();
             $table->json('hidden_bag')->nullable();
+            $table->json('optionals_bag')->nullable();
             $table->timestamps();
         });
     }