[263]: fix ModelTestState to support custom Eloquent casts over JSON columns

src/Testing/ModelTestState.php

@@ -2,34 +2,63 @@
 
 namespace RonasIT\Support\Testing;
 
-use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
 
 class ModelTestState extends TableTestState
 {
+    protected Model $model;
+
+    protected array $castFields;
+
+    /**
+     * @param  class-string<Model>  $modelClassName
+     */
     public function __construct(string $modelClassName)
     {
-        $model = new $modelClassName();
+        $this->model = new $modelClassName();
 
         parent::__construct(
-            tableName: $model->getTable(),
-            jsonFields: $this->getModelJSONFields($model),
-            connectionName: $model->getConnectionName($model),
-            uniqueKey: $model->getKeyName(),
+            tableName: $this->model->getTable(),
+            connectionName: $this->model->getConnectionName(),
+            uniqueKey: $this->model->getKeyName(),
         );
+
+        $this->castFields = array_keys($this->model->getCasts());
+    }
+
+    protected function prepareChanges(array $changes): array
+    {
+        if (empty($this->castFields)) {
+            return $changes;
+        }
+
+        return array_map(fn (array $item) => $this->applyCasts($item), $changes);
     }
 
-    protected function getModelJSONFields(Model $model): array
+    protected function applyCasts(array $item): array
     {
-        $casts = $model->getCasts();
+        $attributes = $this->resolveModelAttributes($item);
+
+        $this->model->setRawAttributes($attributes);
 
-        $jsonCasts = array_filter($casts, fn ($cast) => $this->isJsonCast($cast));
+        foreach ($this->castFields as $field) {
+            if (Arr::has($item, $field)) {
+                $item[$field] = $this->model->getAttribute($field);
+            }
+        }
 
-        return array_keys($jsonCasts);
+        return $item;
     }
 
-    protected function isJsonCast(string $cast): bool
+    protected function resolveModelAttributes(array $item): array
     {
-        return ($cast === 'array') || (class_exists($cast) && is_subclass_of($cast, CastsAttributes::class));
+        $original = $this->state->first(
+            callback: fn (array $record) => $record[$this->uniqueKey] === $item[$this->uniqueKey],
+        );
+
+        return is_null($original)
+            ? $item
+            : array_merge($original, $item);
     }
 }

src/Testing/TableTestState.php

@@ -45,7 +45,7 @@ public function assertNotChanged(): void
 
     public function assertChangesEqualsFixture(string $fixture, bool $exportMode = false): void
     {
-        $changes = $this->getChanges();
+        $changes = json_decode(json_encode($this->getChanges()), true);
 
         $this->assertEqualsFixture($fixture, $changes, $exportMode);
     }

tests/BaseRequestTest.php

@@ -16,7 +16,7 @@ public function testGetOrderableFields()
     {
         $result = $this->callEncapsulatedMethod(new BaseRequest(), 'getOrderableFields', TestModel::class);
 
-        $expectedResult = 'id,name,json_field,castable_field,*,created_at,updated_at';
+        $expectedResult = 'id,name,settings,*,created_at,updated_at';
 
         $this->assertEquals($expectedResult, $result);
     }
@@ -30,7 +30,7 @@ public function testGetOrderableFieldsWithAdditionalFields()
 
         $result = $this->callEncapsulatedMethod(new BaseRequest(), 'getOrderableFields', ...$args);
 
-        $expectedResult = 'id,name,json_field,castable_field,*,created_at,updated_at,additional_field_1,additional_field_2';
+        $expectedResult = 'id,name,settings,*,created_at,updated_at,additional_field_1,additional_field_2';
 
         $this->assertEquals($expectedResult, $result);
     }

tests/ModelTestStateTest.php

@@ -7,7 +7,12 @@
 use RonasIT\Support\Testing\ModelTestState;
 use RonasIT\Support\Tests\Support\Mock\Models\TestModel;
 use RonasIT\Support\Tests\Support\Mock\Models\TestModelNonIdPrimaryKey;
-use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithoutJsonFields;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithCastable;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithCrossAttributeCast;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithCustomCast;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithNativeJsonCasts;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithParameterizedCast;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithPrimitiveCasts;
 use RonasIT\Support\Tests\Support\Traits\TableTestStateMockTrait;
 
 class ModelTestStateTest extends TestCase
@@ -23,20 +28,21 @@ public function setUp(): void
         putenv('FAIL_EXPORT_JSON=false');
     }
 
