Merge pull request #1 from LIQRGV/feature/add-sort-by

Allow sort on URL

Author: LIQRGV

src/RequestParser.php

@@ -13,6 +13,7 @@
 use LIQRGV\QueryFilter\Exception\NotModelException;
 use LIQRGV\QueryFilter\Struct\FilterStruct;
 use LIQRGV\QueryFilter\Struct\ModelBuilderStruct;
+use LIQRGV\QueryFilter\Struct\SortStruct;
 
 class RequestParser
 {
@@ -54,17 +55,23 @@ public function getBuilder(): Builder
         $modelBuilderStruct = $this->createModelBuilderStruct($this->request);
         $model = $this->createModel($modelBuilderStruct->baseModelName);
 
-        return $this->applyFilter($model::query(), $modelBuilderStruct->filters);
+        $builder = $this->applyFilter($model::query(), $modelBuilderStruct->filters);
+        $builder = $this->applySorter($builder, $modelBuilderStruct->sorter);
+
+        return $builder;
     }
 
     private function createModelBuilderStruct(Request $request): ModelBuilderStruct
     {
-        $filterQuery = $request->filter ?: [];
+        $queryParam = $request->query;
+        $filterQuery = $queryParam->get('filter') ?? [];
+        $sortQuery = $queryParam->get('sort') ?? null;
 
         $baseModelName = $this->getBaseModelName($request);
         $filters = $this->parseFilter($filterQuery);
+        $sorter = $this->parseSorter($sortQuery);
 
-        return new ModelBuilderStruct($baseModelName, $filters);
+        return new ModelBuilderStruct($baseModelName, $filters, $sorter);
     }
 
     private function getBaseModelName(Request $request): string
@@ -126,6 +133,23 @@ private function parseFilter(array $filterQuery = []): array
         return $filters;
     }
 
+    private function parseSorter(?string $sortQuery): ?SortStruct
+    {
+        if(is_null($sortQuery)) {
+            return null;
+        }
+
+        $fieldPattern = "/^\-?([a-zA-z\_]+)$/";
+        if(preg_match($fieldPattern, $sortQuery, $match)) {
+            $fieldName = $match[1];
+            $direction = $sortQuery[0] == "-" ? "DESC" : "ASC";
+
+            return new SortStruct($fieldName, $direction);
+        }
+
+        return null;
+    }
+
     private function getModelFromNamespaces(string $modelName, array $modelNamespaces)
     {
         foreach ($modelNamespaces as $modelNamespace) {
@@ -150,6 +174,15 @@ private function applyFilter(Builder $builder, array $filters): Builder
         return $builder;
     }
 
+    private function applySorter(Builder $builder, ?SortStruct $sorter)
+    {
+        if(is_null($sorter)) {
+            return $builder;
+        }
+
+        return $builder->orderBy($sorter->fieldName, $sorter->direction);
+    }
+
     private function createModel(string $baseModelName)
     {
         $model = new $baseModelName;

src/Struct/ModelBuilderStruct.php

@@ -12,9 +12,14 @@ class ModelBuilderStruct {
      * @var array
      */
     public $filters;
+    /**
+     * @var SortStruct
+     */
+    public $sorter;
 
-    public function __construct(string $baseModelName, array $filters) {
+    public function __construct(string $baseModelName, array $filters, ?SortStruct $sorter) {
         $this->baseModelName = $baseModelName;
         $this->filters = $filters;
+        $this->sorter = $sorter;
     }
 }

src/Struct/SortStruct.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace LIQRGV\QueryFilter\Struct;
+
+class SortStruct {
+    public $fieldName;
+    public $direction;
+
+    public function __construct($fieldName, $direction) {
+        $this->fieldName = $fieldName;
+        $this->direction = $direction;
+    }
+}

tests/RequestParserTest.php

@@ -63,6 +63,53 @@ function testRequestViaClosure()
         $this->assertEquals('LIQRGV\QueryFilter\Mocks\MockClosureModel', $builderStruct->baseModelName);
     }
 
+    function testSortBy()
+    {
+        $uri = 'some_model';
+        $controllerClass = MockModelController::class;
+        $query = new ParameterBag([
+            "sort" => "-name",
+        ]);
+        $requestParserOptions = [
+            'model_namespaces' => [
+                'LIQRGV\QueryFilter\Mocks',
+            ]
+        ];
+
+        $request = $this->createControllerRequest($uri, $controllerClass, $query, $requestParserOptions);
+
+        $requestParser = new RequestParser($request);
+        $builder = $requestParser->getBuilder();
+
+        $query = $builder->getQuery();
+        $this->assertEquals("mock_models", $query->from);
+        $this->assertEquals("name", $builder->getQuery()->orders[0]['column']);
+        $this->assertEquals("desc", strtolower($builder->getQuery()->orders[0]['direction']));
+    }
+
+    function testSortByWithInvalidField()
+    {
+        $uri = 'some_model';
+        $controllerClass = MockModelController::class;
+        $query = new ParameterBag([
+            "sort" => "-name-with-dash",
+        ]);
+        $requestParserOptions = [
+            'model_namespaces' => [
+                'LIQRGV\QueryFilter\Mocks',
+            ]
+        ];
+
+        $request = $this->createControllerRequest($uri, $controllerClass, $query, $requestParserOptions);
+
+        $requestParser = new RequestParser($request);
+        $builder = $requestParser->getBuilder();
+
+        $query = $builder->getQuery();
+        $this->assertEquals("mock_models", $query->from);
+        $this->assertEmpty($builder->getQuery()->orders);
+    }
+
     function testFilterKeywordIn()
     {
         $uri = 'some_model';