Merge pull request #5 from yabhq/feat/uuid-models

Feat/UUID models

Author: jimhlad

src/Traits/Uuid.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Yab\Mint\Traits;
+
+use Ramsey\Uuid\Uuid as RamseyUuid;
+
+trait Uuid
+{
+    /**
+     * Hook into the boot method to catch creating and saving events
+     *
+     * @return void
+     */
+    public static function bootUuid()
+    {
+        static::creating(function ($model) {
+            $model->id = RamseyUuid::uuid4()->toString();
+        });
+
+        static::saving(function ($model) {
+            if ($model->id !== $model->getOriginal('id')) {
+                $model->id = $model->getOriginal('id');
+            }
+        });
+    }
+
+    /**
+     * Get the route key for the model.
+     *
+     * @return string
+     */
+    public function getRouteKeyName()
+    {
+        return 'id';
+    }
+
+    /**
+     * Get the value indicating whether the IDs are incrementing.
+     *
+     * @return bool
+     */
+    public function getIncrementing()
+    {
+        return false;
+    }
+}

tests/Factories/UuidModelFactory.php

@@ -0,0 +1,7 @@
+<?php
+
+use Yab\Mint\Tests\Models\UuidModel;
+
+$factory->define(UuidModel::class, function () {
+    return [];
+});

tests/Migrations/2020_06_23_000000_create_archivable_models_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateArchivableModelsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('archivable_models', function (Blueprint $table) {
+            $table->increments('id');
+            $table->timestamp('archived_at')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('archivable_models');
+    }
+}

tests/Migrations/2020_06_23_000000_create_castable_models_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateCastableModelsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('castable_models', function (Blueprint $table) {
+            $table->increments('id');
+            $table->integer('amount');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('castable_models');
+    }
+}

tests/Migrations/2020_06_23_000000_create_eventful_models_table.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateEventfulModelsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('eventful_models', function (Blueprint $table) {
+            $table->increments('id');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('eventful_models');
+    }
+}

tests/Migrations/2020_06_23_000000_create_immutable_models_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateImmutableModelsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('immutable_models', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('field')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('immutable_models');
+    }
+}

tests/Migrations/2020_06_23_000000_create_uuid_models_table.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateUuidModelsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('uuid_models', function (Blueprint $table) {
+            $table->string('id');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('uuid_models');
+    }
+}

tests/Models/UuidModel.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Yab\Mint\Tests\Models;
+
+use Yab\Mint\Traits\Uuid;
+use Illuminate\Database\Eloquent\Model;
+
+class UuidModel extends Model
+{
+    use Uuid;
+}

tests/TestCase.php

@@ -2,8 +2,6 @@
 
 namespace Yab\Mint\Tests;
 
-use Illuminate\Support\Facades\Schema;
-use Illuminate\Database\Schema\Blueprint;
 use Orchestra\Testbench\TestCase as OrchestraTestCase;
 
 abstract class TestCase extends OrchestraTestCase
@@ -17,30 +15,9 @@ public function setUp(): void
     {
         parent::setUp();
 
-        Schema::create('eventful_models', function (Blueprint $table) {
-            $table->increments('id');
-            $table->timestamps();
-        });
-
-        Schema::create('archivable_models', function (Blueprint $table) {
-            $table->increments('id');
-            $table->timestamp('archived_at')->nullable();
-            $table->timestamps();
-        });
-
-        Schema::create('immutable_models', function (Blueprint $table) {
-            $table->increments('id');
-            $table->string('field')->nullable();
-            $table->timestamps();
-        });
-
-        Schema::create('castable_models', function (Blueprint $table) {
-            $table->increments('id');
-            $table->integer('amount');
-            $table->timestamps();
-        });
-
         $this->withFactories(__DIR__ . '/Factories');
+
+        $this->loadMigrationsFrom(__DIR__ . '/Migrations');
     }
 
     /**

tests/UuidTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Yab\Mint\Tests;
+
+use Ramsey\Uuid\Uuid;
+use Yab\Mint\Tests\TestCase;
+use Yab\Mint\Tests\Models\UuidModel;
+
+class UuidTest extends TestCase
+{
+    /** @test */
+    public function a_newly_created_uuid_model_has_a_uuid()
+    {
+        $model = factory(UuidModel::class)->create();
+
+        $this->assertTrue(Uuid::isValid($model->id));
+
+        $this->assertDatabaseHas('uuid_models', [
+            'id' => $model->id,
+        ]);
+    }
+
+    /** @test */
+    public function the_uuid_of_a_model_can_not_be_altered()
+    {
+        $model = factory(UuidModel::class)->create();
+
+        $this->assertTrue(Uuid::isValid($model->id));
+
+        $originalId = $model->id;
+
+        $model->id = 'something-else';
+        $model->save();
+
+        $this->assertDatabaseHas('uuid_models', [
+            'id' => $originalId,
+        ]);
+    }
+}