Merge pull request #292 from ray-di/optional-setter-injection

Handle missing dependencies in setter methods with @Inject(optional=true)

Author: koriym

src/di/AspectBind.php

@@ -22,7 +22,7 @@ public function __construct(AopBind $bind)
     /**
      * Instantiate interceptors
      *
-     * @return array<string, array<MethodInterceptor>>
+     * @return array<string, list<MethodInterceptor>>
      */
     public function inject(Container $container): array
     {
@@ -32,7 +32,6 @@ public function inject(Container $container): array
             $interceptors = [];
             foreach ($interceptorClassNames as $interceptorClassName) {
                 /** @var class-string $interceptorClassName */
-                /** @psalm-suppress MixedAssignment */
                 $interceptor = $container->getInstance($interceptorClassName);
                 assert($interceptor instanceof MethodInterceptor);
                 $interceptors[] = $interceptor;

src/di/AssistedInjectInterceptor.php

@@ -63,6 +63,8 @@ public function invoke(MethodInvocation $invocation)
     }
 
     /**
+     * @param MethodInvocation<object> $invocation
+     *
      * @return array<string, mixed>
      */
     private function getNamedArguments(MethodInvocation $invocation): array

src/di/ContainerFactory.php

@@ -11,7 +11,8 @@
 final class ContainerFactory
 {
     /**
-     * @param AbstractModule|non-empty-array<AbstractModule>|null $module Module(s)
+     * @param non-empty-string                                    $classDir
+     * @param AbstractModule|non-empty-array<AbstractModule>|null $module   Module(s)
      */
     public function __invoke($module, string $classDir): Container
     {

src/di/Dependency.php

@@ -144,7 +144,7 @@ public function weaveAspects(CompilerInterface $compiler, array $pointcuts): voi
 
         $class = $compiler->compile($className, $bind);
         /** @psalm-suppress ArgumentTypeCoercion */
-        $this->newInstance->weaveAspects($class, $bind); // @phpstan-ignore-line
+        $this->newInstance->weaveAspects($class, $bind);
     }
 
     /** @inheritDoc */

src/di/Exception/DirectoryNotWritable.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Di\Exception;
+
+use RuntimeException;
+
+class DirectoryNotWritable extends RuntimeException implements ExceptionInterface
+{
+}

src/di/Grapher.php

@@ -14,14 +14,15 @@
 
 final class Grapher
 {
-    /** @var string */
+    /** @var non-empty-string */
     private $classDir;
 
     /** @var Container */
     private $container;
 
     /**
-     * @param AbstractModule $module Binding module
+     * @param AbstractModule   $module   Binding module
+     * @param non-empty-string $classDir Class directory
      *
      * @throws AnnotationException
      */

src/di/Injector.php

@@ -6,19 +6,21 @@
 
 use Doctrine\Common\Annotations\AnnotationException;
 use Ray\Aop\Compiler;
+use Ray\Di\Exception\DirectoryNotWritable;
 use Ray\Di\Exception\Untargeted;
 
 use function assert;
 use function file_exists;
 use function is_dir;
+use function is_writable;
 use function spl_autoload_register;
 use function sprintf;
 use function str_replace;
 use function sys_get_temp_dir;
 
 class Injector implements InjectorInterface
 {
-    /** @var string */
+    /** @var non-empty-string */
     private $classDir;
 
     /** @var Container */
@@ -30,7 +32,13 @@ class Injector implements InjectorInterface
      */
     public function __construct($module = null, string $tmpDir = '')
     {
-        $this->classDir = is_dir($tmpDir) ? $tmpDir : sys_get_temp_dir();
+        /** @var non-empty-string $classDir */
+        $classDir = is_dir($tmpDir) ? $tmpDir : sys_get_temp_dir();
+        if (! is_writable($classDir)) {
+            throw new DirectoryNotWritable($classDir); // @CodeCoverageIgnore
+        }
+
+        $this->classDir = $classDir;
         $this->container = (new ContainerFactory())($module, $this->classDir);
         // Bind injector (built-in bindings)
         (new Bind($this->container, InjectorInterface::class))->toInstance($this);

src/di/MethodInvocationProvider.php

@@ -12,14 +12,20 @@
  */
 final class MethodInvocationProvider implements ProviderInterface
 {
-    /** @var ?MethodInvocation */
+    /** @var ?MethodInvocation<object> */
     private $invocation;
 
+    /**
+     * @param MethodInvocation<object> $invocation
+     */
     public function set(MethodInvocation $invocation): void
     {
         $this->invocation = $invocation;
     }
 
+    /**
+     * @return MethodInvocation<object>
+     */
     public function get(): MethodInvocation
     {
         if ($this->invocation === null) {

src/di/MultiBinding/LazyTo.php

@@ -27,6 +27,6 @@ public function __construct(string $class)
      */
     public function __invoke(InjectorInterface $injector)
     {
-        return $injector->getInstance($this->class); // @phpstan-ignore-line
+        return $injector->getInstance($this->class);
     }
 }

src/di/SetterMethod.php

@@ -67,6 +67,16 @@ public function setOptional(): void
     /** @inheritDoc */
     public function accept(VisitorInterface $visitor)
     {
-        $visitor->visitSetterMethod($this->method, $this->arguments);
+        try {
+            $visitor->visitSetterMethod($this->method, $this->arguments);
+        } catch (Unbound $e) {
+            if ($this->isOptional) {
+                // Return when no dependency given and @Inject(optional=true) annotated to setter method.
+                return;
+            }
+
+            // Throw exception when no dependency given and @Inject(optional=false) annotated to setter method.
+            throw $e;
+        }
     }
 }