Add simplePaginate() and migrate to protected properties and methods (#11)

Author: mewejo

.gitignore

@@ -5,3 +5,4 @@ vendor
 coverage
 .phpunit.result.cache
 .phpunit.result.cache
+.idea

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-cross-eloquent-search` will be documented in this file
 
+## 1.8.0 - 2020-12-23
+
+- Support for simple pagination (credit to @mewejo).
+
 ## 1.7.0 - 2020-12-16
 
 - Added a `count` method.

README.md

@@ -119,6 +119,19 @@ Search::add(Post::class, 'title')
     ->get('build');
 ```
 
+You may also use [simple pagination](https://laravel.com/docs/master/pagination#simple-pagination). This will return an instance of `\Illuminate\Contracts\Pagination\Paginator`, which is not length aware:
+
+```php
+Search::add(Post::class, 'title')
+    ->add(Video::class, 'title')
+
+    ->simplePaginate()
+    // or
+    ->simplePaginate($perPage = 15, $pageName = 'page', $page = 1)
+
+    ->get('build');
+```
+
 ### Constraints and scoped queries
 
 Instead of the class name, you can also pass an instance of the [Eloquent query builder](https://laravel.com/docs/master/eloquent#retrieving-models) to the `add` method. This allows you to add constraints to each model.

src/ModelToSearchThrough.php

@@ -12,22 +12,22 @@ class ModelToSearchThrough
     /**
      * Builder to search through.
      */
-    private Builder $builder;
+    protected Builder $builder;
 
     /**
      * The columns to search through.
      */
-    private Collection $columns;
+    protected Collection $columns;
 
     /**
      * Order column.
      */
-    private string $orderByColumn;
+    protected string $orderByColumn;
 
     /**
      * Unique key of this instance.
      */
-    private int $key;
+    protected int $key;
 
     /**
      * @param \Illuminate\Database\Eloquent\Builder $builder
@@ -82,7 +82,7 @@ public function getQualifiedColumns(): Collection
      *
      * @return \Illuminate\Database\Eloquent\Model
      */
-    private function getModel(): Model
+    protected function getModel(): Model
     {
         return $this->builder->getModel();
     }
@@ -108,7 +108,7 @@ public function getModelKey($suffix = 'key'): string
      * @param string $column
      * @return string
      */
-    private function qualifyColumn(string $column): string
+    protected function qualifyColumn(string $column): string
     {
         return $this->getModel()->qualifyColumn($column);
     }

src/Search.php

@@ -12,6 +12,7 @@
  * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher startWithWildcard()
  * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher add($query, $columns, string $orderByColumn = 'updated_at')
  * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher paginate($perPage = 15, $pageName = 'page', $page = null)
+ * @method static \ProtoneMedia\LaravelCrossEloquentSearch\Searcher simplePaginate($perPage = 15, $pageName = 'page', $page = null)
  * @method static \Illuminate\Support\Collection parseTerms(string $terms, callable $callback = null)
  * @method static \Illuminate\Database\Eloquent\Collection|\Illuminate\Contracts\Pagination\LengthAwarePaginator get(string $terms = null)
  *

src/Searcher.php

@@ -15,49 +15,54 @@ class Searcher
     /**
      * Collection of models to search through.
      */
-    private Collection $modelsToSearchThrough;
+    protected Collection $modelsToSearchThrough;
 
     /**
      * Sort direction.
      */
-    private string $orderByDirection;
+    protected string $orderByDirection;
 
     /**
      * Start the search term with a wildcard.
      */
-    private bool $startWithWildcard = false;
+    protected bool $startWithWildcard = false;
 
     /**
      * Allow an empty search query.
      */
-    private bool $allowEmptySearchQuery = false;
+    protected bool $allowEmptySearchQuery = false;
 
     /**
      * Collection of search terms.
      */
-    private Collection $terms;
+    protected Collection $terms;
 
     /**
      * The number of items to be shown per page.
      */
-    private int $perPage = 15;
+    protected int $perPage = 15;
 
     /**
      * The query string variable used to store the page.
      */
-    private string $pageName = 'page';
+    protected string $pageName = 'page';
 
     /**
      * Parse the search term into multiple terms.
      */
-    private bool $parseTerm = true;
+    protected bool $parseTerm = true;
+
+    /**
+     * Use simplePaginate() on Eloquent\Builder vs paginate()
+     */
+    protected bool $simplePaginate = false;
 
     /**
      * Current page.
      *
      * @var int|null
      */
-    private $page;
+    protected $page;
 
     /**
      * Initialises the instanace with a fresh Collection and default sort.
@@ -170,9 +175,27 @@ public function startWithWildcard(): self
      */
     public function paginate($perPage = 15, $pageName = 'page', $page = null): self
     {
-        $this->page     = $page ?: Paginator::resolveCurrentPage($pageName);
-        $this->pageName = $pageName;
-        $this->perPage  = $perPage;
+        $this->page           = $page ?: Paginator::resolveCurrentPage($pageName);
+        $this->pageName       = $pageName;
+        $this->perPage        = $perPage;
+        $this->simplePaginate = false;
+
+        return $this;
+    }
+
+    /**
+     * Paginate using simple pagination.
+     *
+     * @param integer $perPage
+     * @param string $pageName
+     * @param int|null $page
+     * @return self
+     */
+    public function simplePaginate($perPage = 15, $pageName = 'page', $page = null): self
+    {
+        $this->paginate($perPage, $pageName, $page);
+
+        $this->simplePaginate = true;
 
         return $this;
     }
@@ -201,7 +224,7 @@ public function parseTerms(string $terms, callable $callback = null): Collection
      * @throws \ProtoneMedia\LaravelCrossEloquentSearch\EmptySearchQueryException
      * @return self
      */
-    private function initializeTerms(string $terms): self
+    protected function initializeTerms(string $terms): self
     {
         $terms = $this->parseTerm ? $this->parseTerms($terms) : $terms;
 
@@ -241,7 +264,7 @@ public function addSearchQueryToBuilder(Builder $builder, ModelToSearchThrough $
      * @param \ProtoneMedia\LaravelCrossEloquentSearch\ModelToSearchThrough $currentModel
      * @return array
      */
-    private function makeSelects(ModelToSearchThrough $currentModel): array
+    protected function makeSelects(ModelToSearchThrough $currentModel): array
     {
         return $this->modelsToSearchThrough->flatMap(function (ModelToSearchThrough $modelToSearchThrough) use ($currentModel) {
             $qualifiedKeyName = $qualifiedOrderByColumnName = 'null';
@@ -264,7 +287,7 @@ private function makeSelects(ModelToSearchThrough $currentModel): array
      *
      * @return string
      */
-    private function makeOrderBy(): string
+    protected function makeOrderBy(): string
     {
         $modelOrderKeys = $this->modelsToSearchThrough->map->getModelKey('order')->implode(',');
 
@@ -276,7 +299,7 @@ private function makeOrderBy(): string
      *
      * @return \Illuminate\Support\Collection
      */
-    private function buildQueries(): Collection
+    protected function buildQueries(): Collection
     {
         return $this->modelsToSearchThrough->map(function (ModelToSearchThrough $modelToSearchThrough) {
             return $modelToSearchThrough->getFreshBuilder()
@@ -293,7 +316,7 @@ private function buildQueries(): Collection
       *
       * @return
       */
-    private function getCompiledQueryBuilder(): QueryBuilder
+    protected function getCompiledQueryBuilder(): QueryBuilder
     {
         $queries = $this->buildQueries();
 
@@ -312,13 +335,16 @@ private function getCompiledQueryBuilder(): QueryBuilder
      *
      * @return \Illuminate\Support\Collection|\Illuminate\Contracts\Pagination\LengthAwarePaginator
      */
-    private function getIdAndOrderAttributes()
+    protected function getIdAndOrderAttributes()
     {
         $query = $this->getCompiledQueryBuilder();
 
+        // Determine the pagination method to call on Eloquent\Builder
+        $paginateMethod = $this->simplePaginate ? 'simplePaginate' : 'paginate';
+
         // get all results or limit the results by pagination
         return $this->perPage
-            ? $query->paginate($this->perPage, ['*'], $this->pageName, $this->page)
+            ? $query->{$paginateMethod}($this->perPage, ['*'], $this->pageName, $this->page)
             : $query->get();
 
         // the collection will be something like:
@@ -345,7 +371,7 @@ private function getIdAndOrderAttributes()
      * @param \Illuminate\Support\Collection|\Illuminate\Contracts\Pagination\LengthAwarePaginator $results
      * @return \Illuminate\Support\Collection
      */
-    private function getModelsPerType($results)
+    protected function getModelsPerType($results)
     {
         return $this->modelsToSearchThrough
             ->keyBy->getModelKey()

tests/SearchTest.php

@@ -3,6 +3,7 @@
 namespace ProtoneMedia\LaravelCrossEloquentSearch\Tests;
 
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Carbon;
 use ProtoneMedia\LaravelCrossEloquentSearch\EmptySearchQueryException;
 use ProtoneMedia\LaravelCrossEloquentSearch\Search;
@@ -258,4 +259,57 @@ public function it_can_eager_load_relations()
         $this->assertEquals(10, $results->first()->comments_count);
         $this->assertTrue($results->first()->relationLoaded('comments'));
     }
+
+    /** @test */
+    public function it_uses_length_aware_paginator_by_default()
+    {
+        $search = Search::add(Post::class, 'title', 'published_at')
+            ->add(Video::class, 'title', 'published_at')
+            ->orderByDesc();
+
+        $results = $search->paginate()->get('foo');
+
+        $this->assertInstanceOf(LengthAwarePaginator::class, $results);
+    }
+
+    /** @test */
+    public function it_can_use_simple_paginator()
+    {
+        $search = Search::new()
+            ->add(Post::class, 'title', 'published_at')
+            ->add(Video::class, 'title', 'published_at')
+            ->orderByDesc();
+
+        $results = $search->simplePaginate()->get('foo');
+
+        $this->assertInstanceOf(Paginator::class, $results);
+    }
+
+    /** @test */
+    public function it_can_simple_paginate_the_results()
+    {
+        $postA  = Post::create(['title' => 'foo', 'published_at' => now()->addDays(1)]);
+        $postB  = Post::create(['title' => 'foo', 'published_at' => now()->addDays(2)]);
+        $videoA = Video::create(['title' => 'foo', 'published_at' => now()]);
+        $videoB = Video::create(['title' => 'foo', 'published_at' => now()->addDays(3)]);
+
+        $search = Search::new()
+            ->add(Post::class, 'title', 'published_at')
+            ->add(Video::class, 'title', 'published_at')
+            ->orderByDesc();
+
+        $resultsPage1 = $search->simplePaginate(2, 'page', 1)->get('foo');
+        $resultsPage2 = $search->simplePaginate(2, 'page', 2)->get('foo');
+
+        $this->assertInstanceOf(Paginator::class, $resultsPage1);
+        $this->assertInstanceOf(Paginator::class, $resultsPage2);
+
+        $this->assertCount(2, $resultsPage1);
+
+        $this->assertTrue($resultsPage1->first()->is($videoB));
+        $this->assertTrue($resultsPage1->last()->is($postB));
+
+        $this->assertTrue($resultsPage2->first()->is($postA));
+        $this->assertTrue($resultsPage2->last()->is($videoA));
+    }
 }