Revamped subquery scoping:

- scope() method is now deprecated
- where clauses and query() method have been fixed
- whereIn() and whereNotIn() (from recent Scout versions) are now supported
- support of soft delete has been refactored

Author: michaelbaril

README.md

@@ -170,11 +170,12 @@ $results = Post::search('you see what happens larry')
 > any effect. See below for the proper way to order results.
 
 If the name of your scope collides with the name of a method of the
-`Baril\Sqlout\Builder` object, you can wrap your scope into the `scope` method:
+`Baril\Sqlout\Builder` object, you still have the option to use Scout's
+`query` method:
 
 ```php
 $results = Post::search('ve vant ze money lebowski')
-    ->scope(function ($query) {
+    ->query(function ($query) {
         $query->within('something');
     })
     ->get();

src/Builder.php

@@ -25,23 +25,6 @@ class Builder extends ScoutBuilder
      */
     public $scopes = [];
 
-    /**
-     * Create a new search builder instance.
-     *
-     * @param  \Illuminate\Database\Eloquent\Model  $model
-     * @param  string  $query
-     * @param  \Closure  $callback
-     * @param  bool  $softDelete
-     * @return void
-     */
-    public function __construct($model, $query, $callback = null, $softDelete = false)
-    {
-        parent::__construct($model, $query, $callback, $softDelete);
-        if ($softDelete) {
-            unset($this->wheres['__soft_deleted']);
-        }
-    }
-
     public function __call($method, $parameters)
     {
         if (static::hasMacro($method)) {
@@ -52,45 +35,12 @@ public function __call($method, $parameters)
         return $this;
     }
 
-    public function scope(Closure $callback)
-    {
-        $this->scopes[] = $callback;
-        return $this;
-    }
-
     /**
-     * Add a constraint to the search query.
-     *
-     * @param  string  $field
-     * @param  mixed  $value
-     * @return $this
+     * @deprecated Will be removed in next major version, use Scout's $builder->query($callback) instead.
      */
-    public function where($field, $value)
-    {
-        $args = func_get_args();
-        $this->scopes[] = ['where', $args];
-        return $this;
-    }
-
-    /**
-     * Include soft deleted records in the results.
-     *
-     * @return $this
-     */
-    public function withTrashed()
-    {
-        $this->scopes[] = ['withTrashed', []];
-        return $this;
-    }
-
-    /**
-     * Include only soft deleted records in the results.
-     *
-     * @return $this
-     */
-    public function onlyTrashed()
+    public function scope(Closure $callback)
     {
-        $this->scopes[] = ['onlyTrashed', []];
+        $this->scopes[] = $callback;
         return $this;
     }
 

src/Engine.php

@@ -162,13 +162,6 @@ protected function performSearch(Builder $builder, array $options = [])
                 ->groupBy('record_id')
                 ->selectRaw("sum(weight * (match(content) against (? $mode))) as _score", [$terms])
                 ->addSelect(['record_type', 'record_id']);
-        foreach ($builder->wheres as $field => $value) {
-            if (is_array($value) || $value instanceof Arrayable) {
-                $query->whereIn($field, $value);
-            } else {
-                $query->where($field, $value);
-            }
-        }
 
         // Order clauses:
         if (!$builder->orders) {
@@ -193,16 +186,8 @@ protected function performSearch(Builder $builder, array $options = [])
             }
         }
 
-        // Applying scopes to the model query:
         $query->whereHasMorph('record', get_class($builder->model), function ($query) use ($builder) {
-            foreach ($builder->scopes as $scope) {
-                if ($scope instanceof Closure) {
-                    $scope($query);
-                } else {
-                    list($method, $parameters) = $scope;
-                    $query->$method(...$parameters);
-                }
-            }
+            $this->applyQueryScopes($builder, $query);
         });
 
         // Applying limit/offset:
@@ -226,6 +211,51 @@ protected function performSearch(Builder $builder, array $options = [])
         return $results;
     }
 
+    /**
+     * @param  \Baril\Sqlout\Builder  $builder
+     * @param  \Illuminate\Database\Eloquent\Query\Builder  $query
+     * @return void
+     */
+    protected function applyQueryScopes($builder, $query)
+    {
+        $softDeleted = $builder->wheres['__soft_deleted'] ?? null;
+        if (!method_exists($builder->model, 'bootSoftDeletes')) {
+            // Model is not soft deletable
+        } elseif (is_null($softDeleted)) {
+            $query->withTrashed();
+        } elseif ($softDeleted) {
+            $query->onlyTrashed();
+        } else {
+            $query->withoutTrashed();
+        }
+        unset($builder->wheres['__soft_deleted']);
+        foreach ($builder->wheres as $field => $value) {
+            if (is_array($value) || $value instanceof Arrayable) {
+                $query->whereIn($field, $value);
+            } else {
+                $query->where($field, $value);
+            }
+        }
+        foreach ($builder->whereIns ?? [] as $field => $values) {
+            $query->whereIn($field, $values);
+        }
+        foreach ($builder->whereNotIns ?? [] as $field => $values) {
+            $query->whereNotIn($field, $values);
+        }
+        foreach ($builder->scopes as $scope) {
+            if ($scope instanceof Closure) {
+                $scope($query);
+            } else {
+                list($method, $parameters) = $scope;
+                $query->$method(...$parameters);
+            }
+        }
+        if ($builder->queryCallback) {
+            $callback = $builder->queryCallback;
+            $callback($query);
+        }
+    }
+
     /**
      * Pluck and return the primary keys of the given results.
      *

tests/Models/Comment.php

@@ -12,6 +12,8 @@ class Comment extends Model
     use HasFactory;
     use Searchable;
 
+    protected $guarded = [];
+
     public function post()
     {
         return $this->belongsTo(Post::class);

tests/Models/Post.php

@@ -14,6 +14,8 @@ class Post extends Model
     use SoftDeletes;
     use Searchable;
 
+    protected $guarded = [];
+
     protected $weights = [
         'title' => 4,
     ];

tests/SearchTest.php

@@ -107,7 +107,51 @@ public function test_restricted_search()
         $this->assertEquals($posts[2]->id, $results[0]->id);
     }
 
-    public function test_where_and_forwarded_scope()
+    public function test_wheres()
+    {
+        Comment::query()->update([
+            'author' => 'kiki',
+            'text' => 'kuku',
+            'post_id' => 1,
+        ]);
+        Comment::all()->searchable();
+        $comments = Comment::all();
+        $comments[0]->update([
+            'author' => 'toto',
+            'post_id' => 2,
+        ]);
+        $comments[1]->update([
+            'author' => 'toto',
+        ]);
+        $comments[2]->update([
+            'author' => 'tutu',
+            'post_id' => 2,
+        ]);
+
+        $search = Comment::search('kuku')->where('author', 'toto');
+        $this->assertEquals(2, $search->count());
+        $this->assertEquals(2, $search->get()->count());
+
+        if (method_exists(Builder::class, 'whereIn')) {
+            $search = Comment::search('kuku')->whereIn('author', ['toto', 'tutu']);
+            $this->assertEquals(3, $search->count());
+            $this->assertEquals(3, $search->get()->count());
+    
+            $search = Comment::search('kuku')
+                ->whereIn('author', ['toto', 'kiki'])
+                ->where('post_id', 1);
+            $this->assertEquals(3, $search->count());
+            $this->assertEquals(3, $search->get()->count());
+        }
+
+        if (method_exists(Builder::class, 'whereNotIn')) {
+            $search = Comment::search('kuku')->whereNotIn('author', ['toto', 'tutu']);
+            $this->assertEquals(2, $search->count());
+            $this->assertEquals(2, $search->get()->count());
+        }
+    }
+
+    public function test_forwarded_scope()
     {
         Comment::query()->update(['text' => 'schtroumpf']);
         Comment::all()->searchable();
@@ -117,15 +161,11 @@ public function test_where_and_forwarded_scope()
 
         $this->assertEquals(5, Comment::search('schtroumpf')->count());
 
-        $results = Comment::search('schtroumpf')->where('author', 'gargamel')->get();
-        $this->assertCount(1, $results);
-        $this->assertEquals($comment->id, $results[0]->id);
-
         $results = Comment::search('schtroumpf')->author('gargamel')->get();
         $this->assertCount(1, $results);
         $this->assertEquals($comment->id, $results[0]->id);
 
-        $results = Comment::search('schtroumpf')->scope(function ($builder) {
+        $results = Comment::search('schtroumpf')->query(function ($builder) {
             $builder->author('gargamel');
         })->get();
         $this->assertCount(1, $results);