Merge pull request #464: Add JSON typecast

cycle · May 9, 2024 · 0677d29 · 0677d29
2 parents 892c275 + 37d98de
commit 0677d29
Show file tree

Hide file tree

Showing 12 changed files with 465 additions and 33 deletions.
diff --git a/src/Parser/Typecast.php b/src/Parser/Typecast.php
@@ -11,9 +11,9 @@
 use ReflectionEnum;
 use Throwable;
 
-final class Typecast implements CastableInterface
+final class Typecast implements CastableInterface, UncastableInterface
 {
-    private const RULES = ['int', 'bool', 'float', 'datetime'];
+    private const RULES = ['int', 'bool', 'float', 'datetime', 'json'];
 
     /** @var array<non-empty-string, bool> */
     private array $callableRules = [];
@@ -25,7 +25,7 @@ final class Typecast implements CastableInterface
     private array $rules = [];
 
     public function __construct(
-        private DatabaseInterface $database
+        private DatabaseInterface $database,
     ) {
     }
 
@@ -91,6 +91,28 @@ public function cast(array $data): array
         return $data;
     }
 
+    /**
+     * @throws \JsonException
+     */
+    public function uncast(array $data): array
+    {
+        foreach ($this->rules as $column => $rule) {
+            if (!isset($data[$column])) {
+                continue;
+            }
+
+            $data[$column] = match ($rule) {
+                'json' => \json_encode(
+                    $data[$column],
+                    \JSON_UNESCAPED_UNICODE | \JSON_THROW_ON_ERROR | JSON_INVALID_UTF8_SUBSTITUTE
+                ),
+                default => $data[$column]
+            };
+        }
+
+        return $data;
+    }
+
     /**
      * @throws \Exception
      */
@@ -104,6 +126,7 @@ private function castPrimitive(mixed $rule, mixed $value): mixed
                 $value,
                 $this->database->getDriver()->getTimezone()
             ),
+            'json' => \json_decode($value, true, 512, \JSON_THROW_ON_ERROR),
             default => $value,
         };
     }

diff --git a/tests/ORM/Fixtures/JsonSerializableClass.php b/tests/ORM/Fixtures/JsonSerializableClass.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\ORM\Tests\Fixtures;
+
+final class JsonSerializableClass implements \JsonSerializable
+{
+    public function jsonSerialize(): array
+    {
+        return [
+            'foo' => 'Lorem',
+            'bar' => 'Ipsum',
+        ];
+    }
+}
diff --git a/tests/ORM/Fixtures/User.php b/tests/ORM/Fixtures/User.php
@@ -69,7 +69,11 @@ class User implements ImagedInterface
      */
     public $credentials;
 
-    public ?string $settings = null;
+    public array $settings;
+
+    public ?array $settingsNullable = null;
+
+    public ?JsonSerializableClass $jsonSerializable = null;
 
     public function __construct()
     {

diff --git a/tests/ORM/Functional/Driver/Common/Select/JsonMethodsTest.php b/tests/ORM/Functional/Driver/Common/Select/JsonMethodsTest.php
@@ -39,7 +39,7 @@ public function setUp(): void
                 Schema::PRIMARY_KEY => 'id',
                 Schema::COLUMNS => ['id' => 'id', 'settings' => 'user_settings'],
                 Schema::SCHEMA => [],
-                Schema::TYPECAST => ['id' => 'int'],
+                Schema::TYPECAST => ['id' => 'int', 'settings' => 'json'],
                 Schema::RELATIONS => [],
             ],
             Post::class => [
@@ -72,7 +72,7 @@ public function testWhereJson(): void
         $user = $selector->whereJson('settings->theme', 'light')->fetchOne();
 
         $this->assertSame(2, $user->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $user->settings);
     }
 
     public function testWhereJsonWithRelation(): void
@@ -81,7 +81,7 @@ public function testWhereJsonWithRelation(): void
         $post = $selector->whereJson('user.settings->theme', 'light')->fetchOne();
 
         $this->assertSame(2, $post->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $post->user->settings);
     }
 
     public function testOrWhereJson(): void
