Add filtering by published at (#194)

* Add filtering by published at

* Update NewsController.php

* style: apply fix

---------

Co-authored-by: Andrei Ioniță <hi@andrei.io>

Author: idormenco

app/Http/Controllers/NewsController.php

@@ -4,10 +4,14 @@
 
 namespace App\Http\Controllers;
 
+use App\Http\Filters\PublishedAfterFilter;
+use App\Http\Filters\PublishedAtFilter;
+use App\Http\Filters\PublishedBeforeFilter;
 use App\Http\Resources\NewsResource;
 use App\Models\News;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Http\Resources\Json\JsonResource;
+use Spatie\QueryBuilder\AllowedFilter;
+use Spatie\QueryBuilder\QueryBuilder;
 
 class NewsController extends Controller
 {
@@ -16,16 +20,22 @@ public function __invoke(): JsonResource
         $this->authorize('accessApi');
 
         return NewsResource::collection(
-            News::query()
-                ->wherePublished()
+            QueryBuilder::for(News::class)
+                ->allowedFilters([
+                    AllowedFilter::custom('published_at', new PublishedAtFilter),
+                    AllowedFilter::custom('published_before', new PublishedBeforeFilter),
+                    AllowedFilter::custom('published_after', new PublishedAfterFilter),
+                ])
                 ->with([
                     'media',
-                    'organisation' => fn(BelongsTo $query) => $query
+                    'organisation' => fn ($query) => $query
                         ->withoutEagerLoads()
                         ->select('id', 'name'),
                 ])
-                ->orderBy('id', 'desc')
+                ->where('status', 'published')
+                ->defaultSort('-published_at')
                 ->paginate(25)
+                ->appends(request()->query())
         );
     }
 }

app/Http/Filters/PublishedAfterFilter.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Carbon;
+use Spatie\QueryBuilder\Filters\Filter;
+
+class PublishedAfterFilter implements Filter
+{
+    public function __invoke(Builder $query, $value, string $property): Builder
+    {
+        try {
+            $date = Carbon::parse($value);
+        } catch (\Exception $e) {
+            return $query;
+        }
+
+        return $query->whereDate('published_at', '>=', $date);
+    }
+}

app/Http/Filters/PublishedAtFilter.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Carbon;
+use Spatie\QueryBuilder\Filters\Filter;
+
+class PublishedAtFilter implements Filter
+{
+    public function __invoke(Builder $query, $value, string $property): Builder
+    {
+        try {
+            $date = Carbon::parse($value);
+        } catch (\Exception $e) {
+            return $query;
+        }
+
+        return $query->whereDate('published_at', $date);
+    }
+}

app/Http/Filters/PublishedBeforeFilter.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Carbon;
+use Spatie\QueryBuilder\Filters\Filter;
+
+class PublishedBeforeFilter implements Filter
+{
+    public function __invoke(Builder $query, $value, string $property): Builder
+    {
+        try {
+            $date = Carbon::parse($value);
+        } catch (\Exception $e) {
+            return $query;
+        }
+
+        return $query->whereDate('published_at', '<=', $date);
+    }
+}

composer.json

@@ -17,7 +17,8 @@
         "laravel/tinker": "^2.8",
         "league/flysystem-aws-s3-v3": "^3.21",
         "pxlrbt/filament-excel": "^1.1",
-        "sentry/sentry-laravel": "^4.1"
+        "sentry/sentry-laravel": "^4.1",
+        "spatie/laravel-query-builder": "^6.3"
     },
     "require-dev": {
         "barryvdh/laravel-debugbar": "^3.13",

composer.lock

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    /*
+     * By default the package will use the `include`, `filter`, `sort`
+     * and `fields` query parameters as described in the readme.
+     *
+     * You can customize these query string parameters here.
+     */
+    'parameters' => [
+        'include' => 'include',
+
+        'filter' => 'filter',
+
+        'sort' => 'sort',
+
+        'fields' => 'fields',
+
+        'append' => 'append',
+    ],
+
+    /*
+     * Related model counts are included using the relationship name suffixed with this string.
+     * For example: GET /users?include=postsCount
+     */
+    'count_suffix' => 'Count',
+
+    /*
+     * Related model exists are included using the relationship name suffixed with this string.
+     * For example: GET /users?include=postsExists
+     */
+    'exists_suffix' => 'Exists',
+
+    /*
+     * By default the package will throw an `InvalidFilterQuery` exception when a filter in the
+     * URL is not allowed in the `allowedFilters()` method.
+     */
+    'disable_invalid_filter_query_exception' => true,
+
+    /*
+     * By default the package will throw an `InvalidSortQuery` exception when a sort in the
+     * URL is not allowed in the `allowedSorts()` method.
+     */
+    'disable_invalid_sort_query_exception' => true,
+
+    /*
+     * By default the package will throw an `InvalidIncludeQuery` exception when an include in the
+     * URL is not allowed in the `allowedIncludes()` method.
+     */
+    'disable_invalid_includes_query_exception' => true,
+
+    /*
+     * By default, the package expects relationship names to be snake case plural when using fields[relationship].
+     * For example, fetching the id and name for a userOwner relation would look like this:
+     * GET /users?fields[user_owner]=id,name
+     *
+     * Set this to `false` if you don't want that and keep the requested relationship names as-is and allows you to
+     * request the fields using a camelCase relationship name:
+     * GET /users?fields[userOwner]=id,name
+     */
+    'convert_relation_names_to_snake_case_plural' => true,
+
+    /*
+     * By default, the package expects relationship names to be snake case plural when using fields[relationship].
+     * For example, fetching the id and name for a userOwner relation would look like this:
+     * GET /users?fields[user_owner]=id,name
+     *
+     * Set this to one of `snake_case`, `camelCase` or `none` if you want to enable table name resolution in addition to the relation name resolution
+     * GET /users?include=topOrders&fields[orders]=id,name
+     */
+    'convert_relation_table_name_strategy' => false,
+
+    /*
+     * By default, the package expects the field names to match the database names
+     * For example, fetching the field named firstName would look like this:
+     * GET /users?fields=firstName
+     *
+     * Set this to `true` if you want to convert the firstName into first_name for the underlying query
+     */
+    'convert_field_names_to_snake_case' => false,
+];