Merge branch 'release/2.2.0'

Author: lindyhopchris

.github/workflows/tests.yml

@@ -14,15 +14,15 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.4, '8.0', 8.1]
+        php: [7.4, '8.0', 8.1, 8.2]
         laravel: [8, 9]
         exclude:
           - php: 7.4
             laravel: 9
 
     steps:
     - name: Checkout Code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -37,7 +37,7 @@ jobs:
       run: composer require "illuminate/database:^${{ matrix.laravel }}" --no-update
 
     - name: Install dependencies
-      uses: nick-invision/retry@v1
+      uses: nick-fields/retry@v2
       with:
         timeout_minutes: 5
         max_attempts: 5

CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.2.0] - 2022-12-22
+
+### Added
+
+- [#27](https://github.com/laravel-json-api/eloquent/pull/27) Added the `WhereNull` and `WhereNotNull` filters.
+
 ## [2.1.1] - 2022-04-04
 
 ### Fixed
@@ -16,10 +22,10 @@ All notable changes to this project will be documented in this file. This projec
 
 - The `Number` field can now be configured to accept numeric strings by calling the `acceptStrings()` method on the
   field.
-  
+
 ### Fixed
 
-- The `JsonApiBuilder` class was previously converting a `null` decoded id to an empty string when querting for a 
+- The `JsonApiBuilder` class was previously converting a `null` decoded id to an empty string when querting for a
   resource id. This has been fixed to pass `null` to the query builder instead of the empty string, as this was most
   likely the cause of failures in Postgres.
 
@@ -36,8 +42,8 @@ All notable changes to this project will be documented in this file. This projec
 - [#20](https://github.com/laravel-json-api/eloquent/pull/20) **BREAKING** To support PHP 8.1 we needed to rename the
   `ReadOnly` contract and trait. This is because PHP 8.1 introduced `readonly` as a reserved word. The following changes
   were made:
-  - `LaravelJsonApi\Eloquent\Contracts\ReadOnly` is now `IsReadOnly`.
-  - `LaravelJsonApi\Eloquent\Fields\Concerns\ReadOnly` is now `IsReadOnly`.
+    - `LaravelJsonApi\Eloquent\Contracts\ReadOnly` is now `IsReadOnly`.
+    - `LaravelJsonApi\Eloquent\Fields\Concerns\ReadOnly` is now `IsReadOnly`.
 
 ## [1.0.1] - 2021-12-08
 

src/Filters/WhereNotNull.php

@@ -0,0 +1,32 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Filters;
+
+class WhereNotNull extends WhereNull
+{
+    /**
+     * @param bool $value
+     * @return bool
+     */
+    protected function isWhereNull(bool $value): bool
+    {
+        return $value === false;
+    }
+}

src/Filters/WhereNull.php

@@ -0,0 +1,111 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Filters;
+
+use LaravelJsonApi\Core\Support\Str;
+use LaravelJsonApi\Eloquent\Contracts\Filter;
+
+class WhereNull implements Filter
+{
+    use Concerns\HasColumn;
+    use Concerns\IsSingular;
+
+    /**
+     * @var string
+     */
+    private string $name;
+
+    /**
+     * Create a new filter.
+     *
+     * @param string $name
+     * @param string|null $column
+     *
+     * @return static
+     */
+    public static function make(string $name, string $column = null): self
+    {
+        return new static($name, $column);
+    }
+
+    /**
+     * WhereNull constructor.
+     *
+     * @param string|null $column
+     */
+    public function __construct(string $name, string $column = null)
+    {
+        $this->name = $name;
+        $this->column = $column ?: $this->guessColumn();
+    }
+
+    /**
+     * @return string
+     */
+    public function key(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function apply($query, $value)
+    {
+        $value = $this->deserialize($value);
+        $column = $query->getModel()->qualifyColumn($this->column());
+
+        if ($this->isWhereNull($value)) {
+            return $query->whereNull($column);
+        }
+
+        return $query->whereNotNull($column);
+    }
+
+    /**
+     * Should a "where null" query be used?
+     *
+     * @param bool $value
+     * @return bool
+     */
+    protected function isWhereNull(bool $value): bool
+    {
+        return $value === true;
+    }
+
+    /**
+     * Deserialize the value.
+     *
+     * @param mixed $value
+     * @return bool
+     */
+    private function deserialize($value): bool
+    {
+        return filter_var($value, FILTER_VALIDATE_BOOL);
+    }
+
+    /**
+     * @return string
+     */
+    private function guessColumn(): string
+    {
+        return Str::underscore($this->name);
+    }
+}

tests/app/Schemas/PostSchema.php

@@ -36,6 +36,8 @@
 use LaravelJsonApi\Eloquent\Filters\WhereHas;
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Filters\WhereIn;
+use LaravelJsonApi\Eloquent\Filters\WhereNotNull;
+use LaravelJsonApi\Eloquent\Filters\WhereNull;
 use LaravelJsonApi\Eloquent\Filters\WithTrashed;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
@@ -44,7 +46,6 @@
 
 class PostSchema extends Schema
 {
-
     use SoftDeletes;
 
     /**
@@ -76,6 +77,7 @@ public function fields(): iterable
                 BelongsToMany::make('images'),
                 BelongsToMany::make('videos'),
             ])->canCount(),
+            DateTime::make('publishedAt'),
             Str::make('slug')->sortable(),
             BelongsToMany::make('tags')
                 ->fields(new ApprovedPivot())
@@ -92,7 +94,9 @@ public function filters(): iterable
     {
         return [
             WhereIdIn::make($this),
+            WhereNull::make('draft', 'published_at'),
             WhereDoesntHave::make($this, 'tags', 'notTags'),
+            WhereNotNull::make('published', 'published_at'),
             WhereHas::make($this, 'tags'),
             OnlyTrashed::make('trashed'),
             Where::make('slug')->singular(),

tests/lib/Acceptance/Filters/TestCase.php

@@ -0,0 +1,55 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Tests\Acceptance\Filters;
+
+use App\Models\Post;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
+use LaravelJsonApi\Eloquent\Tests\Acceptance\TestCase as BaseTestCase;
+
+class TestCase extends BaseTestCase
+{
+    /**
+     * Assert the two iterables contain the same filtered models.
+     *
+     * As we are just asserting filtering, we do not care what order the models are in -
+     * just that the two iterables contain the same models by id.
+     *
+     * @param iterable $expected
+     * @param iterable $actual
+     * @return void
+     */
+    protected function assertFilteredModels(iterable $expected, iterable $actual): void
+    {
+        $expected = Collection::make($expected)
+            ->map(static fn(Model $model) => $model->getKey())
+            ->sort()
+            ->values()
+            ->all();
+
+        $actual = Collection::make($actual)
+            ->map(static fn(Model $model) => $model->getKey())
+            ->sort()
+            ->values()
+            ->all();
+
+        $this->assertSame($expected, $actual);
+    }
+}

tests/lib/Acceptance/Filters/WhereNotNullTest.php

@@ -0,0 +1,84 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Tests\Acceptance\Filters;
+
+use App\Models\Post;
+use App\Schemas\PostSchema;
+use Carbon\Carbon;
+
+class WhereNotNullTest 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 testTrue(): void
+    {
+        $posts = Post::factory()->sequence(
+            ['published_at' => null],
+            ['published_at' => Carbon::now()],
+        )->count(5)->create();
+
+        $expected = $posts->whereNotNull('published_at');
+
+        $actual = $this->schema
+            ->repository()
+            ->queryAll()
+            ->filter(['published' => 'true'])
+            ->get();
+
+        $this->assertFilteredModels($expected, $actual);
+    }
+
+    /**
+     * @return void
+     */
+    public function testFalse(): void
+    {
+        $posts = Post::factory()->sequence(
+            ['published_at' => null],
+            ['published_at' => Carbon::now()],
+        )->count(5)->create();
+
+        $expected = $posts->whereNull('published_at');
+
+        $actual = $this->schema
+            ->repository()
+            ->queryAll()
+            ->filter(['published' => 'false'])
+            ->get();
+
+        $this->assertFilteredModels($expected, $actual);
+    }
+}