Refactor singleton and prototype handling in DI compiler

Updated the dependency injection compiler to streamline the handling of singleton and prototype instances. Introduced a consistent approach for processing $dependencyIndex in both singleton and prototype implementations, ensuring better maintainability and test coverage. Adjusted related tests and modules to align with these changes.
ray-di · Jan 12, 2025 · 5d3352e · 5d3352e
1 parent b974dad
commit 5d3352e
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 27 deletions.
diff --git a/src-function/prototype.php b/src-function/prototype.php
@@ -12,12 +12,12 @@
  *
  * @return mixed
  */
-function prototype(string $scriptDir, string $filePath, ?array $ip = null) {
+function prototype(string $scriptDir, string $dependencyIndex, string $filePath, ?array $ip = null) {
     $file = $scriptDir . DIRECTORY_SEPARATOR . $filePath;
     if (! file_exists($file)) {
         throw new ScriptFileNotFound($filePath);
     }
 
-    // $scriptDir, $Singletons and $ip can be used in the included file
+    // $scriptDir, $Singletons, $dependencyIndex and $ip can be used in the included file
     return require $file;
 };
diff --git a/src-function/singleton.php b/src-function/singleton.php
@@ -15,9 +15,8 @@ function singleton(string $scriptDir, array &$singletons, string $dependencyInde
             throw new ScriptFileNotFound($scriptFile);
         }
 
-        // $scriptDir, $Singletons and $ip can be used in the included file
+        // $scriptDir, $Singletons, $dependencyIndex and $ip can be used in the included file
         $instance = require $scriptFile;
-        $singletons[$dependencyIndex] = $instance;
 
         return $instance;
     };
diff --git a/src/AirInjector.php b/src/AirInjector.php
@@ -94,13 +94,6 @@ public function getInstance($interface, $name = Name::ANY)
         /** @var mixed $instance */
         $instance = require $scriptFile;
 
-        // Save singleton
-        /** @psalm-suppress UndefinedVariable */
-        if (isset($isSingleton) && $isSingleton) {
-            /** @var object $instance */
-            $this->singletons[$dependencyIndex] = $instance;
-        }
-
         /** @pslam-var T $instance */
         return $instance;
     }

diff --git a/src/CompileVisitor.php b/src/CompileVisitor.php
@@ -56,7 +56,9 @@ public function visitProvider(
         $script = $dependency->accept($this);
         assert(is_string($script));
 
-        return str_replace('return $instance', 'return $instance->get()', $script);
+        $providerScript = $this->getProviderScript($isSingleton);
+
+        return str_replace(InstanceScript::COMMENT, $providerScript, $script);
     }
 
     /** @inheritDoc */
@@ -129,4 +131,20 @@ public function visitArgument(
     ): void {
         $this->script->addArg($index, $isDefaultAvailable, $defaultValue, $parameter);
     }
+
+    private function getProviderScript(bool $isSingleton): string
+    {
+        if ($isSingleton) {
+            return <<<'EOT'
+$instance = $instance->get();
+// singleton
+$singletons[$dependencyIndex] = $instance;
+EOT;
+        }
+
+        return <<<'EOT'
+$instance = $instance->get();
+// prototype
+EOT;
+    }
 }
diff --git a/src/InstanceScript.php b/src/InstanceScript.php
@@ -31,6 +31,7 @@ final class InstanceScript
 {
     public const RAY_DI_INJECTOR_INTERFACE = 'Ray\Di\InjectorInterface-';
     public const RAY_DI_INJECTION_POINT_INTERFACE = 'Ray\Di\InjectionPointInterface-';
+    public const COMMENT = '// prototype';
 
     /** @var array<mixed> */
     private $args = [];
@@ -103,7 +104,7 @@ private function addDependencyArg(bool $isSingleton, string $index, ReflectionPa
         // Add prototype or singleton
         $this->args[] = $isSingleton ?
             sprintf("\\Ray\\Compiler\\singleton(\$scriptDir, \$singletons, '%s', '%s', %s)", $index, $filePath, $ip) :
-            sprintf("\\Ray\\Compiler\\prototype(\$scriptDir, '%s', %s)", $filePath, $ip);
+            sprintf("\\Ray\\Compiler\\prototype(\$scriptDir, '%s', '%s', %s)", $index, $filePath, $ip);
     }
 
     /** @param mixed $default */
@@ -168,14 +169,16 @@ public function getScript(?string $postConstruct, bool $isSingleton): string
             $this->laterLines[] = sprintf('$instance->setContext(%s);', var_export($this->context, true));
         }
 
-        $isSingleton = $this->isSingleton ?? $isSingleton;
-        $this->laterLines[] = sprintf('$isSingleton = %s;', $isSingleton ? 'true' : 'false');
+        $this->laterLines[] = self::COMMENT;
+        if ($isSingleton) {
+            $this->laterLines[] = sprintf('$singletons[$dependencyIndex] = $instance;');
+        }
+
         $this->laterLines[] = 'return $instance;';
 
         $script = implode(PHP_EOL, $this->formerLines) . PHP_EOL . implode(PHP_EOL, $this->laterLines);
         $this->formerLines = [];
         $this->laterLines = [];
-        $this->isSingleton = null;
 
         return $script;
     }