@@ -93,7 +93,7 @@ public function testOrWhereJson(): void
             ->fetchOne();
 
         $this->assertSame(2, $user->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $user->settings);
     }
 
     public function testOrWhereJsonWithRelation(): void
@@ -105,7 +105,7 @@ public function testOrWhereJsonWithRelation(): void
             ->fetchOne();
 
         $this->assertSame(2, $post->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $post->user->settings);
     }
 
     public function testWhereJsonContains(): void
@@ -114,7 +114,7 @@ public function testWhereJsonContains(): void
         $users = $selector->whereJsonContains('settings->foo', ['bar', 'baz'])->fetchAll();
 
         $this->assertSame(1, $users[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($users[0]->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $users[0]->settings);
     }
 
     public function testWhereJsonContainsWithRelation(): void
@@ -123,7 +123,7 @@ public function testWhereJsonContainsWithRelation(): void
         $posts = $selector->whereJsonContains('user.settings->foo', ['bar', 'baz'])->fetchAll();
 
         $this->assertSame(1, $posts[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($posts[0]->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $posts[0]->user->settings);
     }
 
     public function testOrWhereJsonContains(): void
@@ -135,7 +135,7 @@ public function testOrWhereJsonContains(): void
             ->fetchAll();
 
         $this->assertSame(1, $users[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($users[0]->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $users[0]->settings);
     }
 
     public function testOrWhereJsonContainsWithRelation(): void
@@ -147,7 +147,7 @@ public function testOrWhereJsonContainsWithRelation(): void
             ->fetchAll();
 
         $this->assertSame(1, $posts[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($posts[0]->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $posts[0]->user->settings);
     }
 
     public function testWhereJsonDoesntContain(): void
@@ -156,7 +156,7 @@ public function testWhereJsonDoesntContain(): void
         $users = $selector->whereJsonDoesntContain('settings->theme', 'light')->fetchAll();
 
         $this->assertSame(1, $users[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($users[0]->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $users[0]->settings);
     }
 
     public function testWhereJsonDoesntContainWithRelation(): void
@@ -165,7 +165,7 @@ public function testWhereJsonDoesntContainWithRelation(): void
         $posts = $selector->whereJsonDoesntContain('user.settings->theme', 'light')->fetchAll();
 
         $this->assertSame(1, $posts[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($posts[0]->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $posts[0]->user->settings);
     }
 
     public function testOrWhereJsonDoesntContain(): void
@@ -177,7 +177,7 @@ public function testOrWhereJsonDoesntContain(): void
             ->fetchAll();
 
         $this->assertSame(1, $users[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($users[0]->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $users[0]->settings);
     }
 
     public function testOrWhereJsonDoesntContainWithRelation(): void
@@ -189,7 +189,7 @@ public function testOrWhereJsonDoesntContainWithRelation(): void
             ->fetchAll();
 
         $this->assertSame(1, $posts[0]->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($posts[0]->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $posts[0]->user->settings);
     }
 
     public function testWhereJsonContainsKey(): void
@@ -198,7 +198,7 @@ public function testWhereJsonContainsKey(): void
         $user = $selector->whereJsonContainsKey('settings->foo')->fetchOne();
 
         $this->assertSame(1, $user->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $user->settings);
     }
 
     public function testWhereJsonContainsKeyWithRelation(): void
@@ -207,7 +207,7 @@ public function testWhereJsonContainsKeyWithRelation(): void
         $post = $selector->whereJsonContainsKey('user.settings->foo')->fetchOne();
 
         $this->assertSame(1, $post->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $post->user->settings);
     }
 
     public function testOrWhereJsonContainsKey(): void
@@ -219,7 +219,7 @@ public function testOrWhereJsonContainsKey(): void
             ->fetchOne();
 
         $this->assertSame(1, $user->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $user->settings);
     }
 
     public function testOrWhereJsonContainsKeyWithRelation(): void
@@ -231,7 +231,7 @@ public function testOrWhereJsonContainsKeyWithRelation(): void
             ->fetchOne();
 
         $this->assertSame(1, $post->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $post->user->settings);
     }
 
     public function testWhereJsonDoesntContainKey(): void
@@ -240,7 +240,7 @@ public function testWhereJsonDoesntContainKey(): void
         $user = $selector->whereJsonDoesntContainKey('settings->foo')->fetchOne();
 
         $this->assertSame(2, $user->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $user->settings);
     }
 
     public function testWhereJsonDoesntContainKeyWithRelation(): void
@@ -249,7 +249,7 @@ public function testWhereJsonDoesntContainKeyWithRelation(): void
         $post = $selector->whereJsonDoesntContainKey('user.settings->foo')->fetchOne();
 
         $this->assertSame(2, $post->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $post->user->settings);
     }
 
     public function testOrWhereJsonDoesntContainKey(): void
@@ -261,7 +261,7 @@ public function testOrWhereJsonDoesntContainKey(): void
             ->fetchOne();
 
         $this->assertSame(2, $user->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $user->settings);
     }
 
     public function testOrWhereJsonDoesntContainKeyWithRelation(): void
