Merge pull request #67 from alexgiuvara/master

filter out orderBy duplicates

Author: freekmurze

src/QueryBuilder.php

@@ -222,7 +222,7 @@ protected function findFilter(string $property) : ? Filter
 
     protected function addSortsToQuery(Collection $sorts)
     {
-        $sorts
+        $this->filterDuplicates($sorts)
             ->each(function (string $sort) {
                 $descending = $sort[0] === '-';
 
@@ -232,6 +232,25 @@ protected function addSortsToQuery(Collection $sorts)
             });
     }
 
+    protected function filterDuplicates(Collection $sorts): Collection
+    {
+        if (! is_array($orders = $this->getQuery()->orders)) {
+            return $sorts;
+        }
+
+        return $sorts->reject(function (string $sort) use ($orders) {
+            $toSort = [
+                'column' => ltrim($sort, '-'),
+                'direction' => ($sort[0] === '-') ? 'desc' : 'asc',
+            ];
+            foreach ($orders as $order) {
+                if ($order === $toSort) {
+                    return true;
+                }
+            }
+        });
+    }
+
     protected function addIncludesToQuery(Collection $includes)
     {
         $includes

tests/SortTest.php

@@ -27,20 +27,24 @@ public function setUp()
     /** @test */
     public function it_can_sort_a_collection_ascending()
     {
+        \DB::enableQueryLog();
         $sortedModels = $this
             ->createQueryFromSortRequest('name')
             ->get();
 
+        $this->assertSame(\DB::getQueryLog()[0]['query'], 'select "test_models".* from "test_models" order by "name" asc');
         $this->assertSortedAscending($sortedModels, 'name');
     }
 
     /** @test */
     public function it_can_sort_a_collection_descending()
     {
+        \DB::enableQueryLog();
         $sortedModels = $this
             ->createQueryFromSortRequest('-name')
             ->get();
 
+        $this->assertSame(\DB::getQueryLog()[0]['query'], 'select "test_models".* from "test_models" order by "name" desc');
         $this->assertSortedDescending($sortedModels, 'name');
     }
 
@@ -89,22 +93,26 @@ public function it_wont_sort_if_no_sort_query_parameter_is_given()
     /** @test */
     public function it_uses_default_sort_parameter()
     {
+        \DB::enableQueryLog();
         $sortedModels = QueryBuilder::for(TestModel::class, new Request())
             ->allowedSorts('name')
             ->defaultSort('name')
             ->get();
 
+        $this->assertSame(\DB::getQueryLog()[0]['query'], 'select "test_models".* from "test_models" order by "name" asc');
         $this->assertSortedAscending($sortedModels, 'name');
     }
 
     /** @test */
     public function it_can_allow_multiple_sort_parameters()
     {
+        \DB::enableQueryLog();
         $sortedModels = $this
             ->createQueryFromSortRequest('name')
             ->allowedSorts('id', 'name')
             ->get();
 
+        $this->assertSame(\DB::getQueryLog()[0]['query'], 'select "test_models".* from "test_models" order by "name" asc');
         $this->assertSortedAscending($sortedModels, 'name');
     }
 
@@ -123,14 +131,15 @@ public function it_can_allow_multiple_sort_parameters_as_an_array()
     public function it_can_sort_by_multiple_columns()
     {
         factory(TestModel::class, 3)->create(['name' => 'foo']);
+        \DB::enableQueryLog();
 
         $sortedModels = $this
             ->createQueryFromSortRequest('name,-id')
             ->allowedSorts('name', 'id')
             ->get();
 
         $expected = TestModel::orderBy('name')->orderByDesc('id');
-
+        $this->assertSame(\DB::getQueryLog()[0]['query'], 'select "test_models".* from "test_models" order by "name" asc, "id" desc');
         $this->assertEquals($expected->pluck('id'), $sortedModels->pluck('id'));
     }