Rename trait and refacto

Author: florianJacques

src/Eloquent/HasDocumentVersion.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Eloquent;
+
+trait HasSchemaVersion
+{
+    public $currentSchemaVersion = 1;
+
+    /**
+     * Auto call on model instance as booting
+     *
+     * @return void
+     */
+    public static function bootHasSchemaVersion(): void
+    {
+        static::saving(function ($model) {
+          if (!$model->getSchemaVersion()) {
+              $model->setSchemaVersion($model->currentSchemaVersion);
+          }
+        });
+
+        static::retrieved(function ($model) {
+            if ($model->getSchemaVersion() < $model->currentSchemaVersion) {
+                $model->migrateSchemaVersion($model->getSchemaVersion());
+            }
+        });
+    }
+
+    /**
+     * Migrate document to the current schema version.
+     */
+    public function migrateSchema(int $fromVersion): void
+    {
+    }
+
+    /**
+     * Get Current document version
+     *
+     * @return int
+     */
+    public function getSchemaVersion(): int
+    {
+        return $this->{static::getSchemaVersionKey()} ?? 0;
+    }
+
+    /**
+     * @param int $version
+     * @return void
+     */
+    public function setSchemaVersion(int $version): void
+    {
+            $this->{static::getSchemaVersionKey()} = $version;
+    }
+
+    /**
+     * Get document version key
+     *
+     * @return string
+     */
+    public static function getSchemaVersionKey(): string
+    {
+       return 'schema_version';
+    }
+}

src/Eloquent/HasSchemaVersion.php

@@ -14,25 +14,29 @@ public function tearDown(): void
         DocumentVersion::truncate();
     }
 
-    public function testCreateWithNullId()
+    public function testWithBasicDocument()
     {
         $document = new DocumentVersion(['name' => 'Luc']);
-        $this->assertEmpty($document->getDocumentVersion());
+        $this->assertEmpty($document->getSchemaVersion());
         $document->save();
 
-        $this->assertEquals(1, $document->getDocumentVersion());
+        $this->assertEquals(1, $document->getSchemaVersion());
         $this->assertNull($document->age);
 
-        $document = DocumentVersion::query()->where('name', 'Luc')->first();
+        $document->currentSchemaVersion = 2;
+        $document->migrateSchemaVersion($document->getSchemaVersion());
+
         $this->assertEquals(35, $document->age);
-        $this->assertEquals(2, $document->getDocumentVersion());
+        $this->assertEquals(2, $document->getSchemaVersion());
 
         // Test without migration
         $newDocument = new DocumentVersion(['name' => 'Vador']);
-        $newDocument->setDocumentVersion(2);
+        $newDocument->setSchemaVersion(2);
         $newDocument->save();
+        $newDocument->currentSchemaVersion = 2;
+        $newDocument->migrateSchema($newDocument->getSchemaVersion());
 
-        $this->assertEquals(2, $newDocument->getDocumentVersion());
+        $this->assertEquals(2, $newDocument->getSchemaVersion());
         $this->assertNull($newDocument->age);
 
         $newDocument = DocumentVersion::query()->where('name', 'Vador')->first();

tests/DocumentVersionTest.php

@@ -4,24 +4,24 @@
 
 namespace MongoDB\Laravel\Tests\Models;
 
-use MongoDB\Laravel\Eloquent\HasDocumentVersion;
+use MongoDB\Laravel\Eloquent\HasSchemaVersion;
 use MongoDB\Laravel\Eloquent\Model as Eloquent;
 
 class DocumentVersion extends Eloquent
 {
-    use HasDocumentVersion;
+    use HasSchemaVersion;
 
     protected $connection       = 'mongodb';
     protected $collection       = 'documentVersion';
     protected static $unguarded = true;
 
-    public function migrateDocumentVersion($fromVersion): void
+    public function migrateSchemaVersion($fromVersion): void
     {
         if ($fromVersion) {
             if ($fromVersion < 2) {
                 $this->age = 35;
 
-                $this->setDocumentVersion(2);
+                $this->setSchemaVersion(2);
             }
         }
     }