Merge branch 'release/0.2.0'

Author: IvanChepurnyi

RELEASE_NOTES.md

@@ -3,12 +3,24 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
-No changes yet
+No unreleased changes yet
+
+## [0.2.0]
+### Added
+- Interface for extracting raw cache value `ExtractableCacheValueInterface`
+
+### Changed
+- `CacheItem::get()` method now ALWAYS returns `null` when `isHit()` returns false. 
+- `CacheItemPool::save()` and `CacheItemPool::saveDeferred()` now supports additionally CacheItems that implement `ExtractableCacheValueInterface` with a fallback to previous implementation, that was relying on `CacheItem::get()` 
+
+## Fixed
+- Fixed version in `module.xml` file, as it was not matching one in composer.json.
 
 ## 0.1.0
 ### Added
 - PSR-6 Implementation
 - DI auto-wiring for CacheItemPool
 - DI auto-wiring for [EcomDev\CacheKey](https://github.com/EcomDev/CacheKey) library
 
-[Unreleased]: https://github.com/EcomDev/magento-psr6-bridge/compare/0.1.0...HEAD
+[Unreleased]: https://github.com/EcomDev/magento-psr6-bridge/compare/0.2.0...HEAD
+[0.2.0]: https://github.com/EcomDev/magento-psr6-bridge/compare/0.1.0...0.2.0

composer.json

@@ -18,7 +18,7 @@
         "ecomdev/phpspec-magento-di-adapter": "~0.1",
         "magento/zendframework1": "*"
     },
