- UUID: adds toBase64() and fromBase64() methods

Author: kodeart

README.md

@@ -134,6 +134,8 @@ Class UUID generates Universally Unique Identifiers following the [RFC 4122][rfc
 - `v5(string $namespace, string $name): string`
 - `valid(string $uuid): bool`
 - `matches(string $uuid, int $version = 4): bool`
+- `toBase64(string $uuid): string`
+- `fromBase64(string $base64): string`
 
 Functions
 ---------

UUID.php

@@ -13,13 +13,16 @@
 
 use AssertionError;
 use InvalidArgumentException;
+use function base64_decode;
+use function base64_encode;
 use function chr;
 use function ctype_digit;
 use function ctype_xdigit;
 use function dechex;
 use function explode;
 use function gethostbyname;
 use function gettimeofday;
+use function hex2bin;
 use function hexdec;
 use function in_array;
 use function md5;
@@ -251,7 +254,46 @@ public static function v1(string|int $address = null): string
     }
 
     /**
-     * Creates the v3 and/or v5 UUID.
+     * Creates a base64 string out of the UUID.
+     *
+     * @param string $uuid UUID string
+     *
+     * @return string base64 encoded string
+     */
+    public static function toBase64(string $uuid): string
+    {
+        if (false === UUID::valid($uuid)) {
+            throw new InvalidArgumentException('Invalid UUID ' . $uuid);
+        }
+        return str_replace(['/', '+', '='], ['-', '_', ''],
+            base64_encode(hex2bin(str_replace('-', '', $uuid)))
+        );
+    }
+
+    /**
+     * Converts a base64 string to UUID.
+     *
+     * @param string $base64
+     *
+     * @return string UUID string
+     */
+    public static function fromBase64(string $base64): string
+    {
+        $uuid = base64_decode(str_replace(
+            ['-', '_', '='], ['/', '+', ''], $base64) . '=='
+        );
+        if (!preg_match('//u', $uuid)) {
+            $uuid = vsprintf('%04x%04x-%04x-%04x-%04x-%04x%04x%04x', unpack('n*', $uuid));
+        }
+        if (UUID::valid($uuid)) {
+            return $uuid;
+        }
+        throw new InvalidArgumentException(
+            'Failed to convert base 64 string to UUID');
+    }
+
+    /**
+     * Creates a v3 or v5 UUID.
      *
      * @param string $namespace UUID namespace identifier (see UUID constants)
      * @param string $name      A name

VERSION

@@ -1 +1 @@
-6.0.2
+6.1.0

tests/UUIDTest.php

@@ -133,20 +133,13 @@ public function method_matches_fails_on_unsupported_uuid_version()
         $this->expectExceptionMessage('Expected UUID version 1, 3, 4 or 5 (got 0)');
         UUID::matches(UUID::NAMESPACE_OID, 0);
     }
-
-    /**
-     * @test
-     */
-    public function verify_uuid_regex()
-    {
-        $this->assertFalse(UUID::valid('00000000-0000-2000-0000-000000000000'));
-    }
-
+    
     /**
      * @test
      */
     public function verify_uuid4()
     {
+        $this->assertFalse(UUID::valid('00000000-0000-a000-0000-000000000000'));
         $this->assertFalse(UUID::valid('00000000-0000-4000-0000-000000000000'));
         $this->assertTrue(UUID::valid('00000000-0000-4000-a000-000000000000'));
     }
@@ -156,6 +149,9 @@ public function verify_uuid4()
      */
     public function issue7()
     {
-        $this->assertSame('1cb8bac3-bb8e-3973-93dc-5119246f0585', UUID::v3(UUID::NAMESPACE_URL, 'fubar'));
+        $this->assertSame(
+            '1cb8bac3-bb8e-3973-93dc-5119246f0585',
+            UUID::v3(UUID::NAMESPACE_URL, 'fubar')
+        );
     }
 }

tests/UUIDbase64Test.php

@@ -0,0 +1,64 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Koded\Stdlib;
+
+use InvalidArgumentException;
+use Koded\Stdlib\UUID;
+use PHPUnit\Framework\TestCase;
+
+class UUIDbase64Test extends TestCase
+{
+    /**
+     * @dataProvider base64Binary
+     */
+    public function test_base64_binary_encoded($uuid, $base64)
+    {
+        $encoded = UUID::toBase64($uuid);
+        $decoded = UUID::fromBase64($encoded);
+
+        $this->assertSame($base64, $encoded);
+        $this->assertSame($uuid, $decoded);;
+    }
+
+    /**
+     * @dataProvider base64Plain
+     */
+    public function test_base64_plain_encoded($uuid, $base64)
+    {
+        $this->assertSame($uuid, UUID::fromBase64($base64));;
+    }
+
+    public function test_to_base64_exception()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Invalid UUID 0');
+        UUID::toBase64('0');
+    }
+
+    public function test_from_base64_exception()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Failed to convert base 64 string to UUID');
+        UUID::fromBase64('0');
+    }
+
+    public function base64Binary()
+    {
+        return [
+            // with hex2bin
+            ['e6421c02-1aab-499b-9123-ef02d69f49ba', '5kIcAhqrSZuRI_8C1p9Jug'],
+            ['524d188a-756d-453b-8af5-674a7291197d', 'Uk0YinVtRTuK9WdKcpEZfQ'],
+            ['ed67a863-ff19-475a-a67d-9f9eb63e4dce', '7WeoY-8ZR1qmfZ_etj5Nzg'],
+        ];
+    }
+
+    public function base64Plain()
+    {
+        return [
+            // only base64 encoded
+            ['e6421c02-1aab-499b-9123-ef02d69f49ba', 'ZTY0MjFjMDItMWFhYi00OTliLTkxMjMtZWYwMmQ2OWY0OWJh'],
+            ['524d188a-756d-453b-8af5-674a7291197d', 'NTI0ZDE4OGEtNzU2ZC00NTNiLThhZjUtNjc0YTcyOTExOTdk'],
+            ['ed67a863-ff19-475a-a67d-9f9eb63e4dce', 'ZWQ2N2E4NjMtZmYxOS00NzVhLWE2N2QtOWY5ZWI2M2U0ZGNl'],
+        ];
+    }
+}