.readthedocs.yaml

@@ -1,9 +1,9 @@
 version: 2
 
 build:
-  os: 'ubuntu-22.04'
+  os: 'ubuntu-24.04'
   tools:
-    python: '3.11'
+    python: '3.12'
 
 sphinx:
   configuration: 'docs/conf.py'

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### 4.0.0
 
+*Jan 3, 2024*
+
 * `$string` parameter is mandatory
 * Added getResponse() method to build PSR-7 response object
 * Removed all custom exceptions 

composer.json

@@ -55,7 +55,7 @@
         "httpsoft/http-message": "^1.1",
         "phpunit/phpunit": ">= 7.0 < 10",
         "psy/psysh": "*",
-        "sandfox.dev/code-standard": "^1.2023.12.09",
+        "sandfox.dev/code-standard": "^1.2024.07.05",
         "squizlabs/php_codesniffer": "*",
         "vimeo/psalm": "^5.4"
     }

docs/_templates/rtd-version.html

@@ -1,3 +1,5 @@
-{%- if current_version -%}
-    <div class="sidebar-brand">{{ current_version }}</div>
-{%- endif -%}
+<div class="navbar-brand">{{ current_version }}</div>
+
+{#- hack scroll issue -#}
+
+<style>#rtd-footer-container{display:none}</style>

docs/conf.py

@@ -6,23 +6,63 @@
 from conf_project import *
 
 author = 'Anton Smirnov'
-copyright = '{} {}'.format(datetime.now().year, author)
+copyright = '{}'.format(datetime.now().year)
 language = 'en'
 
 html_title = project
-html_theme = 'furo'
+html_theme = 'sphinx_book_theme'
 templates_path = ["_templates"]
 html_sidebars = {
     "**": [
-        "sidebar/brand.html",
+        "navbar-logo.html",
+        "icon-links.html",
         "rtd-version.html",
-        "sidebar/search.html",
-        "sidebar/scroll-start.html",
-        "sidebar/navigation.html",
-        "sidebar/ethical-ads.html",
-        "sidebar/scroll-end.html",
-        "sidebar/variant-selector.html",
+        "search-button-field.html",
+        "sbt-sidebar-nav.html",
     ]
 }
+html_theme_options = {
+    'use_edit_page_button': True,
+    'icon_links': [
+        {
+            "name": "GitLab",
+            "url": "https://gitlab.com/sandfox/" + repo,
+            "icon": "fa-brands fa-square-gitlab",
+            "type": "fontawesome",
+        },
+        {
+            "name": "GitHub",
+            "url": "https://github.com/arokettu/" + repo,
+            "icon": "fa-brands fa-square-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "BitBucket",
+            "url": "https://bitbucket.org/sandfox/" + repo,
+            "icon": "fa-brands fa-bitbucket",
+            "type": "fontawesome",
+        },
+        {
+            "name": "Gitea",
+            "url": "https://sandfox.org/sandfox/" + repo,
+            "icon": "fa-solid fa-mug-hot",
+            "type": "fontawesome",
+        },
+   ]
+}
+if packagist:
+    html_theme_options['icon_links'].append({
+        "name": "Packagist",
+        "url": "https://packagist.org/packages/" + packagist,
+        "icon": "https://img.shields.io/packagist/dm/" + packagist + "?style=flat-square",
+        "type": "url",
+    })
+html_context = {
+    'current_version': os.environ.get("READTHEDOCS_VERSION_NAME"),
+    'gitlab_user': "sandfox",
+    'gitlab_repo': repo,
+    'gitlab_version': "master",
+    'doc_path': "docs",
+}
 
 exclude_patterns = ['venv/*']

docs/conf_project.py

@@ -1 +1,3 @@
 project = 'MonsterID'
+repo = 'monsterid'
+packagist = 'arokettu/monsterid'

docs/requirements.txt

@@ -1 +1 @@
-furo
+sphinx-book-theme

docs/usage.rst

@@ -124,7 +124,7 @@ Setting a default factory globally
     use Arokettu\MonsterID\Randomizer\DefaultV2Factory;
     use Arokettu\MonsterID\Randomizer\DefaultV3Factory;
 
-    Config::setRandomizerFactory(); // reset to default (currently V2)
+    Config::setRandomizerFactory(); // reset to default (currently V3)
     Config::setRandomizerFactory(new DefaultV0Factory()); // set V0
     Config::setRandomizerFactory(new DefaultV1Factory()); // set V1
     Config::setRandomizerFactory(new DefaultV2Factory()); // set V2

phpunit.xml

@@ -13,4 +13,7 @@
             <directory>src</directory>
         </include>
     </coverage>
+    <php>
+        <ini name="error_reporting" value="E_ALL"/>
+    </php>
 </phpunit>

src/classes/Config.php

@@ -9,14 +9,14 @@
 
 final class Config
 {
-    private static ?FactoryInterface $randomizerFactory = null;
+    private static FactoryInterface|null $randomizerFactory = null;
 
     private static function buildDefault(): FactoryInterface
     {
         return new DefaultV3Factory();
     }
 
-    public static function setRandomizerFactory(FactoryInterface $factory = null): void
+    public static function setRandomizerFactory(FactoryInterface|null $factory = null): void
     {
         self::$randomizerFactory = $factory ?? self::buildDefault();
     }

src/classes/Monster.php

@@ -30,7 +30,7 @@ final class Monster
     public function __construct(
         private string $string,
         private int $size = self::DEFAULT_SIZE,
-        ?FactoryInterface $rngFactory = null
+        FactoryInterface|null $rngFactory = null
     ) {
         if ($size < 1) {
             throw new DomainException('$size must be 1 or more');
@@ -88,8 +88,8 @@ public function getImage(): string
     }
 
     public function getResponse(
-        ?ResponseFactoryInterface $responseFactory = null,
-        ?StreamFactoryInterface $streamFactory = null,
+        ResponseFactoryInterface|null $responseFactory = null,
+        StreamFactoryInterface|null $streamFactory = null,
     ): ResponseInterface {
         $responseFactory ??= Psr17FactoryDiscovery::findResponseFactory();
         $streamFactory ??= Psr17FactoryDiscovery::findStreamFactory();

src/classes/Randomizer/DefaultV0Factory.php

@@ -13,7 +13,7 @@ public function getRandomizer(string $seed): Engine
         // original code was:
         // $intSeed = hexdec(substr(md5($seed),0,6));
 
-        ['val' => $val] = unpack("Nval", md5($seed, true));
+        ['val' => $val] = unpack("Nval", hash('md5', $seed, true));
         $intSeed = ($val >> 8) & 0xffffff;
 
         // As the original implementation generated on PHP 7.2+

src/classes/Randomizer/DefaultV1Factory.php

@@ -10,7 +10,7 @@ final class DefaultV1Factory implements FactoryInterface
 {
     public function getRandomizer(string $seed): Engine
     {
-        ['val' => $intSeed] = unpack('lval', md5($seed, true)); // convert to 32bit signed integer
+        ['val' => $intSeed] = unpack('lval', hash('md5', $seed, true)); // convert to 32bit signed integer
 
         // As v1.3.0 generated on PHP 7.2+
         return new Engine\Mt19937($intSeed, \MT_RAND_MT19937);

src/classes/Randomizer/DefaultV2Factory.php

@@ -10,7 +10,7 @@ final class DefaultV2Factory implements FactoryInterface
 {
     public function getRandomizer(string $seed): Engine
     {
-        $binSeed = md5($seed, true);
+        $binSeed = hash('md5', $seed, true);
 
         // first index of unpack is 1
         // convert to 32bit signed integer

src/classes/Randomizer/Xorshift32.php

@@ -15,7 +15,8 @@ final class Xorshift32 implements Engine
 {
     public function __construct(
         private int $seed,
-    ) {}
+    ) {
+    }
 
     public function generate(): string
     {

src/functions.php

@@ -21,7 +21,7 @@
 function build_monster(
     string $string,
     int $size = MONSTER_DEFAULT_SIZE,
-    ?FactoryInterface $rngFactory = null,
+    FactoryInterface|null $rngFactory = null,
 ): string {
     $monster = new Monster($string, $size, $rngFactory);
     return $monster->getImage();
@@ -37,7 +37,7 @@ function stream_monster(
     $stream,
     string $string,
     int $size = MONSTER_DEFAULT_SIZE,
-    ?FactoryInterface $rngFactory = null,
+    FactoryInterface|null $rngFactory = null,
 ) {
     $monster = new Monster($string, $size, $rngFactory);
     return $monster->writeToStream($stream);
@@ -51,7 +51,7 @@ function stream_monster(
 function build_monster_gd(
     string $string,
     int $size = MONSTER_DEFAULT_SIZE,
-    ?FactoryInterface $rngFactory = null,
+    FactoryInterface|null $rngFactory = null,
 ): GdImage {
     $monster = new Monster($string, $size, $rngFactory);
     return $monster->getGdImage();
@@ -65,9 +65,9 @@ function build_monster_gd(
 function build_monster_response(
     string $string,
     int $size = MONSTER_DEFAULT_SIZE,
-    ?ResponseFactoryInterface $responseFactory = null,
-    ?StreamFactoryInterface $streamFactory = null,
-    ?FactoryInterface $rngFactory = null,
+    ResponseFactoryInterface|null $responseFactory = null,
+    StreamFactoryInterface|null $streamFactory = null,
+    FactoryInterface|null $rngFactory = null,
 ): ResponseInterface {
     $monster = new Monster($string, $size, $rngFactory);
     return $monster->getResponse($responseFactory, $streamFactory);