Merge pull request #4 from kettasoft/feature/invoker

Add Serializable support to Invoker

Author: kettasoft

composer.json

@@ -33,7 +33,8 @@
   "require": {
     "php": "^8.0",
     "illuminate/database": "^8.0|^9.0|^10.0|^11.0|^12.0",
-    "illuminate/support": "^8.0|^9.0|^10.0|^11.0|^12.0"
+    "illuminate/support": "^8.0|^9.0|^10.0|^11.0|^12.0",
+    "opis/closure": "^4.3"
   },
   "require-dev": {
     "mockery/mockery": "^1.3.2",

composer.lock

@@ -3,11 +3,17 @@
 namespace Kettasoft\Filterable\Foundation;
 
 use Closure;
+use Serializable;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\App;
+use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Traits\ForwardsCalls;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Kettasoft\Filterable\Foundation\Traits\HandleFluentReturn;
 use Kettasoft\Filterable\Foundation\Contracts\QueryBuilderInterface;
 
+use function Opis\Closure\{serialize, unserialize};
+
 /**
  * Class Invoker
  *
@@ -17,7 +23,7 @@
  * 
  * @link https://kettasoft.github.io/filterable/execution/invoker
  */
-class Invoker implements QueryBuilderInterface
+class Invoker implements QueryBuilderInterface, Serializable
 {
   use ForwardsCalls,
     HandleFluentReturn;
@@ -48,7 +54,7 @@ class Invoker implements QueryBuilderInterface
    *
    * @param \Illuminate\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder|QueryBuilderInterface $builder
    */
-  public function __construct(protected EloquentBuilder|QueryBuilderInterface $builder) {}
+  public function __construct(protected EloquentBuilder|Builder|QueryBuilderInterface $builder) {}
 
   /**
    * Instantiate a new Invoker object using a builder.
@@ -133,6 +139,16 @@ public function onError(Closure $callback)
     return $this;
   }
 
+  /**
+   * Get the underlying query builder instance.
+   *
+   * @return Builder|EloquentBuilder|QueryBuilderInterface
+   */
+  public function getBuilder(): EloquentBuilder|Builder|QueryBuilderInterface
+  {
+    return $this->builder;
+  }
+
   /**
    * Dispatch the query execution as a Laravel job.
    *
@@ -161,6 +177,42 @@ public function asJob(string $jobClass, array $jobData = [], string|null $queue
     return dispatch($job);
   }
 
+  /**
+   * Serialize the Invoker instance.
+   *
+   * @return string
+   */
+  public function serialize(): string
+  {
+    return serialize([
+      'builder_sql' => $this->builder->toSql(),
+      'builder_bindings' => $this->builder->getBindings(),
+      'beforeCallback' => $this->beforeCallback ? serialize($this->beforeCallback) : null,
+      'afterCallback' => $this->afterCallback ? serialize($this->afterCallback) : null,
+      'errorCallback' => $this->errorCallback ? serialize($this->errorCallback) : null
+    ]);
+  }
+
+  /**
+   * Unserialize the Invoker instance.
+   *
+   * @param string $data
+   * @return void
+   */
+  public function unserialize($data): void
+  {
+    $unserialized = unserialize($data);
+    $connection = App::make('db')->connection();
+
+    $this->builder = $connection->table(DB::raw("({$unserialized['builder_sql']}) as t"));
+
+    $this->builder->setBindings($unserialized['builder_bindings']);
+
+    $this->beforeCallback = $unserialized['beforeCallback'];
+    $this->afterCallback = $unserialized['afterCallback'];
+    $this->errorCallback = $unserialized['errorCallback'];
+  }
+
   /**
    * Handles dynamic calls to the builder, and tracks execution time
    * for terminal methods only.

src/Foundation/Invoker.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Kettasoft\Filterable\Tests\Feature\Invoker;
+
+use Kettasoft\Filterable\Tests\Models\Post;
+use Kettasoft\Filterable\Tests\TestCase;
+
+class InvokerSerializationTest extends TestCase
+{
+  public function test_it_can_be_serialized_and_unserialized()
+  {
+    $builder = Post::query();
+    $invoker = new \Kettasoft\Filterable\Foundation\Invoker($builder);
+
+    // Set some callbacks
+    $invoker->beforeExecute(function () {
+      return 'before';
+    });
+    $invoker->afterExecute(function () {
+      return 'after';
+    });
+    $invoker->onError(function () {
+      return 'error';
+    });
+
+    // Serialize the invoker
+    $serialized = serialize($invoker);
+
+    // Unserialize the invoker
+    $unserializedInvoker = unserialize($serialized);
+
+    // Assert that the unserialized object is an instance of Invoker
+    $this->assertInstanceOf(\Kettasoft\Filterable\Foundation\Invoker::class, $unserializedInvoker);
+  }
+}