Feature: Configurable UUID version (#142)

* Feature: Added configuration option for uuid version, defaults to uuid4 and if no configuration option is set then still defaults to uuid4.

---------

Co-authored-by: Jamie Fairweather <16147285+zagreusinoz@users.noreply.github.com>
Co-authored-by: Michael Dyrynda <michael@dyrynda.com.au>

Author: zagreusinoz

README.md

@@ -85,13 +85,25 @@ class Post extends Model
 {
     use GeneratesUuid;
 
-    public function uuidVersion(): string
+    public function uuidVersion(): ?string
     {
         return 'uuid5';
     }
 }
 ```
 
+Alternatively, if you would like to use a consistent `$uuidVersion` on all of your models, you may set the `uuid_version` in your `config/model-uuid.php`.
+A non-empty value returned from the model's `uuidVersion(): ?string` method will take priority over the config version.
+
+```php
+return [
+    /**
+     * The default uuid version used to generate UUID value.
+     */
+    'uuid_version' => 'uuid4',
+];
+```
+
 Whilst not recommended, if you _do_ choose to use a UUID as your primary model key (`id`), be sure to configure your model for this setup correctly. Not updating these properties will lead to Laravel attempting to convert your `id` column to an integer, which will be cast to `0`. When used in combination with the `EfficientUuid` cast, this casting will result in a `Ramsey\Uuid\Exception\InvalidUuidStringException` being thrown.
 
 ```php

config/model-uuid.php

@@ -5,4 +5,9 @@
      * The default column name which should be used to store the generated UUID value.
      */
     'column_name' => 'uuid',
+
+    /**
+     * The default uuid version used to generate UUID value.
+     */
+    'uuid_version' => 'uuid4',
 ];

src/GeneratesUuid.php

@@ -92,17 +92,20 @@ public function resolveUuid(): UuidInterface
         return call_user_func([Uuid::class, $this->resolveUuidVersion()]);
     }
 
-    public function uuidVersion(): string
+    public function uuidVersion(): ?string
     {
-        return 'uuid4';
+        return null;
     }
 
     /**
      * Resolve the UUID version to use when setting the UUID value. Default to uuid4.
      */
     public function resolveUuidVersion(): string
     {
-        if (($uuidVersion = $this->uuidVersion()) === 'ordered') {
+
+        $uuidVersion = $this->uuidVersion() ?? config('model-uuid.uuid_version', 'uuid4');
+
+        if ($uuidVersion === 'ordered') {
             $uuidVersion = 'uuid6';
         }
 

tests/Feature/GeneratesUuidTest.php

@@ -30,4 +30,61 @@ public function it_gets_default_column_name()
             'The UUID column should match the configured value.'
         );
     }
+
+    #[Test]
+    public function it_inherits_uuid_version_from_config()
+    {
+        Config::set('model-uuid.uuid_version', 'uuid1');
+
+        $testClass = new class
+        {
+            use GeneratesUuid;
+        };
+
+        $this->assertSame('uuid1', $testClass->resolveUuidVersion());
+    }
+
+    #[Test]
+    public function it_defaults_to_uuid4_when_config_not_set()
+    {
+        Config::set('model-uuid.uuid_version', null);
+
+        $testClass = new class
+        {
+            use GeneratesUuid;
+        };
+
+        $this->assertSame('uuid4', $testClass->resolveUuidVersion());
+    }
+
+    #[Test]
+    public function it_defaults_to_uuid4_when_config_is_empty()
+    {
+        Config::set('model-uuid.uuid_version', '');
+
+        $testClass = new class
+        {
+            use GeneratesUuid;
+        };
+
+        $this->assertSame('uuid4', $testClass->resolveUuidVersion());
+    }
+
+    #[Test]
+    public function it_uses_model_definition_as_highest_precedence()
+    {
+        Config::set('model-uuid.uuid_version', 'uuid7');
+
+        $testClass = new class
+        {
+            use GeneratesUuid;
+
+            public function uuidVersion(): ?string
+            {
+                return 'uuid6';
+            }
+        };
+
+        $this->assertSame('uuid6', $testClass->resolveUuidVersion());
+    }
 }