Use the trait for every test model

Author: GromNaN

src/Eloquent/DocumentModel.php

@@ -53,19 +53,10 @@ trait DocumentModel
     use HybridRelations;
     use EmbedsRelations;
 
-    /**
-     * The collection associated with the model.
-     *
-     * @var string
-     */
-    protected $collection;
-
     /**
      * The parent relation instance.
-     *
-     * @var Relation
      */
-    protected $parentRelation;
+    private Relation $parentRelation;
 
     /**
      * List of field names to unset from the document on save.
@@ -150,7 +141,7 @@ public function freshTimestamp()
     /** @inheritdoc */
     public function getTable()
     {
-        return $this->collection ?: parent::getTable();
+        return $this->collection ?? parent::getTable();
     }
 
     /** @inheritdoc */
@@ -552,12 +543,10 @@ public function setParentRelation(Relation $relation)
 
     /**
      * Get the parent relation.
-     *
-     * @return Relation
      */
-    public function getParentRelation()
+    public function getParentRelation(): ?Relation
     {
-        return $this->parentRelation;
+        return $this->parentRelation ?? null;
     }
 
     /** @inheritdoc */

src/Eloquent/Model.php

@@ -28,7 +28,13 @@ abstract class Model extends BaseModel
      */
     protected $keyType = 'string';
 
