Merge pull request #30 from terox/uuid-generator

Uuid generator

Author: Brunty

.travis.yml

@@ -29,6 +29,7 @@ install:
   - if [ "$DEPENDENCIES" == "dev" ]; then perl -pi -e 's/^}$/,"minimum-stability":"dev"}/' composer.json; fi;
   - if [ "$DEPENDENCIES" != "low" ]; then composer update; fi;
   - if [ "$DEPENDENCIES" == "low" ]; then composer update --prefer-lowest; fi;
+  - composer require ramsey/uuid
 
 before_script:
   - echo "<?php if (PHP_VERSION_ID >= 50400) echo ',@php5.4';" > php_version_tags.php

README.md

@@ -49,6 +49,20 @@ Generates a secure random byte string using the `Symfony\Component\Security\Core
 @Generate(generator="secure_bytes", options={"length"=8})
 ```
 
+### `UuidStringGenerator`
+***For use this generator you should require the package ```ramsey/uuid``` in your application.***
+
+For generating a UUID:
+
+```php
+@Generate(generator="uuid_string", options={"version"=4})
+```
+
+You can use also namespaced versions (v3 and v5). For example with the v5:
+```php
+@Generate(generator="uuid_string", options={"version"=5}, namespace="my_namespace")
+```
+
 ## Usage
 Add the `@Generate(generator="generator_name")` annotation to an entity property
 (where `generator_name` is the name of a generator defined in the configuration).

composer.json

@@ -21,6 +21,9 @@
         "symfony/dependency-injection": "^2.7|^3.3",
         "symfony/config": "^2.7|^3.3"
     },
+    "suggest": {
+        "ramsey/uuid": "To use the UUID generator you should require this package"
+    },
     "require-dev": {
         "phpspec/phpspec": "~2.0"
     },

spec/Vivait/StringGeneratorBundle/Generator/UuidGeneratorSpec.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace spec\Vivait\StringGeneratorBundle\Generator;
+
+use PhpSpec\ObjectBehavior;
+
+class UuidGeneratorSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Vivait\StringGeneratorBundle\Generator\UuidGenerator');
+    }
+
+    function it_should_throw_an_exception_when_no_namespace_on_version_3()
+    {
+        $this->setVersion(3);
+        $this->setNamespace(null);
+        $this->shouldThrow('\RuntimeException')->duringGenerate();
+    }
+
+    function it_should_throw_an_exception_when_no_namespace_on_version_5()
+    {
+        $this->setVersion(5);
+        $this->setNamespace(null);
+        $this->shouldThrow('\RuntimeException')->duringGenerate();
+    }
+
+    function it_generates_a_uuid_based_on_version_1()
+    {
+        $this->setVersion(1);
+        $this->generate()->shouldBeString();
+        $this->generate()->shouldHaveStrlen(36);
+    }
+
+    function it_generates_a_uuid_based_on_version_3()
+    {
+        $this->setVersion(3);
+        $this->setNamespace('testing');
+        $this->generate()->shouldBeString();
+        $this->generate()->shouldHaveStrlen(36);
+    }
+
+    function it_generates_a_uuid_based_on_version_4()
+    {
+        $this->setVersion(4);
+        $this->generate()->shouldBeString();
+        $this->generate()->shouldHaveStrlen(36);
+    }
+
+    function it_generates_a_uuid_based_on_version_5()
+    {
+        $this->setVersion(5);
+        $this->setNamespace('testing');
+        $this->generate()->shouldBeString();
+        $this->generate()->shouldHaveStrlen(36);
+    }
+
+    function getMatchers()
+    {
+        return [
+            'haveStrlen' => function($string, $length){
+                return strlen($string) == $length;
+            }
+        ];
+    }
+}

src/Vivait/StringGeneratorBundle/Generator/UuidGenerator.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\Generator;
+
+use Ramsey\Uuid\Uuid;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Vivait\StringGeneratorBundle\Model\ConfigurableGeneratorInterface;
+
+class UuidGenerator implements ConfigurableGeneratorInterface
+{
+    /**
+     * @var Uuid
+     */
+    private $uuid;
+
+    /**
+     * @var integer
+     */
+    private $version;
+
+    /**
+     * @var string
+     */
+    private $namespace;
+
+    /**
+     * Creates a random string based on a length and alphabet
+     *
+     * @return string
+     */
+    public function generate()
+    {
+        if(!class_exists('Ramsey\Uuid\Uuid')) {
+            throw new \RuntimeException('For use the UUID generator you should setup the ramsey/uuid package');
+        }
+
+        switch($this->version) {
+            case 1:
+                return Uuid::uuid1()->toString();
+
+            case 3:
+                $this->checkNamespace($this->version);
+                return Uuid::uuid3(Uuid::NAMESPACE_DNS, $this->namespace)->toString();
+
+            case 4:
+                return Uuid::uuid4()->toString();
+
+            case 5:
+                $this->checkNamespace($this->version);
+                return Uuid::uuid5(Uuid::NAMESPACE_DNS, $this->namespace)->toString();
+
+            default:
+                throw new \RuntimeException(sprintf('The version %s of UUID does not exists',$this->version));
+        }
+    }
+
+    /**
+     * @param integer $version
+     */
+    private function checkNamespace($version)
+    {
+        if(null === $this->namespace) {
+            throw new \RuntimeException(sprintf('The version %s of UUID needs a namespace', $version));
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setOptions(array $options)
+    {
+        $this->version   = $options['version'];
+        $this->namespace = $options['namespace'];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'version'   => 4,
+            'namespace' => null
+        ]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setLength($length)
+    {
+        return null;
+    }
+
+    /**
+     * @param $version
+     * @return $this
+     */
+    public function setVersion($version)
+    {
+        $this->version = $version;
+
+        return $this;
+    }
+
+    /**
+     * @param $namespace
+     * @return $this
+     */
+    public function setNamespace($namespace)
+    {
+        $this->namespace = $namespace;
+
+        return $this;
+    }
+}

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

@@ -28,5 +28,10 @@ services:
         tags:
             - { name: vivait_generator.generator, alias: 'secure_string' }
 
+    vivait_generator.generator.uuid_string:
+        class: Vivait\StringGeneratorBundle\Generator\UuidGenerator
+        tags:
+            - { name: vivait_generator.generator, alias: 'uuid_string' }
+
     vivait_generator.randomlib:
         class: RandomLib\Factory