Add document version setter, remove public property

Author: florianJacques

src/Eloquent/HasDocumentVersion.php

@@ -6,8 +6,6 @@
 
 trait HasDocumentVersion
 {
-    public $documentVersion = 1;
-
     /**
      * Auto call on model instance as booting
      *
@@ -17,23 +15,26 @@ public static function bootHasDocumentVersion(): void
     {
         static::saving(function ($model) {
           $version = $model->getDocumentVersion();
-          if (empty($version)) {
-              $model->{static::getDocumentVersionKey()} = $model->documentVersion ?? 1;
+
+          if (!$version) {
+              $model->setDocumentVersion(static::getCurrentVersion());
           }
         });
 
         static::retrieved(function ($model) {
-            $model->migrateDocumentVersion($model->getDocumentVersion() ?? 0);
+            $model->migrateDocumentVersion($model->getDocumentVersion());
         });
     }
 
     /**
      * migrate model document version schema
      *
-     * @param int $fromVersion
+     * @param int|null $fromVersion
      * @return void
      */
-    public function migrateDocumentVersion(int $fromVersion): void {}
+    public function migrateDocumentVersion($fromVersion): void
+    {
+    }
 
     /**
      * Get Current document version
@@ -45,6 +46,15 @@ public function getDocumentVersion(): ?int
         return $this->{static::getDocumentVersionKey()} ?? null;
     }
 
+    /**
+     * @param int $version
+     * @return void
+     */
+    public function setDocumentVersion(int $version): void
+    {
+            $this->{static::getDocumentVersionKey()} = $version;
+    }
+
     /**
      * Get document version key
      *
@@ -56,4 +66,14 @@ protected static function getDocumentVersionKey(): string
             ? (string) static::DOCUMENT_VERSION_KEY
             : 'schema_version';
     }
+
+    /**
+     * @return int
+     */
+    protected static function getCurrentVersion(): int
+    {
+        return defined(static::class.'::DOCUMENT_VERSION')
+            ? (int) static::DOCUMENT_VERSION
+            : 1;
+    }
 }

tests/DocumentVersionTest.php

@@ -25,10 +25,11 @@ public function testCreateWithNullId()
 
         $document = DocumentVersion::query()->where('name', 'Luc')->first();
         $this->assertEquals(35, $document->age);
+        $this->assertEquals(2, $document->getDocumentVersion());
 
         // Test without migration
         $newDocument = new DocumentVersion(['name' => 'Vador']);
-        $newDocument->documentVersion = 2;
+        $newDocument->setDocumentVersion(2);
         $newDocument->save();
 
         $this->assertEquals(2, $newDocument->getDocumentVersion());

tests/Models/DocumentVersion.php

@@ -14,11 +14,14 @@ class DocumentVersion extends Eloquent
     protected $connection       = 'mongodb';
     protected $collection       = 'documentVersion';
     protected static $unguarded = true;
-    public function migrateDocumentVersion(int $fromVersion): void
+
+    public function migrateDocumentVersion($fromVersion): void
     {
         if ($fromVersion) {
             if ($fromVersion < 2) {
                 $this->age = 35;
+
+                $this->setDocumentVersion(2);
             }
         }
     }