refactor: use assert inside fillable relation field classes

Author: lindyhopchris

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+### Changed
+
+- Use `assert()` within fillable relation field classes rather as an optimisation.
+
 ## [3.1.0] - 2023-10-29
 
 ### Added

src/Fields/Relations/BelongsTo.php

@@ -20,14 +20,11 @@
 namespace LaravelJsonApi\Eloquent\Fields\Relations;
 
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\BelongsTo as EloquentBelongsTo;
 use LaravelJsonApi\Eloquent\Contracts\FillableToOne;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
-use LogicException;
 
 class BelongsTo extends ToOne implements FillableToOne
 {
-
     use IsReadOnly;
 
     /**
@@ -67,17 +64,31 @@ public function mustExist(): bool
      */
     public function fill(Model $model, ?array $identifier): void
     {
-        $relation = $model->{$this->relationName()}();
+        $name = $this->relationName();
 
-        if (!$relation instanceof EloquentBelongsTo) {
-            throw new LogicException('Expecting an Eloquent belongs-to relation.');
-        }
+        assert(method_exists($model, $name), sprintf(
+            'Expecting method %s to exist on model %s.',
+            $name,
+            $model::class,
+        ));
+
+        $relation = $model->{$name}();
 
         if ($related = $this->find($identifier)) {
+            assert(method_exists($relation, 'associate'), sprintf(
+                'Expecting relation class %s to have an "associate" method.',
+                $relation::class,
+            ));
             $relation->associate($related);
-        } else {
-            $relation->disassociate();
+            return;
         }
+
+        assert(method_exists($relation, 'disassociate'), sprintf(
+            'Expecting relation class %s to have a "disassociate" method.',
+            $relation::class,
+        ));
+
+        $relation->disassociate();
     }
 
     /**
@@ -90,5 +101,4 @@ public function associate(Model $model, ?array $identifier): ?Model
 
         return $model->getRelation($this->relationName());
     }
-
 }

src/Fields/Relations/BelongsToMany.php

@@ -25,8 +25,6 @@
 use InvalidArgumentException;
 use LaravelJsonApi\Eloquent\Contracts\FillableToMany;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
-use LogicException;
-use function get_class;
 use function sprintf;
 
 class BelongsToMany extends ToMany implements FillableToMany
@@ -158,17 +156,23 @@ public function detach(Model $model, array $identifiers): iterable
      */
     private function getRelation(Model $model): EloquentBelongsToMany
     {
-        $relation = $model->{$this->relationName()}();
+        $name = $this->relationName();
 
-        if ($relation instanceof EloquentBelongsToMany) {
-            return $relation;
-        }
+        assert(method_exists($model, $name), sprintf(
+            'Expecting method %s to exist on model %s.',
+            $name,
+            $model::class,
+        ));
+
+        $relation = $model->{$name}();
 
-        throw new LogicException(sprintf(
-            'Expecting relation %s on model %s to be a has-many or morph-many relation.',
-            $this->relationName(),
-            get_class($model)
+        assert($relation instanceof EloquentBelongsToMany, sprintf(
+            'Expecting method %s on model %s to return a belongs-to-many relation.',
+            $name,
+            $model::class,
         ));
+
+        return $relation;
     }
 
     /**
@@ -206,5 +210,4 @@ private function getPivotAttributes(Model $parent, Model $related): array
 
         return [];
     }
-
 }

src/Fields/Relations/HasMany.php

@@ -25,14 +25,17 @@
 use Illuminate\Database\Eloquent\Relations\MorphMany as EloquentMorphMany;
 use LaravelJsonApi\Eloquent\Contracts\FillableToMany;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
-use LogicException;
 use function sprintf;
 
 class HasMany extends ToMany implements FillableToMany
 {
-
+    /** @var int */
     private const KEEP_DETACHED_MODELS = 0;
+
+    /** @var int */
     private const DELETE_DETACHED_MODELS = 1;
+
+    /** @var int */
     private const FORCE_DELETE_DETACHED_MODELS = 2;
 
     use IsReadOnly;
@@ -160,19 +163,25 @@ private function doSync(Model $model, EloquentCollection $new): void
      * @param Model $model
      * @return EloquentHasMany|EloquentMorphMany
      */
-    private function getRelation(Model $model)
+    private function getRelation(Model $model): EloquentHasMany|EloquentMorphMany
     {
-        $relation = $model->{$this->relationName()}();
+        $name = $this->relationName();
 
-        if ($relation instanceof EloquentHasMany || $relation instanceof EloquentMorphMany) {
-            return $relation;
-        }
+        assert(method_exists($model, $name), sprintf(
+            'Expecting method %s to exist on model %s.',
+            $name,
+            $model::class,
+        ));
+
+        $relation = $model->{$name}();
 
-        throw new LogicException(sprintf(
-            'Expecting relation %s on model %s to be a has-many or morph-many relation.',
-            $this->relationName(),
-            get_class($model)
+        assert($relation instanceof EloquentHasMany || $relation instanceof EloquentMorphMany, sprintf(
+            'Expecting method %s on model %s to return a belongs-to-many relation.',
+            $name,
+            $model::class,
         ));
+
+        return $relation;
     }
 
     /**
@@ -228,5 +237,4 @@ private function deleteRelatedModels(EloquentCollection $remove): void
             $model->delete();
         }
     }
-
 }

src/Fields/Relations/HasOne.php

@@ -24,13 +24,16 @@
 use Illuminate\Database\Eloquent\Relations\MorphOne as EloquentMorphOne;
 use LaravelJsonApi\Eloquent\Contracts\FillableToOne;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
-use LogicException;
 
 class HasOne extends ToOne implements FillableToOne
 {
-
+    /** @var int */
     private const KEEP_DETACHED_MODEL = 0;
+
+    /** @var int */
     private const DELETE_DETACHED_MODEL = 1;
+
+    /** @var int */
     private const FORCE_DELETE_DETACHED_MODEL = 2;
 
     use IsReadOnly;
@@ -103,14 +106,24 @@ public function mustExist(): bool
      */
     public function fill(Model $model, ?array $identifier): void
     {
-        $relation = $model->{$this->relationName()}();
+        $name = $this->relationName();
 
-        if (!$relation instanceof EloquentHasOne && !$relation instanceof EloquentMorphOne) {
-            throw new LogicException('Expecting an Eloquent has-one or morph-one relation.');
-        }
+        assert(method_exists($model, $name), sprintf(
+            'Expecting method %s to exist on model %s.',
+            $name,
+            $model::class,
+        ));
+
+        $relation = $model->{$name}();
+
+        assert($relation instanceof EloquentHasOne || $relation instanceof EloquentMorphOne, sprintf(
+            'Expecting method %s on model %s to return a belongs-to-many relation.',
+            $name,
+            $model::class,
+        ));
 
         /** @var Model|null $current */
-        $current = $model->{$this->relationName()};
+        $current = $model->{$name};
         $related = $this->find($identifier);
 
         if ($this->willChange($current, $related)) {
@@ -150,7 +163,7 @@ private function willChange(?Model $current, ?Model $new): bool
      * @param EloquentMorphOne|EloquentHasOne $relation
      * @param Model $current
      */
-    private function disassociate($relation, Model $current): void
+    private function disassociate(EloquentMorphOne|EloquentHasOne $relation, Model $current): void
     {
         if (self::KEEP_DETACHED_MODEL === $this->detachMode) {
             $this->setInverseToNull($relation, $current);
@@ -163,11 +176,11 @@ private function disassociate($relation, Model $current): void
     /**
      * Disassociate the related model by setting the relationship column(s) to `null`.
      *
-     * @param $relation
+     * @param EloquentMorphOne|EloquentHasOne $relation
      * @param Model $current
      * @return void
      */
-    private function setInverseToNull($relation, Model $current): void
+    private function setInverseToNull(EloquentMorphOne|EloquentHasOne $relation, Model $current): void
     {
         if ($relation instanceof EloquentMorphOne) {
             $current->setAttribute($relation->getMorphType(), null);

src/Fields/Relations/MorphToMany.php

@@ -21,6 +21,7 @@
 
 use Generator;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
 use InvalidArgumentException;
 use IteratorAggregate;
 use LaravelJsonApi\Contracts\Schema\Container;
@@ -36,7 +37,6 @@
 
 class MorphToMany extends ToMany implements PolymorphicRelation, IteratorAggregate, FillableToMany
 {
-
     use Polymorphic;
     use IsReadOnly;
 
@@ -76,7 +76,7 @@ public function __construct(string $fieldName, array $relations)
      */
     public function inverseTypes(): array
     {
-        return collect($this->relations)
+        return Collection::make($this->relations)
             ->map(fn(ToMany $relation) => $relation->inverse())
             ->all();
     }