@@ -273,7 +273,7 @@ public function testOrWhereJsonDoesntContainKeyWithRelation(): void
             ->fetchOne();
 
         $this->assertSame(2, $post->id);
-        $this->assertEquals(['theme' => 'light'], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'light'], $post->user->settings);
     }
 
     public function testWhereJsonLength(): void
@@ -282,7 +282,7 @@ public function testWhereJsonLength(): void
         $user = $selector->whereJsonLength('settings->foo', 2)->fetchOne();
 
         $this->assertSame(1, $user->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $user->settings);
     }
 
     public function testWhereJsonLengthWithRelation(): void
@@ -291,7 +291,7 @@ public function testWhereJsonLengthWithRelation(): void
         $post = $selector->whereJsonLength('user.settings->foo', 2)->fetchOne();
 
         $this->assertSame(1, $post->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $post->user->settings);
     }
 
     public function testOrWhereJsonLength(): void
@@ -303,7 +303,7 @@ public function testOrWhereJsonLength(): void
             ->fetchOne();
 
         $this->assertSame(1, $user->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $user->settings);
     }
 
     public function testOrWhereJsonLengthWithRelation(): void
@@ -315,6 +315,6 @@ public function testOrWhereJsonLengthWithRelation(): void
             ->fetchOne();
 
         $this->assertSame(1, $post->id);
-        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], \json_decode($post->user->settings, true));
+        $this->assertEquals(['theme' => 'dark', 'foo' => ['bar', 'baz']], $post->user->settings);
     }
 }
diff --git a/tests/ORM/Functional/Driver/Common/Typecast/Fixture/JsonTypecast.php b/tests/ORM/Functional/Driver/Common/Typecast/Fixture/JsonTypecast.php
@@ -5,8 +5,9 @@
 namespace Cycle\ORM\Tests\Functional\Driver\Common\Typecast\Fixture;
 
 use Cycle\ORM\Parser\CastableInterface;
+use Cycle\ORM\Parser\UncastableInterface;
 
-class JsonTypecast implements CastableInterface
+class JsonTypecast implements CastableInterface, UncastableInterface
 {
     private array $rules = [];
 
@@ -29,7 +30,23 @@ public function cast(array $data): array
                 continue;
             }
 
-            $data[$key] = 'json';
+            $data[$key] = ['json'];
+        }
+
+        return $data;
+    }
+
+    public function uncast(array $data): array
+    {
+        foreach ($this->rules as $column => $rule) {
+            if (!isset($data[$column])) {
+                continue;
+            }
+
+            $data[$column] = match ($rule) {
+                'json' => 'uncast-json',
+                default => (string) $data[$column]
+            };
         }
 
         return $data;