Add retrieved model migration and version helpers

Author: florianJacques

src/Eloquent/HasDocumentVersion.php

@@ -6,6 +6,8 @@
 
 trait HasDocumentVersion
 {
+    public $documentVersion = 1;
+
     /**
      * Auto call on model instance as booting
      *
@@ -16,11 +18,31 @@ public static function bootHasDocumentVersion(): void
         static::saving(function ($model) {
             $versionKey = static::getDocumentVersionKey();
             if (!empty($versionKey)) {
-                $model->{$versionKey} = defined(static::class.'::DOCUMENT_VERSION')
-                    ? (int) static::DOCUMENT_VERSION
-                    : 1;
+                $model->{$versionKey} = $model->documentVersion ?? 1;
             }
         });
+
+        static::retrieved(function ($model) {
+            $model->migrateDocumentVersion($model->getDocumentVersion());
+        });
+    }
+
+    /**
+     * migrate model document version schema
+     *
+     * @param int $fromVersion
+     * @return void
+     */
+    public function migrateDocumentVersion(int $fromVersion): void {}
+
+    /**
+     * Get Current document version
+     *
+     * @return int
+     */
+    public function getDocumentVersion(): int
+    {
+        return (int) $this->{static::getDocumentVersionKey()} ?? 0;
     }
 
     /**
@@ -32,6 +54,6 @@ protected static function getDocumentVersionKey(): string
     {
         return defined(static::class.'::DOCUMENT_VERSION_KEY')
             ? (string) static::DOCUMENT_VERSION_KEY
-            : '__v';
+            : 'schema_version';
     }
 }

tests/DocumentVersionTest.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Tests;
+
+use MongoDB\Laravel\Tests\Models\DocumentVersion;
+use MongoDB\Laravel\Tests\Models\User;
+
+class DocumentVersionTest extends TestCase
+{
+    public function tearDown(): void
+    {
+        DocumentVersion::truncate();
+    }
+
+    public function testCreateWithNullId()
+    {
+        $document = new DocumentVersion(['name' => 'Luc']);
+        $this->assertEmpty($document->getDocumentVersion());
+        $document->save();
+
+        $this->assertEquals(1, $document->getDocumentVersion());
+        $this->assertNull($document->age);
+
+        $document = DocumentVersion::query()->where('name', 'Luc')->first();
+        $this->assertEquals(35, $document->age);
+
+        dump($document->toArray());
+
+        // Test without migration
+        $newDocument = new DocumentVersion(['name' => 'Vador']);
+        $newDocument->documentVersion = 2;
+        $newDocument->save();
+
+        $this->assertEquals(2, $newDocument->getDocumentVersion());
+        $this->assertNull($newDocument->age);
+
+        $document = DocumentVersion::query()->where('name', 'Vador')->first();
+        $this->assertNull($newDocument->age);
+
+        dump($newDocument->toArray());
+    }
+}

tests/ModelTest.php

@@ -19,7 +19,6 @@
 use MongoDB\Laravel\Connection;
 use MongoDB\Laravel\Eloquent\Model;
 use MongoDB\Laravel\Tests\Models\Book;
-use MongoDB\Laravel\Tests\Models\DocumentVersion;
 use MongoDB\Laravel\Tests\Models\Guarded;
 use MongoDB\Laravel\Tests\Models\IdIsBinaryUuid;
 use MongoDB\Laravel\Tests\Models\IdIsInt;
@@ -54,7 +53,6 @@ public function tearDown(): void
         Book::truncate();
         Item::truncate();
         Guarded::truncate();
-        DocumentVersion::truncate();
     }
 
     public function testNewModel(): void
@@ -1190,12 +1188,6 @@ public function testCreateWithNullId()
         $this->assertSame(1, User::count());
     }
 
-    public function testDocumentVersion()
-    {
-        $document = DocumentVersion::create(['name' => 'versionTest']);
-        $this->assertEquals(1, $document->__v);
-    }
-
     /** @param class-string<Model> $modelClass */
     private static function registerModelEvents(string $modelClass, array &$events): void
     {

tests/Models/DocumentVersion.php

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