[Refactor] Add failing test for default include paths

Author: lindyhopchris

src/Contracts/Schema/SchemaProviderInterface.php

@@ -105,4 +105,11 @@ public function getRelationshipSelfLink(object $resource, string $field): LinkIn
      * @return LinkInterface
      */
     public function getRelationshipRelatedLink(object $resource, string $field): LinkInterface;
+
+    /**
+     * Get schema default include paths.
+     *
+     * @return string[]
+     */
+    public function getIncludePaths(): array;
 }

src/Schema/SchemaProvider.php

@@ -169,6 +169,14 @@ public function getRelationshipRelatedLink(object $resource, string $field): Lin
         );
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function getIncludePaths(): array
+    {
+        return [];
+    }
+
     /**
      * Get the relationship self url.
      *

tests/lib/Integration/Eloquent/ResourceTest.php

@@ -18,8 +18,10 @@
 namespace CloudCreativity\LaravelJsonApi\Tests\Integration\Eloquent;
 
 use Carbon\Carbon;
+use CloudCreativity\LaravelJsonApi\Factories\Factory;
 use CloudCreativity\LaravelJsonApi\Tests\Integration\TestCase;
 use DummyApp\Comment;
+use DummyApp\JsonApi\Posts\Schema;
 use DummyApp\Post;
 use DummyApp\Tag;
 use Illuminate\Support\Facades\Event;
@@ -422,6 +424,45 @@ public function testReadWithEmptyInclude(): void
         $response->assertFetchedOne($this->serialize($post));
     }
 
+    public function testReadWithDefaultInclude(): void
+    {
+        $mockSchema = $this
+            ->getMockBuilder(Schema::class)
+            ->onlyMethods(['getIncludePaths'])
+            ->setConstructorArgs([$this->app->make(Factory::class)])
+            ->getMock();
+
+        $mockSchema->method('getIncludePaths')->willReturn(['author', 'tags', 'comments']);
+
+        $this->app->instance(Schema::class, $mockSchema);
+
+        $model = $this->createPost();
+        $tag = $model->tags()->create(['name' => 'Important']);
+
+        $expected = $this->serialize($model);
+
+        $expected['relationships']['author']['data'] = [
+            'type' => 'users',
+            'id' => (string) $model->author_id,
+        ];
+
+        $expected['relationships']['tags']['data'] = [
+            ['type' => 'tags', 'id' => $tag->uuid],
+        ];
+
+        $expected['relationships']['comments']['data'] = [];
+
+        $response = $this
+            ->withoutExceptionHandling()
+            ->jsonApi()
+            ->get(url('/api/v1/posts', $model));
+
+        $response
+            ->assertFetchedOne($expected)
+            ->assertIsIncluded('users', $model->author)
+            ->assertIsIncluded('tags', $tag);
+    }
+
     /**
      * @see https://github.com/cloudcreativity/laravel-json-api/issues/194
      */