-    "version": "0.1.0",
+    "version": "0.2.0",
     "license": "OSL-3.0",
     "authors": [
         {

spec/Model/CacheItemPoolSpec.php

@@ -202,9 +202,10 @@ function it_saves_item_without_expiration_extraction_interface(CacheItemInterfac
         $this->save($cacheItem)->shouldReturn(true);
     }
 
-    function it_saves_item_with_expiration_time(CacheItem $cacheItem)
+    function it_saves_item_with_expiration_time_and_value_provided_from_another_method(CacheItem $cacheItem)
     {
-        $cacheItem->get()->willReturn([1, 2, 3])->shouldBeCalled();
+        $cacheItem->get()->shouldNotBeCalled();
+        $cacheItem->getCacheValue()->willReturn([1, 2, 3])->shouldBeCalled();
         $cacheItem->getKey()->willReturn('key1')->shouldBeCalled();
         $cacheItem->getCacheLifetime()->willReturn(3600)->shouldBeCalled();
 

spec/Model/CacheItemSpec.php

@@ -16,6 +16,8 @@
 
 namespace spec\EcomDev\MagentoPsr6Bridge\Model;
 
+use EcomDev\MagentoPsr6Bridge\ExtractableCacheLifetimeInterface;
+use EcomDev\MagentoPsr6Bridge\ExtractableCacheValueInterface;
 use Psr\Cache\CacheItemInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
@@ -32,6 +34,16 @@ function it_should_implement_cache_item_interface()
         $this->shouldImplement(CacheItemInterface::class);
     }
 
+    function it_should_implement_extractable_cache_lifetime_interface()
+    {
+        $this->shouldImplement(ExtractableCacheLifetimeInterface::class);
+    }
+
+    function it_should_implement_extractable_cache_value_interface()
+    {
+        $this->shouldImplement(ExtractableCacheValueInterface::class);
+    }
+
     function it_returns_key_that_was_passed_in_constructor()
     {
         $this->getKey()->shouldReturn('dummy_key');
@@ -65,6 +77,26 @@ function it_is_possible_to_set_cache_value()
         $this->get()->shouldReturn('some_cache_value');
     }
 
+    function it_should_return_null_if_it_is_not_hit()
+    {
+        $this->beConstructedWith('key1', false);
+        $this->set('some_cache_value')->shouldReturn($this);
+        $this->get()->shouldReturn(null);
+    }
+
+    function it_returns_same_value_that_was_set_before_via_special_method()
+    {
+        $this->beConstructedWith('key1', false);
+        $this->set('some_cache_value')->shouldReturn($this);
+        $this->getCacheValue()->shouldReturn('some_cache_value');
+    }
+
+    function it_returns_same_value_that_was_passed_in_constructor_even_on_cache_miss()
+    {
+        $this->beConstructedWith('key1', false, 'some_cache_value');
+        $this->getCacheValue()->shouldReturn('some_cache_value');
+    }
+
     function it_does_not_have_any_cache_lifetime_set_by_default()
     {
         $this->getCacheLifetime()->shouldReturn(null);

src/ExtractableCacheValueInterface.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Magento PSR-6 Bridge
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/osl-3.0.php
+ *
+ * @copyright Copyright (c) 2016 EcomDev BV (http://www.ecomdev.org)
+ * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @author    Ivan Chepurnyi <[email protected]>
+ */
+
+namespace EcomDev\MagentoPsr6Bridge;
+
+/**
+ * Interface provides a possibility
+ * to extract cache value from cache item
+ *
+ * In default PSR-6 implementation, there are some setters
+ * but no retrieval of value after it was set
+ */
+interface ExtractableCacheValueInterface
+{
+    /**
+     * Returns cache value, that was set or loaded before
+     *
+     * @return mixed|null
+     */
+    public function getCacheValue();
+}

src/Model/CacheItem.php

@@ -16,6 +16,7 @@
 
 namespace EcomDev\MagentoPsr6Bridge\Model;
 
+use EcomDev\MagentoPsr6Bridge\ExtractableCacheValueInterface;
 use Psr\Cache\CacheItemInterface;
 use EcomDev\MagentoPsr6Bridge\ExtractableCacheLifetimeInterface;
 
@@ -28,7 +29,10 @@
  * you must explicitly call cache pool save()
  * or saveDeferred() on a cache pool
  */
-class CacheItem implements CacheItemInterface, ExtractableCacheLifetimeInterface
+class CacheItem implements
+    CacheItemInterface,
+    ExtractableCacheLifetimeInterface,
+    ExtractableCacheValueInterface
 {
     /**
      * Cache life time of the entry
@@ -69,9 +73,7 @@ public function __construct($key, $isHit, $value = null)
     {
         $this->key = $key;
         $this->isHit = $isHit;
-        if ($this->isHit) {
-            $this->value = $value;
-        }
+        $this->value = $value;
     }
 
     /**
@@ -102,7 +104,7 @@ public function getKey()
      */
     public function get()
     {
-        return $this->value;
+        return $this->isHit() ? $this->value : null;
     }
 
     /**
@@ -196,4 +198,14 @@ public function getCacheLifetime()
     {
         return $this->cacheLifetime;
     }
+
+    /**
+     * Returns cache value, that was set or loaded before
+     *
+     * @return mixed|null
+     */
+    public function getCacheValue()
+    {
+        return $this->value;
+    }
 }

src/Model/CacheItemPool.php

@@ -16,6 +16,7 @@
 
 namespace EcomDev\MagentoPsr6Bridge\Model;
 
+use EcomDev\MagentoPsr6Bridge\ExtractableCacheValueInterface;
 use Magento\Framework\Cache\FrontendInterface;
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
@@ -255,7 +256,11 @@ public function save(CacheItemInterface $item)
         }
 
         return $this->cacheFrontend->save(
-            serialize($item->get()),
+            serialize((
+                $item instanceof ExtractableCacheValueInterface ?
+                    $item->getCacheValue() :
+                    $item->get()
+            )),
             $this->prepareKey($item->getKey()),
             $this->tags,
             $expirationTime

src/etc/module.xml

@@ -16,5 +16,5 @@
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="EcomDev_MagentoPsr6Bridge" setup_version="1.0.0" />
+    <module name="EcomDev_MagentoPsr6Bridge" setup_version="0.2.0" />
 </config>