initial commit 1.0

Author: Robin Cawser

README.md

@@ -0,0 +1,101 @@
+# StringGeneratorBundle
+
+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
+generates a new string.
+
+## Install
+
+Add `"vivait/string-generator-bundle": "dev-master"` to your composer.json and run `composer update`
+
+Update your `AppKernel`:
+
+    public function registerBundles()
+    {
+        $bundles = array(
+            ...
+            new Vivait\StringGeneratorBundle\VivaitStringGeneratorBundle(),
+    }
+
+## Basic usage
+
+Add the `@Vivait\StringGenerator()` annotation to an entity property
+
+    use Vivait\StringGeneratorBundle\Annotation as Vivait;
+    
+    /**
+     * Api
+     *
+     * @ORM\Table()
+     * @ORM\Entity()
+     */
+    class Api
+    {
+        /**
+         * @var integer
+         *
+         * @ORM\Column(name="id", type="guid")
+         * @ORM\Id
+         * @ORM\GeneratedValue(strategy="UUID")
+         */
+        private $id;
+    
+        /**
+         * @var string
+         *
+         * @ORM\Column(name="api_id", type="string", nullable=false)
+         * @Vivait\StringGenerator()
+         */
+        private $api_key;
+
+## Options
+
+### Length
+
+To change the length of the generated string, add `length` to the annotation. The default is 8. Length specifies the length
+of the resulting generated string, and does not include the prefix or separator
+
+    @Vivait\StringGenerator(length=4)
+    
+### Prefix the key
+
+To prefix the string, add the `prefix` option to the annotation. The default seperator between the prefix and generated
+string is a `-`, but this can be changed using `separator`:
+
+    @Vivait\StringGenerator(prefix="user", separator="_")
+
+A prefix can be obtained via a callback to a method in the entity using `prefix_callback`, which overrides `prefix`.
+
+    /**
+     * @var string
+     *
+     * @ORM\Column(name="friendly_id", type="string", nullable=false)
+     * @Vivait\StringGenerator(prefix_callback="createPrefix", length=8)
+     */
+    private $friendly_id;
+    
+    public function createPrefix()
+    {
+        return $this->category->getCode();
+    }
+    
+### Alphabet
+
+Setting `alphabet` limits the characters the generator can choose from. Defaults to alphanumeric.
+
+    @Vivait\StringGenerator(alphabet="abcdefghkmnpqrstuwxyz")
+    
+### Unique
+
+Setting `unique` is boolean and tell if the string must be unique or not, by default `true`
+
+    @Vivait\StringGenerator(unique="false")
+    
+## Custom generator
+
+If you want to use a different generator to create your string, create a class that implements namespace 
+`Vivait\StringGeneratorBundle\Model\GeneratorInterface`. Add the fully qualified classname to your config.yml:
+
+    vivait_string_generator:
+      generator_class: Acme\BlogBundle\Generator\UsernameGenerator

composer.json

@@ -0,0 +1,27 @@
+{  
+    "name":"vivait/string-generator-bundle",
+    "description":"Generate random strings for IDs or keys using property annotations",
+    "authors":[
+      {
+         "name":"Robin Cawser",
+         "email":"robin@vivait.co.uk"
+      }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require": {
+        "php": ">=5.3.3",
+        "doctrine/common": "~2.2"
+    },
+    "require-dev": {
+        "phpspec/phpspec": "~2.0"
+    },
+    "config": {
+        "bin-dir": "bin"
+    },
+    "autoload":{
+      "psr-0":{
+         "Vivait\\StringGeneratorBundle":"src/"
+      }
+    }
+}

spec/Vivait/StringGeneratorBundle/Generator/StringGeneratorSpec.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace spec\Vivait\StringGeneratorBundle\Generator;
+
+use PhpSpec\ObjectBehavior;
+
+class StringGeneratorSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Vivait\StringGeneratorBundle\Generator\StrindfggGenerator');
+    }
+}

