feat: rename Valuable to Describer

Author: Ark4ne

src/Descriptors/Valuable.php src/Descriptors/Describer.phpsrc/Descriptors/Valuable.php renamed to src/Descriptors/Describer.php

@@ -10,7 +10,7 @@
 /**
  * @template T as \Illuminate\Database\Eloquent\Model
  */
-abstract class Valuable
+abstract class Describer
 {
     /**
      * @var array<Closure(Request, T, string): bool>
@@ -46,7 +46,7 @@ public function whenNotNull(): static
             Request $request,
             Model $model,
             string $attribute
-        ): bool => null !== $this->valueForModel($model, $attribute));
+        ): bool => null !== $this->retrieveValue($model, $attribute));
     }
 
     /**
@@ -60,7 +60,23 @@ public function whenFilled(): static
             Request $request,
             Model $model,
             string $attribute
-        ): bool => filled($this->valueForModel($model, $attribute)));
+        ): bool => filled($this->retrieveValue($model, $attribute)));
+    }
+
+    /**
+     * @param \Illuminate\Http\Request $request
+     * @param T                        $model
+     * @param string                   $field
+     *
+     * @return mixed
+     */
+    public function valueFor(Request $request, Model $model, string $field): mixed
+    {
+        if (!$this->check($request, $model, $field)) {
+            return new MissingValue();
+        }
+
+        return $this->resolveFor($request, $model, $field);
     }
 
     /**
@@ -72,7 +88,7 @@ public function whenFilled(): static
      *
      * @return bool
      */
-    public function check(Request $request, Model $model, string $attribute): bool
+    protected function check(Request $request, Model $model, string $attribute): bool
     {
         foreach ($this->rules as $rule) {
             if (!$rule($request, $model, $attribute)) {
@@ -83,23 +99,7 @@ public function check(Request $request, Model $model, string $attribute): bool
         return true;
     }
 
-    /**
-     * @param \Illuminate\Http\Request $request
-     * @param T                        $model
-     * @param string                   $field
-     *
-     * @return mixed
-     */
-    public function valueFor(Request $request, Model $model, string $field): mixed
-    {
-        if (!$this->check($request, $model, $field)) {
-            return new MissingValue();
-        }
-
-        return $this->resolveFor($request, $model, $field);
-    }
-
-    private function valueForModel(Model $model, string $attribute): mixed
+    private function retrieveValue(Model $model, string $attribute): mixed
     {
         $retriever = $this->retriever();
         if ($retriever === null) {

src/Descriptors/Relations/Relation.php

@@ -2,17 +2,18 @@
 
 namespace Ark4ne\JsonApi\Descriptors\Relations;
 
-use Ark4ne\JsonApi\Descriptors\Valuable;
+use Ark4ne\JsonApi\Descriptors\Describer;
 use Ark4ne\JsonApi\Resources\Relationship;
 use Closure;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request;
+use Illuminate\Http\Resources\MissingValue;
 
 /**
  * @template T as \Illuminate\Database\Eloquent\Model
- * @extends Valuable<T>
+ * @extends Describer<T>
  */
-abstract class Relation extends Valuable
+abstract class Relation extends Describer
 {
     protected ?Closure $links = null;
     protected ?Closure $meta = null;
@@ -87,13 +88,15 @@ public function whenPivotLoaded(string $table, string $accessor = null): static
 
     public function resolveFor(Request $request, Model $model, string $field): Relationship
     {
-        if ($this->relation instanceof Closure) {
-            $value = fn() => ($this->relation)($model, $field);
+        $retriever = $this->retriever();
+
+        if ($retriever instanceof Closure) {
+            $value = static fn() => $retriever($model, $field);
         } else {
-            $value = fn() => $model->getRelationValue($this->relation ?? $field);
+            $value = static fn() => $model->getRelationValue($retriever ?? $field);
         }
 
-        $relation = $this->value($value);
+        $relation = $this->value(fn() => $this->check($request, $model, $field) ? $value() : new MissingValue());
 
         if ($this->whenIncluded) {
             $relation->whenIncluded();
@@ -102,5 +105,17 @@ public function resolveFor(Request $request, Model $model, string $field): Relat
         return $relation;
     }
 
+    /**
+     * @param \Illuminate\Http\Request $request
+     * @param T                        $model
+     * @param string                   $field
+     *
+     * @return mixed
+     */
+    public function valueFor(Request $request, Model $model, string $field): mixed
+    {
+        return $this->resolveFor($request, $model, $field);
+    }
+
     abstract protected function value(Closure $value): Relationship;
 }

src/Descriptors/Resolver.php

@@ -21,12 +21,12 @@ protected function resolveValues(Request $request, ?iterable $values): ?array
 
         return (new Collection($values))
             ->reduce(function (Collection $fields, $value, int|string $key) use ($request) {
-                if (is_int($key) && ($value instanceof Valuable) && is_string($value->retriever())) {
+                if (is_int($key) && ($value instanceof Describer) && is_string($value->retriever())) {
                     $key = $value->retriever();
                 }
 
                 $fields[$key] = value(
-                    $value instanceof Valuable
+                    $value instanceof Describer
                         ? $value->valueFor($request, $this->resource, $key)
                         : $value
                 );

src/Descriptors/Values/Value.php

@@ -2,17 +2,17 @@
 
 namespace Ark4ne\JsonApi\Descriptors\Values;
 
-use Ark4ne\JsonApi\Descriptors\Valuable;
+use Ark4ne\JsonApi\Descriptors\Describer;
 use Ark4ne\JsonApi\Support\Fields;
 use Closure;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request;
 
 /**
  * @template T as \Illuminate\Database\Eloquent\Model
- * @extends Valuable<T>
+ * @extends Describer<T>
  */
-abstract class Value extends Valuable
+abstract class Value extends Describer
 {
     protected bool $nullable = true;