First release v1.0.0

README.md

@@ -1,9 +1,9 @@
-# Laravel Spatie Filters
+# Laravel Datatable API
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/teamq-ec/teamq-laravel-spatie-filters.svg?style=flat-square)](https://packagist.org/packages/teamq-ec/teamq-laravel-spatie-filters)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/teamq-ec/teamq-laravel-spatie-filters/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/teamq-ec/teamq-laravel-spatie-filters/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/teamq-ec/teamq-laravel-spatie-filters/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/teamq-ec/teamq-laravel-spatie-filters/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/teamq-ec/teamq-laravel-spatie-filters.svg?style=flat-square)](https://packagist.org/packages/teamq-ec/teamq-laravel-spatie-filters)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/teamq-ec/teamq-laravel-datatables-api.svg?style=flat-square)](https://packagist.org/packages/teamq-ec/teamq-laravel-datatables-api)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/teamq-ec/teamq-laravel-datatables-api/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/teamq-ec/teamq-laravel-datatables-api/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/teamq-ec/teamq-laravel-datatables-api/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/teamq-ec/teamq-laravel-datatables-api/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/teamq-ec/teamq-laravel-datatables-api.svg?style=flat-square)](https://packagist.org/packages/teamq-ec/teamq-laravel-datatables-api)
 
 This is a collection of classes for filters and sorts, extending from the [spatie/laravel-query-builder](https://github.com/spatie/laravel-query-builder) package,
 in addition to providing the possibility of applying these filters and sorting in related models using join through
@@ -20,7 +20,7 @@ composer require teamq/laravel-spatie-filters
 You can publish the config file with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-spatie-filters-config"
+php artisan vendor:publish --tag="laravel-datatable-api-config"
 ```
 
 This is the contents of the published config file:

composer.json

@@ -1,14 +1,15 @@
 {
-    "name": "teamq/laravel-spatie-filters",
+    "name": "teamq/laravel-datatables-api",
     "description": "Custom filter and sorting set for 'spatie/laravel-query-builder' package",
     "keywords": [
         "teamq",
         "laravel",
+        "datatables",
         "filters",
         "sortings",
         "spatie/laravel-query-builder"
     ],
-    "homepage": "https://github.com/teamq-ec/teamq-laravel-spatie-filters",
+    "homepage": "https://github.com/teamq-ec/teamq-laravel-datatables-api",
     "license": "MIT",
     "authors": [
         {
@@ -31,7 +32,7 @@
     },
     "autoload": {
         "psr-4": {
-            "TeamQ\\QueryBuilder\\": "src/"
+            "TeamQ\\Datatables\\": "src/"
         }
     },
     "autoload-dev": {
@@ -55,7 +56,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "TeamQ\\QueryBuilder\\QueryBuilderServiceProvider"
+                "TeamQ\\Datatables\\DatatablesServiceProvider"
             ]
         }
     },

src/Concerns/HasPropertyRelationship.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Concerns;
+namespace TeamQ\Datatables\Concerns;
 
 use Illuminate\Contracts\Database\Query\Expression;
 use Illuminate\Database\Eloquent\Builder;

src/Concerns/PerPageQuery.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Concerns;
+namespace TeamQ\Datatables\Concerns;
 
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Database\Eloquent\Collection;
@@ -32,7 +32,7 @@ trait PerPageQuery
      */
     public function result($perPage = null, array $columns = ['*'], string $pageName = 'page', $page = null): Collection|array|LengthAwarePaginator
     {
-        $paramName = config('query-builder.parameters.per_page', 'per_page');
+        $paramName = config('datatables.parameters.per_page', 'per_page');
 
         if ($this->isPerPageAll($paramName)) {
             return $this->get($columns);
@@ -108,6 +108,6 @@ protected function isPerPageAll(string $paramName): bool
     {
         return
             $this->maxPerPage === null &&
-            $this->request->query($paramName) === config('teamq-query-builder.per_page.all');
+            $this->request->query($paramName) === config('datatables.per_page.all');
     }
 }

src/QueryBuilderServiceProvider.php → src/DatatablesServiceProvider.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace TeamQ\QueryBuilder;
+namespace TeamQ\Datatables;
 
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
-class QueryBuilderServiceProvider extends PackageServiceProvider
+class DatatablesServiceProvider extends PackageServiceProvider
 {
     public function configurePackage(Package $package): void
     {
@@ -15,7 +15,7 @@ public function configurePackage(Package $package): void
          * More info: https://github.com/spatie/laravel-package-tools
          */
         $package
-            ->name('teamq-query-builder')
-            ->hasConfigFile();
+            ->name('laravel-datatables-api')
+            ->hasConfigFile('datatables');
     }
 }

src/Enums/AggregationType.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Enums;
+namespace TeamQ\Datatables\Enums;
 
 /**
  * Enum aggregation type.

src/Enums/Comparators/Number.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Enums\Comparators;
+namespace TeamQ\Datatables\Enums\Comparators;
 
 /**
  * Number comparison operators.

src/Enums/Comparators/Text.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Enums\Comparators;
+namespace TeamQ\Datatables\Enums\Comparators;
 
 /**
  * Text comparison operators.

src/Enums/JoinType.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Enums;
+namespace TeamQ\Datatables\Enums;
 
 /**
  * Enum join type.

src/Filters/DateFilter.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Filters;
+namespace TeamQ\Datatables\Filters;
 
-use TeamQ\QueryBuilder\Enums\Comparators;
+use TeamQ\Datatables\Enums\Comparators;
 
 /**
  * Adds custom filter support for dates with comparison operators.

src/Filters/Filter.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Filters;
+namespace TeamQ\Datatables\Filters;
 
 use Illuminate\Database\Eloquent\Builder;
 use Spatie\QueryBuilder\Filters\Filter as IFilter;
-use TeamQ\QueryBuilder\Concerns\HasPropertyRelationship;
-use TeamQ\QueryBuilder\Enums\JoinType;
+use TeamQ\Datatables\Concerns\HasPropertyRelationship;
+use TeamQ\Datatables\Enums\JoinType;
 
 /**
  * Filter Base Class.

src/Filters/GlobalFilter.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Filters;
+namespace TeamQ\Datatables\Filters;
 
 use Illuminate\Contracts\Database\Query\Expression;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Collection;
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\Filters\Filter;
-use TeamQ\QueryBuilder\Concerns\HasPropertyRelationship;
-use TeamQ\QueryBuilder\Enums\JoinType;
+use TeamQ\Datatables\Concerns\HasPropertyRelationship;
+use TeamQ\Datatables\Enums\JoinType;
 
 /**
  * Adds global filter support through the `spatie/laravel-query-builder` package.

src/Filters/NumberFilter.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Filters;
+namespace TeamQ\Datatables\Filters;
 
-use TeamQ\QueryBuilder\Enums\Comparators;
+use TeamQ\Datatables\Enums\Comparators;
 
 /**
  * Adds custom filter support for numbers with comparison operators.

src/Filters/TextFilter.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Filters;
+namespace TeamQ\Datatables\Filters;
 
-use TeamQ\QueryBuilder\Enums\Comparators;
+use TeamQ\Datatables\Enums\Comparators;
 
 /**
  * Adds custom filter support for text with comparison operators.

src/QueryBuilder.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace TeamQ\QueryBuilder;
+namespace TeamQ\Datatables;
 
 use Spatie\QueryBuilder\QueryBuilder as BaseQueryBuilder;
-use TeamQ\QueryBuilder\Concerns\PerPageQuery;
+use TeamQ\Datatables\Concerns\PerPageQuery;
 
 /**
  * Overwrite the query builder base class and add support for the perPage parameter

src/Sorts/CaseSort.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Sorts;
+namespace TeamQ\Datatables\Sorts;
 
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Query\Expression;
 use Spatie\QueryBuilder\Sorts\Sort;
-use TeamQ\QueryBuilder\Concerns\HasPropertyRelationship;
-use TeamQ\QueryBuilder\Enums\AggregationType;
-use TeamQ\QueryBuilder\Enums\JoinType;
+use TeamQ\Datatables\Concerns\HasPropertyRelationship;
+use TeamQ\Datatables\Enums\AggregationType;
+use TeamQ\Datatables\Enums\JoinType;
 
 /**
  * Add support for sorting using select case, for cases such as Enums, States, Constants,

src/Sorts/RelationSort.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace TeamQ\QueryBuilder\Sorts;
+namespace TeamQ\Datatables\Sorts;
 
 use Illuminate\Database\Eloquent\Builder;
 use Spatie\QueryBuilder\Sorts\Sort;
-use TeamQ\QueryBuilder\Concerns\HasPropertyRelationship;
-use TeamQ\QueryBuilder\Enums\AggregationType;
-use TeamQ\QueryBuilder\Enums\JoinType;
+use TeamQ\Datatables\Concerns\HasPropertyRelationship;
+use TeamQ\Datatables\Enums\AggregationType;
+use TeamQ\Datatables\Enums\JoinType;
 
 /**
  * Adds the possibility to sort by related fields using the kirschbaum-development/eloquent-power-joins.

tests/Datasets/Datasets.php

@@ -1,6 +1,6 @@
 <?php
 
-use TeamQ\QueryBuilder\Enums\Comparators;
+use TeamQ\Datatables\Enums\Comparators;
 
 dataset('per-page-functions', [
     'paginate',

tests/Filters/DateFilterTest.php

@@ -4,9 +4,9 @@
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Enums\Comparators;
-use TeamQ\QueryBuilder\Enums\JoinType;
-use TeamQ\QueryBuilder\Filters\DateFilter;
+use TeamQ\Datatables\Enums\Comparators;
+use TeamQ\Datatables\Enums\JoinType;
+use TeamQ\Datatables\Filters\DateFilter;
 use Tests\Mocks\Models\Author;
 use Tests\Mocks\Models\Book;
 use Tests\Mocks\Models\Chapter;

tests/Filters/GlobalFilterTest.php

@@ -3,8 +3,8 @@
 use Illuminate\Database\Query\Expression;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Enums\JoinType;
-use TeamQ\QueryBuilder\Filters\GlobalFilter;
+use TeamQ\Datatables\Enums\JoinType;
+use TeamQ\Datatables\Filters\GlobalFilter;
 use Tests\Mocks\Models\Author;
 use Tests\Mocks\Models\Book;
 use Tests\Mocks\Models\Chapter;

tests/Filters/NumberFilterTest.php

@@ -4,9 +4,9 @@
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Enums\Comparators;
-use TeamQ\QueryBuilder\Enums\JoinType;
-use TeamQ\QueryBuilder\Filters\NumberFilter;
+use TeamQ\Datatables\Enums\Comparators;
+use TeamQ\Datatables\Enums\JoinType;
+use TeamQ\Datatables\Filters\NumberFilter;
 use Tests\Mocks\Models\Author;
 use Tests\Mocks\Models\Book;
 use Tests\Mocks\Models\Chapter;

tests/Filters/PowerJoins/TextFilterTest.php

@@ -3,9 +3,9 @@
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Enums\Comparators;
-use TeamQ\QueryBuilder\Enums\JoinType;
-use TeamQ\QueryBuilder\Filters\TextFilter;
+use TeamQ\Datatables\Enums\Comparators;
+use TeamQ\Datatables\Enums\JoinType;
+use TeamQ\Datatables\Filters\TextFilter;
 use Tests\Mocks\Models\Country;
 use Tests\Mocks\Models\Flight;
 

tests/Filters/TextFilterTest.php

@@ -4,9 +4,9 @@
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Enums\Comparators;
-use TeamQ\QueryBuilder\Enums\JoinType;
-use TeamQ\QueryBuilder\Filters\TextFilter;
+use TeamQ\Datatables\Enums\Comparators;
+use TeamQ\Datatables\Enums\JoinType;
+use TeamQ\Datatables\Filters\TextFilter;
 use Tests\Mocks\Models\Author;
 use Tests\Mocks\Models\Book;
 use Tests\Mocks\Models\Chapter;

tests/Queries/PerPageQueryBuilderTest.php

@@ -3,7 +3,7 @@
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Collection;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\QueryBuilder;
+use TeamQ\Datatables\QueryBuilder;
 use Tests\Mocks\Models\Author;
 
 beforeEach(function () {

tests/Sorts/CaseSortTest.php

@@ -3,7 +3,7 @@
 use Spatie\QueryBuilder\AllowedSort;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Sorts\CaseSort;
+use TeamQ\Datatables\Sorts\CaseSort;
 use Tests\Mocks\Enums\AuthorTypeEnum;
 use Tests\Mocks\Enums\BookClassificationEnum;
 use Tests\Mocks\Models\Author;

tests/Sorts/PowerJoins/RelationSortTest.php

@@ -3,8 +3,8 @@
 use Spatie\QueryBuilder\AllowedSort;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Enums\JoinType;
-use TeamQ\QueryBuilder\Sorts\RelationSort;
+use TeamQ\Datatables\Enums\JoinType;
+use TeamQ\Datatables\Sorts\RelationSort;
 use Tests\Mocks\Models\Country;
 use Tests\Mocks\Models\Flight;
 

tests/Sorts/RelationSortTest.php

@@ -3,9 +3,9 @@
 use Spatie\QueryBuilder\AllowedSort;
 use Spatie\QueryBuilder\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
-use TeamQ\QueryBuilder\Enums\AggregationType;
-use TeamQ\QueryBuilder\Enums\JoinType;
-use TeamQ\QueryBuilder\Sorts\RelationSort;
+use TeamQ\Datatables\Enums\AggregationType;
+use TeamQ\Datatables\Enums\JoinType;
+use TeamQ\Datatables\Sorts\RelationSort;
 use Tests\Mocks\Enums\BookClassificationEnum;
 use Tests\Mocks\Models\Author;
 use Tests\Mocks\Models\Book;

tests/TestCase.php

@@ -4,7 +4,8 @@
 
 use Kirschbaum\PowerJoins\PowerJoinsServiceProvider;
 use Orchestra\Testbench\TestCase as Orchestra;
-use TeamQ\QueryBuilder\QueryBuilderServiceProvider;
+use Spatie\QueryBuilder\QueryBuilderServiceProvider;
+use TeamQ\Datatables\DatatablesServiceProvider;
 
 class TestCase extends Orchestra
 {
@@ -18,8 +19,8 @@ protected function setUp(): void
     protected function getPackageProviders($app): array
     {
         return [
-            \Spatie\QueryBuilder\QueryBuilderServiceProvider::class,
             QueryBuilderServiceProvider::class,
+            DatatablesServiceProvider::class,
             PowerJoinsServiceProvider::class,
         ];
     }