Merge pull request #33 from AlexCatch/feature/identified-by-uuid

Add IdentifiedByUUID trait

README.md

@@ -21,7 +21,7 @@ If you have never used the Composer dependency manager before, head to the [Comp
 - [`ApiResponse`](#apiresponse)
 - [`Response`](#response)
 - [`ResponseCache`](#responsecache)
-
+- [`IdentifiedByUUID`](#identifiedbyuuid)
 
 ### `Models`
 The [Models helper](src/LangleyFoxall/Helpers/Models.php) offers helpful functions to do with [Eloquent Models](https://laravel.com/docs/eloquent).
@@ -656,4 +656,33 @@ if($cache->hasData()){
 }
 
 return ApiResponse::success($data)->cache(1, $cache)->json();
-```
+```
+
+### `IdentifiedByUUID`
+
+The `IdentifiedByUUID` trait allows you to easily use V4 UUIDs over incrementing primary keys.
+
+###### Example Usage
+
+Change your migrations to allow the use of a UUID.
+
+```php
+public function up()
+{
+    Schema::create('demos', function (Blueprint $table) {
+        $table->uuid('id')->primary();
+        $table->timestamps();
+    });
+}
+```
+
+Use the trait.
+
+```php
+class Demo extends Model
+{
+    use IdentifiedByUUID;
+}
+```
+
+Now when the model is saved, it will automatically be populated with a V4 UUID.

composer.json

@@ -35,13 +35,19 @@
     "php": "^7.0.0",
     "illuminate/support": ">=5.0",
     "illuminate/database": ">=5.0",
-    "illuminate/http": ">=5.0"
+    "illuminate/http": ">=5.0",
+    "orchestra/testbench": "3.8.x-dev"
   },
   "autoload": {
     "psr-4": {
       "LangleyFoxall\\": "src/LangleyFoxall/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "LangleyFoxall\\": "tests/"
+    }
+  },
   "extra": {
     "branch-alias": {
       "dev-master": "0.x-dev"

phpunit.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Helpers Laravel Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/LangleyFoxall</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="DB_CONNECTION" value="testing"/>
+    </php>
+</phpunit>

src/LangleyFoxall/Helpers/Traits/IdentifiedByUUID.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace LangleyFoxall\Helpers\Traits;
+
+use Illuminate\Support\Str;
+
+/**
+ * Trait IdentifiedByUUID.
+ */
+trait IdentifiedByUUID
+{
+    /**
+     * Boot the trait.
+     */
+    public static function bootIdentifiedByUUID()
+    {
+        static::creating(function ($model) {
+            if (!$model->getKey()) {
+                $model->{$model->getKeyName()} = (string) Str::uuid();
+            }
+        });
+    }
+
+    /**
+     * @return bool
+     */
+    public function getIncrementing()
+    {
+        return false;
+    }
+}

tests/Traits/IdentifiedByUUID/IdentifiedByUUIDTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace LangleyFoxall\Traits\IdentifiedByUUID;
+
+use LangleyFoxall\Traits\IdentifiedByUUID\Models\Demo;
+use Orchestra\Testbench\TestCase;
+
+class IdentifiedByUUIDTest extends TestCase
+{
+    /**
+     * Setup the test.
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->loadMigrationsFrom(__DIR__.'/Migrations');
+        $this->artisan('migrate', ['--database' => 'testing'])->run();
+    }
+
+    /**
+     * Check that saving a model correctly saves a UUID.
+     *
+     * @return void
+     */
+    public function testSaveStoresUUID()
+    {
+        $demo = Demo::create(['text' => 'hello world']);
+        $this->assertRegExp('/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i', $demo->uuid);
+    }
+
+    /**
+     * Check that updating the model does not change the UUID.
+     */
+    public function testUpdateDoesNotChangeUUID()
+    {
+        $demo = Demo::create(['text' => 'hello world']);
+        $uuid = $demo->uuid;
+
+        $demo->update(['text' => 'updated text']);
+
+        $this->assertTrue($demo->uuid === $uuid);
+    }
+}

tests/Traits/IdentifiedByUUID/Migrations/2019_06_28_121259_create_test_table.php

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

tests/Traits/IdentifiedByUUID/Models/Demo.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace LangleyFoxall\Traits\IdentifiedByUUID\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use LangleyFoxall\Helpers\Traits\IdentifiedByUUID;
+
+class Demo extends Model
+{
+    use IdentifiedByUUID;
+
+    /**
+     * @var string
+     */
+    protected $primaryKey = 'uuid';
+
+    /**
+     * @var array
+     */
+    protected $fillable = ['text'];
+}