Feature: Aspect Search Result Limit

README.md

@@ -156,6 +156,17 @@ $searchResults = (new Search())
    ->search('john');
 ```
 
+### Limiting aspect results
+
+It is possible to limit the amount of results returned by each aspect by calling `limitAspectResults` prior to performing the search.
+
+```php
+$searchResults = (new Search())
+    ->registerAspect(BlogPostAspect::class)
+    ->limitAspectResults(50)
+    ->search('How To');
+```
+
 ### Rendering search results
 
 Here's an example on rendering search results:

src/ModelSearchAspect.php

@@ -106,6 +106,10 @@ public function getResults(string $term): Collection
 
         $this->addSearchConditions($query, $term);
 
+        if($this->limit) {
+            $query->limit($this->limit);
+        }
+
         return $query->get();
     }
 

src/Search.php

@@ -47,6 +47,15 @@ public function getSearchAspects(): array
         return $this->aspects;
     }
 
+    public function limitAspectResults(int $limit) : self
+    {
+        collect($this->getSearchAspects())->each(function(SearchAspect $aspect) use ($limit) {
+           $aspect->limit($limit);
+        });
+
+        return $this;
+    }
+
     public function search(string $query, ?User $user = null): SearchResultCollection
     {
         return $this->perform($query, $user);

src/SearchAspect.php

@@ -7,6 +7,9 @@
 
 abstract class SearchAspect
 {
+    /** @var int */
+    protected $limit;
+
     abstract public function getResults(string $term): Collection;
 
     public function getType(): string
@@ -23,4 +26,9 @@ public function getType(): string
 
         return Str::plural($type);
     }
+
+    public function limit($limit) : void
+    {
+        $this->limit = $limit;
+    }
 }

tests/SearchTest.php

@@ -214,4 +214,43 @@ public function it_can_register_a_model_search_aspect_with_a_attributes_from_a_c
 
         $this->assertCount(2, $attributes);
     }
+
+    /** @test */
+    public function it_can_limit_aspect_results()
+    {
+        $search = new Search();
+
+        TestModel::createWithName('Android 16');
+        TestModel::createWithName('Android 17');
+        TestModel::createWithName('Android 18');
+        TestModel::createWithName('Android 19');
+        TestModel::createWithName('Android 20');
+        TestModel::createWithName('Android 21');
+
+        $search->registerModel(TestModel::class, function (ModelSearchAspect $modelSearchAspect) {
+            $modelSearchAspect
+                ->addSearchableAttribute('name');
+        });
+        $results = $search->limitAspectResults(2)->perform('android');
+        $this->assertCount(2, $results);
+    }
+
+    /** @test */
+    public function it_can_limit_multiple_aspect_results()
+    {
+        $search = new Search();
+
+        TestModel::createWithName('alex doe');
+        TestModel::createWithName('alex doe the second');
+        TestModel::createWithName('alex doe the third');
+        TestModel::createWithName('alex doe the fourth');
+        TestModel::createWithName('jenna');
+
+        // This will return 2 as it's results are hard coded
+        $search->registerAspect(CustomNameSearchAspect::class);
+        // Our limiter should apply to the second aspect registered here and will make it return only 2
+        $search->registerModel(TestModel::class, 'name');
+        $results = $search->limitAspectResults(2)->perform('doe');
+        $this->assertCount(4, $results);
+    }
 }