fix(container): allow enums in the #[Tag] attribute (#1506)

Author: brendt

packages/container/src/Exceptions/TaggedDependencyCouldNotBeResolved.php

@@ -4,17 +4,25 @@
 
 namespace Tempest\Container\Exceptions;
 
+use BackedEnum;
 use Exception;
 use Tempest\Container\Dependency;
 use Tempest\Container\DependencyChain;
+use UnitEnum;
 
 final class TaggedDependencyCouldNotBeResolved extends Exception implements ContainerException
 {
-    public function __construct(DependencyChain $chain, Dependency $brokenDependency, string $tag)
+    public function __construct(DependencyChain $chain, Dependency $brokenDependency, string|UnitEnum $tag)
     {
         $stack = $chain->all();
         $stack[] = $brokenDependency;
 
+        $tag = match (true) {
+            is_string($tag) => $tag,
+            $tag instanceof BackedEnum => (string) $tag->value,
+            $tag instanceof UnitEnum => $tag->name,
+        };
+
         $message = PHP_EOL . PHP_EOL . "Could not resolve tagged dependency {$brokenDependency->getName()}#{$tag}, did you forget to define an initializer for it?" . PHP_EOL;
 
         if (count($stack) < 2) {

packages/container/src/Tag.php

@@ -5,11 +5,12 @@
 namespace Tempest\Container;
 
 use Attribute;
+use UnitEnum;
 
 #[Attribute]
 final readonly class Tag
 {
     public function __construct(
-        public string $name,
+        public string|UnitEnum $name,
     ) {}
 }

packages/container/tests/ContainerTest.php

@@ -12,6 +12,7 @@
 use Tempest\Container\Exceptions\InvokedCallableWasInvalid;
 use Tempest\Container\Exceptions\TaggedDependencyCouldNotBeResolved;
 use Tempest\Container\GenericContainer;
+use Tempest\Container\Tests\Fixtures\AutowireWithEnumTags;
 use Tempest\Container\Tests\Fixtures\BuiltinArrayClass;
 use Tempest\Container\Tests\Fixtures\BuiltinDependencyArrayInitializer;
 use Tempest\Container\Tests\Fixtures\BuiltinDependencyBoolInitializer;
@@ -609,4 +610,26 @@ public function test_has_tags_support(): void
         $this->assertSame('A', $container->get(HasTagObject::class, 'tagA')->name);
         $this->assertSame('B', $container->get(HasTagObject::class, 'tagB')->name);
     }
+
+    public function test_tag_attribute_with_enum(): void
+    {
+        $container = new GenericContainer();
+
+        $container->singleton(
+            TaggedDependency::class,
+            new TaggedDependency('foo'),
+            tag: EnumTag::FOO,
+        );
+
+        $container->singleton(
+            TaggedDependency::class,
+            new TaggedDependency('bar'),
+            tag: EnumTag::BAR,
+        );
+
+        $dependency = $container->get(AutowireWithEnumTags::class);
+
+        $this->assertSame('foo', $dependency->foo->name);
+        $this->assertSame('bar', $dependency->bar->name);
+    }
 }

packages/container/tests/Fixtures/AutowireWithEnumTags.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Tempest\Container\Tests\Fixtures;
+
+use Tempest\Container\Tag;
+
+class AutowireWithEnumTags
+{
+    public function __construct(
+        #[Tag(EnumTag::FOO)]
+        public TaggedDependency $foo,
+        #[Tag(EnumTag::BAR)]
+        public TaggedDependency $bar,
+    ) {}
+}

tests/Integration/Core/DiscoveryCacheTest.php

@@ -14,7 +14,7 @@ final class DiscoveryCacheTest extends FrameworkIntegrationTestCase
 {
     public function test_exception_with_unserializable_discovery_items(): void
     {
-        $this->assertException(CouldNotStoreDiscoveryCache::class, function () {
+        $this->assertException(CouldNotStoreDiscoveryCache::class, function (): void {
             $discoveryCache = $this->container->get(DiscoveryCache::class);
 
             $location = new DiscoveryLocation('Test\\', '.');