v0.1.0

Author: vvval

.coveralls.yml

@@ -0,0 +1,3 @@
+coverage_clover: clover.xml
+json_path: upload.json
+service_name: travis-ci

.gitignore

@@ -0,0 +1,3 @@
+.idea
+composer.phar
+vendor/

.scrutinizer.yml

@@ -0,0 +1,10 @@
+build:
+  environment:
+    php: "7.0.8"
+
+  tests:
+      before:
+          - "phpunit"
+
+before_commands:
+    - "composer install --no-interaction --prefer-source"

.travis.yml

@@ -0,0 +1,17 @@
+language: php
+
+php:
+  - '7.0'
+  - '7.1'
+
+before_install:
+- composer require satooshi/php-coveralls:dev-master
+- composer install --dev
+
+install:
+  - composer install --no-interaction --prefer-source
+
+after_script:
+  - php vendor/bin/coveralls -v
+
+script: phpunit --coverage-clover clover.xml

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Spiral Framework Modules
+
+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,35 @@
+# phpfastcache
+Spiral cache bridges module.
+
+Spiral utilizes PSR-16 (ORM) and PSR-6 (psr7-middlewares) protocols to allow your application to communicate with cache engines.
+
+You are able to choose any caching library which support this mechanisms. To enable cache support in application create PSR interface binding to your implementation or factory:
+
+```php
+use Psr\SimpleCache\CacheInterface;
+
+class CacheBootloader extends Bootloader {
+    const SINGLETONS = [
+        CacheInterface::class => [self::class, 'makeCache']
+    ];
+
+    protected function makeCache(): CacheItemPoolInterface
+    {
+        return new MyCache();
+    }
+}
+```
+
+## Installation
+```
+composer require spiral/phpfastcache
+spiral register spiral/phpfastcache
+```
+
+## Existed Bridges
+Take a look at existed module `spiral/phpfastcache` which creates bridge to [https://github.com/PHPSocialNetwork/phpfastcache](https://github.com/PHPSocialNetwork/phpfastcache) library and adds cache configuration into your application.
+
+`composer require spiral/phpfastcache`
+`spiral register spiral/phpfastcache`
+
+Add bootloader `Spiral/PhpFastCache/CacheBootloader` to enable caching.

composer.json

@@ -0,0 +1,30 @@
+{
+  "name": "spiral/fastcache",
+  "description": "Spiral simple cache adapter and phpFastCache bootloaders.",
+  "authors": [
+    {
+      "name": "Valentin V / vvval",
+      "email": "vintsukevich@gmail.com"
+    }
+  ],
+  "require": {
+    "php": ">=7.0",
+    "spiral/framework": "^1.0",
+    "phpFastCache/phpFastCache": "^5.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "~6.0",
+    "mockery/mockery": "dev-master"
+  },
+  "autoload": {
+    "psr-4": {
+      "Spiral\\": "source/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Spiral\\Tests\\": "tests/",
+      "TestApplication\\": "tests/-app-/classes/"
+    }
+  }
+}

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="tests/bootstrap.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         stopOnError="false"
+         syntaxCheck="true">
+
+    <testsuites>
+        <testsuite name="Spiral Statistics module">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>source/Statistics/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

source/PhpFastCache/CacheBootloader.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Spiral\PhpFastCache;
+
+use phpFastCache\CacheManager;
+use Psr\Cache\CacheItemPoolInterface;
+use Psr\SimpleCache\CacheInterface;
+use Spiral\Core\Bootloaders\Bootloader;
+
+class CacheBootloader extends Bootloader
+{
+    const BINDINGS = [
+        'cache'               => CacheInterface::class,
+        CacheInterface::class => SimpleCacheAdapter::class
+    ];
+
+    const SINGLETONS = [
+        CacheItemPoolInterface::class => [self::class, 'makeCache']
+    ];
+
+    protected function makeCache(Config $config): CacheItemPoolInterface
+    {
+        return CacheManager::getInstance($config->getAdapter(), $config->getAdapterOptions());
+    }
+}

source/PhpFastCache/Config.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Spiral\PhpFastCache;
+
+use Spiral\Core\InjectableConfig;
+
+class Config extends InjectableConfig
+{
+    const CONFIG = 'modules/spiralPhpFastCache';
+
+    /** @var array */
+    protected $config = [
+        'adapter'  => '',
+        'adapters' => []
+    ];
+
+    /**
+     * @return string
+     */
+    public function getAdapter(): string
+    {
+        return $this->config['adapter'];
+    }
+
+    /**
+     * @return array
+     */
+    public function getAdapterOptions(): array
+    {
+        return $this->config['adapters'][$this->getAdapter()];
+    }
+}

source/PhpFastCache/Exceptions/SpiralFastCacheException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Spiral\PhpFastCache\Exceptions;
+
+class SpiralFastCacheException extends \Exception
+{
+
+}

source/PhpFastCache/SimpleCacheAdapter.php

@@ -0,0 +1,142 @@
+<?php
+
+namespace Spiral\PhpFastCache;
+
+use phpFastCache\Cache\ExtendedCacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use Psr\SimpleCache\CacheInterface;
+use Spiral\PhpFastCache\Exceptions\SpiralFastCacheException;
+
+class SimpleCacheAdapter implements CacheInterface
+{
+    /**
+     * @var CacheItemPoolInterface
+     */
+    protected $pool;
+
+    /**
+     * PSR16Adapter constructor.
+     *
+     * @param CacheItemPoolInterface $pool
+     */
+    public function __construct(CacheItemPoolInterface $pool)
+    {
+        $this->pool = $pool;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get($key, $default = null)
+    {
+        try {
+            $value = $this->pool->getItem($key)->get();
+            if ($value !== null) {
+                return $value;
+            } else {
+                return $default;
+            }
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function set($key, $value, $ttl = null)
+    {
+        try {
+            $item = $this->pool
+                ->getItem($key)
+                ->set($value);
+            if (is_int($ttl) || $ttl instanceof \DateInterval) {
+                $item->expiresAfter($ttl);
+            }
+
+            return $this->pool->save($item);
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete($key)
+    {
+        try {
+            return $this->pool->deleteItem($key);
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clear()
+    {
+        try {
+            return $this->pool->clear();
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getMultiple($keys, $default = null)
+    {
+        try {
+            return array_map(function (ExtendedCacheItemInterface $item) {
+                return $item->get();
+            }, $this->pool->getItems($keys));
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setMultiple($values, $ttl = null)
+    {
+        try {
+            foreach ($values as $key => $value) {
+                $item = $this->pool->getItem($key)->set($value);
+                $this->pool->saveDeferred($item);
+                unset($item);
+            }
+
+            return $this->pool->commit();
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function deleteMultiple($keys)
+    {
+        try {
+            return $this->pool->deleteItems($keys);
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function has($key)
+    {
+        try {
+            return $this->pool->getItem($key)->isHit();
+        } catch (\Throwable $e) {
+            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
+        }
+    }
+}