feat: update implementation for static schemas

lindyhopchris · lindyhopchris · commit c8b5433389d9 · 2024-03-24T18:05:49.000Z
diff --git a/src/Schema.php b/src/Schema.php
@@ -33,7 +33,6 @@
 
 abstract class Schema extends BaseSchema implements CountableSchema
 {
-
     /**
      * The relationships that should always be eager loaded.
      *
@@ -86,6 +85,14 @@ public function repository(): Repository
         );
     }
 
+    /**
+     * @return class-string<Model>
+     */
+    public function model(): string
+    {
+        return $this->static->getModel();
+    }
+
     /**
      * @return Model
      */
@@ -354,5 +361,4 @@ protected function driver(): Driver
     {
         return new StandardDriver($this->newInstance());
     }
-
 }
diff --git a/tests/app/Schemas/CarOwnerSchema.php b/tests/app/Schemas/CarOwnerSchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\CarOwner;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -21,16 +22,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(CarOwner::class)]
 class CarOwnerSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = CarOwner::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/CarSchema.php b/tests/app/Schemas/CarSchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\Car;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -20,16 +21,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Car::class)]
 class CarSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Car::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/CommentSchema.php b/tests/app/Schemas/CommentSchema.php
@@ -13,6 +13,7 @@
 
 use App\Models\Comment;
 use LaravelJsonApi\Contracts\Pagination\Paginator;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsTo;
@@ -22,16 +23,9 @@
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Comment::class)]
 class CommentSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Comment::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/CountrySchema.php b/tests/app/Schemas/CountrySchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\Country;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -20,16 +21,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Country::class)]
 class CountrySchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Country::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/ImageSchema.php b/tests/app/Schemas/ImageSchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\Image;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -20,16 +21,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Image::class)]
 class ImageSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Image::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/MechanicSchema.php b/tests/app/Schemas/MechanicSchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\Mechanic;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -20,16 +21,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Mechanic::class)]
 class MechanicSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Mechanic::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/PhoneSchema.php b/tests/app/Schemas/PhoneSchema.php
@@ -13,6 +13,7 @@
 
 use App\Models\Phone;
 use LaravelJsonApi\Contracts\Pagination\Paginator;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsTo;
@@ -21,16 +22,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Phone::class)]
 class PhoneSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Phone::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/PostSchema.php b/tests/app/Schemas/PostSchema.php
@@ -13,6 +13,7 @@
 
 use App\Models\Post;
 use LaravelJsonApi\Contracts\Pagination\Paginator;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsTo;
@@ -36,17 +37,11 @@
 use LaravelJsonApi\Eloquent\SoftDeletes;
 use LaravelJsonApi\Eloquent\Sorting\SortCountable;
 
+#[Model(Post::class)]
 class PostSchema extends Schema
 {
     use SoftDeletes;
 
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Post::class;
-
     /**
      * @var array|null
      */
diff --git a/tests/app/Schemas/RoleSchema.php b/tests/app/Schemas/RoleSchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\Role;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -20,16 +21,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Role::class)]
 class RoleSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Role::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/TagSchema.php b/tests/app/Schemas/TagSchema.php
@@ -13,6 +13,7 @@
 
 use App\Models\Tag;
 use LaravelJsonApi\Contracts\Pagination\Paginator;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsToMany;
@@ -21,16 +22,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Tag::class)]
 class TagSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Tag::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/UserAccountSchema.php b/tests/app/Schemas/UserAccountSchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\UserAccount;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -23,16 +24,9 @@
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\ProxySchema;
 
+#[Model(UserAccount::class)]
 class UserAccountSchema extends ProxySchema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = UserAccount::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/UserSchema.php b/tests/app/Schemas/UserSchema.php
@@ -12,6 +12,7 @@
 namespace App\Schemas;
 
 use App\Models\User;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
@@ -25,16 +26,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(User::class)]
 class UserSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = User::class;
-
     /**
      * @inheritDoc
      */
diff --git a/tests/app/Schemas/VideoSchema.php b/tests/app/Schemas/VideoSchema.php
@@ -13,6 +13,7 @@
 
 use App\Models\Video;
 use LaravelJsonApi\Contracts\Pagination\Paginator;
+use LaravelJsonApi\Core\Schema\Attributes\Model;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsToMany;
@@ -22,16 +23,9 @@
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
 use LaravelJsonApi\Eloquent\Schema;
 
+#[Model(Video::class)]
 class VideoSchema extends Schema
 {
-
-    /**
-     * The model the schema corresponds to.
-     *
-     * @var string
-     */
-    public static string $model = Video::class;
-
     /**
      * @inheritDoc
      */
@@ -69,5 +63,4 @@ public function pagination(): ?Paginator
     {
         return null;
     }
-
 }
diff --git a/tests/lib/Acceptance/FilterTest.php b/tests/lib/Acceptance/FilterTest.php
@@ -33,10 +33,12 @@ protected function setUp(): void
     {
         parent::setUp();
 
+        $static = self::$staticSchemas->schemaFor(PostSchema::class);
+
         $this->posts = $this
             ->getMockBuilder(PostSchema::class)
             ->onlyMethods(['isSingular'])
-            ->setConstructorArgs(['server' => $this->server()])
+            ->setConstructorArgs(['server' => $this->server(), 'static' => $static])
             ->getMock();
     }
 
diff --git a/tests/lib/Acceptance/Pagination/PagePaginationTest.php b/tests/lib/Acceptance/Pagination/PagePaginationTest.php
diff --git a/tests/lib/Acceptance/SortTest.php b/tests/lib/Acceptance/SortTest.php
diff --git a/tests/lib/Acceptance/TestCase.php b/tests/lib/Acceptance/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,6 @@`
`33`	`33`
`34`	`34`	`abstract class Schema extends BaseSchema implements CountableSchema`
`35`	`35`	`{`
`36`		`-`
`37`	`36`	`/**`
`38`	`37`	`* The relationships that should always be eager loaded.`
`39`	`38`	`*`
`@@ -86,6 +85,14 @@ public function repository(): Repository`
`86`	`85`	`);`
`87`	`86`	`}`
`88`	`87`
	`88`	`+ /**`
	`89`	`+ * @return class-string<Model>`
	`90`	`+ */`
	`91`	`+ public function model(): string`
	`92`	`+ {`
	`93`	`+ return $this->static->getModel();`
	`94`	`+ }`
	`95`	`+`
`89`	`96`	`/**`
`90`	`97`	`* @return Model`
`91`	`98`	`*/`
`@@ -354,5 +361,4 @@ protected function driver(): Driver`
`354`	`361`	`{`
`355`	`362`	`return new StandardDriver($this->newInstance());`
`356`	`363`	`}`
`357`		`-`
`358`	`364`	`}`