Add BooleanDateTime attribute

Author: tobyzerner

docs/attributes.md

@@ -42,6 +42,21 @@ Date::make('dob');
 DateTime::make('publishedAt');
 ```
 
+### BooleanDateTime
+
+The `BooleanDateTime` attribute behaves like the `Boolean` attribute, except
+that before setting the value to the model, a `true` value is set as the current
+date, and a `false` value is set as `null`. This can be used to represent a
+field that is stored internally as a timestamp as a boolean in the API.
+
+```php
+use Tobyz\JsonApiServer\Field\DateTime;
+
+BooleanDateTime::make('isDeleted')
+    ->property('deleted_at')
+    ->writable();
+```
+
 ### Number and Integer
 
 The `Number` attribute serializes values to floats, and performs validation to

src/Schema/Field/BooleanDateTime.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Tobyz\JsonApiServer\Schema\Field;
+
+use Tobyz\JsonApiServer\Context;
+
+class BooleanDateTime extends Boolean
+{
+    public function setValue(mixed $model, mixed $value, Context $context): void
+    {
+        parent::setValue($model, $value ? new \DateTime() : null, $context);
+    }
+
+    public function saveValue(mixed $model, mixed $value, Context $context): void
+    {
+        parent::saveValue($model, $value ? new \DateTime() : null, $context);
+    }
+}

tests/feature/BooleanDateTimeTest.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace Tobyz\Tests\JsonApiServer\feature;
+
+use Tobyz\JsonApiServer\Endpoint\Create;
+use Tobyz\JsonApiServer\Endpoint\Update;
+use Tobyz\JsonApiServer\Exception\UnprocessableEntityException;
+use Tobyz\JsonApiServer\JsonApi;
+use Tobyz\JsonApiServer\Schema\Field\BooleanDateTime;
+use Tobyz\Tests\JsonApiServer\AbstractTestCase;
+use Tobyz\Tests\JsonApiServer\MockResource;
+
+class BooleanDateTimeTest extends AbstractTestCase
+{
+    private JsonApi $api;
+
+    public function setUp(): void
+    {
+        $this->api = new JsonApi();
+    }
+
+    public function test_validates_boolean()
+    {
+        $this->api->resource(
+            new MockResource(
+                'users',
+                endpoints: [Create::make()],
+                fields: [
+                    BooleanDateTime::make('isDeleted')
+                        ->property('deletedAt')
+                        ->writable(),
+                ],
+            ),
+        );
+
+        $this->expectException(UnprocessableEntityException::class);
+
+        $this->api->handle(
+            $this->buildRequest('POST', '/users')->withParsedBody([
+                'data' => ['type' => 'users', 'attributes' => ['isDeleted' => 'hello']],
+            ]),
+        );
+    }
+
+    public function test_sets_value_as_date_time()
+    {
+        $this->api->resource(
+            new MockResource(
+                'users',
+                models: [($user = (object) ['id' => '1'])],
+                endpoints: [Update::make()],
+                fields: [
+                    BooleanDateTime::make('isDeleted')
+                        ->property('deletedAt')
+                        ->writable(),
+                ],
+            ),
+        );
+
+        $response = $this->api->handle(
+            $this->buildRequest('PATCH', '/users/1')->withParsedBody([
+                'data' => ['type' => 'users', 'id' => '1', 'attributes' => ['isDeleted' => true]],
+            ]),
+        );
+
+        $this->assertInstanceOf(\DateTime::class, $user->deletedAt);
+
+        $this->assertJsonApiDocumentSubset(
+            ['data' => ['attributes' => ['isDeleted' => true]]],
+            $response->getBody(),
+            true,
+        );
+    }
+
+    public function test_sets_value_as_null()
+    {
+        $this->api->resource(
+            new MockResource(
+                'users',
+                models: [($user = (object) ['id' => '1'])],
+                endpoints: [Update::make()],
+                fields: [
+                    BooleanDateTime::make('isDeleted')
+                        ->property('deletedAt')
+                        ->writable(),
+                ],
+            ),
+        );
+
+        $response = $this->api->handle(
+            $this->buildRequest('PATCH', '/users/1')->withParsedBody([
+                'data' => ['type' => 'users', 'id' => '1', 'attributes' => ['isDeleted' => false]],
+            ]),
+        );
+
+        $this->assertNull($user->deletedAt);
+
+        $this->assertJsonApiDocumentSubset(
+            ['data' => ['attributes' => ['isDeleted' => false]]],
+            $response->getBody(),
+            true,
+        );
+    }
+}

tests/feature/BooleanTest.php

@@ -51,7 +51,7 @@ public function test_validates_boolean()
 
         $this->expectException(UnprocessableEntityException::class);
 
-        $response = $this->api->handle(
+        $this->api->handle(
             $this->buildRequest('POST', '/users')->withParsedBody([
                 'data' => ['type' => 'users', 'attributes' => ['name' => 'hello']],
             ]),