- Added allowing dynamic fields

Author: dash8x

docs/advanced-usage/supporting-complex-selects.md

@@ -14,7 +14,9 @@ For these scenarios, you can override the `modifyQuery` method to call these sco
 protected function modifyQuery(\Spatie\QueryBuilder\QueryBuilder $query): \Spatie\QueryBuilder\QueryBuilder
 {
     if (request()->has('lat') && request()->has('lng')) {
-        if ($this->sorts()->has('distance') || $this->fields()->has('distance')) {
+        $fields = $this->fields()->isNotEmpty() ? $this->fields()->get('_') : [];
+
+        if ($this->sorts()->contains('distance') || $this->sorts()->contains('-distance') || (is_array($fields) && in_array('distance', $fields))) {
             $query->withDistance('islands.coordinates', new Point(request()->input('lat'), request()->input('lng'), Srid::WGS84));
         }
     }
@@ -39,7 +41,7 @@ protected function modifyQuery(\Spatie\QueryBuilder\QueryBuilder $query): \Spati
 {   
     $fields = $this->fields()->isNotEmpty() ? $this->fields()->get('_') : [];
 
-    if ((is_array($fields) && in_array('formatted_name', $fields)) || $this->appends()->has('formatted_name')) {
+    if ((is_array($fields) && in_array('formatted_name', $fields)) || $this->appends()->contains('formatted_name')) {
         $query->with('atoll');
     }
 
@@ -49,20 +51,24 @@ protected function modifyQuery(\Spatie\QueryBuilder\QueryBuilder $query): \Spati
 
 The `$this->fields()->get('_')` will return the fields requested for the main model.
 
-For complex selects, you might need to dynamically set the allowed fields and sorts as well.
+For complex selects, use the `getAllowedDynamicFields` method to allow these fields to be included.
 
 ```php
-public function getAllowedFields(): array
+public function getAllowedDynamicFields(): array
 {
-    $fields = \Schema::getColumnListing('islands');
+    $fields = [];
 
     if (request()->has('lat') && request()->has('lng')) {
         $fields[] = 'distance';
     }
 
-    return array_diff($fields, (new Island)->getHidden());
+    return $fields;
 }
+```
 
+You may need to also dynamically set the allowed sorts as well.
+
+```php
 public function getAllowedSorts(): array
 {
     $sorts = [

src/Concerns/IsApiController.php

@@ -101,7 +101,8 @@ protected function indexEndpoint(Request $request)
             ->allowedFilters($this->getAllowedFilters())
             ->allowedAppends($this->getAllowedAppends())
             ->fieldsToAlwaysInclude($this->getFieldsToAlwaysInclude())
-            ->allowedFields($this->getAllowedFields())
+            ->allowedDynamicFields($this->getIndexAllowedDynamicFields())
+            ->allowedFields($this->getIndexAllowedFields())
             ->allowedIncludes($this->getAllowedIncludes());
 
         $query = $this->modifyQuery($query);
@@ -130,6 +131,7 @@ protected function showEndpoint($model_id, Request $request)
             $model = $this->getQueryBuilder()
                 ->allowedAppends($this->getAllShowAllowedAppends())
                 ->fieldsToAlwaysInclude($this->getFieldsToAlwaysInclude())
+                ->allowedDynamicFields($this->getAllowedDynamicFields())
                 ->allowedFields($this->getAllowedFields())
                 ->allowedIncludes($this->getAllowedIncludes());
 
@@ -347,4 +349,20 @@ public function getShowAllowedAppends(): array
     {
         return [];
     }
+
+    /**
+     * Get the dynamic fields
+     */
+    public function getAllowedDynamicFields(): array
+    {
+        return [];
+    }
+
+    /**
+     * Get the dynamic fields
+     */
+    public function getIndexAllowedDynamicFields(): array
+    {
+        return $this->getAllowedDynamicFields();
+    }
 }

src/Exceptions/AllowedDynamicFieldsMustBeCalledBeforeAllowedFields.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Javaabu\QueryBuilder\Exceptions;
+
+use BadMethodCallException;
+
+class AllowedDynamicFieldsMustBeCalledBeforeAllowedFields extends BadMethodCallException
+{
+    public function __construct()
+    {
+        parent::__construct("The QueryBuilder's `allowedDynamicFields` method must be called before the `allowedFields` method.");
+    }
+}

src/Http/Controllers/ApiBaseController.php

@@ -36,6 +36,11 @@ public abstract function getBaseQuery(): Builder;
      */
     public abstract function getAllowedFields(): array;
 
+    /**
+     * Get the dynamic fields
+     */
+    public abstract function getAllowedDynamicFields(): array;
+
     /**
      * Get the includes
      */

src/QueryBuilder.php

@@ -11,6 +11,7 @@
 use Illuminate\Support\Str;
 use Javaabu\QueryBuilder\Concerns\AppendsAttributesToResults;
 use Javaabu\QueryBuilder\Exceptions\AllowedAppendsMustBeCalledBeforeAllowedFields;
+use Javaabu\QueryBuilder\Exceptions\AllowedDynamicFieldsMustBeCalledBeforeAllowedFields;
 use Javaabu\QueryBuilder\Exceptions\FieldsToAlwaysIncludeMustBeCalledBeforeAllowedFields;
 use Spatie\QueryBuilder\AllowedInclude;
 use Spatie\QueryBuilder\Exceptions\InvalidFieldQuery;
@@ -47,6 +48,22 @@ class QueryBuilder extends \Spatie\QueryBuilder\QueryBuilder
      */
     protected $allAppends = null;
 
+    protected ?Collection $allowedDynamicFields = null;
+
+
+    public function allowedDynamicFields($fields): static
+    {
+        if ($this->allowedFields instanceof Collection) {
+            throw new AllowedDynamicFieldsMustBeCalledBeforeAllowedFields();
+        }
+
+        $fields = is_array($fields) ? $fields : func_get_args();
+
+        $this->allowedDynamicFields = collect($fields);
+
+        return $this;
+    }
+
     /**
      * Set to ignore invalid filters
      */
@@ -155,7 +172,12 @@ protected function ensureAllFieldsExist(): void
 
         // get rid of any appended fields present
         $requestedFields = $requestedFields->diff(
-            $this->prependFieldsWithTableName(($this->allowedAppends ? $this->allowedAppends->all() : []), $modelTable)
+            $this->prependFieldsWithTableName(($this->allowedAppends ? $this->allowedAppends->all() : []), $modelTable),
+        );
+
+        // get rid of any dynamic fields present
+        $requestedFields = $requestedFields->diff(
+            $this->prependFieldsWithTableName(($this->allowedDynamicFields ? $this->allowedDynamicFields->all() : []), $modelTable)
         );
 
         $unknownFields = $requestedFields->diff($this->allowedFields);
@@ -294,6 +316,12 @@ protected function addRequestedModelFieldsToQuery(): void
             $this->prependFieldsWithTableName(($this->allowedAppends ? $this->allowedAppends->all() : []), $modelTableName)
         );
 
+        // get rid of any dynamic fields present
+        $prependedFields = array_diff(
+            $prependedFields,
+            $this->prependFieldsWithTableName(($this->allowedDynamicFields ? $this->allowedDynamicFields->all() : []), $modelTableName)
+        );
+
         $prependedFields = array_unique($prependedFields);
 
         $this->select($prependedFields);

tests/Controllers/ProductsController.php

@@ -19,6 +19,18 @@ public function getBaseQuery(): Builder
         return Product::query();
     }
 
+    protected function modifyQuery(\Spatie\QueryBuilder\QueryBuilder $query): \Spatie\QueryBuilder\QueryBuilder
+    {
+        if (request()->has('rating')) {
+            $fields = $this->fields()->isNotEmpty() ? $this->fields()->get('_') : [];
+
+            if ($this->sorts()->contains('rating') || $this->sorts()->contains('-rating') || (is_array($fields) && in_array('rating', $fields))) {
+                $query->withRating(request()->input('rating'));
+            }
+        }
+
+        return $query;
+    }
     /**
      * Get the allowed fields
      *
@@ -29,6 +41,17 @@ public function getAllowedFields(): array
         return array_diff(\Schema::getColumnListing('products'), (new Product)->getHidden());
     }
 
+    public function getAllowedDynamicFields(): array
+    {
+        if (request()->has('rating')) {
+            return [
+                'rating'
+            ];
+        }
+
+        return [];
+    }
+
     /**
      * Get the allowed includes
      *
@@ -62,13 +85,19 @@ public function getAllowedAppends(): array
      */
     public function getAllowedSorts(): array
     {
-        return [
+        $sorts = [
             'id',
             'name',
             'slug',
             'created_at',
             'updated_at',
         ];
+
+        if (request()->has('rating')) {
+            $sorts[] = 'rating';
+        }
+
+        return $sorts;
     }
 
     /**

tests/Feature/ApiControllerTest.php

@@ -9,6 +9,7 @@
 use Javaabu\QueryBuilder\Tests\Models\Product;
 use Javaabu\QueryBuilder\Tests\TestCase;
 use PHPUnit\Framework\Attributes\Test;
+use Spatie\QueryBuilder\Exceptions\InvalidFieldQuery;
 
 class ApiControllerTest extends TestCase
 {
@@ -226,4 +227,78 @@ public function it_can_load_api_model_appends_from_fields_even_if_appends_is_bla
                 'slug' => 'orange',
             ]);
     }
+
+    #[Test]
+    public function it_can_include_dynamic_fields(): void
+    {
+        $this->withoutExceptionHandling();
+
+        $product_1 = Product::factory()->create([
+            'name' => 'Apple'
+        ]);
+
+        $product_2 = Product::factory()->create([
+            'name' => 'Orange'
+        ]);
+
+        $this->getJson('/products?fields=id,rating&rating=10')
+            ->assertSuccessful()
+            ->assertJsonFragment([
+                'id' => $product_1->id,
+                'rating' => $product_1->id + 10,
+            ])
+            ->assertJsonFragment([
+                'id' => $product_2->id,
+                'rating' => $product_2->id + 10,
+            ]);
+    }
+
+    #[Test]
+    public function it_can_sort_by_dynamic_fields(): void
+    {
+        $this->withoutExceptionHandling();
+
+        $product_1 = Product::factory()->create([
+            'name' => 'Apple'
+        ]);
+
+        $product_2 = Product::factory()->create([
+            'name' => 'Orange'
+        ]);
+
+        $this->getJson('/products?fields=id,name&rating=10&sort=rating')
+            ->assertSuccessful()
+            ->assertJsonFragment([
+                'id' => $product_1->id,
+            ])
+            ->assertJsonFragment([
+                'id' => $product_2->id,
+            ]);
+    }
+
+    #[Test]
+    public function it_cannot_include_dynamic_fields_if_required_params_are_missing(): void
+    {
+        $this->withoutExceptionHandling();
+
+        $product_1 = Product::factory()->create([
+            'name' => 'Apple'
+        ]);
+
+        $product_2 = Product::factory()->create([
+            'name' => 'Orange'
+        ]);
+
+        $this->expectException(InvalidFieldQuery::class);
+
+        $this->getJson('/products?fields=id,rating')
+            ->assertJsonMissing([
+                'id' => $product_1->id,
+                'rating' => $product_1->id + 10,
+            ])
+            ->assertJsonMissing([
+                'id' => $product_2->id,
+                'rating' => $product_2->id + 10,
+            ]);
+    }
 }

tests/Models/Product.php

@@ -36,4 +36,15 @@ public function getFormattedNameAttribute(): string
     {
         return 'Formatted ' . $this->name;
     }
+
+    public function scopeWithRating($query, $rating)
+    {
+        if (! $query->getQuery()->columns) {
+            $query->select('*');
+        }
+
+        $rating = (int) $rating;
+
+        return $query->selectRaw('(' .$rating . ' + id) as rating');
+    }
 }