add assertRelationship assertion

Author: Gummibeer

README.md

@@ -135,6 +135,8 @@ This will prevent any method name conflicts with core, your custom or other trai
 ```php
 \Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertExists($model);
 \Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertSame($model, \App\Models\User::first());
+\Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertRelated($post, $comment, 'comments');
+\Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertRelationship($post, \App\Models\Comment::class, 'comments', \Illuminate\Database\Eloquent\Relations\HasMany::class);
 ```
 
 ### Blade

src/Laravel/ModelAssertions.php

@@ -10,6 +10,11 @@
 
 trait ModelAssertions
 {
+    /**
+     * @param string|\Illuminate\Database\Eloquent\Model $table
+     * @param array $data
+     * @param string|null $connection
+     */
     public static function assertExists($table, array $data = [], ?string $connection = null): void
     {
         if ($table instanceof Model) {
@@ -28,14 +33,23 @@ public static function assertExists($table, array $data = [], ?string $connectio
         );
     }
 
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $expected
+     * @param \Illuminate\Database\Eloquent\Model|mixed $actual
+     */
     public static function assertSame(Model $expected, $actual): void
     {
         PHPUnit::assertInstanceOf(get_class($expected), $actual);
         PHPUnit::assertSame($expected->exists, $actual->exists);
         PHPUnit::assertTrue($expected->is($actual));
     }
 
-    public static function assertRelated(Model $model, $actual, string $relation)
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string $relation
+     * @param \Illuminate\Database\Eloquent\Model|mixed $actual
+     */
+    public static function assertRelated(Model $model, string $relation, $actual)
     {
         PHPUnit::assertInstanceOf(Model::class, $actual);
         PHPUnit::assertTrue(method_exists($model, $relation));
@@ -44,4 +58,30 @@ public static function assertRelated(Model $model, $actual, string $relation)
         $related = $model->$relation()->whereKey($actual->getKey())->first();
         self::assertSame($actual, $related);
     }
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string $relation
+     * @param string|\Illuminate\Database\Eloquent\Model|mixed $actual
+     * @param string|null $type
+     */
+    public static function assertRelationship(Model $model, string $relation, $actual, ?string $type = null)
+    {
+        PHPUnit::assertTrue(method_exists($model, $relation));
+        PHPUnit::assertInstanceOf(Relation::class, $model->$relation());
+
+        if($type) {
+            PHPUnit::assertInstanceOf($type, $model->$relation());
+        }
+
+        $related = $model->$relation()->getRelated();
+        PHPUnit::assertInstanceOf(Model::class, $related);
+
+        if(is_string($actual)) {
+            PHPUnit::assertInstanceOf($actual, $related);
+        } else {
+            PHPUnit::assertInstanceOf(get_class($actual), $related);
+            self::assertRelated($model, $relation, $actual);
+        }
+    }
 }

tests/Laravel/ModelAssertionsTest.php

@@ -5,6 +5,8 @@
 use Astrotomic\PhpunitAssertions\Laravel\ModelAssertions;
 use Astrotomic\PhpunitAssertions\Tests\Laravel\Models\Comment;
 use Astrotomic\PhpunitAssertions\Tests\Laravel\Models\Post;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 
 final class ModelAssertionsTest extends TestCase
 {
@@ -57,7 +59,31 @@ public function it_can_validate_related(): void
             'post_id' => $post->getKey(),
         ]);
 
-        ModelAssertions::assertRelated($post, $comment, 'comments');
-        ModelAssertions::assertRelated($comment, $post, 'post');
+        ModelAssertions::assertRelated($post, 'comments', $comment);
+        ModelAssertions::assertRelated($comment, 'post', $post);
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public function it_can_validate_relationship(): void
+    {
+        $post = Post::create([
+            'title' => self::randomString(),
+        ]);
+
+        $comment = Comment::create([
+            'message' => self::randomString(),
+            'post_id' => $post->getKey(),
+        ]);
+
+        ModelAssertions::assertRelationship($post, 'comments', Comment::class);
+        ModelAssertions::assertRelationship($post, 'comments', Comment::class, HasMany::class);
+        ModelAssertions::assertRelationship($post, 'comments', $comment, HasMany::class);
+
+        ModelAssertions::assertRelationship($comment, 'post', Post::class);
+        ModelAssertions::assertRelationship($comment, 'post', Post::class, BelongsTo::class);
+        ModelAssertions::assertRelationship($comment, 'post', $post, BelongsTo::class);
     }
 }