Merge branch 'diegomagikal-multiple_uuids'

Author: michaeldyrynda

.travis.yml

@@ -6,20 +6,6 @@ cache:
 
 matrix:
   include:
-    - php: 7.1
-      env: ILLUMINATE_VERSION=5.6.*
-    - php: 7.2
-      env: ILLUMINATE_VERSION=5.6.*
-    - php: 7.1
-      env: ILLUMINATE_VERSION=5.7.*
-    - php: 7.2
-      env: ILLUMINATE_VERSION=5.7.*
-    - php: 7.1
-      env: ILLUMINATE_VERSION=5.8.*
-    - php: 7.2
-      env: ILLUMINATE_VERSION=5.8.*
-    - php: 7.3
-      env: ILLUMINATE_VERSION=5.8.*
     - php: 7.2
       env: ILLUMINATE_VERSION=6.*
     - php: 7.3

README.md

@@ -1,5 +1,5 @@
 # Laravel Model UUIDs
-## v4.1.0
+## v5.0.0
 
 [![Build Status](https://travis-ci.org/michaeldyrynda/laravel-model-uuid.svg?branch=master)](https://travis-ci.org/michaeldyrynda/laravel-model-uuid)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/michaeldyrynda/laravel-model-uuid/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/michaeldyrynda/laravel-model-uuid/?branch=master)
@@ -44,13 +44,25 @@ It is assumed that you already have a field named `uuid` in your database, which
 ```php
 class Post extends Model
 {
-    public function uuidColumn()
+    public function uuidColumn(): string
     {
         return 'custom_column';
     }
 }
 ```
 
+You can have multiple UUID columns in each table by specifying an array in the `uuidColumns` method. When querying using the `whereUuid` scope, the default column - specified by `uuidColumn` will be used.
+
+```php
+class Post extends Model
+{
+    public function uuidColumns(): array
+    {
+        return ['uuid', 'custom_column'];
+    }
+}
+```
+
 By default, this package will use UUID version 4 values, however, you are welcome to use `uuid1`, `uuid3`, `uuid4`, or `uuid5` by specifying the protected property `$uuidVersion` in your model. Should you wish to take advantage of ordered UUID (version 4) values that were introduced in Laravel 5.6, you should specify `ordered` as the `$uuidVersion` in your model.
 
 ```php
@@ -72,7 +84,17 @@ class Post extends Model
 This trait also provides a query scope which will allow you to easily find your records based on their UUID, and respects any custom field name you choose.
 
 ```php
+// Find a specific post with the default (uuid) column name
 $post = Post::whereUuid($uuid)->first();
+
+// Find multiple posts with the default (uuid) column name
+$post = Post::whereUuid([$first, $second])->get();
+
+// Find a specific post with a custom column name
+$post = Post::whereUuid($uuid, 'custom_column')->first();
+
+// Find multiple posts with a custom column name
+$post = Post::whereUuid([$first, $second], 'custom_column')->get();
 ```
 
 If you use the suggested [laravel-efficient-uuid](https://github.com/michaeldyrynda/laravel-efficient-uuid) package, you will need to add a cast to your model in order to correctly set and retrieve your UUID values. This will ensure your UUIDs are written to your (MySQL) database as binary and presented as strings.
@@ -124,7 +146,7 @@ public function boot()
 This package is installed via [Composer](https://getcomposer.org/). To install, run the following command.
 
 ```bash
-composer require "dyrynda/laravel-model-uuid:~4.1"
+composer require dyrynda/laravel-model-uuid
 ```
 ## Support
 

composer.json

@@ -16,10 +16,10 @@
         }
     ],
     "require": {
-        "php": "^7.1.3",
-        "illuminate/database": "~5.6|^6.0",
-        "illuminate/events": "~5.6|^6.0",
-        "illuminate/support": "~5.6|^6.0",
+        "php": "^7.2",
+        "illuminate/database": "^6.0",
+        "illuminate/events": "^6.0",
+        "illuminate/support": "^6.0",
         "ramsey/uuid": "~3.7",
         "moontoast/math": "^1.1"
     },
@@ -29,7 +29,7 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.0"
+        "phpunit/phpunit": "^8.0"
     },
     "autoload-dev": {
         "psr-4": {

src/GeneratesUuid.php

@@ -3,7 +3,10 @@
 namespace Dyrynda\Database\Support;
 
 use Ramsey\Uuid\Uuid;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Contracts\Support\Arrayable;
 
 /**
  * UUID generation trait.
@@ -50,18 +53,18 @@ abstract public function hasCast($key, $types = null);
      *
      * @return void
      */
-    public static function bootGeneratesUuid()
+    public static function bootGeneratesUuid(): void
     {
         static::creating(function ($model) {
             /* @var \Illuminate\Database\Eloquent\Model|static $model */
             $uuid = $model->resolveUuid();
-
-            if (isset($model->attributes[$model->uuidColumn()]) && ! is_null($model->attributes[$model->uuidColumn()])) {
-                /* @var \Ramsey\Uuid\Uuid $uuid */
-                $uuid = $uuid->fromString(strtolower($model->attributes[$model->uuidColumn()]));
+            foreach ($model->uuidColumns() as $item) {
+                if (isset($model->attributes[$item]) && ! is_null($model->attributes[$item])) {
+                    /* @var \Ramsey\Uuid\Uuid $uuid */
+                    $uuid = $uuid->fromString(strtolower($model->attributes[$item]));
+                }
+                $model->attributes[$item] = $model->hasCast($item, 'uuid') ? $uuid->getBytes() : $uuid->toString();
             }
-
-            $model->attributes[$model->uuidColumn()] = $model->hasCast($model->uuidColumn(), 'uuid') ? $uuid->getBytes() : $uuid->toString();
         });
     }
 
@@ -70,17 +73,27 @@ public static function bootGeneratesUuid()
      *
      * @return string
      */
-    public function uuidColumn()
+    public function uuidColumn(): string
     {
         return 'uuid';
     }
 
+    /**
+     * The names of the columns that should be used for the UUID.
+     *
+     * @return array
+     */
+    public function uuidColumns(): array
+    {
+        return [$this->uuidColumn()];
+    }
+
     /**
      * Resolve a UUID instance for the configured version.
      *
      * @return \Ramsey\Uuid\Uuid
      */
-    public function resolveUuid()
+    public function resolveUuid(): Uuid
     {
         if (($version = $this->resolveUuidVersion()) == 'ordered') {
             return Str::orderedUuid();
@@ -94,7 +107,7 @@ public function resolveUuid()
      *
      * @return string
      */
-    public function resolveUuidVersion()
+    public function resolveUuidVersion(): string
     {
         if (property_exists($this, 'uuidVersion') && in_array($this->uuidVersion, $this->uuidVersions)) {
             return $this->uuidVersion;
@@ -108,16 +121,40 @@ public function resolveUuidVersion()
      *
      * @param  \Illuminate\Database\Eloquent\Builder  $query
      * @param  string  $uuid
+     * @param  string  $uuidColumn
      *
      * @return \Illuminate\Database\Eloquent\Builder
      */
-    public function scopeWhereUuid($query, $uuid)
+    public function scopeWhereUuid($query, $uuid, $uuidColumn = null): Builder
+    {
+        $uuidColumn = ! is_null($uuidColumn) && in_array($uuidColumn, $this->uuidColumns())
+            ? $uuidColumn
+            : $this->uuidColumns()[0];
+
+        if ($this->hasCast($uuidColumn)) {
+            $uuid = $this->bytesFromUuid($uuid);
+        }
+
+        return $query->whereIn($uuidColumn, Arr::wrap($uuid));
+    }
+
+    /**
+     * Convert a single UUID or array of UUIDs to bytes
+     *
+     * @param  \Illuminate\Contracts\Support\Arrayable|array|string  $uuid
+     * @return array
+     */
+    protected function bytesFromUuid($uuid): array
     {
-        if ($this->hasCast($this->uuidColumn())) {
-            $uuid = $this->resolveUuid()->fromString($uuid)->getBytes();
+        if (is_array($uuid) || $uuid instanceof Arrayable) {
+            array_walk($uuid, function (&$uuid) {
+                $uuid = $this->resolveUuid()->fromString($uuid)->getBytes();
+            });
+
+            return $uuid;
         }
 
-        return $query->where($this->uuidColumn(), $uuid);
+        return Arr::wrap($this->resolveUuid()->fromString($uuid)->getBytes());
     }
 
     /**
@@ -129,7 +166,7 @@ public function scopeWhereUuid($query, $uuid)
      */
     protected function castAttribute($key, $value)
     {
-        if ($key === $this->uuidColumn() && ! is_null($value)) {
+        if (in_array($key, $this->uuidColumns()) && ! empty($value)) {
             return $this->resolveUuid()->fromBytes($value)->toString();
         }
 

tests/Feature/UuidTest.php

@@ -9,12 +9,13 @@
 use Illuminate\Events\Dispatcher;
 use Tests\Fixtures\CustomUuidPost;
 use Illuminate\Container\Container;
+use Tests\Fixtures\MultipleUuidPost;
 use Tests\Fixtures\CustomCastUuidPost;
 use Illuminate\Database\Capsule\Manager;
 
 class UuidTest extends TestCase
 {
-    public static function setupBeforeClass()
+    public static function setupBeforeClass(): void
     {
         $manager = new Manager;
         $manager->addConnection(['driver' => 'sqlite', 'database' => ':memory:']);
@@ -55,12 +56,57 @@ public function you_can_find_a_model_by_its_uuid()
 
         Post::create(['title' => 'test post', 'uuid' => $uuid]);
 
-        $post = Post::whereUuid(strtoupper($uuid))->first();
+        $post = Post::whereUuid($uuid)->first();
 
         $this->assertInstanceOf(Post::class, $post);
         $this->assertSame($uuid, $post->uuid);
     }
 
+    /** @test */
+    public function you_can_find_a_model_by_custom_uuid_parameter()
+    {
+        $uuid = '6499332d-25e1-4d75-bd92-c6ded0820fb3';
+        $custom_uuid = '99635d83-05bc-424f-bf3f-395ea7a5b323';
+
+        MultipleUuidPost::create(['title' => 'test post', 'uuid' => $uuid, 'custom_uuid' => $custom_uuid]);
+
+        $post1 = MultipleUuidPost::whereUuid($uuid)->first();
+        $this->assertInstanceOf(MultipleUuidPost::class, $post1);
+        $this->assertSame($uuid, $post1->uuid);
+
+        $post2 = MultipleUuidPost::whereUuid($uuid, 'uuid')->first();
+        $this->assertInstanceOf(MultipleUuidPost::class, $post2);
+        $this->assertSame($uuid, $post2->uuid);
+
+        $post3 = MultipleUuidPost::whereUuid($custom_uuid, 'custom_uuid')->first();
+        $this->assertInstanceOf(MultipleUuidPost::class, $post3);
+        $this->assertSame($custom_uuid, $post3->custom_uuid);
+    }
+
+    /** @test */
+    public function you_can_search_by_array_of_uuids()
+    {
+        $first = Post::create(['title' => 'first post', 'uuid' => '8ab48e77-d9cd-4fe7-ace5-a5a428590c18']);
+        $second = Post::create(['title' => 'second post', 'uuid' => 'c7c26456-ddb0-45cd-9b1c-318296cce7a3']);
+
+        $this->assertEquals(2, Post::whereUuid([
+            '8ab48e77-d9cd-4fe7-ace5-A5A428590C18',
+            'c7c26456-ddb0-45cd-9b1c-318296cce7a3',
+        ])->count());
+    }
+
+    /** @test */
+    public function you_can_search_by_array_of_uuids_for_custom_column()
+    {
+        $first = CustomCastUuidPost::create(['title' => 'first post', 'custom_uuid' => '8ab48e77-d9cd-4fe7-ace5-a5a428590c18']);
+        $second = CustomCastUuidPost::create(['title' => 'second post', 'custom_uuid' => 'c7c26456-ddb0-45cd-9b1c-318296cce7a3']);
+
+        $this->assertEquals(2, CustomCastUuidPost::whereUuid([
+            '8ab48e77-d9cd-4fe7-ace5-A5A428590C18',
+            'c7c26456-ddb0-45cd-9b1c-318296cce7a3',
+        ], 'custom_uuid')->count());
+    }
+
     /** @test */
     public function you_can_generate_a_uuid_without_casting()
     {

tests/Fixtures/CustomCastUuidPost.php

@@ -9,7 +9,7 @@ class CustomCastUuidPost extends Model
      */
     protected $casts = ['custom_uuid' => 'uuid'];
 
-    public function uuidColumn()
+    public function uuidColumn(): string
     {
         return 'custom_uuid';
     }

tests/Fixtures/CustomUuidPost.php

@@ -4,7 +4,7 @@
 
 class CustomUuidPost extends Model
 {
-    public function uuidColumn()
+    public function uuidColumn(): string
     {
         return 'custom_uuid';
     }

tests/Fixtures/MultipleUuidPost.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Tests\Fixtures;
+
+class MultipleUuidPost extends Model
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected $casts = ['uuid' => 'uuid', 'custom_uuid' => 'uuid'];
+
+    public function uuidColumns(): array
+    {
+        return ['uuid', 'custom_uuid'];
+    }
+}