refactor(cuid2): leverage markrogoyski/math-php when GMP extension is unavailable (#261)

Signed-off-by: Alan Brault <alan.brault@visus.io>

Author: xaevik

README.md

@@ -17,12 +17,12 @@ A PHP implementation of collision-resistant ids. You can read more about CUIDs f
 
 You can install visus/cuid2 as a [composer package](https://packagist.org/packages/visus/cuid2):
 
-> [!IMPORTANT]
-> The PHP extension [GMP](https://www.php.net/manual/en/intro.gmp.php) is required in order to use this library.
-
 ```shell
 composer require visus/cuid2
 ```
+> [!TIP]
+> Consider installing/enabling the PHP extension [GMP](https://www.php.net/manual/en/intro.gmp.php).
+> If this is not an option then [markrogoyski/math-php](https://github.com/markrogoyski/math-php) will be used as a fallback.
 
 ## Quick Example
 

composer.json

@@ -15,7 +15,7 @@
     ],
     "require": {
         "php": "^8.1",
-        "ext-gmp": "*",
+        "markrogoyski/math-php": "^2.11",
         "symfony/polyfill-php83": "^1.32"
     },
     "require-dev": {
@@ -29,6 +29,9 @@
         "squizlabs/php_codesniffer": "^3.7",
         "vimeo/psalm": "^6.0"
     },
+    "suggest": {
+        "ext-gmp": "Allows for quicker Base16 to Base36 conversion"
+    },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "autoload": {

src/Cuid2.php

@@ -7,11 +7,15 @@
 use DateTime;
 use Exception;
 use JsonSerializable;
+use MathPHP\Exception\BadParameterException;
+use MathPHP\Functions\BaseEncoderDecoder;
 use OutOfRangeException;
 use Override;
 
 final class Cuid2 implements JsonSerializable
 {
+    public const BASE36_ALPHANUMERIC = '0123456789abcdefghijklmnopqrstuvwxyz';
+
     private readonly int $counter;
 
     /**
@@ -99,12 +103,13 @@ public function jsonSerialize(): string
 
     /**
      * @throws Exception
+     * @throws BadParameterException
      */
     private function render(): string
     {
         if (!in_array('sha3-512', hash_algos())) {
             // phpcs:ignore Generic.Files.LineLength
-            throw new Exception('SHA3-512 appears to be unsupported - make sure you have support for it, or upgrade your version of PHP.');
+            throw new InvalidOperationException('SHA3-512 appears to be unsupported - make sure you have support for it, or upgrade your version of PHP.');
         }
 
         $hash = hash_init('sha3-512');
@@ -117,8 +122,25 @@ private function render(): string
 
         $hash = hash_final($hash);
 
-        $result = gmp_strval(gmp_init($hash, 16), 36);
+        $result = self::convert($hash);
 
         return $this->prefix . substr($result, 0, $this->length - 1);
     }
+
+    /**
+     * Converts Base16 to Base36
+     *
+     * @param string $value
+     * @return string
+     * @throws BadParameterException
+     */
+    private static function convert(string $value): string
+    {
+        if (extension_loaded('gmp')) {
+            return gmp_strval(gmp_init($value, 16), 36);
+        }
+
+        $integer = BaseEncoderDecoder::createArbitraryInteger($value, 16);
+        return BaseEncoderDecoder::toBase($integer, 36, self::BASE36_ALPHANUMERIC);
+    }
 }

src/InvalidOperationException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Visus\Cuid2;
+
+use Exception;
+
+/**
+ * Exception that is thrown when a method call is invalid for the object's current state.
+ */
+final class InvalidOperationException extends Exception
+{
+}