initial commit 1.0

Author: Robin Cawser

composer.json

@@ -7,6 +7,8 @@
          "email":"robin@vivait.co.uk"
       }
     ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "require": {
         "php": ">=5.3.3",
         "doctrine/common": "~2.2"
@@ -19,8 +21,7 @@
     },
     "autoload":{
       "psr-0":{
-         "Vivait\\StringGeneratorBundle":""
+         "Vivait\\StringGeneratorBundle":"src/"
       }
-    },
-    "target-dir":"Vivait/StringGeneratorBundle"
+    }
 }

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;
+        }
+
+    }
+
+}

src/Vivait/StringGeneratorBundle/Generator/StringGenerator.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\Generator;
+
+use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
+
+class StringGenerator implements GeneratorInterface
+{
+
+    /**
+     * @var
+     */
+    private $length;
+
+    /**
+     * @var string
+     */
+    private $chars;
+
+    public function __construct()
+    {
+        $this->chars = 'abcdefjhijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ12345567890';
+    }
+
+    /**
+     * @param string $chars
+     */
+    public function setChars($chars)
+    {
+        if(!$chars){
+            throw new \OutOfBoundsException('$chars cannot be empty');
+        }
+
+        $this->chars = $chars;
+    }
+
+    /**
+     * Set the length of the generated string
+     * @param $length
+     * @return $this
+     */
+    public function setLength($length)
+    {
+        $this->length = $length;
+        return $this;
+    }
+
+    /**
+     * Creates a random string based on a length and alphabet
+     *
+     * @return string
+     */
+    public function generate()
+    {
+        $str = [];
+        $alphaLength = strlen($this->chars) - 1;
+        for ($i = 0; $i < $this->length; $i++) {
+            $n = rand(0, $alphaLength);
+            $str[] = $this->chars[$n];
+        }
+
+        return implode($str);
+    }
+}

src/Vivait/StringGeneratorBundle/Model/GeneratorInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\Model;
+
+interface GeneratorInterface
+{
+    /**
+     * @param integer $length
+     * @return $this
+     */
+    public function setLength($length);
+
+    /**
+     * @return string
+     */
+    public function generate();
+}

src/Vivait/StringGeneratorBundle/Resources/config/services.yml

@@ -0,0 +1,10 @@
+services:
+    vivait_stringgenerator.generator:
+        class: "%vivait_string_generator.generator_class%"
+        public: false
+    vivait_stringgenerator.generator.listener:
+        class: Vivait\StringGeneratorBundle\EventListener\StringGeneratorListener
+        public: false
+        arguments: ["@annotation_reader", "@vivait_stringgenerator.generator"]
+        tags:
+            - { name: doctrine.event_listener, event: prePersist }

src/Vivait/StringGeneratorBundle/VivaitStringGeneratorBundle.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class VivaitStringGeneratorBundle extends Bundle
+{
+}