feat: add WhereAll and WhereAny filters

Gregory Haddow · lindyhopchris · commit 3702578a8cef · 2024-10-13T12:39:04.000+01:00
diff --git a/src/Filters/Concerns/HasColumns.php b/src/Filters/Concerns/HasColumns.php
@@ -0,0 +1,81 @@
+<?php
+/*
+ * Copyright 2024 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Filters\Concerns;
+
+trait HasColumns
+{
+
+    /**
+     * @var string|null
+     */
+    private ?string $table = null;
+
+
+    /**
+     * @var array<string>
+     */
+    private array $columns = [];
+
+    /**
+     * @return array<string>
+     */
+    public function columns(): array
+    {
+        return $this->columns;
+    }
+
+    public function withColumn(string $column): self
+    {
+        $this->columns[] = $column;
+
+        return $this;
+    }
+
+    /**
+     * Force the table name when qualifying the columns.
+     *
+     * This allows the developer to force the table that the columns are qualified with.
+     *
+     * @param string $table
+     * @return $this
+     */
+    public function qualifyAs(string $table): self
+    {
+        $this->table = $table;
+
+        return $this;
+    }
+
+    /**
+     * Determine if developer has forced a table to qualify columns as
+     *
+     * @return bool
+     */
+    public function isQualified(): bool
+    {
+        return $this->table === null;
+    }
+
+    /**
+     * Get qualified columns.
+     *
+     * @return array<string>
+     */
+    protected function qualifiedColumns(): array
+    {
+        if ($this->table) {
+            return array_map(fn($column) => $this->table . '.' . $column, $this->columns);
+        }
+
+        return $this->columns;
+    }
+}
diff --git a/src/Filters/WhereAll.php b/src/Filters/WhereAll.php
@@ -0,0 +1,79 @@
+<?php
+/*
+ * Copyright 2024 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Filters;
+
+use Illuminate\Support\Traits\Conditionable;
+use LaravelJsonApi\Eloquent\Contracts\Filter;
+
+class WhereAll implements Filter
+{
+
+    use Concerns\DeserializesValue;
+    use Concerns\HasColumns;
+    use Concerns\HasOperator;
+    use Concerns\IsSingular;
+    use Conditionable;
+
+    /**
+     * @var string
+     */
+    private string $name;
+
+    /**
+     * Create a new filter.
+     *
+     * @param string $name
+     * @param array<string> $columns
+     * @return static
+     */
+    public static function make(string $name, array $columns = null): self
+    {
+        return new static($name, $columns);
+    }
+
+    /**
+     * WhereAny constructor.
+     *
+     * @param string $name
+     * @param array<string> $columns
+    */
+    public function __construct(string $name, array $columns = null)
+    {
+        $this->name = $name;
+        $this->columns = $columns ?? [];
+        $this->operator = '=';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function key(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function apply($query, $value)
+    {
+        if (!$this->isQualified()){
+            $this->qualifyAs($query->getModel()->getTable());
+        }
+
+        return $query->whereAll(
+            $this->qualifiedColumns(),
+            $this->operator(),
+            $this->deserialize($value)
+        );
+    }
+}
diff --git a/src/Filters/WhereAny.php b/src/Filters/WhereAny.php
@@ -0,0 +1,79 @@
+<?php
+/*
+ * Copyright 2024 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Filters;
+
+use Illuminate\Support\Traits\Conditionable;
+use LaravelJsonApi\Eloquent\Contracts\Filter;
+
+class WhereAny implements Filter
+{
+
+    use Concerns\DeserializesValue;
+    use Concerns\HasColumns;
+    use Concerns\HasOperator;
+    use Concerns\IsSingular;
+    use Conditionable;
+
+    /**
+     * @var string
+     */
+    private string $name;
+
+    /**
+     * Create a new filter.
+     *
+     * @param string $name
+     * @param array<string> $columns
+     * @return static
+     */
+    public static function make(string $name, array $columns = null): self
+    {
+        return new static($name, $columns);
+    }
+
+    /**
+     * WhereAny constructor.
+     *
+     * @param string $name
+     * @param array<string> $columns
+    */
+    public function __construct(string $name, array $columns = null)
+    {
+        $this->name = $name;
+        $this->columns = $columns ?? [];
+        $this->operator = '=';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function key(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function apply($query, $value)
+    {
+        if (!$this->isQualified()){
+            $this->qualifyAs($query->getModel()->getTable());
+        }
+
+        return $query->whereAny(
+            $this->qualifiedColumns(),
+            $this->operator(),
+            $this->deserialize($value)
+        );
+    }
+}
diff --git a/tests/app/Schemas/PostSchema.php b/tests/app/Schemas/PostSchema.php
@@ -24,6 +24,8 @@
 use LaravelJsonApi\Eloquent\Fields\Str;
 use LaravelJsonApi\Eloquent\Filters\OnlyTrashed;
 use LaravelJsonApi\Eloquent\Filters\Where;
+use LaravelJsonApi\Eloquent\Filters\WhereAll;
+use LaravelJsonApi\Eloquent\Filters\WhereAny;
 use LaravelJsonApi\Eloquent\Filters\WhereDoesntHave;
 use LaravelJsonApi\Eloquent\Filters\WhereHas;
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
@@ -94,6 +96,8 @@ public function filters(): iterable
             Where::make('slug')->singular(),
             WhereIn::make('slugs')->delimiter(','),
             WithTrashed::make('withTrashed'),
+            WhereAll::make('all', ['title','content'])->withColumn('slug')->using('like'),
+            WhereAny::make('any', ['title','content'])->withColumn('slug')->using('like'),
         ];
     }
 
