Apply ORDER BY clauses set on the builder instance. Resolves #16

Author: Peter Matseykanets

CHANGELOG.md

@@ -1,10 +1,16 @@
 # Changelog
 
+## [2.1.0](https://github.com/pmatseykanets/laravel-scout-postgres/releases/tag/v2.1.0) - 2018-02-23
+
+### Added
+
+- Added support for applying `ORDER BY` clauses set on the builder instance.
+
 ## [2.0.0](https://github.com/pmatseykanets/laravel-scout-postgres/releases/tag/v2.0.0) - 2018-02-09
 
 ### Changed
 
-- Switched to Scout 4 (Laravel 5.6) and PHPUnit 7
+- Switched to Scout 4 (Laravel 5.6) and PHPUnit 7.
 
 ## [1.0.0](https://github.com/pmatseykanets/laravel-scout-postgres/releases/tag/v1.0.0) - 2017-09-03
 

src/PostgresEngine.php

@@ -235,11 +235,9 @@ protected function performSearch(Builder $builder, $perPage = 0, $page = 1)
             ->select($builder->model->getKeyName())
             ->selectRaw("{$this->rankingExpression($builder->model, $indexColumn)} AS rank")
             ->selectRaw('COUNT(*) OVER () AS total_count')
-            ->whereRaw("$indexColumn @@ query")
-            ->orderBy('rank', 'desc')
-            ->orderBy($builder->model->getKeyName());
+            ->whereRaw("$indexColumn @@ query");
 
-        // Transfer the where clauses that were set on the builder instance if any
+        // Apply where clauses that were set on the builder instance if any
         foreach ($builder->wheres as $key => $value) {
             $query->where($key, $value);
             $bindings->push($value);
@@ -253,6 +251,17 @@ protected function performSearch(Builder $builder, $perPage = 0, $page = 1)
             }
         }
 
+        // Apply order by clauses that were set on the builder instance if any
+        foreach ($builder->orders as $order) {
+            $query->orderBy($order['column'], $order['direction']);
+        }
+
+        // Apply default order by clauses (rank and id)
+        if (empty($builder->orders)) {
+            $query->orderBy('rank', 'desc')
+                ->orderBy($builder->model->getKeyName());
+        }
+
         if ($perPage > 0) {
             $query->skip(($page - 1) * $perPage)
                 ->limit($perPage);

tests/PostgresEngineTest.php

@@ -91,22 +91,39 @@ public function test_search()
 
         $skip = 0;
         $limit = 5;
-        $table = $this->setDbExpectations($db, $skip, $limit);
+        $table = $this->setDbExpectations($db);
 
-        $table->shouldReceive('skip')
-                ->with($skip)
-                ->andReturnSelf()
-            ->shouldReceive('limit')
-                ->with($limit)
-                ->andReturnSelf()
-            ->shouldReceive('where')
-                ->with('bar', 1);
+        $table->shouldReceive('skip')->with($skip)->andReturnSelf()
+            ->shouldReceive('limit')->with($limit)->andReturnSelf()
+            ->shouldReceive('where')->with('bar', 1)->andReturnSelf()
+            ->shouldReceive('where')->with('baz', 'qux');
 
         $db->shouldReceive('select')
-            ->with(null, [null, 'foo', 1]);
+            ->with(null, [null, 'foo', 1, 'qux']);
 
         $builder = new Builder(new TestModel(), 'foo');
-        $builder->where('bar', 1)->take(5);
+        $builder->where('bar', 1)
+            ->where('baz', 'qux')
+            ->take(5);
+
+        $engine->search($builder);
+    }
+
+    public function test_search_with_order_by()
+    {
+        list($engine, $db) = $this->getEngine();
+
+        $table = $this->setDbExpectations($db, false);
+
+        $table->shouldReceive('orderBy')->with('bar', 'desc')->andReturnSelf()
+            ->shouldReceive('orderBy')->with('baz', 'asc')->andReturnSelf();
+
+        $db->shouldReceive('select')
+            ->with(null, [null, 'foo']);
+
+        $builder = new Builder(new TestModel(), 'foo');
+        $builder->orderBy('bar', 'desc')
+            ->orderBy('baz', 'asc');
 
         $engine->search($builder);
     }
@@ -247,7 +264,7 @@ protected function getEngine($config = [])
         return [new PostgresEngine($resolver, $config), $db];
     }
 
-    protected function setDbExpectations($db)
+    protected function setDbExpectations($db, $withDefaultOrderBy = true)
     {
         $db->shouldReceive('table')
             ->andReturn($table = Mockery::mock('stdClass'));
@@ -268,14 +285,18 @@ protected function setDbExpectations($db)
                 ->with('COUNT(*) OVER () AS total_count')
                 ->andReturnSelf()
             ->shouldReceive('whereRaw')
-                ->andReturnSelf()
-            ->shouldReceive('orderBy')
-                ->with('rank', 'desc')
-                ->andReturnSelf()
-            ->shouldReceive('orderBy')
-                ->with('id')
-                ->andReturnSelf()
-            ->shouldReceive('toSql');
+                ->andReturnSelf();
+
+        if ($withDefaultOrderBy) {
+            $table->shouldReceive('orderBy')
+                    ->with('rank', 'desc')
+                    ->andReturnSelf()
+                ->shouldReceive('orderBy')
+                    ->with('id')
+                    ->andReturnSelf();
+        }
+
+        $table->shouldReceive('toSql');
 
         return $table;
     }