Added PSR-6 to Illuminate adapter (#140)

* Added PSR-6 to Illuminate adapter

* Required illuminate/cache 5.4+

* Drop PHP 5.5 support

Author: florianv

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+This is a READ ONLY repository. 
+
+Please make your pull request to https://github.com/php-cache/cache
+
+Thank you for contributing. 

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+composer.lock

.travis.yml

@@ -0,0 +1,22 @@
+language: php
+sudo: false
+
+matrix:
+    include:
+      - php: 7.0
+
+cache:
+    directories:
+      - "$HOME/.composer/cache"
+
+install:
+    - composer update --prefer-dist --prefer-stable
+
+script:
+    - ./vendor/bin/phpunit --coverage-clover=coverage.xml
+
+after_success:
+    - pip install --user codecov && codecov
+
+notifications:
+    email: false

Changelog.md

@@ -0,0 +1,3 @@
+# Change Log
+
+The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.

IlluminateCachePool.php

@@ -0,0 +1,128 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 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\Illuminate;
+
+use Cache\Adapter\Common\AbstractCachePool;
+use Cache\Adapter\Common\PhpCacheItem;
+use Illuminate\Contracts\Cache\Store;
+
+/**
+ * This is a bridge between PSR-6 and an Illuminate cache store.
+ *
+ * @author Florian Voutzinos <[email protected]>
+ */
+class IlluminateCachePool extends AbstractCachePool
+{
+    /**
+     * @type Store
+     */
+    protected $store;
+
+    /**
+     * @param Store $store
+     */
+    public function __construct(Store $store)
+    {
+        $this->store = $store;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function storeItemInCache(PhpCacheItem $item, $ttl)
+    {
+        $ttl = null === $ttl ? 0 : $ttl / 60;
+
+        $data = serialize([true, $item->get(), $item->getTags(), $item->getExpirationTimestamp()]);
+
+        $this->store->put($item->getKey(), $data, $ttl);
+
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function fetchObjectFromCache($key)
+    {
+        if (null === $data = $this->store->get($key)) {
+            return [false, null, [], null];
+        }
+
+        return unserialize($data);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function clearAllObjectsFromCache()
+    {
+        return $this->store->flush();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function clearOneObjectFromCache($key)
+    {
+        return $this->store->forget($key);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getList($name)
+    {
+        $list = $this->store->get($name);
+
+        if (!is_array($list)) {
+            return [];
+        }
+
+        return $list;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function removeList($name)
+    {
+        return $this->store->forget($name);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function appendListItem($name, $key)
+    {
+        $list   = $this->getList($name);
+        $list[] = $key;
+
+        $this->store->forever($name, $list);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function removeListItem($name, $key)
+    {
+        $list = $this->getList($name);
+
+        foreach ($list as $i => $item) {
+            if ($item === $key) {
+                unset($list[$i]);
+            }
+        }
+
+        $this->store->forever($name, $list);
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Aaron Scherer, Tobias Nyholm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+# Illuminate PSR-6 Cache pool 
+[![Gitter](https://badges.gitter.im/php-cache/cache.svg)](https://gitter.im/php-cache/cache?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Latest Stable Version](https://poser.pugx.org/cache/illuminate-adapter/v/stable)](https://packagist.org/packages/cache/illuminate-adapter)
+[![codecov.io](https://codecov.io/github/php-cache/illuminate-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/illuminate-adapter?branch=master)
+[![Total Downloads](https://poser.pugx.org/cache/illuminate-adapter/downloads)](https://packagist.org/packages/cache/illuminate-adapter)
+[![Monthly Downloads](https://poser.pugx.org/cache/illuminate-adapter/d/monthly.png)](https://packagist.org/packages/cache/illuminate-adapter)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
+
+This is a PSR-6 cache implementation using Illuminate cache. 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). 
+
+This is a PSR-6 to Illuminate bridge.
+
+### Install
+
+```bash
+composer require cache/illuminate-adapter
+```
+
+## Use
+
+```php
+use Illuminate\Cache\ArrayStore;
+use Cache\Adapter\Illuminate\IlluminateCachePool;
+
+// Create an instance of an Illuminate's Store
+$store = new ArrayStore();
+
+// Wrap the Illuminate's store with the PSR-6 adapter
+$pool = new IlluminateCachePool($store);
+```
+
+
+### Contribute
+
+Contributions are very welcome! Send a pull request to the [main repository](https://github.com/php-cache/cache) or 
+report any issues you find on the [issue tracker](http://issues.php-cache.com).

Tests/CreatePoolTrait.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 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\Illuminate\Tests;
+
+use Cache\Adapter\Illuminate\IlluminateCachePool;
+use Illuminate\Cache\ArrayStore;
+
+trait CreatePoolTrait
+{
+    private $illuminateStore = null;
+
+    public function createCachePool()
+    {
+        return new IlluminateCachePool($this->getIlluminateStore());
+    }
+
+    private function getIlluminateStore()
+    {
+        if ($this->illuminateStore === null) {
+            $this->illuminateStore = new ArrayStore();
+        }
+
+        return $this->illuminateStore;
+    }
+
+    public function createSimpleCache()
+    {
+        return $this->createCachePool();
+    }
+}

Tests/IlluminateAdapterTest.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 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\Illuminate\Tests;
+
+use Cache\Adapter\Common\CacheItem;
+use Cache\Adapter\Illuminate\IlluminateCachePool;
+use Illuminate\Contracts\Cache\Store;
+use Mockery as m;
+use Mockery\MockInterface;
+use Psr\Cache\CacheItemPoolInterface;
+
+class IlluminateAdapterTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @type IlluminateCachePool
+     */
+    private $pool;
+
+    /**
+     * @type MockInterface|CacheItem
+     */
+    private $mockItem;
+
+    /**
+     * @type MockInterface|Store
+     */
+    private $mockStore;
+
+    protected function setUp()
+    {
+        $this->mockItem  = m::mock(CacheItem::class);
+        $this->mockStore = m::mock(Store::class);
+        $this->pool      = new IlluminateCachePool($this->mockStore);
+    }
+
+    public function testConstructor()
+    {
+        $this->assertInstanceOf(IlluminateCachePool::class, $this->pool);
+        $this->assertInstanceOf(CacheItemPoolInterface::class, $this->pool);
+    }
+}

Tests/IntegrationPoolTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 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\Illuminate\Tests;
+
+use Cache\IntegrationTests\CachePoolTest;
+
+class IntegrationPoolTest extends CachePoolTest
+{
+    use CreatePoolTrait;
+}