diff --git a/tests/Fake/FakeToBindSingletonModule.php b/tests/Fake/FakeToBindSingletonModule.php
@@ -12,6 +12,6 @@ class FakeToBindSingletonModule extends AbstractModule
     protected function configure()
     {
         $this->bind(FakeRobotInterface::class)->to(FakeRobot::class)->in(Scope::SINGLETON);
-        $this->bind(FakeDependSingleton::class);
+        $this->bind(FakeDependSingleton::class)->in(Scope::SINGLETON);
     }
 }
diff --git a/tests/VisitorCompilerTest.php b/tests/VisitorCompilerTest.php
@@ -71,15 +71,15 @@ public function testDependencyCompile(): Container
         assert($dependency instanceof AcceptInterface);
         $code = $dependency->accept(new CompileVisitor($container));
         $expected = <<<'EOT'
-$instance = new \Ray\Compiler\FakeCar(\Ray\Compiler\prototype($scriptDir, '/Ray_Compiler_FakeEngineInterface-.php', ['Ray\Compiler\FakeCar', '__construct', 'engine']));
-$instance->setTires(\Ray\Compiler\prototype($scriptDir, '/Ray_Compiler_FakeTyreInterface-.php', ['Ray\Compiler\FakeCar', 'setTires', 'frontTyre']), \Ray\Compiler\prototype($scriptDir, '/Ray_Compiler_FakeTyreInterface-.php', ['Ray\Compiler\FakeCar', 'setTires', 'rearTyre']), NULL);
-$instance->setHardtop(\Ray\Compiler\prototype($scriptDir, '/Ray_Compiler_FakeHardtopInterface-.php', ['Ray\Compiler\FakeCar', 'setHardtop', 'hardtop']));
+$instance = new \Ray\Compiler\FakeCar(\Ray\Compiler\prototype($scriptDir, 'Ray\Compiler\FakeEngineInterface-', '/Ray_Compiler_FakeEngineInterface-.php', ['Ray\Compiler\FakeCar', '__construct', 'engine']));
+$instance->setTires(\Ray\Compiler\prototype($scriptDir, 'Ray\Compiler\FakeTyreInterface-', '/Ray_Compiler_FakeTyreInterface-.php', ['Ray\Compiler\FakeCar', 'setTires', 'frontTyre']), \Ray\Compiler\prototype($scriptDir, 'Ray\Compiler\FakeTyreInterface-', '/Ray_Compiler_FakeTyreInterface-.php', ['Ray\Compiler\FakeCar', 'setTires', 'rearTyre']), NULL);
+$instance->setHardtop(\Ray\Compiler\prototype($scriptDir, 'Ray\Compiler\FakeHardtopInterface-', '/Ray_Compiler_FakeHardtopInterface-.php', ['Ray\Compiler\FakeCar', 'setHardtop', 'hardtop']));
 $instance->setMirrors(\Ray\Compiler\singleton($scriptDir, $singletons, 'Ray\Compiler\FakeMirrorInterface-right', '/Ray_Compiler_FakeMirrorInterface-right.php', ['Ray\Compiler\FakeCar', 'setMirrors', 'rightMirror']), \Ray\Compiler\singleton($scriptDir, $singletons, 'Ray\Compiler\FakeMirrorInterface-left', '/Ray_Compiler_FakeMirrorInterface-left.php', ['Ray\Compiler\FakeCar', 'setMirrors', 'leftMirror']));
 $instance->setSpareMirror(\Ray\Compiler\singleton($scriptDir, $singletons, 'Ray\Compiler\FakeMirrorInterface-right', '/Ray_Compiler_FakeMirrorInterface-right.php', ['Ray\Compiler\FakeCar', 'setSpareMirror', 'rightMirror']));
-$instance->setHandle(\Ray\Compiler\prototype($scriptDir, '/Ray_Compiler_FakeHandleInterface-.php', ['Ray\Compiler\FakeCar', 'setHandle', 'handle']));
-$instance->setOil(\Ray\Compiler\prototype($scriptDir, '/Ray_Compiler_FakeOilInterface-.php', ['Ray\Compiler\FakeCar', 'setOil', 'oil']));
+$instance->setHandle(\Ray\Compiler\prototype($scriptDir, 'Ray\Compiler\FakeHandleInterface-', '/Ray_Compiler_FakeHandleInterface-.php', ['Ray\Compiler\FakeCar', 'setHandle', 'handle']));
+$instance->setOil(\Ray\Compiler\prototype($scriptDir, 'Ray\Compiler\FakeOilInterface-', '/Ray_Compiler_FakeOilInterface-.php', ['Ray\Compiler\FakeCar', 'setOil', 'oil']));
 $instance->postConstruct();
-$isSingleton = false;
+// prototype
 return $instance;
 EOT;
         $this->assertSame(
@@ -98,8 +98,9 @@ public function testDependencyProviderCompile(Container $container): void
         $code = $dependency->accept(new CompileVisitor($container));
         $expected = <<<'EOT'
 $instance = new \Ray\Compiler\FakeHandleProvider('momo');
-$isSingleton = false;
-return $instance->get();
+$instance = $instance->get();
+// prototype
+return $instance;
 EOT;
         $this->assertSame(
             $this->normalizeLineEndings($expected),
@@ -143,8 +144,9 @@ public function testContextualProviderCompile(): void
         $expected = <<<'EOT'
 $instance = new \Ray\Compiler\FakeContextualProvider();
 $instance->setContext('context');
-$isSingleton = false;
-return $instance->get();
+$instance = $instance->get();
+// prototype
+return $instance;
 EOT;
         $this->assertSame(
             $this->normalizeLineEndings($expected),