feat(container): support injecting properties using #[Inject] (#690)

Author: brendt

phpstan.neon.dist

@@ -23,6 +23,8 @@ parameters:
 		-
 		    message: '#.*exec*#'
 		    path: src/Tempest/Console/src/Terminal/Terminal.php
+		-
+		    message: '#.*uninitialized readonly property \$console*#'
 
 	disallowedFunctionCalls:
 		-

src/Tempest/Cache/src/CacheClearCommand.php

@@ -4,7 +4,6 @@
 
 namespace Tempest\Cache;
 
-use Tempest\Console\Console;
 use Tempest\Console\ConsoleCommand;
 use Tempest\Console\HasConsole;
 use Tempest\Container\Container;
@@ -14,7 +13,6 @@
     use HasConsole;
 
     public function __construct(
-        private Console $console,
         private CacheConfig $cacheConfig,
         private Container $container,
     ) {

src/Tempest/Console/src/HasConsole.php

@@ -5,12 +5,12 @@
 namespace Tempest\Console;
 
 use Closure;
+use Tempest\Container\Inject;
 
 trait HasConsole
 {
-    public function __construct(private readonly Console $console)
-    {
-    }
+    #[Inject]
+    private readonly Console $console;
 
     public function readln(): string
     {

src/Tempest/Container/src/GenericContainer.php

@@ -334,6 +334,12 @@ private function autowire(string $className, mixed ...$params): object
             $this->singleton($className, $instance);
         }
 
+        foreach ($classReflector->getProperties() as $property) {
+            if ($property->hasAttribute(Inject::class) && ! $property->isInitialized($instance)) {
+                $property->set($instance, $this->get($property->getType()->getName()));
+            }
+        }
+
         return $instance;
     }
 

src/Tempest/Container/src/Inject.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Container;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final readonly class Inject
+{
+}

src/Tempest/Container/tests/ContainerTest.php

@@ -29,6 +29,8 @@
 use Tempest\Container\Tests\Fixtures\ContainerObjectEInitializer;
 use Tempest\Container\Tests\Fixtures\DependencyWithBuiltinDependencies;
 use Tempest\Container\Tests\Fixtures\DependencyWithTaggedDependency;
+use Tempest\Container\Tests\Fixtures\InjectA;
+use Tempest\Container\Tests\Fixtures\InjectB;
 use Tempest\Container\Tests\Fixtures\IntersectionInitializer;
 use Tempest\Container\Tests\Fixtures\InvokableClass;
 use Tempest\Container\Tests\Fixtures\InvokableClassWithParameters;
@@ -379,4 +381,14 @@ public function test_builtin_dependency_initializer(): void
         $this->assertSame(["hallo", "array", 42], $a->arrayValue);
         $this->assertTrue($a->boolValue);
     }
+
+    public function test_inject(): void
+    {
+        $container = new GenericContainer();
+
+        /** @var InjectA $a */
+        $a = $container->get(InjectA::class);
+
+        $this->assertInstanceOf(InjectB::class, $a->getB());
+    }
 }

src/Tempest/Container/tests/Fixtures/InjectA.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Container\Tests\Fixtures;
+
+use Tempest\Container\Inject;
+
+final readonly class InjectA
+{
+    #[Inject]
+    private InjectB $b; // @phpstan-ignore-line
+
+    public function getB(): InjectB
+    {
+        return $this->b;
+    }
+}

src/Tempest/Container/tests/Fixtures/InjectB.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Container\Tests\Fixtures;
+
+final readonly class InjectB
+{
+}

src/Tempest/Reflection/src/ClassReflector.php

@@ -46,6 +46,14 @@ public function getPublicProperties(): Generator
         }
     }
 
+    /** @return Generator<PropertyReflector> */
+    public function getProperties(): Generator
+    {
+        foreach ($this->reflectionClass->getProperties() as $property) {
+            yield new PropertyReflector($property);
+        }
+    }
+
     /** @return Generator<MethodReflector> */
     public function getPublicMethods(): Generator
     {