-    public function testInitialization()
+    public function testInitialization(): void
     {
-        $datasetMock = collect($this->getJsonFixture('initialization/dataset.json'));
-        $originRecords = collect($this->getJsonFixture('initialization/origin_records.json'));
+        $datasetMock = collect($this->getJsonFixture('initialization/dataset'));
+        $originRecords = collect($this->getJsonFixture('initialization/origin_records'));
 
         $this->mockGettingDataset($datasetMock);
 
         $modelTestState = new ModelTestState(TestModel::class);
         $reflectionClass = new ReflectionClass($modelTestState);
 
-        $jsonFields = $this->getProtectedProperty($reflectionClass, 'jsonFields', $modelTestState);
+        $customCastFields = $this->getProtectedProperty($reflectionClass, 'castFields', $modelTestState);
         $state = $this->getProtectedProperty($reflectionClass, 'state', $modelTestState);
 
-        $this->assertEquals(['json_field', 'castable_field'], $jsonFields);
+        $this->assertEquals(['id', 'settings', 'deleted_at'], $customCastFields);
+
         $this->assertEquals($originRecords, $state);
     }
 
@@ -53,60 +59,86 @@ public static function getInitializationViaPrepareModelTestStateFilters(): array
     }
 
     #[DataProvider('getInitializationViaPrepareModelTestStateFilters')]
-    public function testInitializationViaPrepareTableTestState(bool $testCaseGlobalExportMode)
+    public function testInitializationViaPrepareTableTestState(bool $testCaseGlobalExportMode): void
     {
-        $datasetMock = collect($this->getJsonFixture('initialization/dataset.json'));
+        $datasetMock = collect($this->getJsonFixture('initialization/dataset'));
         $this->mockGettingDataset($datasetMock);
 
         $actualGlobalExportModeValue = $this->mockTestStateCreationSetGlobalExportMode('prepareModelTestState', TestModel::class, $testCaseGlobalExportMode);
 
         $this->assertEquals($actualGlobalExportModeValue, $testCaseGlobalExportMode);
     }
 
-    public function testAssertChangesEqualsFixture()
+    public static function getChangeScenarios(): array
     {
-        $initialDatasetMock = collect($this->getJsonFixture('changes_equals_fixture/initial_dataset.json'));
-        $changedDatasetMock = collect($this->getJsonFixture('changes_equals_fixture/changed_dataset.json'));
-
-        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_models');
-
-        $modelTestState = new ModelTestState(TestModel::class);
-        $modelTestState->assertChangesEqualsFixture('assertion_fixture.json');
+        return [
+            'base' => [
+                'fixtureDir' => 'changes_equals_fixture',
+                'table' => 'test_models',
+                'modelClass' => TestModel::class,
+            ],
+            'primitive casts' => [
+                'fixtureDir' => 'changes_equals_fixture_with_primitive_casts',
+                'table' => 'test_model_with_primitive_casts',
+                'modelClass' => TestModelWithPrimitiveCasts::class,
+            ],
+            'native json casts' => [
+                'fixtureDir' => 'changes_equals_fixture_with_native_json_casts',
+                'table' => 'test_model_with_native_json_casts',
+                'modelClass' => TestModelWithNativeJsonCasts::class,
+            ],
+            'custom cast' => [
+                'fixtureDir' => 'changes_equals_fixture_with_custom_cast',
+                'table' => 'test_model_with_custom_casts',
+                'modelClass' => TestModelWithCustomCast::class,
+            ],
+            'parameterized cast' => [
+                'fixtureDir' => 'changes_equals_fixture_with_parameterized_cast',
+                'table' => 'test_model_with_parameterized_casts',
+                'modelClass' => TestModelWithParameterizedCast::class,
+            ],
+            'castable' => [
+                'fixtureDir' => 'changes_equals_fixture_with_castable',
+                'table' => 'test_model_with_castables',
+                'modelClass' => TestModelWithCastable::class,
+            ],
+            'cross attribute cast' => [
+                'fixtureDir' => 'changes_equals_fixture_with_cross_attribute_cast',
+                'table' => 'test_model_with_cross_attribute_casts',
+                'modelClass' => TestModelWithCrossAttributeCast::class,
+            ],
+            'custom primary key' => [
+                'fixtureDir' => 'changes_equals_fixture_primary_key',
+                'table' => 'test_model_non_id_primary_keys',
+                'modelClass' => TestModelNonIdPrimaryKey::class,
+                'uniqueKey' => 'name',
+            ],
+        ];
     }
 
