Merge pull request #69 from cjmellor/68-issue-creating-an-approval-wh…

…en-it-has-a-field-cast-as-array-type Add comprehensive test for nested array attributes in approval process
cjmellor · Nov 10, 2024 · 72d9875 · 72d9875
2 parents 6d88e29 + aa4f700
commit 72d9875
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 2 deletions.
diff --git a/src/Concerns/MustBeApproved.php b/src/Concerns/MustBeApproved.php
@@ -29,7 +29,7 @@ protected static function insertApprovalRequest($model): ?bool
         unset($filteredDirty[$foreignKey]);
 
         foreach ($filteredDirty as $key => $value) {
-            if (isset($model->casts[$key]) && $model->casts[$key] === 'json') {
+            if (isset($model->casts[$key]) && ($model->casts[$key] === 'json' || $model->casts[$key] === 'array')) {
                 $filteredDirty[$key] = json_decode(json: $value, associative: true);
             }
         }

diff --git a/tests/Feature/MustBeApprovedTraitTest.php b/tests/Feature/MustBeApprovedTraitTest.php
@@ -201,7 +201,7 @@
     $this->assertDatabaseHas(table: Approval::class, data: [
         'new_data' => json_encode([
             'name' => 'Neo',
-            'data' => json_encode(['foo', 'bar']),
+            'data' => ['foo', 'bar'],
         ]),
         'original_data' => json_encode([]),
     ]);
@@ -317,3 +317,69 @@ public function getApprovalForeignKeyName(): string
         'foreign_key' => null,
     ]);
 });
+
+test(description: 'approve a model with nested array attributes', closure: function () {
+    Schema::create('models_with_nested_arrays', function (Blueprint $table) {
+        $table->id();
+        $table->string('name')->nullable();
+        $table->json('settings')->nullable();
+        $table->json('metadata')->nullable();
+    });
+
+    $model = new class extends Model
+    {
+        use MustBeApproved;
+
+        protected $table = 'models_with_nested_arrays';
+        protected $guarded = [];
+        public $timestamps = false;
+
+        protected $casts = [
+            'settings' => 'array',
+            'metadata' => 'array'
+        ];
+    };
+
+    // Create a model with complex nested array data
+    $testData = [
+        'name' => 'Test Model',
+        'settings' => [
+            'preferences' => [
+                'theme' => 'dark',
+                'notifications' => true
+            ],
+            'features' => ['feature1', 'feature2']
+        ],
+        'metadata' => [
+            'tags' => ['important', 'test'],
+            'version' => 2
+        ]
+    ];
+
+    $model->create($testData);
+
+    // Verify data in approval table using database assertion instead of model property
+    $this->assertDatabaseHas(Approval::class, [
+        'new_data' => json_encode($testData),
+        'original_data' => json_encode([])
+    ]);
+
+    // Nothing should be in the main table yet
+    expect($model->count())->toBe(0);
+
+    // Approve the model
+    Approval::first()->approve();
+
+    // Verify the data after approval
+    $savedModel = $model->first();
+
+    expect($savedModel)
+        ->name->toBe('Test Model')
+        ->settings->toBeArray()
+        ->metadata->toBeArray()
+        ->and($savedModel->settings['preferences']['theme'])->toBe('dark')
+        ->and($savedModel->settings['preferences']['notifications'])->toBeTrue()
+        ->and($savedModel->settings['features'])->toMatchArray(['feature1', 'feature2'])
+        ->and($savedModel->metadata['tags'])->toMatchArray(['important', 'test'])
+        ->and($savedModel->metadata['version'])->toBe(2);
+});