init 🎉

.github/workflows/tests.yml

@@ -0,0 +1,30 @@
+name: Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-interaction --no-progress
+
+      - name: Validate PHP PSR
+        run: composer run-script php-psr
+
+      - name: Run test suite
+        run: composer run-script test

.gitignore

@@ -0,0 +1,6 @@
+/vendor/
+/.phpunit.result.cache
+/phpunit.xml
+/composer.lock
+.idea/
+.TODO

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Multividas Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,31 @@
+<div align="center">
+
+<img width="150" height="150" src="./assets/query-filters.svg" alt="Query Option package logo"/>
+
+# Query Filters
+
+[![Tests](https://github.com/multividas/query-filters/actions/workflows/tests.yml/badge.svg)](https://github.com/multividas/query-filters/actions/workflows/tests.yml)
+[![Total Downloads](https://img.shields.io/packagist/dt/multividas/query-filters.svg?style=flat-square)](https://packagist.org/packages/multividas/query-filters)
+[![License](https://img.shields.io/github/license/multividas/query-filters?style=flat-square)](https://github.com/multividas/query-filters/blob/master/LICENSE.md)
+
+</div>
+
+Composer package to simplify the process of filtering and sorting queries.
+
+---
+
+### Run PHPUnit tests
+
+```sh
+composer test
+```
+
+---
+
+Need helps? Reach us
+
+> Multividas.com Ⓜ️
+
+> Email: contact@multividas.com
+
+🌌 🚀

composer.json

@@ -0,0 +1,53 @@
+{
+    "name": "multividas/query-filters",
+    "description": "composer package to simplify the process of filtering and sorting queries.",
+    "keywords": [
+        "query-filters"
+    ],
+    "type": "package",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "multividas inc",
+            "email": "contact@multividas.com"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Multividas\\QueryFilters\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Multividas\\QueryFilters\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit tests/Feature",
+        "php-psr": [
+            "./vendor/bin/phpcs --standard=PSR2 --encoding=utf-8 --extensions=php src/* tests/*"
+        ]
+    },
+    "minimum-stability": "dev",
+    "require": {
+        "php": "^7.4 || ^8.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "dev-develop",
+        "squizlabs/php_codesniffer": "4.0.x-dev",
+        "phpunit/phpunit": "9.6.x-dev"
+    },
+    "config": {
+        "optimize-autoloader": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Multividas\\QueryFilters\\Providers\\QueryFiltersServiceProvider"
+            ],
+            "aliases": {
+                "QueryFilters": "Multividas\\QueryFilters\\Facades\\QueryFilters"
+            }
+        }
+    }
+}

src/Facades/QueryFilters.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * (c) 2023 Multividas inc. All rights reserved.
+ * Unauthorized use prohibited.
+ * Website: https://www.multividas.com
+ */
+
+namespace Multividas\QueryFilters\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use Multividas\QueryFilters\Interfaces\QueryFiltersRepositoryInterface;
+
+class QueryFilters extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return QueryFiltersRepositoryInterface::class;
+    }
+}

src/Interfaces/QueryFiltersRepositoryInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * (c) 2023 Multividas inc. All rights reserved.
+ * Unauthorized use prohibited.
+ * Website: https://www.multividas.com
+ */
+
+namespace Multividas\QueryFilters\Interfaces;
+
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Collection;
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Database\Eloquent\Collection as EloquentCollection;
+
+interface QueryFiltersRepositoryInterface
+{
+    public function applyFilters(Collection|EloquentCollection|JsonResource $collection): array|JsonResponse;
+}

src/Providers/QueryFiltersServiceProvider.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * (c) 2023 Multividas inc. All rights reserved.
+ * Unauthorized use prohibited.
+ * Website: https://www.multividas.com
+ */
+
+namespace Multividas\QueryFilters\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use Multividas\QueryFilters\Repositories\QueryFiltersRepository;
+use Multividas\QueryFilters\Interfaces\QueryFiltersRepositoryInterface;
+
+class QueryFiltersServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        //
+    }
+
+    public function register(): void
+    {
+        $this->app->bind(QueryFiltersRepositoryInterface::class, function () {
+            return new QueryFiltersRepository();
+        });
+    }
+}

src/Repositories/QueryFiltersRepository.php

