Allow you to create a custom factory (#184)

This will fix #178

Author: Nyholm

BazingaGeocoderBundle.php

@@ -13,6 +13,7 @@
 namespace Bazinga\GeocoderBundle;
 
 use Bazinga\GeocoderBundle\DependencyInjection\Compiler\AddProvidersPass;
+use Bazinga\GeocoderBundle\DependencyInjection\Compiler\FactoryValidatorPass;
 use Bazinga\GeocoderBundle\DependencyInjection\Compiler\ProfilerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -31,5 +32,6 @@ public function build(ContainerBuilder $container)
 
         $container->addCompilerPass(new ProfilerPass());
         $container->addCompilerPass(new AddProvidersPass());
+        $container->addCompilerPass(new FactoryValidatorPass());
     }
 }

DependencyInjection/BazingaGeocoderExtension.php

@@ -13,6 +13,7 @@
 namespace Bazinga\GeocoderBundle\DependencyInjection;
 
 use Bazinga\GeocoderBundle\DataCollector\GeocoderDataCollector;
+use Bazinga\GeocoderBundle\DependencyInjection\Compiler\FactoryValidatorPass;
 use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
 use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
 use Bazinga\GeocoderBundle\ProviderFactory\PluginProviderFactory;
@@ -25,6 +26,7 @@
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
@@ -60,14 +62,20 @@ public function load(array $configs, ContainerBuilder $container)
     private function loadProviders(ContainerBuilder $container, array $config)
     {
         foreach ($config['providers'] as $providerName => $providerConfig) {
-            $factoryService = $container->getDefinition($providerConfig['factory']);
-            $factoryClass = $factoryService->getClass() ?: $providerConfig['factory'];
-            if (!$this->implementsPoviderFactory($factoryClass)) {
-                throw new \LogicException(sprintf('Provider factory "%s" must implement ProviderFactoryInterface', $providerConfig['factory']));
+            try {
+                $factoryService = $container->getDefinition($providerConfig['factory']);
+                $factoryClass = $factoryService->getClass() ?: $providerConfig['factory'];
+                if (!$this->implementsPoviderFactory($factoryClass)) {
+                    throw new \LogicException(sprintf('Provider factory "%s" must implement ProviderFactoryInterface', $providerConfig['factory']));
+                }
+                // See if any option has a service reference
+                $providerConfig['options'] = $this->findReferences($providerConfig['options']);
+                $factoryClass::validate($providerConfig['options'], $providerName);
+            } catch (ServiceNotFoundException $e) {
+                // Assert: We are using a custom factory. If invalid config, it will be caught in FactoryValidatorPass
+                $providerConfig['options'] = $this->findReferences($providerConfig['options']);
+                FactoryValidatorPass::addFactoryServiceId($providerConfig['factory']);
             }
-            // See if any option has a service reference
-            $providerConfig['options'] = $this->findReferences($providerConfig['options']);
-            $factoryClass::validate($providerConfig['options'], $providerName);
 
             $serviceId = 'bazinga_geocoder.provider.'.$providerName;
             $plugins = $this->configureProviderPlugins($container, $providerConfig, $serviceId);

DependencyInjection/Compiler/FactoryValidatorPass.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
+
+/**
+ * Make sure that the factory actually exists
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class FactoryValidatorPass implements CompilerPassInterface
+{
+    private static $factoryServiceIds = [];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        foreach (self::$factoryServiceIds as $id) {
+            if (!$container->hasAlias($id) && !$container->hasDefinition($id)) {
+                throw new ServiceNotFoundException(sprintf('Factory with ID "%s" could not be found', $id));
+            }
+        }
+    }
+
+    /**
+     * @param mixed $factoryServiceIds
+     */
+    public static function addFactoryServiceId($factoryServiceIds)
+    {
+        self::$factoryServiceIds[] = $factoryServiceIds;
+    }
+}