morphable extended support

AnourValar · Nov 16, 2024 · 756c123 · 756c123
1 parent 6d7a868
commit 756c123
Show file tree

Hide file tree

Showing 5 changed files with 109 additions and 6 deletions.
diff --git a/src/Grammars/ModelGrammar.php b/src/Grammars/ModelGrammar.php
@@ -50,17 +50,24 @@ protected function unpack(\AnourValar\EloquentSerialize\Package $package): \Illu
      */
     private function setup(): void
     {
-        \Illuminate\Database\Eloquent\Relations\Relation::macro('importExtraParametersForSerialize', function (array $params) {
+        $serializeMorphableEager = fn ($value) => $this->serializeMorphableEager($value);
+        $unserializeMorphableEager = fn ($value) => $this->unserializeMorphableEager($value);
+
+        \Illuminate\Database\Eloquent\Relations\Relation::macro('importExtraParametersForSerialize', function (array $params) use ($unserializeMorphableEager) {
             foreach ($params as $key => $value) {
+                if ($key == 'morphableEagerLoads' || $key == 'morphableEagerLoadCounts') {
+                    $value = $unserializeMorphableEager($value);
+                }
+
                 $this->$key = $value;
             }
         });
 
-        \Illuminate\Database\Eloquent\Relations\Relation::macro('exportExtraParametersForSerialize', function () {
+        \Illuminate\Database\Eloquent\Relations\Relation::macro('exportExtraParametersForSerialize', function () use ($serializeMorphableEager) {
             if ($this instanceof \Illuminate\Database\Eloquent\Relations\MorphTo) {
                 return [
-                    'morphableEagerLoads' => $this->morphableEagerLoads,
-                    'morphableEagerLoadCounts' => $this->morphableEagerLoadCounts,
+                    'morphableEagerLoads' => $serializeMorphableEager($this->morphableEagerLoads),
+                    'morphableEagerLoadCounts' => $serializeMorphableEager($this->morphableEagerLoadCounts),
                     'morphableConstraints' => $this->morphableConstraints,
                 ];
             }
@@ -77,4 +84,67 @@ private function setup(): void
             return null;
         });
     }
+
+    /**
+     * @param array $value
+     * @return array
+     * @psalm-suppress UndefinedClass
+     */
+    private function serializeMorphableEager(array $value): array
+    {
+        foreach ($value as $class => &$items) {
+            foreach ($items as $relation => &$item) {
+                if (! is_callable($item)) {
+                    continue;
+                }
+
+                if (! method_exists($class, $relation)) {
+                    throw new \RuntimeException("Serialization error. Does relation '{$relation}' exists in the model '{$class}' ?");
+                }
+
+                // ALT: $obj->cleanStaticConstraints($item['builder'], $obj->packQueryBuilder((new $class)->getQuery()->getQuery()));
+                $eloquentBuilder = (new $class())->$relation()->getModel()->newQuery();
+                $item($eloquentBuilder);
+
+                $item = [
+                    'eloquent' => $this->packEloquentBuilder($eloquentBuilder),
+                    'builder' => $this->packQueryBuilder($eloquentBuilder->getQuery()),
+                ];
+            }
+            unset($item);
+        }
+        unset($items);
+
+        return $value;
+    }
+
+    /**
+     * @param array $value
+     * @return array
+     */
+    private function unserializeMorphableEager(array $value): array
+    {
+        foreach ($value as &$items) {
+            foreach ($items as &$item) {
+                if (! is_array($item)) {
+                    continue;
+                }
+
+                $item = function ($query) use ($item) {
+                    if ($query instanceof \Illuminate\Database\Eloquent\Builder) {
+                        $this->unpackEloquentBuilder($item['eloquent'], $query);
+                        $this->unpackQueryBuilder($item['builder'], $query->getQuery());
+                    } else {
+                        $eloquent = $query->getQuery();
+                        $this->unpackEloquentBuilder($item['eloquent'], $eloquent);
+                        $this->unpackQueryBuilder($item['builder'], $query->getBaseQuery());
+                    }
+                };
+            }
+            unset($item);
+        }
+        unset($items);
+
+        return $value;
+    }
 }
diff --git a/tests/AbstractSuite.php b/tests/AbstractSuite.php
@@ -97,7 +97,7 @@ protected function setUpSeeder()
         factory(File::class)->times(40)->create();
 
         factory(Post::class)->times(10)->create();
-        factory(Tag::class)->times(10)->create();
+        factory(Tag::class)->times(30)->create();
     }
 
     /**

diff --git a/tests/EagerTest.php b/tests/EagerTest.php
@@ -333,6 +333,7 @@ public function testMorphTo()
             Tag::with(['taggable' => function (\Illuminate\Database\Eloquent\Relations\MorphTo $morphTo) {
                 $morphTo->morphWith([
                     Post::class => ['user'],
+                    UserPhone::class => ['userPhoneNote'],
                 ]);
             }])
         );
@@ -342,6 +343,7 @@ public function testMorphTo()
             Tag::with(['taggable' => function (\Illuminate\Database\Eloquent\Relations\MorphTo $morphTo) {
                 $morphTo->morphWithCount([
                     Post::class => ['user'],
+                    UserPhone::class => ['userPhoneNote'],
                 ]);
             }])
         );
@@ -352,6 +354,32 @@ public function testMorphTo()
                 $morphOne->with('taggable');
             }])
         );
+
+        // Nested - closure
+        $this->compare(
+            Tag::with(['taggable' => function (\Illuminate\Database\Eloquent\Relations\MorphTo $morphTo) {
+                $morphTo->morphWith([
+                    Post::class => [
+                        'user' => fn ($query) => $query->with('userPhones')->where('id', '>', 0)->whereIn('sort', [1, 2, 3, 4, 5]),
+                        'tag' => fn ($query) => $query->where('id', '>', 5),
+                    ],
+                    UserPhone::class => ['user', 'userPhoneNote' => fn ($query) => $query->whereNotNull('note')],
+                ]);
+            }])
+        );
+
+        // Nested count - closure
+        $this->compare(
+            Tag::with(['taggable' => function (\Illuminate\Database\Eloquent\Relations\MorphTo $morphTo) {
+                $morphTo->morphWithCount([
+                    Post::class => [
+                        'user' => fn ($query) => $query->with('userPhones')->where('id', '>', 0)->whereIn('sort', [1, 2, 3, 4, 5]),
+                        'tag' => fn ($query) => $query->where('id', '>', 5),
+                    ],
+                    UserPhone::class => ['user', 'userPhoneNote' => fn ($query) => $query->whereNotNull('note')],
+                ]);
+            }])
+        );
     }
 
     /**

diff --git a/tests/Models/UserPhone.php b/tests/Models/UserPhone.php
@@ -4,6 +4,11 @@
 
 class UserPhone extends \Illuminate\Database\Eloquent\Model
 {
+    public function tag()
+    {
+        return $this->morphOne(Tag::class, 'taggable');
+    }
+
     /**
      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */

diff --git a/tests/factories/Factory.php b/tests/factories/Factory.php
@@ -98,6 +98,6 @@
         'taggable_id' => function () use ($posts) {
             return $posts->shuffle()->first();
         },
-        'taggable_type' => Post::class,
+        'taggable_type' => $faker->randomElement([Post::class, UserPhone::class]),
     ];
 });