order by related updates

Author: begimov

README.md

@@ -139,6 +139,12 @@ Paginate the given query by 'limit' request parameter:
 $news = $this->news->smartPaginate();
 ```
 
+Add an "order by" clause to the query:
+
+```php
+$news = $this->news->orderBy('title', 'desc')->get();
+```
+
 Save a new model and return the instance:
 
 ```php
@@ -276,9 +282,11 @@ $this->news->scope($request)->get();
 ```
 
 ```
-https://example.com/news?orderBy=email&begin=2019-01-24&end=2019-01-26
+https://example.com/news?orderBy=email_desc&begin=2019-01-24&end=2019-01-26
 ```
 
+**orderBy=email_desc** will order by email in descending order, **orderBy=email** - in ascending
+
 You can also build your own custom scopes. In your repository override **scope()** method:
 
 ```php

docs/index.md

@@ -132,6 +132,12 @@ Paginate the given query by 'limit' request parameter:
 $news = $this->news->smartPaginate();
 ```
 
+Add an "order by" clause to the query:
+
+```php
+$news = $this->news->orderBy('title', 'desc')->get();
+```
+
 Save a new model and return the instance:
 
 ```php
@@ -269,9 +275,11 @@ $this->news->scope($request)->get();
 ```
 
 ```
-https://example.com/news?orderBy=email&begin=2019-01-24&end=2019-01-26
+https://example.com/news?orderBy=email_desc&begin=2019-01-24&end=2019-01-26
 ```
 
+**orderBy=email_desc** will order by email in descending order, **orderBy=email** - in ascending
+
 You can also build your own custom scopes. In your repository override **scope()** method:
 
 ```php

src/Contracts/RepositoryInterface.php

@@ -122,4 +122,13 @@ public function findOrFail($id, $columns = ['*']);
      * @return mixed
      */
     public function smartPaginate();
+
+    /**
+     * Add an "order by" clause to the query.
+     *
+     * @param  string  $column
+     * @param  string  $direction
+     * @return $this
+     */
+    public function orderBy($column, $direction = 'asc');
 }

src/Eloquent/BaseRepository.php

@@ -214,4 +214,18 @@ public function smartPaginate()
 
         return $this->paginate($limit);
     }
+
+    /**
+     * Add an "order by" clause to the query.
+     *
+     * @param  string  $column
+     * @param  string  $direction
+     * @return $this
+     */
+    public function orderBy($column, $direction = 'asc')
+    {
+        $this->entity = $this->entity->orderBy($column, $direction);
+
+        return $this;
+    }
 }

src/Scopes/Clauses/OrderByScope.php

@@ -6,21 +6,21 @@
 
 class OrderByScope extends ScopeAbstract
 {
-    public function mappings()
-    {
-        return [
-            // 'id' => 'asc',
-        ];
-    }
-
     public function scope($builder, $value, $scope)
     {
-        $field = $value;
+        $arr = explode('_', $value);
+
+        $orderable = $builder->orderable ?? [];
+
+        if (array_pop($arr) == 'desc' 
+            && in_array($field = implode('_', $arr), $orderable)) {
+
+            return $builder->orderBy($field, 'desc');
 
-        $value = $this->resolveScopeValue($value);
+        } elseif (in_array($value, $orderable)) {
 
-        return is_null($value) 
-            ? $builder->orderBy($field, 'desc') 
-            : $builder->orderBy($field, $value);
+            return $builder->orderBy($value, 'asc');
+        }
+        return $builder;
     }
 }

tests/Stubs/Model.php

@@ -7,6 +7,8 @@
 
 class Model extends BaseModel
 {
+    public $orderable = ['id'];
+
     protected $fillable = ['name'];
 
     public function submodels()

tests/Unit/RepositoryTest.php

@@ -354,6 +354,22 @@ public function it_executes_model_methods()
 
         $result = $repository->submodels();
 
-        $this->assertInstanceOf(BelongsToMany::class, $result);
+        $this->assertInstanceOf(Repository::class, $result);
+    }
+
+    /** @test */
+    public function it_orders_by()
+    {
+        factory(Model::class, 5)->create();
+
+        $repository = new Repository;
+
+        $results = $repository->get();
+
+        $this->assertEquals(1, $results->first()->id);
+
+        $results = $repository->orderBy('id', 'desc')->get();
+
+        $this->assertEquals(5, $results->first()->id);
     }
 }

tests/Unit/Scopes/OrderByTest.php

@@ -9,7 +9,7 @@
 class OrderByTest extends TestCase
 {
     /** @test */
-    public function it_orders_by_desc()
+    public function it_orders_by_asc()
     {
         factory(Model::class, 5)->create();
 
@@ -21,6 +21,22 @@ public function it_orders_by_desc()
 
         $results = $scope->scope(new Model, 'id', '')->get();
 
+        $this->assertEquals(1, $results->first()->id);
+    }
+
+    /** @test */
+    public function it_orders_by_desc()
+    {
+        factory(Model::class, 5)->create();
+
+        $scope = new OrderByScope;
+
+        $results = Model::get();
+
+        $this->assertEquals(1, $results->first()->id);
+
+        $results = $scope->scope(new Model, 'id_desc', '')->get();
+
         $this->assertEquals(5, $results->first()->id);
     }
 }

tests/Unit/Scopes/ScopesTest.php

@@ -15,7 +15,7 @@ public function it_scopes_request_by_orderBy()
         $request = Request::create(
             '/',
             'GET',
-            ['orderBy' => 'id']
+            ['orderBy' => 'id_desc']
         );
 
         $scopes = new Scopes($request, []);