Merge pull request #6 from kodedphp/2

Start PHP 8 version

Author: kodeart

.scrutinizer.yml

@@ -7,7 +7,7 @@ build:
           - php-scrutinizer-run
       environment:
         php:
-          version: '7.3'
+          version: '8.0.1'
 
 before_commands:
   - 'composer update -o --prefer-source --no-interaction'

.travis.yml

@@ -1,6 +1,6 @@
 language: php
 os: linux
-dist: xenial
+dist: bionic
 
 notifications:
   email: false
@@ -10,9 +10,7 @@ cache:
     - $HOME/.composer/cache
 
 php:
-  - 7.2
-  - 7.3
-  - 7.4
+  - 8.0.1
   - nightly
 
 jobs:

CacheItem.php

@@ -4,70 +4,52 @@
 
 use Psr\Cache\CacheItemInterface;
 
-
 abstract class CacheItem implements CacheItemInterface
 {
-    /** @var bool */
-    protected $isHit = false;
-
-    /** @var string Expects a valid cache key name */
-    private $key;
-
-    /** @var mixed */
-    private $value;
-    
-    /** @var int Number of seconds for the expiration time */
-    private $expiresAt;
-
+    protected bool $isHit = false;
+    private string $key;
+    private mixed $value = null;
+    private ?int $expiresAt;
 
     public function __construct($key, ?int $ttl)
     {
         $this->key = $key;
         $this->expiresAt = $ttl;
     }
 
-
     public function getKey(): string
     {
         return $this->key;
     }
 
-
     public function get()
     {
         return $this->value;
     }
 
-
     public function isHit(): bool
     {
         return $this->isHit;
     }
 
-
     public function set($value)
     {
         $this->value = $value;
-
         return $this;
     }
 
-
-    public function expiresAfter($time)
+    public function expiresAfter($time): static
     {
         // The TTL is calculated in the cache client instance
         return $this->expiresAt($time);
     }
 
-
-    public function expiresAt($expiration)
+    public function expiresAt($expiration): static
     {
         $this->expiresAt = normalize_ttl($expiration ?? $this->expiresAt);
-
         if ($this->expiresAt < 1) {
             $this->isHit = false;
         }
-
         return $this;
     }
 

CacheItemPool.php

@@ -6,15 +6,12 @@
 use Psr\Cache\{CacheItemInterface, CacheItemPoolInterface};
 use function Koded\Stdlib\now;
 
-
 abstract class CacheItemPool implements CacheItemPoolInterface
 {
-    /** @var Cache */
-    protected $client;
+    protected Cache $client;
 
     /** @var CacheItemInterface[] */
-    private $deferred = [];
-
+    private array $deferred = [];
 
     abstract public function __construct(string $client, array $parameters);
 
@@ -32,34 +29,28 @@ public function commit(): bool
                 unset($this->deferred[$key]);
             }
         }
-
         return empty($this->deferred);
     }
 
-
     public function save(CacheItemInterface $item): bool
     {
         /** @var CacheItem $item */
         return $this->client->set($item->getKey(), $item->get(), $item->getExpiresAt());
     }
 
-
     public function getItems(array $keys = []): array
     {
         $items = [];
         foreach ($keys as $key) {
             $items[$key] = $this->getItem($key);
         }
-
         return $items;
     }
 
-
     public function getItem($key): CacheItemInterface
     {
         try {
             $item = new class($key, $this->client->getTtl()) extends CacheItem {};
-
             if (false === $this->client->has($key)) {
                 if (isset($this->deferred[$key])) {
                     return clone $this->deferred[$key];
@@ -79,7 +70,6 @@ public function getItem($key): CacheItemInterface
         }
     }
 
-
     public function hasItem($key): bool
     {
         try {
@@ -89,17 +79,14 @@ public function hasItem($key): bool
         }
     }
 
-
     public function clear(): bool
     {
         if ($cleared = $this->client->clear()) {
             $this->deferred = [];
         }
-
         return $cleared;
     }
 
-
     public function deleteItems(array $keys): bool
     {
         try {
@@ -109,22 +96,18 @@ public function deleteItems(array $keys): bool
         }
     }
 
-
     public function deleteItem($key): bool
     {
         try {
             if ($deleted = $this->client->delete($key)) {
                 unset($this->deferred[$key]);
             }
-
             return $deleted;
-
         } catch (Exception $e) {
             throw CachePoolException::from($e);
         }
     }
 
-
     public function saveDeferred(CacheItemInterface $item): bool
     {
         /** @var CacheItem $item */
@@ -139,4 +122,16 @@ public function saveDeferred(CacheItemInterface $item): bool
 
         return true;
     }
-}
+
+    /**
+     * Returns the instance of the underlying cache client.
+     *
+     * This method is not part of the PSR-6.
+     *
+     * @return Cache
+     */
+    public function client(): Cache
+    {
+        return $this->client;
+    }
+}

CachePool.php