-    public function testAssertChangesWithoutJsonFields()
-    {
-        $initialDatasetMock = collect(
-            value: $this->getJsonFixture('changes_equals_fixture_without_json_fields/initial_dataset.json'),
-        );
-        $changedDatasetMock = collect(
-            value: $this->getJsonFixture('changes_equals_fixture_without_json_fields/changed_dataset.json'),
-        );
+    #[DataProvider('getChangeScenarios')]
+    public function testAssertChanges(
+        string $fixtureDir,
+        string $table,
+        string $modelClass,
+        string $uniqueKey = 'id',
+    ): void {
+        $initialDatasetMock = collect($this->getJsonFixture("{$fixtureDir}/initial_dataset"));
+        $changedDatasetMock = collect($this->getJsonFixture("{$fixtureDir}/changed_dataset"));
 
-        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_model_without_json_fields');
+        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, $table, $uniqueKey);
 
-        $modelTestState = new ModelTestState(TestModelWithoutJsonFields::class);
-        $modelTestState->assertChangesEqualsFixture('assertion_fixture_without_json_fields.json');
+        $modelTestState = new ModelTestState($modelClass);
+        $modelTestState->assertChangesEqualsFixture('assertion_fixture');
     }
 
-    public function testAssertNoChanges()
+    public function testAssertNoChanges(): void
     {
-        $datasetMock = collect($this->getJsonFixture('get_without_changes/dataset.json'));
+        $datasetMock = collect($this->getJsonFixture('get_without_changes/dataset'));
 
         $this->mockGettingDatasetForChanges($datasetMock, $datasetMock, 'test_models');
 
         $modelTestState = new ModelTestState(TestModel::class);
         $modelTestState->assertNotChanged();
     }
-
-    public function testAssertChangesWithCustomPrimaryKey()
-    {
-        $initialDatasetMock = collect($this->getJsonFixture('changes_equals_fixture_primary_key/initial_dataset'));
-        $changedDatasetMock = collect($this->getJsonFixture('changes_equals_fixture_primary_key/changed_dataset'));
-
-        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_model_non_id_primary_keys', 'name');
-
-        $modelTestState = new ModelTestState(TestModelNonIdPrimaryKey::class);
-        $modelTestState->assertChangesEqualsFixture('assertion_fixture_primary_key');
-    }
 }

tests/fixtures/ModelTestStateTest/changes_equals_fixture/changed_dataset.json

@@ -2,32 +2,24 @@
   {
     "id": 1,
     "name": "name1 updated",
-    "json_field": "{\"field1\": \"value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
-    "castable_field": "{\"field1\": \"value 1\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "id": 2,
     "name": "name2",
-    "json_field": "{}",
-    "castable_field": "{\"one\": \"first value updated\", \"two\": \"second value\"}",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "id": 3,
     "name": "name3",
-    "castable_field": "{}",
-    "json_field": "[2, \"two\"]",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "id": 4,
-    "name": "name4",
-    "castable_field": "{}",
-    "json_field": "{}",
+    "name": "name44",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   }

tests/fixtures/ModelTestStateTest/changes_equals_fixture/initial_dataset.json

@@ -2,32 +2,24 @@
   {
     "id": 1,
     "name": "name1",
-    "json_field": "{\"field1\": \"updated value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
-    "castable_field": "{\"field1\": \"updated value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "id": 2,
     "name": "name2",
-    "json_field": "{}",
-    "castable_field": "{\"one\": \"first value\", \"two\": \"second value\"}",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "id": 3,
     "name": "name3",
-    "castable_field": "{}",
-    "json_field": "[2, \"two\"]",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "id": 5,
     "name": "name5",
-    "castable_field": "{}",
-    "json_field": "{}",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   }

tests/fixtures/ModelTestStateTest/changes_equals_fixture_primary_key/changed_dataset.json

@@ -1,29 +1,19 @@
 [
   {
     "name": "name1",
-    "json_field": "{\"field1\": \"updated_value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
-    "castable_field": "{\"field1\": \"value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "value": "alpha",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "name": "name2",
-    "json_field": "{\"field1\": \"added_value\"}",
-    "castable_field": "{\"one\": \"first value\", \"two\": \"second value\"}",
+    "value": "beta_updated",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "name": "name4",
-    "castable_field": "{}",
-    "json_field": "{}",
-    "created_at": "2018-10-10 10:10:10",
-    "updated_at": "2018-10-10 10:10:10"
-  },
-  {
-    "name": "name5",
-    "castable_field": "{}",
-    "json_field": "{}",
+    "value": "delta",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   }

tests/fixtures/ModelTestStateTest/changes_equals_fixture_primary_key/initial_dataset.json

@@ -1,29 +1,19 @@
 [
   {
     "name": "name1",
-    "json_field": "{\"field1\": \"value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
-    "castable_field": "{\"field1\": \"value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "value": "alpha",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "name": "name2",
-    "json_field": "{}",
-    "castable_field": "{\"one\": \"first value\", \"two\": \"second value\"}",
+    "value": "beta",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "name": "name3",
-    "castable_field": "{}",
-    "json_field": "[2, \"two\"]",
-    "created_at": "2018-10-10 10:10:10",
-    "updated_at": "2018-10-10 10:10:10"
-  },
-  {
-    "name": "name4",
-    "castable_field": "{}",
-    "json_field": "{}",
+    "value": "gamma",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   }