Add document version feature

Author: florianJacques

src/Eloquent/HasDocumentVersion.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Eloquent;
+
+trait HasDocumentVersion
+{
+    /**
+     * Auto call on model instance as booting
+     *
+     * @return void
+     */
+    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;
+            }
+        });
+    }
+
+    /**
+     * Get document version key
+     *
+     * @return string
+     */
+    protected static function getDocumentVersionKey(): string
+    {
+        return defined(static::class.'::DOCUMENT_VERSION_KEY')
+            ? (string) static::DOCUMENT_VERSION_KEY
+            : '__v';
+    }
+}

tests/ModelTest.php

@@ -19,6 +19,7 @@
 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;
@@ -53,6 +54,7 @@ public function tearDown(): void
         Book::truncate();
         Item::truncate();
         Guarded::truncate();
+        DocumentVersion::truncate();
     }
 
     public function testNewModel(): void
@@ -1188,6 +1190,12 @@ 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

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Tests\Models;
+
+use MongoDB\Laravel\Eloquent\HasDocumentVersion;
+use MongoDB\Laravel\Eloquent\Model as Eloquent;
+
+/** @property int __v */
+class DocumentVersion extends Eloquent
+{
+    use HasDocumentVersion;
+
+    protected $connection       = 'mongodb';
+    protected $collection       = 'documentVersion';
+    protected static $unguarded = true;
+}