feature: add InteractsWithJsonFields trait with castField(s)ToJson helper methods

Author: alexzarbn

src/Testing/InteractsWithJsonFields.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Orion\Testing;
+
+use Illuminate\Contracts\Support\Jsonable;
+use Illuminate\Database\Query\Expression;
+use Illuminate\Support\Facades\DB;
+
+trait InteractsWithJsonFields
+{
+    protected function castFieldsToJson(array $fields): array
+    {
+        return collect($fields)->map(function ($value) {
+            if (is_array($value) || $value instanceof Jsonable) {
+                return $this->castFieldToJson($value);
+            }
+
+            return $value;
+        })->toArray();
+    }
+
+    protected function castFieldToJson($value): Expression
+    {
+        if ($value instanceof Jsonable) {
+            $value = $value->toJson();
+        } else {
+            $value = json_encode($value);
+        }
+
+        if (config('database.default') === 'mysql') {
+            $value = DB::raw("CAST('{$value}' AS JSON)");
+        }
+        if (config('database.default') === 'pgsql') {
+            $value = DB::raw("'{$value}'::jsonb");
+        }
+
+        return $value;
+    }
+}

src/Testing/InteractsWithResources.php

@@ -326,7 +326,7 @@ protected function assertResourcesToggled($response, string $relation, Model $pa
 
     protected function assertResourceAttached(string $relation, Model $parentModel, Model $relationModel, array $pivotFields = []): void
     {
-        $pivotFields = $this->castPivotFields($pivotFields);
+        $pivotFields = $this->castFieldsToJson($pivotFields);
 
         $this->assertDatabaseHas($parentModel->{$relation}()->getTable(), array_merge([
             $parentModel->{$relation}()->getForeignPivotKeyName() => $parentModel->getKey(),
@@ -346,7 +346,7 @@ protected function assertResourcePivotUpdated($response, string $relation, Model
     {
         $this->assertResponseContent(['updated' => [$relationModel->getKey()]], $response, $exact);
 
-        $pivotFields = $this->castPivotFields($pivotFields);
+        $pivotFields = $this->castFieldsToJson($pivotFields);
 
         $this->assertDatabaseHas($parentModel->{$relation}()->getTable(), array_merge([
             $parentModel->{$relation}()->getForeignPivotKeyName() => $parentModel->getKey(),
@@ -397,23 +397,6 @@ protected function assertJsonSame(array $expected, $response): void
         self::assertSame($expected, $actual);
     }
 
-    protected function castPivotFields(array $pivotFields): array
-    {
-        return collect($pivotFields)->map(function ($pivotFieldValue) {
-            if (is_array($pivotFieldValue)) {
-                $pivotFieldValue = json_encode($pivotFieldValue);
-                if (config('database.default') === 'mysql') {
-                    $pivotFieldValue = DB::raw("CAST('{$pivotFieldValue}' AS JSON)");
-                }
-                if (config('database.default') === 'pgsql') {
-                    $pivotFieldValue = DB::raw("'{$pivotFieldValue}'::jsonb");
-                }
-            }
-
-            return $pivotFieldValue;
-        })->toArray();
-    }
-
     protected function buildSyncMap(array $attached = [], array $detached = [], array $updated = [], array $remained = []): array
     {
         return [

tests/Feature/TestCase.php

@@ -3,13 +3,14 @@
 namespace Orion\Tests\Feature;
 
 use Orion\Testing\InteractsWithAuthorization;
+use Orion\Testing\InteractsWithJsonFields;
 use Orion\Testing\InteractsWithResources;
 use Orion\Tests\Fixtures\App\Models\User;
 use Orion\Tests\TestCase as BaseTestCase;
 
 abstract class TestCase extends BaseTestCase
 {
-    use InteractsWithResources, InteractsWithAuthorization;
+    use InteractsWithResources, InteractsWithJsonFields, InteractsWithAuthorization;
 
     protected function setUp(): void
     {