Plugin reference (#199)

* Fix plugin reference

* Implemented tests

* Added null logger

* Fixed tests

* Reference is always set

* Test multiple plugins config

Author: toooni

DependencyInjection/BazingaGeocoderExtension.php

@@ -106,7 +106,9 @@ public function configureProviderPlugins(ContainerBuilder $container, array $con
     {
         $plugins = [];
         foreach ($config['plugins'] as $plugin) {
-            $plugins[] = $plugin['id'];
+            if ($plugin['reference']['enabled']) {
+                $plugins[] = $plugin['reference']['id'];
+            }
         }
 
         if (isset($config['cache']) || isset($config['cache_lifetime'])) {

DependencyInjection/Configuration.php

@@ -92,6 +92,7 @@ private function getProvidersNode()
             ->requiresAtLeastOneElement()
             ->useAttributeAsKey('name')
             ->prototype('array')
+            ->fixXmlConfig('plugin')
                 ->children()
                     ->scalarNode('factory')->isRequired()->cannotBeEmpty()->end()
                     ->variableNode('options')->defaultValue([])->end()

Tests/Functional/BundleInitializationTest.php

@@ -14,6 +14,7 @@
 
 use Bazinga\GeocoderBundle\BazingaGeocoderBundle;
 use Geocoder\Plugin\Plugin\CachePlugin;
+use Geocoder\Plugin\Plugin\LoggerPlugin;
 use Geocoder\Plugin\PluginProvider;
 use Geocoder\Provider\GoogleMaps\GoogleMaps;
 use Geocoder\ProviderAggregator;
@@ -81,4 +82,34 @@ public function testBundleWithCachedProvider()
         $this->assertNotEmpty($plugins);
         $this->assertInstanceOf(CachePlugin::class, $plugins[0]);
     }
+
+    public function testBundleWithPluginsYml()
+    {
+        $kernel = $this->createKernel();
+        $kernel->addConfigFile(__DIR__.'/config/service_plugin.yml');
+        $this->bootKernel();
+        $container = $this->getContainer();
+
+        $this->assertTrue($container->has('bazinga_geocoder.provider.acme'));
+        $service = $container->get('bazinga_geocoder.provider.acme');
+        $this->assertInstanceOf(PluginProvider::class, $service);
+        $plugins = NSA::getProperty($service, 'plugins');
+        $this->assertCount(3, $plugins);
+        $this->assertInstanceOf(LoggerPlugin::class, $plugins[0]);
+    }
+
+    public function testBundleWithPluginXml()
+    {
+        $kernel = $this->createKernel();
+        $kernel->addConfigFile(__DIR__.'/config/service_plugin.xml');
+        $this->bootKernel();
+        $container = $this->getContainer();
+
+        $this->assertTrue($container->has('bazinga_geocoder.provider.acme'));
+        $service = $container->get('bazinga_geocoder.provider.acme');
+        $this->assertInstanceOf(PluginProvider::class, $service);
+        $plugins = NSA::getProperty($service, 'plugins');
+        $this->assertNotEmpty($plugins);
+        $this->assertInstanceOf(LoggerPlugin::class, $plugins[0]);
+    }
 }

Tests/Functional/config/service_plugin.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container xmlns="http://symfony.com/schema/dic/services">
+
+    <config xmlns="http://example.org/schema/dic/bazinga_geocoder">
+        <profiling enabled="true" />
+        <providers>
+            <acme factory="Bazinga\GeocoderBundle\ProviderFactory\NominatimFactory" >
+                <plugin>acme.logger</plugin>
+            </acme>
+        </providers>
+    </config>
+
+    <services>
+        <service id="logger" class="Psr\Log\NullLogger" />
+        <service id="acme.logger" class="Geocoder\Plugin\Plugin\LoggerPlugin">
+            <argument type="service" id="logger" />
+        </service>
+    </services>
+</container>

Tests/Functional/config/service_plugin.yml

@@ -0,0 +1,36 @@
+
+bazinga_geocoder:
+  profiling:
+    enabled: false
+  providers:
+    acme:
+      factory: Bazinga\GeocoderBundle\ProviderFactory\NominatimFactory
+      plugins:
+        - acme.logger
+        - acme.2nd_logger
+        - {'reference': {'enabled': false, 'id': acme.3d_logger}}
+        - {'reference': {'enabled': true, 'id': acme.4th_logger}}
+
+services:
+  logger:
+    class: Psr\Log\NullLogger
+
+  acme.logger:
+    class: Geocoder\Plugin\Plugin\LoggerPlugin
+    arguments:
+      - '@logger'
+
+  acme.2nd_logger:
+    class: Geocoder\Plugin\Plugin\LoggerPlugin
+    arguments:
+      - '@logger'
+
+  acme.3d_logger:
+    class: Geocoder\Plugin\Plugin\LoggerPlugin
+    arguments:
+      - '@logger'
+
+  acme.4th_logger:
+    class: Geocoder\Plugin\Plugin\LoggerPlugin
+    arguments:
+      - '@logger'