feat: add support of enum

Author: Ark4ne

src/Descriptors/Values.php

@@ -4,15 +4,14 @@
 
 use Ark4ne\JsonApi\Descriptors\Relations\RelationMany;
 use Ark4ne\JsonApi\Descriptors\Relations\RelationOne;
-use Ark4ne\JsonApi\Descriptors\Values\{
- ValueArray,
+use Ark4ne\JsonApi\Descriptors\Values\{ValueArray,
  ValueBool,
  ValueDate,
+ ValueEnum,
  ValueFloat,
  ValueInteger,
  ValueMixed,
- ValueString
-};
+ ValueString};
 use Closure;
 
 /**
@@ -89,4 +88,14 @@ protected function mixed(null|string|Closure $attribute = null): ValueMixed
  {
  return new ValueMixed($attribute);
  }
+
+ /**
+ * @param null|string|Closure(T):mixed $attribute
+ *
+ * @return \Ark4ne\JsonApi\Descriptors\Values\ValueEnum<T>
+ */
+ protected function enum(null|string|Closure $attribute = null): ValueEnum
+ {
+ return new ValueEnum($attribute);
+ }
 }

src/Descriptors/Values/ValueEnum.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Ark4ne\JsonApi\Descriptors\Values;
+
+use BackedEnum;
+use UnitEnum;
+
+/**
+ * @template T
+ * @extends Value<T>
+ */
+class ValueEnum extends Value
+{
+ protected function value(mixed $of): mixed
+ {
+ if ($of instanceof BackedEnum) return $of->value;
+ if ($of instanceof UnitEnum) return $of->name;
+
+ return $of;
+ }
+}

tests/Feature/SchemaTest.php

@@ -14,7 +14,7 @@ class SchemaTest extends FeatureTestCase
  public function testSchema()
  {
  $user = new Skeleton(UserResource::class, 'user', ['name', 'email', 'only-with-fields']);
- $post = new Skeleton(PostResource::class, 'post', ['title', 'content']);
+ $post = new Skeleton(PostResource::class, 'post', ['state', 'title', 'content']);
  $comment = new Skeleton(CommentResource::class, 'comment', ['content']);
 
  $user->relationships['posts'] = $post;

tests/Unit/Descriptors/ValueTest.php

@@ -6,6 +6,7 @@
 use Ark4ne\JsonApi\Descriptors\Values\ValueArray;
 use Ark4ne\JsonApi\Descriptors\Values\ValueBool;
 use Ark4ne\JsonApi\Descriptors\Values\ValueDate;
+use Ark4ne\JsonApi\Descriptors\Values\ValueEnum;
 use Ark4ne\JsonApi\Descriptors\Values\ValueFloat;
 use Ark4ne\JsonApi\Descriptors\Values\ValueInteger;
 use Ark4ne\JsonApi\Descriptors\Values\ValueMixed;
@@ -67,6 +68,8 @@ public static function values()
  'date.2' => [ValueDate::class, 1640995200, '2022-01-01T00:00:00+00:00', '1970-01-01T00:00:00+00:00'],
  'date.3' => [ValueDate::class, new DateTime("@1640995200"), '2022-01-01T00:00:00+00:00', '1970-01-01T00:00:00+00:00'],
  'date.4' => [ValueDate::class, new Carbon("@1640995200"), '2022-01-01T00:00:00+00:00', '1970-01-01T00:00:00+00:00'],
+ 'enum.0' => [ValueEnum::class, TestUnitEnum::A, 'A', null],
+ 'enum.1' => [ValueEnum::class, TestBackendEnum::A, 'aaa', null],
  ];
  }
 
@@ -243,3 +246,15 @@ private function throughRetrieverTest(&$model, \Closure $missing, \Closure $upda
  $this->assertEquals($expected, $check($valueClosureRetriever));
  }
 }
+
+enum TestBackendEnum: string
+{
+ case A = 'aaa';
+ case B = 'bbb';
+ case C = 'ccc';
+}
+enum TestUnitEnum {
+ case A;
+ case B;
+ case C;
+}

tests/app/Enums/State.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Test\app\Enums;
+
+enum State: int
+{
+ case Draft = 0;
+ case Published = 1;
+}

tests/app/Http/Resources/PostResource.php

@@ -19,6 +19,7 @@ protected function toType(Request $request): string
  protected function toAttributes(Request $request): iterable
  {
  return [
+ 'state' => $this->enum(),
  'title' => $this->string(),
  'content' => $this->string()->whenInFields(),
  ];

tests/app/Models/Post.php

@@ -6,10 +6,12 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Test\app\Enums\State;
 use Test\app\Factories\PostFactory;
 
 /**
  * @property int $id
+ * @property State $state
  * @property string $title
  * @property string $content
  * @property \DateTimeInterface $created_at
@@ -22,6 +24,11 @@ class Post extends Model
 {
  use HasFactory;
 
+ /** @var array<string, mixed> */
+ protected $casts = [
+ 'state' => State::class,
+ ];
+
  protected static function newFactory(): PostFactory
  {
  return new PostFactory();

tests/app/migrations.php

@@ -18,6 +18,9 @@ public function tables()
  },
  'posts' => function (Blueprint $table) {
  $table->id();
+ $table->boolean('state')
+ ->default(false)
+ ->comment('0: draft, 1: published');
  $table->string('title');
  $table->string('content');
  $table->timestamps();