diff --git a/tests/lib/Acceptance/Filters/WhereAllTest.php b/tests/lib/Acceptance/Filters/WhereAllTest.php
@@ -0,0 +1,56 @@
+<?php
+/*
+ * Copyright 2024 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Tests\Acceptance\Filters;
+
+use App\Models\Post;
+use App\Schemas\PostSchema;
+
+class WhereAllTest extends TestCase
+{
+    /**
+     * @var PostSchema
+     */
+    private PostSchema $schema;
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->schema = $this->schemas()->schemaFor('posts');
+    }
+
+    /**
+     * @return void
+     */
+    public function testWhereAll(): void
+    {
+        Post::factory()->count(5)->create();
+
+        $all = Post::factory()->create(['title' => "foobar boofar", 'content' => "boofar foobar", 'slug' => "totally_foobar_1"]);
+        Post::factory()->create(['title' => "foobar boofar"]);
+        Post::factory()->create(['content' => "boofar foobar"]);
+        Post::factory()->create(['slug' => "totally_foobar"]);
+
+        $expected = [$all];
+
+        $actual = $this->schema
+            ->repository()
+            ->queryAll()
+            ->filter(['all' => '%foobar%'])
+            ->get();
+
+        $this->assertFilteredModels($expected, $actual);
+    }
+}
diff --git a/tests/lib/Acceptance/Filters/WhereAnyTest.php b/tests/lib/Acceptance/Filters/WhereAnyTest.php
@@ -0,0 +1,55 @@
+<?php
+/*
+ * Copyright 2024 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Tests\Acceptance\Filters;
+
+use App\Models\Post;
+use App\Schemas\PostSchema;
+
+class WhereAnyTest extends TestCase
+{
+    /**
+     * @var PostSchema
+     */
+    private PostSchema $schema;
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->schema = $this->schemas()->schemaFor('posts');
+    }
+
+    /**
+     * @return void
+     */
+    public function testWhereAny(): void
+    {
+        Post::factory()->count(5)->create();
+
+        $title = Post::factory()->create(['title' => "foobar boofar"]);
+        $content = Post::factory()->create(['content' => "boofar foobar"]);
+        $slug = Post::factory()->create(['slug' => "totally_foobar"]);
+
+        $expected = [$title,$content, $slug];
+
+        $actual = $this->schema
+            ->repository()
+            ->queryAll()
+            ->filter(['any' => '%foobar%'])
+            ->get();
+
+        $this->assertFilteredModels($expected, $actual);
+    }
+}