@@ -22,25 +22,20 @@
  */
 final class CachePool
 {
-    /**
-     * @var CacheItemPoolInterface[] The registry
-     */
-    private static $instances = [];
+    /** @var CacheItemPoolInterface[] The registry */
+    private static array $instances = [];
 
     /**
      * @param string $client     The name of the cache client
      * @param array  $parameters [optional] Configuration parameters for the cache client
-     *
      * @return CacheItemPoolInterface
      */
     public static function use(string $client, array $parameters = []): CacheItemPoolInterface
     {
-        $ident = md5($client . serialize($parameters));
-
+        $ident = \md5($client . \serialize($parameters));
         if (isset(self::$instances[$ident])) {
             return self::$instances[$ident];
         }
-
         return self::$instances[$ident] = new class($client, $parameters) extends CacheItemPool
         {
             public function __construct(string $client, array $parameters)
@@ -57,8 +52,8 @@ public function __construct(string $client, array $parameters)
  */
 class CachePoolException extends Exception implements InvalidArgumentException
 {
-    public static function from(Exception $e)
+    public static function from(Exception $e): static
     {
-        return new self($e->getMessage(), $e->getCode());
+        return new static($e->getMessage(), $e->getCode());
     }
-}
+}

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2019, Mihail Binev
+Copyright (c) 2021, Mihail Binev
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -5,7 +5,7 @@ Koded - Extended Caching Library
 [![Build Status](https://travis-ci.org/kodedphp/cache-extended.svg?branch=master)](https://travis-ci.org/kodedphp/cache-extended)
 [![Code Coverage](https://scrutinizer-ci.com/g/kodedphp/cache-extended/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/kodedphp/cache-extended/?branch=master)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/kodedphp/cache-extended/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/kodedphp/cache-extended/?branch=master)
-[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.2-8892BF.svg)](https://php.net/)
+[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg)](https://php.net/)
 [![Software license](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
 
 A [PSR-6][psr-6] caching library for PHP 7 using several caching technologies.
@@ -15,7 +15,7 @@ Requirements
 ------------
 
 - Linux machine
-- PHP 7.1 or higher
+- PHP 8
 
 Recommended cache technologies are
 
@@ -59,7 +59,7 @@ Please see the README in that repository for the specific arguments.
 You can grab the cache client if you want to use it directly
 
 ```php
-/** $var Psr\SimpleCache\CacheInterface $client */
+/** $var Koded\Caching\Cache $client */
 $client = $cache->client();
 ```
 

Tests/CacheItemTest.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace Koded\Caching;
+namespace Tests\Koded\Caching;
 
+use Koded\Caching\CachePool;
 use PHPUnit\Framework\TestCase;
 
 class CacheItemTest extends TestCase
 {
-
     public function test_expiresAfter_with_global_ttl()
     {
         $pool = CachePool::use('memory', ['ttl' => 60]);

Tests/CachePoolFactoryTest.php

@@ -1,21 +1,27 @@
 <?php
 
-namespace Koded\Caching;
+namespace Tests\Koded\Caching;
 
-use Koded\Caching\Client\{FileClient, MemcachedClient, MemoryClient, PredisClient, RedisClient};
+use Koded\Caching\Client\{FileClient, MemcachedClient, MemoryClient, PredisClient, RedisClient, ShmopClient};
+use Koded\Caching\CachePool;
 use PHPUnit\Framework\TestCase;
 
 class CachePoolFactoryTest extends TestCase
 {
-
     public function test_MemcachedClient()
     {
+        if (false === \extension_loaded('memcached')) {
+            $this->markTestSkipped('memcached extension is not loaded');
+        }
         $pool = CachePool::use('memcached');
         $this->assertAttributeInstanceOf(MemcachedClient::class, 'client', $pool);
     }
 
     public function test_RedisClient()
     {
+        if (false === \extension_loaded('redis')) {
+            $this->markTestSkipped('redis extension is not loaded');
+        }
         $pool = CachePool::use('redis', [
             'host' => getenv('REDIS_SERVER_HOST'),
         ]);
@@ -24,12 +30,24 @@ public function test_RedisClient()
 
     public function test_PredisClient()
     {
+        if (false === \extension_loaded('redis')) {
+            $this->markTestSkipped('redis extension is not loaded');
+        }
         $pool = CachePool::use('predis', [
             'host' => getenv('REDIS_SERVER_HOST'),
         ]);
         $this->assertAttributeInstanceOf(PredisClient::class, 'client', $pool);
     }
 
+    public function test_ShmopClient()
+    {
+        if (false === \extension_loaded('shmop')) {
+            $this->markTestSkipped('shmop extension is not loaded');
+        }
+        $pool = CachePool::use('shmop');
+        $this->assertAttributeInstanceOf(ShmopClient::class, 'client', $pool);
+    }
+
     public function test_MemoryClient()
     {
         $pool1 = CachePool::use('memory');

Tests/Integration/CachePoolIntegrationTest.php

@@ -1,11 +1,16 @@
 <?php
 
-namespace Koded\Caching\Tests\Integration;
+namespace Tests\Koded\Caching\Integration;
 
 use Cache\IntegrationTests\CachePoolTest;
 
 abstract class CachePoolIntegrationTest extends CachePoolTest
 {
+    protected $skippedTests = [
+        'testGetItemInvalidKeys' => 'Does not make sense for typed arguments',
+        'testGetItemsInvalidKeys' => 'Does not make sense for typed arguments',
+        'testHasItemInvalidKeys' => 'Does not make sense for typed arguments',
+    ];
 
     public static function invalidKeys()
     {