Init

Author: Nyholm

.gitignore

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

.travis.yml

@@ -0,0 +1,25 @@
+language: php
+php:
+  - 7.0
+  - 5.6
+  - 5.5
+  - hhvm
+
+matrix:
+  fast_finish: true
+
+sudo: false
+
+before_install:
+    - if [[ $TRAVIS_PHP_VERSION != 'hhvm' ]]; then phpenv config-rm xdebug.ini; fi;
+    - pip install --user codecov
+
+before_script:
+    - travis_retry composer self-update
+    - travis_retry composer install --prefer-source --no-interaction
+
+script:
+    - php -dzend_extension=xdebug.so vendor/bin/phpunit --coverage-clover=coverage.xml
+
+after_success:
+    - codecov

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Aaron Scherer
+
+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.
+

composer.json

@@ -0,0 +1,43 @@
+{
+    "name":         "cache/session-handler",
+    "type":         "library",
+    "description":  "An implementation of PHP's SessionHandlerInterface that allows PSR-6",
+    "keywords": [
+        "cache",
+        "psr-6",
+        "session handler"
+    ],
+    "homepage": "https://github.com/php-cache/session-handler",
+    "license": "MIT",
+    "authors": [
+        {
+            "name":     "Aaron Scherer",
+            "email":    "[email protected]",
+            "homepage": "https://github.com/aequasi"
+        },
+        {
+            "name":     "Tobias Nyholm",
+            "email":    "[email protected]",
+            "homepage": "https://github.com/nyholm"
+        }
+    ],
+    "require": {
+        "php": "^5.5|^7.0",
+        "psr/cache": "~1.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.1|^4.0",
+        "mockery/mockery": "^0.9.4",
+        "cache/array-adapter": "@stable"
+    },
+    "autoload": {
+        "psr-4": {
+            "Cache\\SessionHandler\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Cache\\SessionHandler\\Tests\\": "tests/"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+  backupStaticAttributes="false"
+  colors="true"
+  convertErrorsToExceptions="true"
+  convertNoticesToExceptions="true"
+  convertWarningsToExceptions="true"
+  processIsolation="false"
+  stopOnFailure="false"
+  syntaxCheck="false"
+  bootstrap="vendor/autoload.php"
+  >
+  <testsuites>
+    <testsuite name="Main Test Suite">
+      <directory>./tests/</directory>
+    </testsuite>
+  </testsuites>
+
+  <logging>
+    <log type="coverage-text" target="php://stdout"/>
+  </logging>
+
+  <groups>
+    <exclude>
+      <group>benchmark</group>
+    </exclude>
+  </groups>
+
+  <filter>
+    <whitelist>
+      <directory>src/</directory>
+    </whitelist>
+  </filter>
+</phpunit>

src/Psr6SessionHandler.php

@@ -0,0 +1,125 @@
+<?php
+
+/*
+ * This file is part of php-cache\cache-bundle 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\SessionHandler;
+
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ * Class SessionHandler.
+ *
+ * @author Aaron Scherer <[email protected]>
+ */
+class Psr6SessionHandler implements \SessionHandlerInterface
+{
+    /**
+     * @type CacheItemPoolInterface Cache driver.
+     */
+    private $cache;
+
+    /**
+     * @type int Time to live in seconds
+     */
+    private $ttl;
+
+    /**
+     * @type string Key prefix for shared environments.
+     */
+    private $prefix;
+
+    /**
+     * Constructor.
+     *
+     * List of available options:
+     *  * prefix: The prefix to use for the cache keys in order to avoid collision
+     *  * expiretime: The time to live in seconds
+     *
+     * @param CacheItemPoolInterface $cache   A Cache instance
+     * @param array                  $options An associative array of cache options
+     *
+     * @throws \InvalidArgumentException When unsupported options are passed
+     */
+    public function __construct(CacheItemPoolInterface $cache, array $options = [])
+    {
+        $this->cache = $cache;
+
+        $this->ttl    = isset($options['ttl']) ? (int) $options['ttl'] : 86400;
+        $this->prefix = isset($options['prefix']) ? $options['prefix'] : 'psr6ses_';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function open($savePath, $sessionName)
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function close()
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($sessionId)
+    {
+        $item = $this->getCacheItem($sessionId);
+        if ($item->isHit()) {
+            return $item->get();
+        }
+
+        return '';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function write($sessionId, $data)
+    {
+        $item = $this->getCacheItem($sessionId);
+        $item->set($data)
+            ->expiresAfter($this->ttl);
+
+        return $this->cache->save($item);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function destroy($sessionId)
+    {
+        return $this->cache->deleteItem($this->prefix.$sessionId);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function gc($lifetime)
+    {
+        // not required here because cache will auto expire the records anyhow.
+        return true;
+    }
+
+    /**
+     * @param $sessionId
+     *
+     * @return \Psr\Cache\CacheItemInterface
+     */
+    private function getCacheItem($sessionId)
+    {
+        return $this->cache->getItem($this->prefix.$sessionId);
+    }
+}

tests/Psr6SessionHandlerTest.php

@@ -0,0 +1,83 @@
+<?php
+
+/*
+ * This file is part of php-cache\doctrine-bridge 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\SessionHandler\Tests;
+
+use Cache\SessionHandler\Psr6SessionHandler;
+use Mockery as m;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ * @author Aaron Scherer <[email protected]>
+ */
+class Psr6SessionHandlerTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @type Psr6SessionHandler
+     */
+    private $handler;
+
+    /**
+     * @type m\MockInterface|CacheItemPoolInterface
+     */
+    private $mock;
+
+    /**
+     * @type m\MockInterface|CacheItemInterface
+     */
+    private $itemMock;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->mock   = m::mock(CacheItemPoolInterface::class);
+        $this->handler = new Psr6SessionHandler($this->mock);
+
+        $this->itemMock = m::mock(CacheItemInterface::class);
+    }
+
+    public function testConstructor()
+    {
+        $this->assertInstanceOf(Psr6SessionHandler::class, $this->handler);
+    }
+
+    public function testOpen()
+    {
+        $this->assertTrue($this->handler->open('foo', 'bar'));
+    }
+
+    public function testClose()
+    {
+        $this->assertTrue($this->handler->close());
+    }
+
+    public function testGc()
+    {
+        $this->assertTrue($this->handler->gc(4711));
+    }
+
+    public function testRead()
+    {
+
+    }
+
+    public function testWrite()
+    {
+
+    }
+
+    public function testDestroy()
+    {
+
+    }
+}