Refactor (#2)

* Use ramsey/uuid

* Improve test coverage.

Author: mtvbrianking

composer.json

@@ -54,10 +54,7 @@
         "laravel": {
             "providers": [
                 "Bmatovu\\Uuid\\UuidServiceProvider"
-            ],
-            "aliases": {
-                "Uuid": "Bmatovu\\Uuid\\UuidFacade"
-            }
+            ]
         }
     }
 }

config/uuid.php

@@ -10,4 +10,18 @@
     | http://tools.ietf.org/html/rfc4122
     */
     'version' => env('UUID_VERSION', 4),
+
+    /*
+    |--------------------------------------------------------------------------
+    | UUID Namespace
+    |--------------------------------------------------------------------------
+    */
+    'namespace' => env('UUID_NAMESPACE'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | UUID Name
+    |--------------------------------------------------------------------------
+    */
+    'name' => env('UUID_NAMESPACE'),
 ];

src/Uuid.php renamed to src/Support/Util.php

@@ -1,11 +1,12 @@
 <?php
 
-namespace Bmatovu\Uuid;
+namespace Bmatovu\Uuid\Support;
 
-use Ramsey\Uuid\Uuid as RamseyUuid;
+use Ramsey\Uuid\Exception\InvalidUuidStringException;
+use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidInterface;
 
-class Uuid
+class Util
 {
     /**
      * Generate UUID by version.
@@ -18,24 +19,24 @@ class Uuid
      *
      * @return \Ramsey\Uuid\UuidInterface UUID
      */
-    public static function generate(int $version = 4, $ns = null, string $name = null): UuidInterface
+    public static function generateUuid(int $version = 4, $ns = null, string $name = null): UuidInterface
     {
-        $ns = $ns ? $ns : RamseyUuid::NAMESPACE_DNS;
+        $ns = $ns ? $ns : Uuid::NAMESPACE_DNS;
 
         $name = $name ? $name : php_uname('n');
 
         switch ($version) {
             case 1:
-                $uuid = RamseyUuid::uuid1();
+                $uuid = Uuid::uuid1();
             break;
             case 3:
-                $uuid = RamseyUuid::uuid3($ns, $name);
+                $uuid = Uuid::uuid3($ns, $name);
             break;
             case 5:
-                $uuid = RamseyUuid::uuid5($ns, $name);
+                $uuid = Uuid::uuid5($ns, $name);
             break;
             default:
-                $uuid = RamseyUuid::uuid4();
+                $uuid = Uuid::uuid4();
             break;
         }
 
@@ -45,21 +46,19 @@ public static function generate(int $version = 4, $ns = null, string $name = nul
     /**
      * Validate UUID plus version.
      *
-     * @param  string   $uuid
+     * @param  string   $str
      * @param  int|null $version UUID Version
      *
      * @return bool True for valid.
      */
-    public static function validate(string $uuid, int $version = null)
+    public static function validateUuid(string $str, int $version = null)
     {
         if ($version === null) {
-            return RamseyUuid::isValid($value);
+            return Uuid::isValid($str);
         }
 
         try {
-            $uuid = RamseyUuid::fromString($value);
-
-            return $uuid->getVersion() === $version;
+            return Uuid::fromString($str)->getVersion() === $version;
         } catch (InvalidUuidStringException $e) {
             return false;
         }

src/Traits/HasUuidKey.php

@@ -2,7 +2,7 @@
 
 namespace Bmatovu\Uuid\Traits;
 
-use Bmatovu\Uuid\Uuid;
+use Bmatovu\Uuid\Support\Util;
 use Illuminate\Database\Eloquent\Model;
 
 trait HasUuidKey
@@ -39,7 +39,10 @@ protected static function boot(): void
         static::creating(function (Model $model): void {
             if (! $model->getKey()) {
                 $version = config('uuid.version');
-                $model->{$model->getKeyName()} = Uuid::generate($version)->toString();
+                $namespace = config('uuid.namespace');
+                $name = config('uuid.name');
+
+                $model->{$model->getKeyName()} = Util::generateUuid($version, $namespace, $name)->toString();
             }
         });
     }

src/UuidFacade.php

@@ -25,10 +25,6 @@ public function boot()
      */
     public function register()
     {
-        $this->app->bind('uuid', function () {
-            return new Uuid();
-        });
-
         $this->mergeConfigFrom(__DIR__.'/../config/uuid.php', 'uuid');
     }
 }

src/UuidServiceProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Bmatovu\Uuid\Tests\Support;
+
+use Bmatovu\Uuid\Support\Util;
+use Bmatovu\Uuid\Tests\TestCase;
+
+class UtilTest extends TestCase
+{
+    public function test_generate_v1_uuids()
+    {
+        foreach ([1,3,4,5] as $version) {
+            $uuid_v{$version} = Util::generateUuid($version);
+
+            $this->assertInstanceOf(\Ramsey\Uuid\Uuid::class, $uuid_v{$version});
+            $this->assertEquals($version, $uuid_v{$version}->getVersion());
+        }
+    }
+
+    public function test_validate_uuids()
+    {
+        $valid_uuid = Util::generateUuid();
+        $invalid_uuid = '3f6f8cb0-c57d-11e1-9b21-0800200c9a6';
+
+        $this->assertTrue(Util::validateUuid($valid_uuid));
+        $this->assertTrue(Util::validateUuid($valid_uuid, 4));
+
+        $this->assertFalse(Util::validateUuid($invalid_uuid, 1));
+    }
+}