Add configurable generators

Author: Robin Cawser

composer.json

@@ -14,7 +14,9 @@
         "php": ">=5.3.3",
         "doctrine/common": "~2.2",
         "doctrine/orm": "~2.2",
-        "symfony/security": "~2.1"
+        "symfony/security": "~2.1",
+        "symfony/options-resolver": "~2.1",
+        "ircmaxell/random-lib": "~1.0"
     },
     "require-dev": {
         "phpspec/phpspec": "~2.0"

spec/Vivait/StringGeneratorBundle/EventListener/GeneratorListenerSpec.php

@@ -11,8 +11,10 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 use Vivait\StringGeneratorBundle\Annotation\GeneratorAnnotation;
 use Vivait\StringGeneratorBundle\Generator\StringGenerator;
+use Vivait\StringGeneratorBundle\Model\ConfigurableGeneratorInterface;
 use Vivait\StringGeneratorBundle\Registry\Registry;
 
 class GeneratorListenerSpec extends ObjectBehavior
@@ -96,6 +98,24 @@ function it_generates_a_string_on_a_property(Registry $registry, Reader $reader,
 
         $this->prePersist($args);
     }
+
+    function it_can_configure_a_generator(Registry $registry, Reader $reader, LifecycleEventArgs $args, ConfigurableGeneratorInterface $generator)
+    {
+        $annotation = new GeneratorAnnotation([]);
+
+        $reader->getPropertyAnnotations(Argument::any())->willReturn([$annotation]);
+
+        $registry->get(Argument::any())->willReturn($generator);
+        $generator->generate()->shouldBeCalled();
+        $generator->setLength(Argument::any())->shouldBeCalled();
+
+        $resolver = new OptionsResolver();
+
+        $generator->getDefaultOptions($resolver)->shouldBeCalled();
+        $generator->setOptions(Argument::any())->shouldBeCalled();
+
+        $this->prePersist($args);
+    }
 }
 
 class Entity

src/Vivait/StringGeneratorBundle/Annotation/GeneratorAnnotation.php

@@ -12,7 +12,16 @@
  */
 class GeneratorAnnotation extends Annotation
 {
+    /**
+     * @var array
+     */
     public $callbacks = [];
+
+    /**
+     * @var array
+     */
+    public $options = [];
+
     /**
      * @var
      */
@@ -28,5 +37,8 @@ class GeneratorAnnotation extends Annotation
      */
     public $unique = true;
 
+    /**
+     * @var bool
+     */
     public $override = true;
 }

src/Vivait/StringGeneratorBundle/EventListener/GeneratorListener.php

@@ -6,7 +6,9 @@
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Event\LifecycleEventArgs;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 use Vivait\StringGeneratorBundle\Annotation\GeneratorAnnotation;
+use Vivait\StringGeneratorBundle\Model\ConfigurableGeneratorInterface;
 use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
 use Vivait\StringGeneratorBundle\Registry\Registry;
 
@@ -88,7 +90,7 @@ public function prePersist(LifecycleEventArgs $args)
      */
     private function generateString($property, GeneratorAnnotation $annotation, $object)
     {
-        /** @var GeneratorInterface $generator */
+        /** @var GeneratorInterface|ConfigurableGeneratorInterface $generator */
         $generator = $this->getRegistry()->get($annotation->generator);
 
         $generator->setLength($annotation->length);
@@ -97,6 +99,10 @@ private function generateString($property, GeneratorAnnotation $annotation, $obj
             $this->performCallbacks($generator, $annotation, $object);
         }
 
+        if($generator instanceof ConfigurableGeneratorInterface){
+            $generator = $this->configureGenerator($generator, $annotation->options);
+        }
+
         $str = $generator->generate();
 
         if (!$annotation->unique) {
@@ -110,6 +116,22 @@ private function generateString($property, GeneratorAnnotation $annotation, $obj
         }
     }
 
+    /**
+     * @param ConfigurableGeneratorInterface $generator
+     * @param $options
+     * @return \Vivait\StringGeneratorBundle\Model\ConfigurableGeneratorInterface
+     */
+    public function configureGenerator(ConfigurableGeneratorInterface $generator, $options)
+    {
+        $resolver = new OptionsResolver();
+        $generator->getDefaultOptions($resolver);
+
+        $options = $resolver->resolve($options);
+        $generator->setOptions($options);
+
+        return $generator;
+    }
+
     /**
      * @param GeneratorInterface $generator
      * @param GeneratorAnnotation $annotation

src/Vivait/StringGeneratorBundle/Generator/StringGenerator.php

@@ -66,4 +66,12 @@ public function generate()
 
         return $this->prefix . implode($str);
     }
+
+    /**
+     * @param array $options
+     */
+    public function setOptions(array $options)
+    {
+        // TODO: Implement setOptions() method.
+    }
 }

src/Vivait/StringGeneratorBundle/Model/ConfigurableGeneratorInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\Model;
+
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+interface ConfigurableGeneratorInterface extends GeneratorInterface
+{
+    public function setOptions(array $options = []);
+
+    public function getDefaultOptions(OptionsResolver $resolver);
+}