src/Vivait/StringGeneratorBundle/Annotation/StringGenerator.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\Annotation;
+
+use Doctrine\Common\Annotations\Annotation;
+
+/**
+ * @Annotation
+ *
+ * Class StringGenerator
+ * @package Vivait\StringGeneratorBundle\Annotation
+ */
+class StringGenerator extends Annotation
+{
+    /**
+     * @var string
+     */
+    public $prefix;
+
+    /**
+     * @var int
+     */
+    public $length = 8;
+
+    /**
+     * @var boolean
+     */
+    public $unique = true;
+
+    /**
+     * @var string
+     */
+    public $separator = "-";
+
+    /**
+     * @var string
+     */
+    public $prefix_callback;
+}

src/Vivait/StringGeneratorBundle/DependencyInjection/Configuration.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+/**
+ * This is the class that validates and merges configuration from your app/config files
+ *
+ * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
+ */
+class Configuration implements ConfigurationInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $rootNode = $treeBuilder->root('vivait_string_generator');
+        $rootNode
+            ->children()
+                ->scalarNode('generator_class')
+                    ->cannotBeEmpty()
+                    ->defaultValue('Vivait\StringGeneratorBundle\Generator\StringGenerator')
+                ->end()
+            ->end()
+        ;
+
+        return $treeBuilder;
+    }
+}

src/Vivait/StringGeneratorBundle/DependencyInjection/VivaitStringGeneratorExtension.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader;
+
+/**
+ * This is the class that loads and manages your bundle configuration
+ *
+ * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
+ */
+class VivaitStringGeneratorExtension extends Extension
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $container->setParameter('vivait_string_generator.generator_class', $config['generator_class']);
+
+        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('services.yml');
+    }
+}

src/Vivait/StringGeneratorBundle/EventListener/StringGeneratorListener.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\EventListener;
+
+use Doctrine\Common\Annotations\Reader;
+use Doctrine\ORM\Event\LifecycleEventArgs;
+use Vivait\StringGeneratorBundle\Annotation as Vivait;
+use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
+
+class StringGeneratorListener
+{
+    private $reader;
+    private $repo;
+    /**
+     * @var GeneratorInterface
+     */
+    private $generator;
+
+    public function __construct(Reader $reader, GeneratorInterface $generator)
+    {
+        $this->reader = $reader;
+        $this->generator = $generator;
+    }
+
+    /**
+     * @param LifecycleEventArgs $args
+     */
+    public function prePersist(LifecycleEventArgs $args)
+    {
+        $entity = $args->getEntity();
+        $em = $args->getEntityManager();
+        $meta = $em->getClassMetadata(get_class($entity));
+        $this->repo = $em->getRepository($meta->getName());
+
+        $obj = new \ReflectionObject($entity);
+
+        //Loop through each of entity's properties
+        foreach ($obj->getProperties() as $property) {
+            //Loop through the property's annotations
+            foreach ($this->reader->getPropertyAnnotations($property) as $annotation) {
+
+                if ($annotation instanceof Vivait\StringGenerator) {
+                    if (method_exists($entity, $annotation->prefix_callback) && is_callable([$entity, $annotation->prefix_callback])) {
+                        $callback = $annotation->prefix_callback;
+                        $annotation->prefix = $entity->$callback();
+                    }
+
+                    $id = $this->generateId(
+                        $property->name,
+                        $annotation
+                    );
+                    $meta->getReflectionProperty($property->name)->setValue($entity, $id);
+                }
+            }
+        }
+    }
+
+    /**
+     * @param $property
+     * @param $annotation
+     * @return string
+     */
+    private function generateId($property, Vivait\StringGenerator $annotation)
+    {
+        $this->generator
+            ->setLength($annotation->length);
+
+        $str = $this->generator->generate();
+
+        if ($annotation->prefix) {
+            $str = sprintf("%s%s%s", $annotation->prefix, $annotation->separator, $str);
+        }
+
+        if (!$annotation->unique) {
+            return $str;
+        }
+
+        if ($this->repo->findOneBy([$property => $str])) {
+            return $this->generateId($property, $annotation);
+        } else {
+            return $str;
+        }
+
+    }
+
+}