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

src/Testing/ModelTestState.php

@@ -2,34 +2,89 @@
 
 namespace RonasIT\Support\Testing;
 
+use Illuminate\Contracts\Database\Eloquent\Castable;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Str;
 
 class ModelTestState extends TableTestState
 {
+    protected const array NATIVE_JSON_CASTS = ['array', 'json', 'object', 'collection'];
+
+    protected array $classCastFields = [];
+
+    /**
+     * @param  class-string<Model>  $modelClassName
+     */
     public function __construct(string $modelClassName)
     {
         $model = new $modelClassName();
 
+        $this->classCastFields = $this->resolveClassCastFields($model);
+
         parent::__construct(
             tableName: $model->getTable(),
-            jsonFields: $this->getModelJSONFields($model),
-            connectionName: $model->getConnectionName($model),
+            jsonFields: $this->resolveNativeJsonFields($model),
+            connectionName: $model->getConnectionName(),
             uniqueKey: $model->getKeyName(),
         );
     }
 
-    protected function getModelJSONFields(Model $model): array
+    protected function resolveNativeJsonFields(Model $model): array
     {
-        $casts = $model->getCasts();
+        return $this->getFilteredCasts($model, fn (string $type) => in_array($type, self::NATIVE_JSON_CASTS, true));
+    }
 
-        $jsonCasts = array_filter($casts, fn ($cast) => $this->isJsonCast($cast));
+    protected function resolveClassCastFields(Model $model): array
+    {
+        return $this->getFilteredCasts($model, fn (string $type) => $this->isClassCast($type));
+    }
+
+    protected function isClassCast(string $type): bool
+    {
+        return is_subclass_of($type, CastsAttributes::class)
+            || is_subclass_of($type, Castable::class);
+    }
+
+    protected function prepareChanges(array $changes): array
+    {
+        if (!empty($this->classCastFields)) {
+            $changes = array_map(fn (array $item) => $this->decodeClassCastFields($item), $changes);
+        }
+
+        return parent::prepareChanges($changes);
+    }
+
+    protected function decodeClassCastFields(array $item): array
+    {
+        foreach ($this->classCastFields as $field) {
+            if (Arr::has($item, $field) && is_string($item[$field])) {
+                $decoded = json_decode($item[$field], true);
+
+                if (json_last_error() === JSON_ERROR_NONE && is_array($decoded)) {
+                    $item[$field] = $decoded;
+                }
+            }
+        }
+
+        return $item;
+    }
+
+    protected function getFilteredCasts(Model $model, callable $callback): array
+    {
+        $filtered = array_filter(
+            array: $model->getCasts(),
+            callback: fn (mixed $definition) => $callback($this->resolveCastType($definition)),
+        );
 
-        return array_keys($jsonCasts);
+        return array_keys($filtered);
     }
 
-    protected function isJsonCast(string $cast): bool
+    protected function resolveCastType(mixed $definition): string
     {
-        return ($cast === 'array') || (class_exists($cast) && is_subclass_of($cast, CastsAttributes::class));
+        return (is_string($definition))
+            ? Str::before($definition, ':')
+            : $definition::class;
     }
 }

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,json_field,custom_cast_field,castable_field,*,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,json_field,custom_cast_field,castable_field,*,created_at,updated_at,additional_field_1,additional_field_2';
 
         $this->assertEquals($expectedResult, $result);
     }

tests/ModelTestStateTest.php

@@ -7,7 +7,11 @@
 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\TestModelWithCastInstance;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithCustomJsonCast;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithCustomNonJsonCast;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithNativeJsonCasts;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModelWithPrimitiveCasts;
 use RonasIT\Support\Tests\Support\Traits\TableTestStateMockTrait;
 
 class ModelTestStateTest extends TestCase
@@ -23,20 +27,23 @@ 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);
+        $classCastFields = $this->getProtectedProperty($reflectionClass, 'classCastFields', $modelTestState);
         $state = $this->getProtectedProperty($reflectionClass, 'state', $modelTestState);
 
-        $this->assertEquals(['json_field', 'castable_field'], $jsonFields);
+        $this->assertEquals(['json_field'], $jsonFields);
+        $this->assertEquals(['custom_cast_field', 'castable_field'], $classCastFields);
+
         $this->assertEquals($originRecords, $state);
     }
 
@@ -53,60 +60,81 @@ 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 getAssertChangesData(): 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 [
+            'mixed native, custom and castable casts' => [
+                'fixtureDir' => 'changes_equals_fixture',
+                'table' => 'test_models',
+                'modelClass' => TestModel::class,
+            ],
+            'cast defined as an instance' => [
+                'fixtureDir' => 'changes_equals_fixture_with_cast_instance',
+                'table' => 'test_model_with_cast_instances',
+                'modelClass' => TestModelWithCastInstance::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 json cast' => [
+                'fixtureDir' => 'changes_equals_fixture_with_custom_json_cast',
+                'table' => 'test_model_with_custom_json_casts',
+                'modelClass' => TestModelWithCustomJsonCast::class,
+            ],
+            'custom non-json cast' => [
+                'fixtureDir' => 'changes_equals_fixture_with_custom_non_json_cast',
+                'table' => 'test_model_with_custom_non_json_casts',
+                'modelClass' => TestModelWithCustomNonJsonCast::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('getAssertChangesData')]
+    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,36 @@
   {
     "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}}",
+    "json_field": "{\"field1\": \"updated value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "custom_cast_field": "{\"one\": \"first value updated\", \"two\": \"second value\"}",
+    "castable_field": "{\"theme\": \"dark\"}",
     "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\"}",
+    "custom_cast_field": "{}",
+    "castable_field": "{\"theme\": \"light\"}",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
-    "id": 3,
-    "name": "name3",
+    "id": 4,
+    "name": "name4",
+    "json_field": "[1, 2]",
+    "custom_cast_field": "not a json",
     "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": "{}",
+    "id": 5,
+    "name": "name5",
     "json_field": "{}",
+    "custom_cast_field": "{}",
+    "castable_field": "{}",
     "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,36 @@
   {
     "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}}",
+    "json_field": "{\"field1\": \"value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "custom_cast_field": "{\"one\": \"first value\", \"two\": \"second value\"}",
+    "castable_field": "{\"theme\": \"dark\"}",
     "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\"}",
+    "custom_cast_field": "{}",
+    "castable_field": "{\"theme\": \"dark\"}",
     "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\"]",
+    "custom_cast_field": "plain text",
+    "castable_field": "{}",
     "created_at": "2018-10-10 10:10:10",
     "updated_at": "2018-10-10 10:10:10"
   },
   {
     "id": 5,
     "name": "name5",
-    "castable_field": "{}",
     "json_field": "{}",
+    "custom_cast_field": "{}",
+    "castable_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"
   }