Merge branch 'release/1.1.0'

Author: IvanChepurnyi

README.md

@@ -91,6 +91,23 @@ $generator = new Generator(
 $generator->generate($object); // Generates "some-key_some-value_another-key_another-value"
 ```
 
+### PSR-6 compatible key generation
+```php
+use EcomDev\CacheKey\Normalizer\Psr6Normalizer;
+use EcomDev\CacheKey\Generator;
+
+$generator = new Generator(Psr6Normalizer::create());
+$generator->generate('give_me-psr-6-compatible_#^.;:/\\-key'); // Generates "give_me-psr-6-compatible_235e.3b3a2f5c-key"
+```
+
+### Prefixed Key Generation
+```php
+use EcomDev\CacheKey\Normalizer\Psr6Normalizer;
+use EcomDev\CacheKey\Generator;
+
+$generator = new Generator(Psr6Normalizer::create(), null, 'prefix-');
+$generator->generate('some-non-prefixed-key'); // Generates "prefix-some-non-prefixed-key"
+```
 
 ## Contribution
 Make a pull request based on develop branch

RELEASE_NOTES.md

@@ -0,0 +1,13 @@
+# Release 1.1.0
+New functionality:
+
+* Added normalizer for PSR-6 compatible key. `Psr6Normalizer` uses `EncodeNormalier` and `LengthNormalizer` behind the scenes. 
+
+# Release 1.0.0
+Initial features:
+
+* **Encode Normalizer** encodes all characters except alphanum into hex representation 
+* **Length Normalizer** strips characters after some length is reached 
+* **Scalar Converter** converts any non string scalar to string representation 
+* **Hash Converter** converts any array into md5 hash of json encoded value
+* **Key Value Converter** converts simple key value pair array into string representation like `key1_value1_key2_value2`

spec/Normalizer/EncodeNormalizerSpec.php

@@ -2,19 +2,20 @@
 
 namespace spec\EcomDev\CacheKey\Normalizer;
 
+use EcomDev\CacheKey\NormalizerInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 
 class EncodeNormalizerSpec extends ObjectBehavior
 {
     function it_implements_normalizer_interface()
     {
-        $this->shouldHaveType('EcomDev\CacheKey\NormalizerInterface');
+        $this->shouldHaveType(NormalizerInterface::class);
     }
 
     function it_encodes_everything_except_alphanums_hypen_and_underscores()
     {
-        $this->normalize('this:is../not&a#valid91code')->shouldReturn('this3ais2e2e2fnot26a23valid91code');
+        $this->normalize('this:is../not&a#valid91code')->shouldReturn('this3ais..2fnot26a23valid91code');
 
     }
 
@@ -23,9 +24,10 @@ function it_lowers_uppercase_characters()
         $this->normalize('ThisIsUpperCASE')->shouldReturn('thisisuppercase');
     }
 
-    function it_allows_underscore_and_hypen()
+    function it_allows_underscore_and_hypen_and_dot()
     {
         $this->normalize('this-is-a-valid-key')->shouldReturn('this-is-a-valid-key');
         $this->normalize('this_is_a_valid_key')->shouldReturn('this_is_a_valid_key');
+        $this->normalize('this.is.a.valid.key')->shouldReturn('this.is.a.valid.key');
     }
 }

spec/Normalizer/LengthNormalizerSpec.php

@@ -2,14 +2,15 @@
 
 namespace spec\EcomDev\CacheKey\Normalizer;
 
+use EcomDev\CacheKey\NormalizerInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 
 class LengthNormalizerSpec extends ObjectBehavior
 {
     function it_implements_normalizer_interface()
     {
-        $this->shouldHaveType('EcomDev\CacheKey\NormalizerInterface');
+        $this->shouldHaveType(NormalizerInterface::class);
     }
 
     function it_is_possible_to_specify_custom_max_length()

spec/Normalizer/Psr6NormalizerSpec.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace spec\EcomDev\CacheKey\Normalizer;
+
+use EcomDev\CacheKey\Normalizer\EncodeNormalizer;
+use EcomDev\CacheKey\Normalizer\LengthNormalizer;
+use EcomDev\CacheKey\NormalizerInterface;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class Psr6NormalizerSpec extends ObjectBehavior
+{
+
+    function it_implements_normalizer_interface(
+        EncodeNormalizer $encodeNormalizer, LengthNormalizer $lengthNormalizer
+    )
+    {
+        $this->beConstructedWith($encodeNormalizer, $lengthNormalizer);
+        $this->shouldHaveType(NormalizerInterface::class);
+    }
+
+    function it_uses_encode_and_length_normalizer_as_dependency(
+        EncodeNormalizer $encodeNormalizer, LengthNormalizer $lengthNormalizer
+    )
+    {
+        $this->beConstructedWith($encodeNormalizer, $lengthNormalizer);
+        $encodeNormalizer->normalize('value1')->willReturn('value2')->shouldBeCalled();
+        $lengthNormalizer->normalize('value2')->willReturn('value_normalized')->shouldBeCalled();
+        $this->normalize('value1')->shouldReturn('value_normalized');
+    }
+
+    function it_has_factory_to_create_it_with_needed_normalizers()
+    {
+        $this->beConstructedThrough('create');
+        $this->normalize('some-in&valid-012931231value')->shouldReturn('some-in26valid-012931231value');
+        $this->normalize('some-very-long-value-that-is-longer-than-sixty-four-characters-can-you-belive-it')
+            ->shouldReturn('some-very-long-value-that-is-longer-than-sixty-four-char485b813b');
+    }
+}

src/Normalizer/EncodeNormalizer.php

@@ -7,8 +7,10 @@
 /**
  * Encode Normalizer
  *
- * Encodes all characters that are not alphanum, dash or underscore
+ * Encodes all characters that are not alphanum, dash, underscore or dots
  * Also it makes all characters lower cased
+ *
+ * Fully PSR-6 compliant cache key generator
  */
 class EncodeNormalizer implements NormalizerInterface
 {
@@ -31,8 +33,7 @@ public function normalize($key)
                 FILTER_FLAG_ENCODE_HIGH | FILTER_FLAG_ENCODE_LOW | FILTER_FLAG_ENCODE_AMP
             ),
             [
-                '%' => '',
-                '.' => '2e'
+                '%' => ''
             ]
         ));
     }

src/Normalizer/Psr6Normalizer.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace EcomDev\CacheKey\Normalizer;
+
+use EcomDev\CacheKey\NormalizerInterface;
+
+/**
+ * PSR-6 Normalizer
+ *
+ * By default follows these rules:
+ * Implementing libraries MUST support keys consisting of the characters A-Z, a-z, 0-9, _,
+ * and . in any order in UTF-8 encoding and a length of up to 64 characters.
+ */
+class Psr6Normalizer implements NormalizerInterface
+{
+    /**
+     * Encode normalizer
+     *
+     * @var EncodeNormalizer
+     */
+    private $encodeNormalizer;
+
+    /**
+     * Length normalizer
+     *
+     * @var LengthNormalizer
+     */
+    private $lengthNormalizer;
+
+    /**
+     * Configured dependencies
+     *
+     * @param EncodeNormalizer $encodeNormalizer
+     * @param LengthNormalizer $lengthNormalizer
+     */
+    public function __construct(
+        EncodeNormalizer $encodeNormalizer,
+        LengthNormalizer $lengthNormalizer
+    ) {
+    
+        $this->encodeNormalizer = $encodeNormalizer;
+        $this->lengthNormalizer = $lengthNormalizer;
+    }
+
+    /**
+     * Creates a new instance of PSR-6 compatible normalizer
+     *
+     * @return static
+     */
+    public static function create()
+    {
+        return new static(new EncodeNormalizer(), new LengthNormalizer(64));
+    }
+
+    /**
+     * Normalizes key according to PSR-6 specification
+     *
+     * @param string $key
+     *
+     * @return string
+     */
+    public function normalize($key)
+    {
+        return $this->lengthNormalizer->normalize(
+            $this->encodeNormalizer->normalize($key)
+        );
+    }
+}