Big refactoring

* Code simplified, old "hacks" removed
* Better support for apps that use many 3rd party bundles

Author: Jirka Koutny

AutowiringCompilerPass.php

@@ -5,12 +5,10 @@
 use Kutny\AutowiringBundle\Compiler\ClassConstructorFiller;
 use Kutny\AutowiringBundle\Compiler\ClassListBuilder;
 use ReflectionClass;
-use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\Yaml\Yaml;
 
 class AutowiringCompilerPass implements CompilerPassInterface
 {
@@ -27,62 +25,51 @@ public function __construct(ClassConstructorFiller $classConstructorFiller, Clas
     public function process(ContainerBuilder $containerBuilder)
     {
         $classList = $this->classListBuilder->buildClassList($containerBuilder);
+        $serviceDefinitions = $containerBuilder->getDefinitions();
 
-        $servicesForAutowiring = $this->getServicesForAutowiring($containerBuilder);
-        $parameterBag = $containerBuilder->getParameterBag();
+        $ignoredServicesRegExp = $this->getIgnoredServicesRegExp($containerBuilder);
 
-        foreach ($containerBuilder->getDefinitions() as $serviceId => $definition) {
-            if (!in_array($serviceId, $servicesForAutowiring)) {
+        foreach ($serviceDefinitions as $serviceId => $definition) {
+            if ($definition->isAbstract() || !$definition->isPublic()) {
                 continue;
             }
 
-            $this->watchServiceClassForChanges($definition, $containerBuilder);
-
-            if (!$definition->isPublic()) {
+            if ($definition->getClass() === null) {
                 continue;
             }
 
-            if ($definition->getFactoryClass() || $definition->getFactoryMethod()) {
+            if ($ignoredServicesRegExp && preg_match($ignoredServicesRegExp, $serviceId)) {
                 continue;
             }
 
-            $class = $parameterBag->resolveValue($definition->getClass());
-
-            if ($class === null) {
+            if ($definition->getFactoryClass() || $definition->getFactoryMethod()) {
                 continue;
             }
 
-            $reflection = new ReflectionClass($class);
+            $this->watchServiceClassForChanges($definition, $containerBuilder);
+
+            $reflection = new ReflectionClass($definition->getClass());
             $constructor = $reflection->getConstructor();
 
             if ($constructor !== null && $constructor->isPublic()) {
-                $this->classConstructorFiller->autowireParams($constructor, $definition, $classList);
+                $this->classConstructorFiller->autowireParams($constructor, $serviceId, $definition, $classList);
             }
         }
     }
 
-    private function getServicesForAutowiring(ContainerBuilder $containerBuilder)
+    private function getIgnoredServicesRegExp(ContainerBuilder $containerBuilder)
     {
-        $kernelRootDir = $containerBuilder->getParameter('kernel.root_dir');
-        $symfonyEnvironment = $containerBuilder->getParameter('kernel.environment');
-        $configDirectories = array($kernelRootDir . '/config');
-
-        $pathToConfigFile = $kernelRootDir . '/config/config_' . $symfonyEnvironment . '.yml';
-
-        $fileLocator = new FileLocator($configDirectories);
-        $configLoader = new YamlConfigLoader($fileLocator);
-        $serviceDefinitions = $configLoader->load($pathToConfigFile);
+        $ignoredServices = $containerBuilder->getParameter('kutny_autowiring.ignored_services');
 
-        if (!array_key_exists('services', $serviceDefinitions) || !is_array($serviceDefinitions['services'])) {
-            return array();
+        if (empty($ignoredServices)) {
+            return null;
         }
 
-        $serviceIds = array_keys($serviceDefinitions['services']);
-
-        return $serviceIds;
+        return '~^(' . implode('|', $ignoredServices) . ')$~';
     }
 
-    private function watchServiceClassForChanges(Definition $definition, ContainerBuilder $containerBuilder) {
+    private function watchServiceClassForChanges(Definition $definition, ContainerBuilder $containerBuilder)
+    {
         $classReflection = new ReflectionClass($definition->getClass());
 
         do {

DependencyInjection/Configuration.php

@@ -0,0 +1,33 @@
+<?php
+namespace Kutny\AutowiringBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+/**
+ * This is the class that validates and merges configuration from your app/config files
+ *
+ * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
+ */
+class Configuration implements ConfigurationInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $rootNode = $treeBuilder->root('kutny_autowiring');
+
+        $rootNode
+            ->children()
+                ->arrayNode('ignored_services')
+                    ->defaultValue(array())
+                    ->prototype('scalar')->end()
+                    ->end()
+                ->end()
+            ->end();
+
+        return $treeBuilder;
+    }
+}

DependencyInjection/KutnyAutowiringExtension.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Kutny\AutowiringBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+
+class KutnyAutowiringExtension extends Extension
+{
+
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $container->setParameter('kutny_autowiring.ignored_services', $config['ignored_services']);
+    }
+
+}

KutnyAutowiringBundle.php

@@ -5,6 +5,7 @@
 use Kutny\AutowiringBundle\Compiler\ClassConstructorFiller;
 use Kutny\AutowiringBundle\Compiler\ClassListBuilder;
 use Kutny\AutowiringBundle\Compiler\ParameterProcessor;
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -14,7 +15,8 @@ class KutnyAutowiringBundle extends Bundle
     public function build(ContainerBuilder $container)
     {
         $container->addCompilerPass(
-            new AutowiringCompilerPass(new ClassConstructorFiller(new ParameterProcessor()), new ClassListBuilder())
+            new AutowiringCompilerPass(new ClassConstructorFiller(new ParameterProcessor()), new ClassListBuilder()),
+            PassConfig::TYPE_BEFORE_REMOVING
         );
     }
 

README.md

@@ -32,6 +32,34 @@ public function registerBundles()
 }
 ~~~~~
 
+Configuration
+-------------
+
+In most cases this bundle **does not require any configuration**. However if your app fails to start after installing this bundle giving you Kutny\AutowiringBundle\Compiler\CannotResolveParameterException, you may need to remove some services from autowiring. See example bellow:
+
+**Example 1**:
+
+You are receiving Kutny\AutowiringBundle\Compiler\CannotResolveParameterException with message like "Class Thrace\FormBundle\Form\Type\Select2Type (service **thrace_form.form.type.select2**), parameter $widget".
+
+The problem is that Thrace\FormBundle\Form\Type\Select2Type service definition does not contain explicit $widget argument definition. It is very likely that the Thrace\FormBundle developer just forgot to define the $widget argument.
+KutnyAutowiringBundle expects all services to have all arguments defined (or have default values). As a result we have to disable autowiring for the thrace_form.form.type.select2 service by adding it (as a regular expression) among ignored_services:
+
+~~~~~ yml
+
+kutny_autowiring:
+    ignored_services: ['thrace_form\.form\.type\.select2']
+
+~~~~~
+
+If you run into problems with more services from the Thrace\FormBundle bundle (thrace_form.form.type.select2, thrace_form.form.type.recaptcha, ...), you can easily add the whole "service namespace" to ignored_services using the following reqular expression:
+
+~~~~~ yml
+
+kutny_autowiring:
+    ignored_services: ['thrace_form\.form\.type.*']
+
+~~~~~
+
 Example 1: Simple controller autowiring
 -----------------------------------------