allowEmptySearchQuery() + new() method

Author: pascalbaljet

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to `laravel-cross-eloquent-search` will be documented in this file
 
+## 1.4.0 - 2020-10-28
+
+- Allow empty search terms
+- Added `new()` method method
+
+## 1.3.1 - 2020-10-28
+
+- Docs
+
 ## 1.3.0 - 2020-09-24
 
 - Support for Laravel 8.0

src/Search.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /*
+ * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher new()
  * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher orderByAsc()
  * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher orderByDesc()
  * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher dontParseTerm()

src/SearchFactory.php

@@ -8,6 +8,16 @@ class SearchFactory
 {
     use ForwardsCalls;
 
+    /**
+     * Returns a new Searcher instance.
+     *
+     * @return \ProtoneMedia\LaravelCrossEloquentSearch\Searcher
+     */
+    public function new(): Searcher
+    {
+        return new Searcher;
+    }
+
     /**
     * Handle dynamic method calls into a new Searcher instance.
     *
@@ -18,7 +28,7 @@ class SearchFactory
     public function __call($method, $parameters)
     {
         return $this->forwardCallTo(
-            new Searcher,
+            $this->new(),
             $method,
             $parameters
         );

src/Searcher.php

@@ -26,6 +26,11 @@ class Searcher
      */
     private bool $startWithWildcard = false;
 
+    /**
+     * Allow an empty search query.
+     */
+    private bool $allowEmptySearchQuery = false;
+
     /**
      * Collection of search terms.
      */
@@ -97,6 +102,16 @@ public function dontParseTerm(): self
         return $this;
     }
 
+    /**
+     * Allow empty search terms.
+     */
+    public function allowEmptySearchQuery(): self
+    {
+        $this->allowEmptySearchQuery = true;
+
+        return $this;
+    }
+
     /**
      * Add a model to search through.
      *
@@ -180,7 +195,7 @@ private function initializeTerms(string $terms): self
             ->filter()
             ->map(fn ($term) => ($this->startWithWildcard ? '%' : '') . "{$term}%");
 
-        if ($this->terms->isEmpty()) {
+        if (!$this->allowEmptySearchQuery && $this->terms->isEmpty()) {
             throw new EmptySearchQueryException;
         }
 

tests/SearchTest.php

@@ -119,6 +119,23 @@ public function it_throws_an_exception_when_the_query_is_empty()
         $this->fail('Should have thrown EmptySearchQueryException.');
     }
 
+    /** @test */
+    public function it_can_search_without_a_term()
+    {
+        Post::create(['title' => 'foo']);
+        Post::create(['title' => 'bar']);
+        Video::create(['title' => 'foo']);
+        Video::create(['title' => 'bar']);
+
+        $results = Search::new()
+            ->add(Post::class, 'title')
+            ->add(Video::class, 'title')
+            ->allowEmptySearchQuery()
+            ->get();
+
+        $this->assertCount(4, $results);
+    }
+
     /** @test */
     public function it_can_search_on_the_left_side_of_the_term()
     {