feature #40530 [Uid] Handle predefined namespaces keywords "dns", "ur…

…l", "oid" and "x500" (fancyweb) This PR was merged into the 5.3-dev branch. Discussion ---------- [Uid] Handle predefined namespaces keywords "dns", "url", "oid" and "x500" | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Before: `uuid:generate --name-based="https://symfony.com" --namespace=6ba7b811-9dad-11d1-80b4-00c04fd430c8` After: `uuid:generate --name-based="https://symfony.com" --namespace=url` Same for FWB configuration. Commits ------- ede46ac13a [Uid] Handle predefined namespaces keywords "dns", "url", "oid" and "x500"
symfony · Mar 23, 2021 · 8311a3f · 8311a3f
2 parents b2f324a + c9f4aed
commit 8311a3f
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 8 deletions.
diff --git a/Command/GenerateUuidCommand.php b/Command/GenerateUuidCommand.php
@@ -44,7 +44,7 @@ protected function configure(): void
                 new InputOption('time-based', null, InputOption::VALUE_REQUIRED, 'The timestamp, to generate a time-based UUID: a parsable date/time string'),
                 new InputOption('node', null, InputOption::VALUE_REQUIRED, 'The UUID whose node part should be used as the node of the generated UUID'),
                 new InputOption('name-based', null, InputOption::VALUE_REQUIRED, 'The name, to generate a name-based UUID'),
-                new InputOption('namespace', null, InputOption::VALUE_REQUIRED, 'The UUID to use at the namespace for named-based UUIDs'),
+                new InputOption('namespace', null, InputOption::VALUE_REQUIRED, 'The UUID to use at the namespace for named-based UUIDs, predefined namespaces keywords "dns", "url", "oid" and "x500" are accepted'),
                 new InputOption('random-based', null, InputOption::VALUE_NONE, 'To generate a random-based UUID'),
                 new InputOption('count', 'c', InputOption::VALUE_REQUIRED, 'The number of UUID to generate', 1),
                 new InputOption('format', 'f', InputOption::VALUE_REQUIRED, 'The UUID output format: rfc4122, base58 or base32', 'rfc4122'),
@@ -144,7 +144,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 break;
 
             case null !== $name:
-                if ($namespace) {
+                if ($namespace && !\in_array($namespace, ['dns', 'url', 'oid', 'x500'], true)) {
                     try {
                         $namespace = Uuid::fromString($namespace);
                     } catch (\InvalidArgumentException $e) {

diff --git a/Factory/UuidFactory.php b/Factory/UuidFactory.php
@@ -40,8 +40,8 @@ public function __construct($defaultClass = UuidV6::class, $timeBasedClass = Uui
             $timeBasedNode = Uuid::fromString($timeBasedNode);
         }
 
-        if (null !== $nameBasedNamespace && !$nameBasedNamespace instanceof Uuid) {
-            $nameBasedNamespace = Uuid::fromString($nameBasedNamespace);
+        if (null !== $nameBasedNamespace) {
+            $nameBasedNamespace = $this->getNamespace($nameBasedNamespace);
         }
 
         $this->defaultClass = is_numeric($defaultClass) ? Uuid::class.'V'.$defaultClass : $defaultClass;
@@ -95,10 +95,24 @@ public function nameBased($namespace = null): NameBasedUuidFactory
             throw new \LogicException(sprintf('A namespace should be defined when using "%s()".', __METHOD__));
         }
 
-        if (!$namespace instanceof Uuid) {
-            $namespace = Uuid::fromString($namespace);
+        return new NameBasedUuidFactory($this->nameBasedClass, $this->getNamespace($namespace));
+    }
+
+    /**
+     * @param Uuid|string $namespace
+     */
+    private function getNamespace($namespace): Uuid
+    {
+        if ($namespace instanceof Uuid) {
+            return $namespace;
         }
 
-        return new NameBasedUuidFactory($this->nameBasedClass, $namespace);
+        switch ($namespace) {
+            case 'dns': return new UuidV1(Uuid::NAMESPACE_DNS);
+            case 'url': return new UuidV1(Uuid::NAMESPACE_URL);
+            case 'oid': return new UuidV1(Uuid::NAMESPACE_OID);
+            case 'x500': return new UuidV1(Uuid::NAMESPACE_X500);
+            default: return Uuid::fromString($namespace);
+        }
     }
 }
diff --git a/Tests/Command/GenerateUlidCommandTest.php b/Tests/Command/GenerateUlidCommandTest.php
@@ -90,7 +90,7 @@ public function testFormat()
         Ulid::fromRfc4122(trim($commandTester->getDisplay()));
     }
 
-    public function testTimestampIncrementWhenGeneratingSeveralUlids()
+    public function testUlidsAreDifferentWhenGeneratingSeveralNow()
     {
         $commandTester = new CommandTester(new GenerateUlidCommand());
 

diff --git a/Tests/Command/GenerateUuidCommandTest.php b/Tests/Command/GenerateUuidCommandTest.php
@@ -220,4 +220,13 @@ public function testTimestampIncrementWhenGeneratingSeveralTimeBasedUuids()
 
         $this->assertNotSame($uuids[0], $uuids[1]);
     }
+
+    public function testNamespacePredefinedKeyword()
+    {
+        $commandTester = new CommandTester(new GenerateUuidCommand());
+
+        $this->assertSame(0, $commandTester->execute(['--name-based' => 'https://symfony.com', '--namespace' => 'url']));
+
+        $this->assertSame('9c7d0eda-982d-5708-b4bd-79b3b179725d', (string) Uuid::fromRfc4122(trim($commandTester->getDisplay())));
+    }
 }
diff --git a/Tests/Factory/UuidFactoryTest.php b/Tests/Factory/UuidFactoryTest.php
@@ -90,4 +90,9 @@ public function testCreateRandom()
     {
         $this->assertInstanceOf(UuidV4::class, (new UuidFactory())->randomBased()->create());
     }
+
+    public function testCreateNamedWithNamespacePredefinedKeyword()
+    {
+        $this->assertSame('1002657d-3019-59b1-96dc-afc2a3e57c61', (string) (new UuidFactory())->nameBased('dns')->create('symfony.com'));
+    }
 }