Uuid Observer

Author: joselfonseca

app/Entities/Users/User.php

@@ -34,7 +34,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      *
      * @var array
      */
-    protected $fillable = ['name', 'email', 'password'];
+    protected $fillable = ['uuid', 'name', 'email', 'password'];
 
     /**
      * The attributes excluded from the model's JSON form.

app/Observers/UuidObserver.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Observers;
+
+use Webpatser\Uuid\Uuid;
+
+/**
+ * Class UuidObserver
+ * @package App\Observers
+ */
+class UuidObserver
+{
+
+    /**
+     * @param $model
+     * @throws \Exception
+     */
+    public function creating($model)
+    {
+        $model->uuid = Uuid::generate(4);
+    }
+
+}

app/Providers/EventServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace App\Providers;
 
+use App\Entities\Users\User;
+use App\Observers\UuidObserver;
 use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
 
@@ -25,7 +27,15 @@ class EventServiceProvider extends ServiceProvider
     public function boot(DispatcherContract $events)
     {
         parent::boot($events);
+        $this->registerObservers();
+    }
 
-        //
+    /**
+     * @return $this
+     */
+    public function registerObservers()
+    {
+        User::observe(app(UuidObserver::class));
+        return $this;
     }
 }

database/migrations/2014_10_12_000000_create_users_table.php

@@ -14,6 +14,7 @@ public function up()
     {
         Schema::create('users', function (Blueprint $table) {
             $table->increments('id');
+            $table->string('uuid')->index();
             $table->string('name');
             $table->string('email')->unique();
             $table->string('password', 60);

readme.md

@@ -167,6 +167,58 @@ $api->version('v1', function ($api) {
 );
 ```
 
+## Uuid
+
+The started kit comes with a UUID observer to add to your models, this way the uuid will be generated when the model is being created.
+
+This is an example for the User model.
+
+```php
+namespace App\Providers;
+
+use App\Entities\Users\User;
+use App\Observers\UuidObserver;
+use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+
+/**
+ * Class EventServiceProvider
+ * @package App\Providers
+ */
+class EventServiceProvider extends ServiceProvider
+{
+    /**
+     * The event listener mappings for the application.
+     *
+     * @var array
+     */
+    protected $listen = [
+
+    ];
+
+    /**
+     * Register any other events for your application.
+     *
+     * @param  \Illuminate\Contracts\Events\Dispatcher $events
+     * @return void
+     */
+    public function boot(DispatcherContract $events)
+    {
+        parent::boot($events);
+        $this->registerObservers();
+    }
+
+    /**
+     * @return $this
+     */
+    public function registerObservers()
+    {
+        User::observe(app(UuidObserver::class));
+        return $this;
+    }
+}
+```
+
 ## Tests
 
 Navigate to the project root and run `vendor/bin/phpunit` after installing all the composer dependencies and after the .env file was created.

tests/Observers/UuidObserverTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Tests\Observers;
+
+use App\Tests\TestCase;
+use App\Entities\Users\User;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+
+class UuidObserverTest extends TestCase
+{
+
+    use DatabaseMigrations;
+
+    /**
+     * @test
+     */
+    public function itGeneratesUuidForUser()
+    {
+        $user = factory(User::class)->create();
+        $this->assertFalse(empty($user->uuid));
+        $this->seeInDatabase('users', [
+            'uuid' => $user->uuid->string
+        ]);
+    }
+
+}