Merge pull request ProAI#8 from garret-gunter/fix/no-extra-versions

Only add version when saving versioned fields

Author: garret-gunter

src/BuilderTrait.php

@@ -119,6 +119,11 @@ public function update(array $values) {
 		// get records
 		$affectedRecords = $this->getAffectedRecords();
 
+		// only update main table if not updating versioned fields.
+		if (empty($versionValues)) {
+			return $this->toBase()->update($values);
+		}
+
 		// update main table records
 		if (! $this->query->increment($this->model->getLatestVersionColumn(), 1, $values)) {
 			return false;

tests/Models/Comment.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace ProAI\Versioning\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use ProAI\Versioning\Versionable;
+
+/**
+ * Class Comment
+ *
+ * A model without versioned timestamps.
+ *
+ * @package ProAI\Versioning\Tests\Models
+ *
+ * @property int $id
+ * @property string $latest_version
+ * @property string $content
+ * @property string $title
+ * @property \Carbon\Carbon|null $created_at
+ * @property \Carbon\Carbon|null $updated_at
+ *
+ * @mixin \Illuminate\Database\Eloquent\Builder
+ */
+class Comment extends Model {
+	use Versionable;
+
+	/**
+	 * The attributes that are mass assignable.
+	 *
+	 * @var array
+	 */
+	protected $fillable = [
+		'content', 'latest_version', 'title',
+	];
+
+	/**
+	 * Indicates if the model should be timestamped.
+	 *
+	 * @var bool
+	 */
+	public $timestamps = true;
+
+	public $versioned = ['content'];
+}

tests/Models/Post.php

@@ -2,7 +2,7 @@
 
 namespace ProAI\Versioning\Tests\Models;
 
-use Illuminate\Foundation\Auth\User as Authenticatable;
+use Illuminate\Database\Eloquent\Model;
 use ProAI\Versioning\Versionable;
 use ProAI\Versioning\SoftDeletes;
 
@@ -19,7 +19,7 @@
  *
  * @mixin \Illuminate\Database\Eloquent\Builder
  */
-class Post extends Authenticatable {
+class Post extends Model {
 	use Versionable;
 	use SoftDeletes;
 

tests/Unit/BuilderTest.php

@@ -206,8 +206,8 @@ public function itWillThrowExceptionWhenKeysAreTooLong(): void {
 
 		$builder = $model->newQuery();
 		$builder->update([
-			               'a.long.key'  => 'Citadel',
-		               ]);
+						   'a.long.key'  => 'Citadel',
+					   ]);
 	}
 
 	/**

tests/Unit/VersionableTest.php

@@ -3,6 +3,7 @@
 namespace ProAI\Versioning\Tests\Unit;
 
 use Carbon\Carbon;
+use ProAI\Versioning\Tests\Models\Comment;
 use ProAI\Versioning\Tests\Models\User;
 use ProAI\Versioning\Tests\TestCase;
 
@@ -159,30 +160,48 @@ public function itWillUpdateTheLatestVersionWhenSaving(): void {
 	 * @test
 	 */
 	public function itWillOnlyVersionVersionedAttributes(): void {
-		/** @var User $model */
-		$model = factory(User::class)->create([]);
-		$email = $model->email;
+		/** @var Comment $model */
+		$model = factory(Comment::class)->create(
+			[
+				'title' => 'Some kind of lorem impsum should go here',
+			]
+		);
+		$originalContent = $model->content;
+
+		$newContent = 'I approve of this comment.';
+		$model->content = $newContent;
+		$model->save();
 
-		$model->email = '[email protected]';
-		$model->username = 'RickSanchez';
+		$newTitle = 'Not lorem ipsum';
+		$model->title = $newTitle;
 		$model->save();
 
 		$this->assertDatabaseHas($model->getTable(), [
-			'username'  => 'RickSanchez',
+			'title'  => $newTitle,
 		]);
 
 		$this->assertDatabaseHas($model->getVersionTable(), [
 			'ref_id'    => $model->id,
 			'version'   => 1,
-			'email'     => $email,
-			'city'      => $model->city
+			'content'     => $originalContent,
 		]);
 
 		$this->assertDatabaseHas($model->getVersionTable(), [
 			'ref_id'    => $model->id,
 			'version'   => 2,
-			'email'     => $model->email,
-			'city'      => $model->city
+			'content'   => $newContent,
+		]);
+
+		// Latest version should be 2.
+		$this->assertDatabaseHas($model->getTable(), [
+			'title' => $newTitle,
+			'latest_version' => 2,
+		]);
+
+		// A 3rd version should not exist.
+		$this->assertDatabaseMissing($model->getVersionTable(), [
+			['ref_id', $model->id,],
+			['version', '>=', 3,],
 		]);
 	}
 }

tests/database/factories/CommentFactory.php

@@ -0,0 +1,18 @@
+<?php
+
+use Faker\Generator as Faker;
+use ProAI\Versioning\Tests\Models\Comment;
+
+/*
+|--------------------------------------------------------------------------
+| Comment Factories
+|--------------------------------------------------------------------------
+|
+*/
+/** @var \Illuminate\Database\Eloquent\Factory $factory */
+$factory->define(Comment::class, static function (Faker $faker) {
+	return [
+		'title' => $faker->sentence,
+		'content' => $faker->text,
+	];
+});

tests/database/migrations/2020_05_29_100000_create_comments_table.php

@@ -0,0 +1,40 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateCommentsTable extends Migration {
+
+	/**
+	 * Run the migrations.
+	 *
+	 * @return void
+	 */
+	public function up(): void {
+		Schema::create('comments', static function (Blueprint $table) {
+			$table->increments('id');
+			$table->integer('latest_version');
+			$table->text('title');
+			$table->timestamps();
+		});
+
+		Schema::create('comments_version', static function (Blueprint $table) {
+			$table->integer('ref_id')->unsigned();
+			$table->integer('version')->unsigned();
+			$table->text('content');
+
+			$table->primary(['ref_id', 'version']);
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 *
+	 * @return void
+	 */
+	public function down(): void {
+		Schema::dropIfExists('comments');
+		Schema::dropIfExists('comments_version');
+	}
+}