-    /** @param class-string|object $related */
+    /**
+     * Indicates if the given model class is a MongoDB document model.
+     * It must be a subclass of {@see BaseModel} and use the
+     * {@see DocumentModel} trait.
+     *
+     * @param class-string|object $related
+     */
     public static function isDocumentModel(string|object $related): bool
     {
         return is_subclass_of($related, BaseModel::class)

tests/Models/Address.php

@@ -4,12 +4,17 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use Illuminate\Database\Eloquent\Model;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 use MongoDB\Laravel\Relations\EmbedsMany;
 
-class Address extends Eloquent
+class Address extends Model
 {
-    protected $connection       = 'mongodb';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
     protected static $unguarded = true;
 
     public function addresses(): EmbedsMany

tests/Models/Birthday.php

@@ -4,17 +4,22 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use Illuminate\Database\Eloquent\Model;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
 /**
  * @property string $name
  * @property string $birthday
  * @property string $time
  */
-class Birthday extends Eloquent
+class Birthday extends Model
 {
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
     protected $connection = 'mongodb';
-    protected $collection = 'birthday';
+    protected string $collection = 'birthday';
     protected $fillable   = ['name', 'birthday'];
 
     protected $casts = ['birthday' => 'datetime'];

tests/Models/Book.php

@@ -4,20 +4,24 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
 /**
  * @property string $title
  * @property string $author
  * @property array $chapters
  */
-class Book extends Eloquent
+class Book extends Model
 {
-    protected $connection       = 'mongodb';
-    protected $collection       = 'books';
+    use DocumentModel;
+
+    protected $primaryKey = 'title';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
+    protected string $collection = 'books';
     protected static $unguarded = true;
-    protected $primaryKey       = 'title';
 
     public function author(): BelongsTo
     {

tests/Models/CastObjectId.php

@@ -4,12 +4,17 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
 use MongoDB\Laravel\Eloquent\Casts\ObjectId;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class CastObjectId extends Eloquent
+class CastObjectId extends Model
 {
-    protected $connection       = 'mongodb';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
     protected static $unguarded = true;
     protected $casts            = [
         'oid' => ObjectId::class,

tests/Models/Casting.php

@@ -4,13 +4,18 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
 use MongoDB\Laravel\Eloquent\Casts\BinaryUuid;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class Casting extends Eloquent
+class Casting extends Model
 {
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
     protected $connection = 'mongodb';
-    protected $collection = 'casting';
+    protected string $collection = 'casting';
 
     protected $fillable = [
         'uuid',

tests/Models/Client.php

@@ -4,15 +4,20 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\MorphOne;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class Client extends Eloquent
+class Client extends Model
 {
-    protected $connection       = 'mongodb';
-    protected $collection       = 'clients';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
+    protected string $collection = 'clients';
     protected static $unguarded = true;
 
     public function users(): BelongsToMany

tests/Models/Experience.php

@@ -4,13 +4,18 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphToMany;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class Experience extends Eloquent
+class Experience extends Model
 {
-    protected $connection       = 'mongodb';
-    protected $collection       = 'experiences';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
+    protected string $collection = 'experiences';
     protected static $unguarded = true;
 
     protected $casts = ['years' => 'int'];

tests/Models/Group.php

@@ -4,13 +4,18 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class Group extends Eloquent
+class Group extends Model
 {
-    protected $connection       = 'mongodb';
-    protected $collection       = 'groups';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
+    protected string $collection = 'groups';
     protected static $unguarded = true;
 
     public function users(): BelongsToMany

tests/Models/Guarded.php

@@ -4,11 +4,16 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use Illuminate\Database\Eloquent\Model;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class Guarded extends Eloquent
+class Guarded extends Model
 {
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
     protected $connection = 'mongodb';
-    protected $collection = 'guarded';
-    protected $guarded    = ['foobar', 'level1->level2'];
+    protected string $collection = 'guarded';
+    protected $guarded = ['foobar', 'level1->level2'];
 }

tests/Models/HiddenAnimal.php

@@ -4,6 +4,8 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 use MongoDB\Laravel\Eloquent\Model as Eloquent;
 use MongoDB\Laravel\Query\Builder;
 
@@ -16,8 +18,12 @@
  * @method static Builder truncate()
  * @method static Eloquent sole(...$parameters)
  */
-final class HiddenAnimal extends Eloquent
+final class HiddenAnimal extends Model
 {
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
     protected $fillable = [
         'name',
         'country',

tests/Models/IdIsBinaryUuid.php

@@ -4,14 +4,19 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
+use Illuminate\Database\Eloquent\Model;
 use MongoDB\Laravel\Eloquent\Casts\BinaryUuid;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class IdIsBinaryUuid extends Eloquent
+class IdIsBinaryUuid extends Model
 {
-    protected $connection       = 'mongodb';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
     protected static $unguarded = true;
-    protected $casts            = [
+    protected $casts = [
         '_id' => BinaryUuid::class,
     ];
 }

tests/Models/IdIsInt.php

@@ -4,12 +4,16 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use Illuminate\Database\Eloquent\Model;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class IdIsInt extends Eloquent
+class IdIsInt extends Model
 {
-    protected $keyType          = 'int';
-    protected $connection       = 'mongodb';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'int';
+    protected $connection = 'mongodb';
     protected static $unguarded = true;
-    protected $casts            = ['_id' => 'int'];
+    protected $casts = ['_id' => 'int'];
 }

tests/Models/IdIsString.php

@@ -4,11 +4,16 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use Illuminate\Database\Eloquent\Model;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
-class IdIsString extends Eloquent
+class IdIsString extends Model
 {
-    protected $connection       = 'mongodb';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
     protected static $unguarded = true;
-    protected $casts            = ['_id' => 'string'];
+    protected $casts = ['_id' => 'string'];
 }

tests/Models/Item.php

@@ -5,15 +5,20 @@
 namespace MongoDB\Laravel\Tests\Models;
 
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use MongoDB\Laravel\Eloquent\Builder;
-use MongoDB\Laravel\Eloquent\Model as Eloquent;
+use MongoDB\Laravel\Eloquent\DocumentModel;
 
 /** @property Carbon $created_at */
-class Item extends Eloquent
+class Item extends Model
 {
-    protected $connection       = 'mongodb';
-    protected $collection       = 'items';
+    use DocumentModel;
+
+    protected $primaryKey = '_id';
+    protected $keyType = 'string';
+    protected $connection = 'mongodb';
+    protected string $collection = 'items';
     protected static $unguarded = true;
 
     public function user(): BelongsTo