Merge pull request #15 from soatok/deterministic-id

Create generic automatic ID generation class

Author: soatok

composer.json

@@ -15,6 +15,7 @@
   "require": {
     "php": "^8",
     "paragonie/ionizer": "^1",
+    "paragonie/sodium_compat": "^1",
     "ezyang/htmlpurifier": "^4"
   },
   "require-dev": {
@@ -31,5 +32,8 @@
     "taint": ["psalm --taint-analysis"],
     "test": ["phpunit", "psalm", "psalm --taint-analysis"],
     "unit-test": ["phpunit"]
+  },
+  "suggest": {
+    "ext-sodium": "ID population is faster."
   }
 }

src/AutoID.php

@@ -0,0 +1,87 @@
+<?php
+declare(strict_types=1);
+namespace Soatok\Cupcake;
+
+use Soatok\Cupcake\Core\Container;
+use SodiumException;
+
+class AutoID
+{
+    private bool $objectHash;
+    private string $key;
+    private int $length;
+
+    public function __construct(?string $key = null, int $length = 16, bool $objectHash = false)
+    {
+        if (is_null($key)) {
+            $key = sodium_crypto_generichash_keygen();
+        }
+        $this->key = $key;
+        $this->length = $length;
+        $this->objectHash = $objectHash;
+    }
+
+    /**
+     * @throws SodiumException
+     */
+    public function autoId(string $unique): string
+    {
+        return 'cupcake-' . sodium_bin2hex(
+                sodium_crypto_generichash(
+                    $unique,
+                    $this->key,
+                    $this->length
+                )
+            );
+    }
+
+    public function autoPopulate(Container $container): Container
+    {
+        $copy = clone $container;
+        $obj = $this->objectHash ? spl_object_hash($this) : '';
+        if (!$copy->idIsPopulated()) {
+            $copy->setId($this->autoId(
+                pack('P', 0) . $obj
+            ));
+        }
+        return $this->recursivePopulate($copy, $obj);
+    }
+
+    public function setLength(int $length): void
+    {
+        $this->length = $length;
+    }
+
+    public function setObjectHash(bool $useObjectHash): void
+    {
+        $this->objectHash = $useObjectHash;
+    }
+
+    private function recursivePopulate(
+        Container $container,
+        string $prefix = '',
+        int $depth = 1
+    ): Container {
+        $depthPacked = pack('P', $depth);
+        $iterator = 0;
+        foreach ($container->getIngredients() as $ingredient) {
+            // Calculate the current position in the structure.
+            $current = $prefix . pack('P', $iterator);
+            if (!$ingredient->idIsPopulated()) {
+                $ingredient->setId(
+                    $this->autoId($depthPacked . $current)
+                );
+            }
+
+            ++$iterator;
+            if ($ingredient instanceof Container) {
+                $this->recursivePopulate(
+                    $ingredient,
+                    $current,
+                    $depth + 1
+                );
+            }
+        }
+        return $container;
+    }
+}

src/Core/Container.php

@@ -26,6 +26,13 @@ abstract class Container implements IngredientInterface
     protected string $afterEach = '';
     protected string $beforeEach = '';
 
+    public function __clone()
+    {
+        foreach ($this->ingredients as $index => $original) {
+            $this->ingredients[$index] = clone $original;
+        }
+    }
+
     /**
      * @param IngredientInterface $ingredient
      * @return self

src/Core/IngredientInterface.php

@@ -25,6 +25,11 @@ public function customAttributes(): array;
      */
     public function getId(): string;
 
+    /**
+     * @return bool
+     */
+    public function idIsPopulated(): bool;
+
     /**
      * Return the HTML to display to the end user.
      *

src/Core/StapleTrait.php

@@ -116,6 +116,11 @@ public function getId(): string
         return $this->id;
     }
 
+    public function idIsPopulated(): bool
+    {
+        return !empty($this->id);
+    }
+
     /**
      * @param string $id
      * @return self

tests/AutoIDTest.php

@@ -0,0 +1,84 @@
+<?php
+declare(strict_types=1);
+namespace Soatok\Cupcake\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Soatok\Cupcake\Form;
+use Soatok\Cupcake\AutoID;
+use Soatok\Cupcake\Ingredients\Div;
+use Soatok\Cupcake\Ingredients\Input\Text;
+
+/**
+ * @covers \Soatok\Cupcake\AutoID
+ */
+class AutoIDTest extends TestCase
+{
+    public function testEmpty()
+    {
+        $form = new Form();
+        $form->disableAntiCSRF();
+        $autoId = new AutoID(str_repeat("\0", 32));
+
+        // Default behavior:
+        $this->assertSame(
+            '<form id="cupcake-b5e166965cf1713adfda5de4b6c52228" method="GET" action=""></form>',
+            $autoId->autoPopulate($form) . ''
+        );
+
+        // This always mixes with spl_object_hash even with weak keys
+        $autoId->setObjectHash(true);
+
+        $this->assertNotSame(
+            '<form id="cupcake-b5e166965cf1713adfda5de4b6c52228" method="GET" action=""></form>',
+            $autoId->autoPopulate($form) . ''
+        );
+
+        $expect = $autoId->autoId(pack('P', 0) . spl_object_hash($autoId));
+        $this->assertSame(
+            '<form id="' . $expect . '" method="GET" action=""></form>',
+            $autoId->autoPopulate($form) . ''
+        );
+    }
+
+    public function testFormWithZeroKey()
+    {
+        $form = $this->getDummyForm();
+        $autoId = new AutoID(str_repeat("\0", 32));
+
+        $this->assertSame(
+            '<form id="cupcake-b5e166965cf1713adfda5de4b6c52228" method="GET" action=""><input id="cupcake-2d7603abf000d275112cbe001b7ff4f1" type="text" name="foo" /><div id="cupcake-481ad0fd1b490065721c82859ee4e00b"><input id="cupcake-6f90b0f6691dfb0521222b0a9312366f" type="text" name="bar" /></div></form>',
+            $autoId->autoPopulate($form) . ''
+        );
+
+        $autoId->setObjectHash(true);
+        $this->assertNotSame(
+            '<form id="cupcake-b5e166965cf1713adfda5de4b6c52228" method="GET" action=""><input id="cupcake-2d7603abf000d275112cbe001b7ff4f1" type="text" name="foo" /><div id="cupcake-481ad0fd1b490065721c82859ee4e00b"><input id="cupcake-6f90b0f6691dfb0521222b0a9312366f" type="text" name="bar" /></div></form>',
+            $autoId->autoPopulate($form) . ''
+        );
+
+        $h0 = $autoId->autoId(pack('P', 0) . spl_object_hash($autoId));
+        $h1 = $autoId->autoId(pack('P', 1) . spl_object_hash($autoId) . pack('P', 0));
+        $h2 = $autoId->autoId(pack('P', 1) . spl_object_hash($autoId) . pack('P', 1));
+        $h3 = $autoId->autoId(pack('P', 2) . spl_object_hash($autoId) . pack('P', 1) . pack('P', 0));
+
+        $this->assertSame(
+            '<form id="' . $h0
+                . '" method="GET" action=""><input id="' . $h1
+                . '" type="text" name="foo" /><div id="' . $h2
+                . '"><input id="' . $h3 .
+                '" type="text" name="bar" /></div></form>',
+            $autoId->autoPopulate($form) . ''
+        );
+    }
+
+    private function getDummyForm(): Form
+    {
+        $form = new Form();
+        $form->disableAntiCSRF();
+        $form->append(new Text('foo'));
+        $form->append(
+            (new Div())->append(new Text('bar'))
+        );
+        return $form;
+    }
+}