[Uid] Make AbstractUid implement Ds\Hashable if available

jahudka · jahudka · commit b417d1482bcf · 2024-06-04T16:40:47.000+02:00
diff --git a/src/Symfony/Component/Uid/AbstractUid.php b/src/Symfony/Component/Uid/AbstractUid.php
@@ -11,10 +11,15 @@
 
 namespace Symfony\Component\Uid;
 
+use Ds\Hashable;
+
+// ensure we have _some_ version of the Ds\Hashable interface
+require_once __DIR__.'/DsHashablePolyfill.php';
+
 /**
  * @author Nicolas Grekas <p@tchwork.com>
  */
-abstract class AbstractUid implements \JsonSerializable, \Stringable
+abstract class AbstractUid implements \JsonSerializable, \Stringable, Hashable
 {
     /**
      * The identifier in its canonic representation.
@@ -159,6 +164,11 @@ public function equals(mixed $other): bool
         return $this->uid === $other->uid;
     }
 
+    public function hash(): mixed
+    {
+        return $this->uid;
+    }
+
     public function compare(self $other): int
     {
         return (\strlen($this->uid) - \strlen($other->uid)) ?: ($this->uid <=> $other->uid);
diff --git a/src/Symfony/Component/Uid/CHANGELOG.md b/src/Symfony/Component/Uid/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add `UuidV1::toV6()`, `UuidV1::toV7()` and `UuidV6::toV7()`
  * Add `AbstractUid::toString()`
+ * Make `AbstractUid` implement `Ds\Hashable` if available
 
 6.2
 ---
diff --git a/src/Symfony/Component/Uid/DsHashablePolyfill.php b/src/Symfony/Component/Uid/DsHashablePolyfill.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Uid;
+
+interface DsHashablePolyfill
+{
+    public function equals(mixed $other): bool;
+
+    public function hash(): mixed;
+}
+
+if (!interface_exists(\Ds\Hashable::class)) {
+    class_alias(DsHashablePolyfill::class, \Ds\Hashable::class);
+}
diff --git a/src/Symfony/Component/Uid/Tests/UuidTest.php b/src/Symfony/Component/Uid/Tests/UuidTest.php
@@ -248,6 +248,24 @@ public static function provideInvalidEqualType(): iterable
         yield [new \stdClass()];
     }
 
+    public function testHashable()
+    {
+        $uuid1 = new UuidV4(self::A_UUID_V4);
+        $uuid2 = new UuidV4(self::A_UUID_V4);
+
+        $this->assertSame($uuid1->hash(), $uuid2->hash());
+
+        if (\extension_loaded('ds')) {
+            $set = new \Ds\Set();
+            $set->add($uuid1);
+            $set->add($uuid2);
+
+            $this->assertTrue($set->contains($uuid1));
+            $this->assertTrue($set->contains($uuid2));
+            $this->assertSame(1, $set->count());
+        }
+    }
+
     public function testCompare()
     {
         $uuids = [];