@@ -0,0 +1,142 @@
+<?php
+
+/**
+ * (c) 2023 Multividas inc. All rights reserved.
+ * Unauthorized use prohibited.
+ * Website: https://www.multividas.com
+ */
+
+namespace Multividas\QueryFilters\Repositories;
+
+use Illuminate\Support\Collection;
+use Illuminate\Pagination\LengthAwarePaginator;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+use Multividas\ApiResponser\Traits\ApiResponser;
+
+use Illuminate\Database\Eloquent\Collection as EloquentCollection;
+use Multividas\QueryFilters\Interfaces\QueryFiltersRepositoryInterface;
+
+class QueryFiltersRepository implements QueryFiltersRepositoryInterface
+{
+    use ApiResponser;
+
+    public function applyFilters(Collection|EloquentCollection|JsonResource $collection): array
+    {
+        if ($collection instanceof Collection || $collection instanceof EloquentCollection) {
+            $transformer = $collection->first()?->transformer ?? null;
+        } elseif ($collection instanceof JsonResource) {
+            $transformer = $collection->collects ?? null;
+        }
+
+        $collection = $this->filterData($collection, $transformer);
+        $collection = $this->sortData($collection, $transformer);
+
+        $paginatedResult = $this->paginateData($collection);
+
+        return [
+            'data' => $paginatedResult['data'],
+            'meta' => $paginatedResult['meta'],
+        ];
+    }
+
+    protected function filterData(
+        Collection|EloquentCollection|JsonResource $collection,
+        ?string $transformer
+    ): Collection|EloquentCollection|JsonResource {
+        if (isset(request()->query()['filters'])) {
+            foreach (request()->query()['filters'] as $query) {
+                if (!is_null($transformer) && is_callable([$transformer, 'originalAttribute'])) {
+                    $queryField = $transformer::originalAttribute($query['field']);
+                } else {
+                    $queryField = $query['field'];
+                }
+
+                $collection = $collection->where($queryField, $query['value']);
+            }
+        }
+
+        return $collection;
+    }
+
+    protected function sortData(
+        Collection|EloquentCollection|JsonResource $collection,
+        ?string $transformer
+    ): Collection|EloquentCollection|JsonResource {
+        if (request()->has('_sort')) {
+            if (!is_null($transformer) && is_callable([$transformer, 'originalAttribute'])) {
+                $sortField = $transformer::originalAttribute(request()->_sort);
+            } else {
+                $sortField = request()->_sort;
+            }
+
+            $sortOrder = request()->has('_order') && request()->_order == 'desc' ? true : false;
+
+            $collection = $collection->sortBy($sortField, SORT_REGULAR, $sortOrder);
+        }
+
+        return $collection;
+    }
+
+    protected function paginateData(Collection|EloquentCollection|JsonResource $collection): array
+    {
+        $rules = [
+            'per_page' => ['integer', 'min:2', 'max:50'],
+        ];
+
+        $validator = \Illuminate\Support\Facades\Validator::make(request()->all(), $rules);
+
+        if ($validator->fails()) {
+            throw new \Illuminate\Validation\ValidationException($validator);
+        }
+
+        $perPage = (int) request()->input('per_page', 10);
+
+        $page = LengthAwarePaginator::resolveCurrentPage();
+        $paginatedCollection = $collection->slice(($page - 1) * $perPage, $perPage)->values();
+
+        $paginated = new LengthAwarePaginator(
+            $paginatedCollection,
+            $collection->count(),
+            $perPage,
+            $page,
+            [
+                'path' => LengthAwarePaginator::resolveCurrentPath(),
+                'query' => request()->query()
+            ]
+        );
+
+        $paginated->appends(request()->all());
+
+        $paginationData = [
+            'total' => $paginated->total(),
+            'count' => $paginated->count(),
+            'per_page' => $paginated->perPage(),
+            'current_page' => $paginated->currentPage(),
+            'total_pages' => $paginated->lastPage(),
+        ];
+
+        $links = [];
+
+        if ($paginated->previousPageUrl() !== null) {
+            $links['prev'] = $paginated->previousPageUrl();
+        }
+
+        if ($paginated->nextPageUrl() !== null) {
+            $links['next'] = $paginated->nextPageUrl();
+        }
+
+        $links = array_filter($links, fn ($url) => $url !== null);
+
+        if (!empty($links)) {
+            $paginationData['links'] = $links;
+        }
+
+        $meta = $paginated->total() > $perPage ? ['pagination' => $paginationData] : [];
+
+        return [
+            'data' => $paginatedCollection,
+            'meta' => $meta,
+        ];
+    }
+}