Add "whereNotIn" support to Meilisearch, Database and Collection engines. (#760)

Author: guestpectacular

src/Builder.php

@@ -62,6 +62,13 @@ class Builder
      */
     public $whereIns = [];
 
+    /**
+     * The "where not in" constraints added to the query.
+     *
+     * @var array
+     */
+    public $whereNotIns = [];
+
     /**
      * The "limit" that should be applied to the search.
      *
@@ -144,6 +151,20 @@ public function whereIn($field, array $values)
         return $this;
     }
 
+    /**
+     * Add a "where not in" constraint to the search query.
+     *
+     * @param  string  $field
+     * @param  array  $values
+     * @return $this
+     */
+    public function whereNotIn($field, array $values)
+    {
+        $this->whereNotIns[$field] = $values;
+
+        return $this;
+    }
+
     /**
      * Include soft deleted records in the results.
      *

src/Engines/CollectionEngine.php

@@ -100,6 +100,11 @@ protected function searchModels(Builder $builder)
                                 $query->whereIn($key, $values);
                             }
                         })
+                        ->when(! $builder->callback && count($builder->whereNotIns) > 0, function ($query) use ($builder) {
+                            foreach ($builder->whereNotIns as $key => $values) {
+                                $query->whereNotIn($key, $values);
+                            }
+                        })
                         ->when($builder->orders, function ($query) use ($builder) {
                             foreach ($builder->orders as $order) {
                                 $query->orderBy($order['column'], $order['direction']);

src/Engines/DatabaseEngine.php

@@ -249,6 +249,10 @@ protected function addAdditionalConstraints(Builder $builder, $query)
             foreach ($builder->whereIns as $key => $values) {
                 $query->whereIn($key, $values);
             }
+        })->when(! $builder->callback && count($builder->whereNotIns) > 0, function ($query) use ($builder) {
+            foreach ($builder->whereNotIns as $key => $values) {
+                $query->whereNotIn($key, $values);
+            }
         })->when(! is_null($builder->queryCallback), function ($query) use ($builder) {
             call_user_func($builder->queryCallback, $query);
         });

src/Engines/MeilisearchEngine.php

@@ -186,16 +186,25 @@ protected function filters(Builder $builder)
                 : sprintf('%s="%s"', $key, $value);
         });
 
-        foreach ($builder->whereIns as $key => $values) {
-            $filters->push(sprintf('%s IN [%s]', $key, collect($values)->map(function ($value) {
-                if (is_bool($value)) {
-                    return sprintf('%s', $value ? 'true' : 'false');
+        $whereInOperators = [
+            'whereIns'    => 'IN',
+            'whereNotIns' => 'NOT IN'
+        ];
+
+        foreach ($whereInOperators as $property => $operator) {
+            if (property_exists($builder, $property)) {
+                foreach ($builder->{$property} as $key => $values) {
+                    $filters->push(sprintf('%s %s [%s]', $key, $operator, collect($values)->map(function ($value) {
+                        if (is_bool($value)) {
+                            return sprintf('%s', $value ? 'true' : 'false');
+                        }
+
+                        return filter_var($value, FILTER_VALIDATE_INT) !== false
+                            ? sprintf('%s', $value)
+                            : sprintf('"%s"', $value);
+                    })->values()->implode(', ')));
                 }
-
-                return filter_var($value, FILTER_VALIDATE_INT) !== false
-                    ? sprintf('%s', $value)
-                    : sprintf('"%s"', $value);
-            })->values()->implode(', ')));
+            }
         }
 
         return $filters->values()->implode(' AND ');

tests/Unit/MeilisearchEngineTest.php

@@ -541,6 +541,25 @@ public function test_where_in_conditions_are_applied()
         $engine->search($builder);
     }
 
+    public function test_where_not_in_conditions_are_applied()
+    {
+        $builder = new Builder(new SearchableModel(), '');
+        $builder->where('foo', 'bar');
+        $builder->where('bar', 'baz');
+        $builder->whereIn('qux', [1, 2]);
+        $builder->whereIn('quux', [1, 2]);
+        $builder->whereNotIn('eaea', [3]);
+        $client = m::mock(Client::class);
+        $client->shouldReceive('index')->once()->andReturn($index = m::mock(Indexes::class));
+        $index->shouldReceive('rawSearch')->once()->with($builder->query, array_filter([
+            'filter' => 'foo="bar" AND bar="baz" AND qux IN [1, 2] AND quux IN [1, 2] AND eaea NOT IN [3]',
+            'hitsPerPage' => $builder->limit,
+        ]))->andReturn([]);
+
+        $engine = new MeilisearchEngine($client);
+        $engine->search($builder);
+    }
+
     public function test_where_in_conditions_are_applied_without_other_conditions()
     {
         $builder = new Builder(new SearchableModel(), '');
@@ -557,6 +576,23 @@ public function test_where_in_conditions_are_applied_without_other_conditions()
         $engine->search($builder);
     }
 
+    public function test_where_not_in_conditions_are_applied_without_other_conditions()
+    {
+        $builder = new Builder(new SearchableModel(), '');
+        $builder->whereIn('qux', [1, 2]);
+        $builder->whereIn('quux', [1, 2]);
+        $builder->whereNotIn('eaea', [3]);
+        $client = m::mock(Client::class);
+        $client->shouldReceive('index')->once()->andReturn($index = m::mock(Indexes::class));
+        $index->shouldReceive('rawSearch')->once()->with($builder->query, array_filter([
+            'filter' => 'qux IN [1, 2] AND quux IN [1, 2] AND eaea NOT IN [3]',
+            'hitsPerPage' => $builder->limit,
+        ]))->andReturn([]);
+
+        $engine = new MeilisearchEngine($client);
+        $engine->search($builder);
+    }
+
     public function test_empty_where_in_conditions_are_applied_correctly()
     {
         $builder = new Builder(new SearchableModel(), '');