Merge pull request #12 from robcaw/feature/NullOnly

Override feature

Author: rcwsr

README.md

@@ -1,5 +1,7 @@
 # StringGeneratorBundle
 
+[![Build Status](https://scrutinizer-ci.com/g/vivait/StringGeneratorBundle/badges/build.png?b=master)](https://scrutinizer-ci.com/g/vivait/StringGeneratorBundle/build-status/master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/vivait/StringGeneratorBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/vivait/StringGeneratorBundle/?branch=master)
+
 This bundle allows you to automatically generate a unique random string on an entity property, useful for
 creating keys. Using Doctrine's `prePersist` callback, StringGenerator adds the generated string to a property
 before the entity is persisted. It also checks whether the string is unique to that property (just in case) and if not, quietly
@@ -21,7 +23,7 @@ public function registerBundles()
 ## Configure
 
 The default configuration is shown below:
-  
+
 ```yaml
 vivait_string_generator:
   generators:
@@ -33,14 +35,16 @@ vivait_string_generator:
 * `SecureBytesGenerator` generates a secure random string using the `Symfony\Component\Security\Core\Util\SecureRandom` class
 
 ### Custom generators
-You can use your own generators by implementing `GeneratorInterface` and defining the generator in the configuration, 
+You can use your own generators by implementing `GeneratorInterface` and defining the generator in the configuration,
 using either its service or classname.
 
 ## Basic usage
 
-Add the `@Generate(generator="generator_name")` annotation to an entity property 
+Add the `@Generate(generator="generator_name")` annotation to an entity property
 (where `generator_name` is the name of a generator defined in the configuration).
 
+`generator` is a required property of the annotation.
+
 ```php
 use Vivait\StringGeneratorBundle\Annotation\GeneratorAnnotation as Generate;
 
@@ -79,9 +83,9 @@ To change the length of the generated string, add `length` to the annotation.
 ```  
 
 ### Callbacks
-    
-It's possible to define callbacks on the `Generator` class that you are using. 
-For example, with the bundled StringGenerator, you may wish to set the character pool. 
+
+It's possible to define callbacks on the `Generator` class that you are using.
+For example, with the bundled StringGenerator, you may wish to set the character pool.
 
 This can be achieved by setting the `callbacks` option. For example:
 
@@ -110,11 +114,20 @@ public function getPrefix()
 
 In this case `StringGenerator::setPrefix("default")` will be called
 
-    
+
 ### Unique
 
 Setting `unique` is boolean and tell if the string must be unique or not, by default `true`
 
 ```php
 @Generate(generator="secure_bytes", unique=false)
 ```
+
+### Override
+
+By default, `override` is set to true, so a string is always generated for a property.
+However, by setting `override` to false, only null properties will have a string generated for them.
+
+```php
+@Generate(generator="string", override=false)
+```

composer.json

@@ -12,6 +12,7 @@
     "require": {
         "php": ">=5.3.3",
         "doctrine/common": "~2.2",
+        "doctrine/orm": "~2.2",
         "symfony/security": "~2.1"
     },
     "require-dev": {

spec/Vivait/StringGeneratorBundle/EventListener/GeneratorListenerSpec.php

@@ -3,6 +3,12 @@
 namespace spec\Vivait\StringGeneratorBundle\EventListener;
 
 use Doctrine\Common\Annotations\Reader;
+
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\Event\LifecycleEventArgs;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 use Vivait\StringGeneratorBundle\Annotation\GeneratorAnnotation;
@@ -11,42 +17,100 @@
 
 class GeneratorListenerSpec extends ObjectBehavior
 {
+    public $mockEntity;
+
     function it_is_initializable()
     {
         $this->shouldHaveType('Vivait\StringGeneratorBundle\EventListener\GeneratorListener');
     }
 
-    function let(Reader $reader, Registry $registry)
+    function let(Reader $reader, Registry $registry, EntityRepository $entityRepository, ClassMetadata $meta, EntityManagerInterface $entityManager, LifecycleEventArgs $args)
     {
         $this->beConstructedWith($reader, $registry);
+
+        //Set up for EM etc.
+        $this->mockEntity = new Entity();
+        $args->getEntity()->willReturn($this->mockEntity);
+        $args->getEntityManager()->willReturn($entityManager);
+        $entityManager->getClassMetadata(Argument::any())->willReturn($meta);
+        $entityManager->getRepository(Argument::any())->willReturn($entityRepository);
+        $meta->getName()->willReturn('Entity');
+
     }
 
-    function it_performs_callbacks_on_the_generator(StringGenerator $generator, Entity $mockEntity)
+    function it_performs_callbacks_on_the_generator(StringGenerator $generator)
     {
         $annotation = new GeneratorAnnotation([]);
         $annotation->callbacks = ['setChars' => 'abcdef'];
-        $this->shouldNotThrow('\InvalidArgumentException')->duringPerformCallbacks($generator, $annotation, $mockEntity);
+        $this->shouldNotThrow('\InvalidArgumentException')->duringPerformCallbacks($generator, $annotation, $this->mockEntity);
 
         $annotation->callbacks = ['noMethod' => 'something'];
-        $this->shouldThrow('\InvalidArgumentException')->duringPerformCallbacks($generator, $annotation, $mockEntity);
+        $this->shouldThrow('\InvalidArgumentException')->duringPerformCallbacks($generator, $annotation, $this->mockEntity);
     }
 
-    function it_can_get_callback_values_from_annotated_object(StringGenerator $generator, Entity $mockEntity)
+    function it_can_get_callback_values_from_annotated_object(StringGenerator $generator)
     {
         $annotation = new GeneratorAnnotation([]);
-        $annotation->callbacks = ['setPrefix' => 'getPrefix'];
+        $annotation->callbacks = ['setPrefix' => 'createPrefix'];
 
-        $mockEntity->getPrefix()->willReturn('VIVA_');
+        $this->mockEntity->createPrefix();
         $generator->setPrefix('VIVA_')->shouldBeCalled();
-        $this->performCallbacks($generator, $annotation, $mockEntity);
+        $this->performCallbacks($generator, $annotation, $this->mockEntity);
+    }
+
+    function it_sets_null_properties_if_override_set_to_true(Registry $registry, Reader $reader, LifecycleEventArgs $args, StringGenerator $generator)
+    {
+        $annotation = new GeneratorAnnotation([]);
+        $annotation->override = false;
+        $annotation->unique = false;
+
+        $reader->getPropertyAnnotations(Argument::any())->willReturn([$annotation]);
+
+        $registry->get(Argument::any())->willReturn($generator)->shouldBeCalled();
+        $generator->generate()->shouldBeCalled();
+        $generator->setLength(Argument::any())->shouldBeCalled();
+
+        $this->prePersist($args);
+    }
+    function it_wont_set_non_null_properties_if_override_set_to_true(Reader $reader, LifecycleEventArgs $args, StringGenerator $generator)
+    {
+        $this->mockEntity->setName('Robin');
+        $annotation = new GeneratorAnnotation([]);
+        $annotation->override = false;
+
+        $reader->getPropertyAnnotations(Argument::any())->willReturn([$annotation]);
+        $generator->generate()->shouldNotBeCalled();
+
+        $this->prePersist($args);
+    }
+
+    function it_generates_a_string_on_a_property(Registry $registry, Reader $reader, LifecycleEventArgs $args, StringGenerator $generator)
+    {
+        $annotation = new GeneratorAnnotation([]);
+
+        $reader->getPropertyAnnotations(Argument::any())->willReturn([$annotation]);
+
+        $registry->get(Argument::any())->willReturn($generator);
+        $generator->generate()->shouldBeCalled();
+        $generator->setLength(Argument::any())->shouldBeCalled();
+
+        $this->prePersist($args);
     }
 }
 
 class Entity
 {
-    public function getPrefix()
+    private $name;
+
+    public function createPrefix()
     {
+        return 'VIVA_';
+    }
 
+    public function setName($name)
+    {
+        $this->name = $name;
     }
+
 }
 

src/Vivait/StringGeneratorBundle/Annotation/GeneratorAnnotation.php

@@ -27,4 +27,6 @@ class GeneratorAnnotation extends Annotation
      * @var boolean
      */
     public $unique = true;
+
+    public $override = true;
 }

src/Vivait/StringGeneratorBundle/EventListener/GeneratorListener.php

@@ -3,14 +3,21 @@
 namespace Vivait\StringGeneratorBundle\EventListener;
 
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Event\LifecycleEventArgs;
 use Vivait\StringGeneratorBundle\Annotation\GeneratorAnnotation;
 use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
 use Vivait\StringGeneratorBundle\Registry\Registry;
 
 class GeneratorListener
 {
+    /**
+     * @var Reader
+     */
     private $reader;
+    /**
+     * @var EntityRepository
+     */
     private $repo;
     /**
      * @var GeneratorInterface
@@ -45,11 +52,15 @@ public function prePersist(LifecycleEventArgs $args)
 
         foreach ($object->getProperties() as $property) {
             foreach ($this->reader->getPropertyAnnotations($property) as $annotation) {
-
                 if ($annotation instanceof GeneratorAnnotation) {
-                    $string = $this->generateString($property->name, $annotation, $object);
 
-                    $meta->getReflectionProperty($property->name)->setValue($entity, $string);
+                    $property->setAccessible(true);
+                    if (!$annotation->override && $property->getValue($entity)) {
+                        break;
+                    }
+
+                    $string = $this->generateString($property->name, $annotation, $object);
+                    $property->setValue($entity, $string);
                 }
             }
         }
@@ -77,13 +88,11 @@ private function generateString($property, GeneratorAnnotation $annotation, $obj
             return $str;
         }
 
-
         if ($this->repo->findOneBy([$property => $str])) {
             return $this->generateString($property, $annotation, $object);
         } else {
             return $str;
         }
-
     }
 
     /**