Merge pull request #16 from php-cache/updates

[WIP] Updated to adapter 0.2 and tagging 0.3

Author: Nyholm

README.md

@@ -1,15 +1,15 @@
-# Doctrine PSR-6 adapter 
-[![Build Status](https://travis-ci.org/php-cache/doctrine-adapter.svg?branch=master)](https://travis-ci.org/php-cache/doctrine-adapter) [![codecov.io](https://codecov.io/github/php-cache/doctrine-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/doctrine-adapter?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/1ac09139-8edd-41a9-84ab-3d84791a2659/mini.png)](https://insight.sensiolabs.com/projects/1ac09139-8edd-41a9-84ab-3d84791a2659)
+# Doctrine PSR-6 Cache pool 
+[![Latest Stable Version](https://poser.pugx.org/cache/doctrine-adapter/v/stable)](https://packagist.org/packages/cache/doctrine-adapter) [![codecov.io](https://codecov.io/github/php-cache/doctrine-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/doctrine-adapter?branch=master) [![Build Status](https://travis-ci.org/php-cache/doctrine-adapter.svg?branch=master)](https://travis-ci.org/php-cache/doctrine-adapter) [![Total Downloads](https://poser.pugx.org/cache/doctrine-adapter/downloads)](https://packagist.org/packages/cache/doctrine-adapter)  [![Monthly Downloads](https://poser.pugx.org/cache/doctrine-adapter/d/monthly.png)](https://packagist.org/packages/cache/doctrine-adapter) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
-This is a implementation for the PSR-6 that wraps the Doctrine cache. This implementation supports tags. 
+This is a PSR-6 cache implementation using Doctrine. It is a part of the PHP Cache organisation. To read about 
+features like tagging and hierarchy support please read the shared documentation at [www.php-cache.com](http://www.php-cache.com). 
 
-If you want to use this library with Symfony you may be intrerested in
-[Doctrine Adapter Bundle](https://github.com/php-cache/doctrine-adapter-bundle). 
+This is a PSR-6 to Doctrine bridge. If you are interested in a Doctrine to PSR-6 bridge you should have a look at 
+[PSR-6 Doctrine Bridge](https://github.com/php-cache/doctrine-bridge).
 
-## To Install
+### Install
 
-Run the following in your project root, assuming you have composer set up for your project
-```sh
+```bash
 composer require cache/doctrine-adapter
 ```
 
@@ -19,42 +19,14 @@ composer require cache/doctrine-adapter
 use Doctrine\Common\Cache\MemcachedCache;
 use Cache\Doctrine\CachePool;
 
-// Create a instance of Doctrine's MemcachedCache
+
 $memcached = new \Memcached();
 $memcached->addServer('localhost', 11211);
+
+// Create a instance of Doctrine's MemcachedCache
 $doctrineCache = new MemcachedCache();
 $doctrineCache->setMemcached($memcached);
 
 // Wrap Doctrine's cache with the PSR-6 adapter
 $pool = new CachePool($doctrineCache);
-
-/** @var CacheItemInterface $item */
-$item = $pool->getItem('key');
-```
-
-## Tagging
-
-The `CachePool` implements `Cache\Taggable\TaggablePoolInterface` from [Taggable Cache](https://github.com/php-cache/taggable-cache). 
-Below is an example of how you could use tags: 
-
-```php
-
-$item = $pool->getItem('tobias', ['person']);
-$item->set('foobar');
-$pool->save($item);
-
-$item = $pool->getItem('aaron', ['person', 'developer']);
-$item->set('foobar');
-$pool->save($item);
-
-$pool->getItem('tobias', ['person'])->isHit(); // true
-$pool->getItem('aaron', ['person', 'developer'])->isHit(); // true
-
-// Clear all cache items tagged with 'developer'
-$pool->clear(['developer']);
-
-$pool->getItem('tobias', ['person'])->isHit(); // true
-$pool->getItem('aaron', ['person', 'developer'])->isHit(); // false
 ```
-
-See more example and understand how you use tags here: https://github.com/php-cache/taggable-cache

composer.json

@@ -27,16 +27,16 @@
     ],
     "require":
     {
-        "psr/cache":            "1.0.0",
-        "cache/adapter-common": "^0.1",
-        "cache/taggable-cache": "^0.2",
+        "psr/cache":            "1.0",
+        "cache/adapter-common": "^0.2",
+        "cache/taggable-cache": "^0.3",
         "doctrine/cache":       "^1.3"
     },
     "require-dev":
     {
         "phpunit/phpunit":         "^5.1|^4.0",
         "mockery/mockery":         "^0.9.4",
-        "cache/integration-tests": "dev-master"
+        "cache/integration-tests": "^0.7"
     },
     "provide":
     {

src/DoctrineCachePool.php

@@ -39,7 +39,11 @@ public function __construct(Cache $cache)
 
     protected function fetchObjectFromCache($key)
     {
-        return $this->cache->fetch($key);
+        if (false === $data = $this->cache->fetch($key)) {
+            return [false, null];
+        }
+
+        return [true, unserialize($data)];
     }
 
     protected function clearAllObjectsFromCache()
@@ -62,7 +66,7 @@ protected function storeItemInCache($key, CacheItemInterface $item, $ttl)
             $ttl = 0;
         }
 
-        return $this->cache->save($key, $item, $ttl);
+        return $this->cache->save($key, serialize($item->get()), $ttl);
     }
 
     /**

tests/CachePoolTest.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of php-cache\doctrine-adapter package.
+ *
+ * (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Doctrine\Tests;
+
+use Cache\Adapter\Doctrine\DoctrineCachePool;
+use Doctrine\Common\Cache\ArrayCache;
+
+trait CreatePoolTrait
+{
+    private $doctrineCache = null;
+
+    public function createCachePool()
+    {
+        return new DoctrineCachePool($this->getDoctrineCache());
+    }
+
+    private function getDoctrineCache()
+    {
+        if ($this->doctrineCache === null) {
+            $this->doctrineCache = new ArrayCache();
+        }
+
+        return $this->doctrineCache;
+    }
+}

tests/CreatePoolTrait.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of php-cache\doctrine-adapter package.
+ *
+ * (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Doctrine\Tests;
+
+use Cache\Adapter\Common\CacheItem;
+use Cache\Adapter\Doctrine\DoctrineCachePool;
+use Doctrine\Common\Cache\Cache;
+use Doctrine\Common\Cache\FlushableCache;
+use Mockery as m;
+use Mockery\MockInterface;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ * @author Aaron Scherer <[email protected]>
+ */
+class DoctrineAdapterTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @type DoctrineCachePool
+     */
+    private $pool;
+
+    /**
+     * @type MockInterface|CacheItem
+     */
+    private $mockItem;
+
+    /**
+     * @type MockInterface|Cache
+     */
+    private $mockDoctrine;
+
+    protected function setUp()
+    {
+        $this->mockItem     = m::mock(CacheItem::class);
+        $this->mockDoctrine = m::mock(Cache::class);
+
+        $this->pool = new DoctrineCachePool($this->mockDoctrine);
+    }
+
+    public function testConstructor()
+    {
+        $this->assertInstanceOf(DoctrineCachePool::class, $this->pool);
+        $this->assertInstanceOf(CacheItemPoolInterface::class, $this->pool);
+    }
+
+    public function testGetCache()
+    {
+        $this->assertInstanceOf(Cache::class, $this->pool->getCache());
+        $this->assertEquals($this->mockDoctrine, $this->pool->getCache());
+    }
+
+    public function testClear()
+    {
+        $this->assertFalse($this->pool->clear());
+
+        $cache = m::mock(Cache::class.','.FlushableCache::class);
+        $cache->shouldReceive('flushAll')->andReturn(true);
+
+        $newPool = new DoctrineCachePool($cache);
+        $this->assertTrue($newPool->clear());
+
+        $cache->shouldReceive('fetch');
+        $cache->shouldReceive('save');
+        $this->assertTrue($newPool->clear(['dummy_tag']));
+    }
+}