Merge pull request #5 from lcobucci/implement-delayed-passes

Implement delayed passes
lcobucci · Nov 16, 2017 · fbffb83 · fbffb83
2 parents 4d85492 + 6d8f076
commit fbffb83
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 8 deletions.
diff --git a/src/Builder.php b/src/Builder.php
@@ -32,6 +32,12 @@ public function addPass(
         string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION
     ): Builder;
 
+    public function addDelayedPass(
+        string $className,
+        array $constructArguments = [],
+        string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION
+    ): Builder;
+
     /**
      * Mark the container to be used as development mode
      */

diff --git a/src/Compiler.php b/src/Compiler.php
@@ -6,6 +6,7 @@
 use Lcobucci\DependencyInjection\Config\ContainerConfiguration;
 use Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper;
 use Symfony\Component\Config\ConfigCache;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder as SymfonyBuilder;
 use Symfony\Component\DependencyInjection\Dumper\DumperInterface;
 use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
@@ -52,8 +53,16 @@ private function configurePassList(
         SymfonyBuilder $container,
         ContainerConfiguration $config
     ): void {
-        foreach ($config->getPassList() as $pass) {
-            $container->addCompilerPass(...$pass);
+        foreach ($config->getPassList() as $passConfig) {
+            [$pass, $type] = $passConfig;
+
+            if (! $pass instanceof CompilerPassInterface) {
+                [$className, $constructArguments] = $pass;
+
+                $pass = new $className(...$constructArguments);
+            }
+
+            $container->addCompilerPass($pass, $type);
         }
     }
 

diff --git a/src/Config/ContainerConfiguration.php b/src/Config/ContainerConfiguration.php
@@ -52,7 +52,7 @@ public function getFiles(): array
         return $this->files;
     }
 
-    public function addFile(string $file)
+    public function addFile(string $file): void
     {
         $this->files[] = $file;
     }
@@ -65,16 +65,24 @@ public function getPassList(): array
     public function addPass(
         CompilerPassInterface $pass,
         string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION
-    ) {
+    ): void {
         $this->passList[] = [$pass, $type];
     }
 
+    public function addDelayedPass(
+        string $className,
+        array $constructArguments,
+        string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION
+    ): void {
+        $this->passList[] = [[$className, $constructArguments], $type];
+    }
+
     public function getPaths(): array
     {
         return $this->paths;
     }
 
-    public function addPath(string $path)
+    public function addPath(string $path): void
     {
         $this->paths[] = $path;
     }
@@ -84,7 +92,7 @@ public function getBaseClass(): ?string
         return $this->baseClass;
     }
 
-    public function setBaseClass(string $baseClass)
+    public function setBaseClass(string $baseClass): void
     {
         $this->baseClass = $baseClass;
     }
@@ -94,7 +102,7 @@ public function getDumpDir(): string
         return $this->dumpDir;
     }
 
-    public function setDumpDir(string $dumpDir)
+    public function setDumpDir(string $dumpDir): void
     {
         $this->dumpDir = rtrim($dumpDir, DIRECTORY_SEPARATOR);
     }

diff --git a/src/ContainerBuilder.php b/src/ContainerBuilder.php
@@ -82,6 +82,16 @@ public function addPass(
         return $this;
     }
 
+    public function addDelayedPass(
+        string $className,
+        array $constructArguments = [],
+        string $type = PassConfig::TYPE_BEFORE_OPTIMIZATION
+    ): Builder {
+        $this->config->addDelayedPass($className, $constructArguments, $type);
+
+        return $this;
+    }
+
     public function useDevelopmentMode(): Builder
     {
         $this->parameterBag->set('app.devmode', true);
@@ -123,7 +133,7 @@ public function getContainer(): ContainerInterface
             $this->config,
             new ConfigCache(
                 $this->config->getDumpFile(),
-                $this->parameterBag->get('app.devmode')
+                (bool) $this->parameterBag->get('app.devmode')
             )
         );
     }

diff --git a/test/Config/ContainerConfigurationTest.php b/test/Config/ContainerConfigurationTest.php
@@ -3,7 +3,9 @@
 
 namespace Lcobucci\DependencyInjection\Config;
 
+use Lcobucci\DependencyInjection\Compiler\ParameterBag;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 
 /**
  * @author Luís Otávio Cobucci Oblonczyk <lcobucci@gmail.com>
@@ -100,6 +102,25 @@ public function addPassShouldAppendANewHandlerToTheList(): void
         self::assertAttributeSame([[$this->pass, 'beforeOptimization']], 'passList', $config);
     }
 
+    /**
+     * @test
+     *
+     * @covers \Lcobucci\DependencyInjection\Config\ContainerConfiguration::addDelayedPass
+     *
+     * @uses \Lcobucci\DependencyInjection\Config\ContainerConfiguration::__construct
+     */
+    public function addDelayedPassShouldAppendANewCompilerPassToTheList(): void
+    {
+        $config = new ContainerConfiguration();
+        $config->addDelayedPass(ParameterBag::class, ['a' => 'b']);
+
+        self::assertAttributeSame(
+            [[[ParameterBag::class, ['a' => 'b']], 'beforeOptimization']],
+            'passList',
+            $config
+        );
+    }
+
     /**
      * @test
      *

diff --git a/test/ContainerBuilderTest.php b/test/ContainerBuilderTest.php
@@ -141,6 +141,26 @@ public function addPassShouldAppendANewHandlerOnTheListAndReturnSelf(): void
         self::assertContains([$pass, PassConfig::TYPE_BEFORE_OPTIMIZATION], $this->config->getPassList());
     }
 
+    /**
+     * @test
+     *
+     * @covers \Lcobucci\DependencyInjection\ContainerBuilder::addDelayedPass
+     *
+     * @uses \Lcobucci\DependencyInjection\ContainerBuilder::__construct
+     * @uses \Lcobucci\DependencyInjection\ContainerBuilder::setDefaultConfiguration
+     *
+     * @uses \Lcobucci\DependencyInjection\Config\ContainerConfiguration
+     * @uses \Lcobucci\DependencyInjection\Compiler\ParameterBag
+     */
+    public function addDelayedPassShouldAppendANewHandlerOnTheListAndReturnSelf(): void
+    {
+        $builder = new ContainerBuilder($this->config, $this->generator, $this->parameterBag);
+        $pass    = get_class($this->createMock(CompilerPassInterface::class));
+
+        self::assertSame($builder, $builder->addDelayedPass($pass));
+        self::assertContains([[$pass, []], PassConfig::TYPE_BEFORE_OPTIMIZATION], $this->config->getPassList());
+    }
+
     /**
      * @test
      *