Merge pull request #38 from vivait/feature/v3

Remove legacy v1 configuration support

Author: Brunty

README.md

@@ -9,7 +9,7 @@ generates a new string.
 
 ## Install
 
-Run: `composer require vivait/string-generator-bundle:^2.0` to install the bundle.
+Run: `composer require vivait/string-generator-bundle:^3.0` to install the bundle.
 
 If you are using PHP 5.3 or 5.4 you can use the legacy version`vivait/string-generator-bundle:^1.1`
 
@@ -203,3 +203,20 @@ public function setOptions(array $options)
     $this->prefix = $options['prefix'];
 }
 ```
+
+## Upgrading from version 1 to version 2
+Defining generators in configuration was deprecated in version 2 in favour of service definitions, so they must be removed.
+
+1. For any **CUSTOM** generators you have added, you must now define them as services with a `vivait_generator.generator` tag and an `alias` attribute. You will **not** need to do this for the bundled default generators.
+
+    ```yaml
+    my_generator:
+        class: App\Generator\MyGenerator
+        tags:
+            - { name: vivait_generator.generator, alias: 'my_generator' }
+    ```
+
+1. Remove all `vivait_string_generator` configuration from your project  
+
+## Upgrading from version 2 to version 3
+1. Remove all `vivait_string_generator` configuration from your project if not already gone as it will no longer be recognised.

src/Vivait/StringGeneratorBundle/DependencyInjection/Configuration.php

@@ -5,35 +5,17 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader;
-use Symfony\Component\HttpKernel\DependencyInjection\ConfigurableExtension;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
-class VivaitStringGeneratorExtension extends ConfigurableExtension
+class VivaitStringGeneratorExtension extends Extension
 {
 
     /**
      * {@inheritdoc}
      */
-    public function loadInternal(array $mergedConfig, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container)
     {
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.yml');
-
-        if ($mergedConfig['generators'] && $container->hasDefinition('vivait_generator.registry')) {
-            @trigger_error(
-                'Defining Generators in config is deprecated since version 2.0.1 and will be removed in version 3.0. ' .
-                'Use services tagged with "vivait_generator.generator" and an "alias" instead.',
-                E_USER_DEPRECATED
-            );
-
-            $registry = $container->findDefinition('vivait_generator.registry');
-
-            $legacyGenerators = [];
-
-            foreach ($mergedConfig['generators'] as $alias => $generatorService) {
-                $legacyGenerators[$alias] = $container->get($generatorService);
-            }
-
-            $registry->addArgument($legacyGenerators);
-        }
     }
 }

src/Vivait/StringGeneratorBundle/DependencyInjection/VivaitStringGeneratorExtension.php

@@ -10,15 +10,7 @@ class Registry
     /**
      * @var array
      */
-    private $generators;
-
-    /**
-     * @param array $legacyGenerators
-     */
-    public function __construct(array $legacyGenerators = [])
-    {
-        $this->generators = $legacyGenerators;
-    }
+    private $generators = [];
 
     /**
      * @param GeneratorInterface $generator