Small updates, CS cleaning (#11)

- FileClient creates now 1-level subdirectories (down from 2) - improves the error handling in Redis/Json clients - uses psr-4 for autoloading - upgraded phpunit version - updates some unit tests - CS cleanup
kodedphp · Sep 23, 2018 · 0272fa8 · 0272fa8
1 parent e7a52f1
commit 0272fa8
Show file tree

Hide file tree

Showing 18 changed files with 62 additions and 34 deletions.
diff --git a/Cache.php b/Cache.php
@@ -13,7 +13,7 @@
 namespace Koded\Caching;
 
 use Koded\Stdlib\Interfaces\StringSerializable;
-use Psr\SimpleCache\{ CacheInterface, InvalidArgumentException };
+use Psr\SimpleCache\{CacheInterface, InvalidArgumentException};
 
 interface Cache
 {

diff --git a/CacheException.php b/CacheException.php
@@ -36,7 +36,7 @@ public static function forUnsupportedLogger(string $supported, string $given)
     {
         return new self(Cache::E_UNSUPPORTED_LOGGER, [':supported' => $supported, ':given' => $given]);
     }
-    
+
     public static function forCreatingDirectory(string $directory)
     {
         return new static(Cache::E_DIRECTORY_NOT_CREATED, [':dir' => $directory]);

diff --git a/Client/FileClient.php b/Client/FileClient.php
@@ -50,7 +50,7 @@ public function get($key, $default = null)
     {
         $filename = $this->filename($key, false);
 
-        if (!is_file($filename)) {
+        if (false === is_file($filename)) {
             return $default;
         }
 
@@ -100,8 +100,8 @@ public function clear()
             $this->logger->error($e->getMessage());
 
             return false;
+            // @codeCoverageIgnoreEnd
         }
-        // @codeCoverageIgnoreEnd
     }
 
     public function deleteMultiple($keys)
@@ -133,7 +133,7 @@ private function initialize(string $directory)
         $dir = $directory ?: sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'cache';
         $dir = rtrim($dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 
-        if (!is_dir($dir) && false === mkdir($dir, 0775, true)) {
+        if (false === is_dir($dir) && false === mkdir($dir, 0775, true)) {
             $e = FileCacheClientException::forCreatingDirectory($dir);
             $this->logger->error($e->getMessage());
             throw $e;
@@ -153,13 +153,13 @@ private function initialize(string $directory)
     private function filename(string $key, bool $create = true): string
     {
         $filename = sha1($key);
-        $dir = $this->dir . substr($filename, 0, 2);
+        $dir = $this->dir . substr($filename, 0, 1);
 
-        if ($create && !is_dir($dir)) {
-            mkdir($dir, 0775, true);
+        if ($create && false === is_dir($dir)) {
+            mkdir($dir, 0775, true) || $this->logger->error('Failed to create cache directory: {dir}', ['dir' => $dir]);
         }
 
-        $filename = $dir . DIRECTORY_SEPARATOR . substr($filename, 2) . '.php';
+        $filename = $dir . DIRECTORY_SEPARATOR . substr($filename, 1) . '.php';
 
         if ($create && !is_file($filename)) {
             touch($filename);

diff --git a/Client/PredisClient.php b/Client/PredisClient.php
@@ -13,7 +13,7 @@
 namespace Koded\Caching\Client;
 
 use Exception;
-use Koded\Caching\{ CacheException, CacheSerializer };
+use Koded\Caching\{CacheException, CacheSerializer};
 use Koded\Caching\Configuration\PredisConfiguration;
 use Koded\Caching\Serializer\PhpSerializer;
 use Predis\Client;

diff --git a/Client/RedisClient.php b/Client/RedisClient.php
@@ -15,8 +15,10 @@
 use Exception;
 use Koded\Caching\CacheException;
 use Koded\Caching\Configuration\RedisConfiguration;
+use function Koded\Stdlib\dump;
 use Psr\SimpleCache\CacheInterface;
 use Redis;
+use RedisException;
 
 /**
  * Class RedisClient uses the Redis PHP extension.
@@ -35,7 +37,9 @@ public function __construct(Redis $client, RedisConfiguration $config)
         try {
             // Because connect() does not throw exception, but E_WARNING
             if (false === @$this->client->connect(...$config->getConnectionParams())) {
+                // @codeCoverageIgnoreStart
                 throw CacheException::withConnectionErrorFor('Redis');
+                // @codeCoverageIgnoreEnd
             }
 
             $this->client->setOption(Redis::OPT_SERIALIZER, $config->getSerializerType());
@@ -45,6 +49,10 @@ public function __construct(Redis $client, RedisConfiguration $config)
             if ($auth = $config->get('auth')) {
                 $this->client->auth($auth);
             }
+
+        } catch (RedisException $e) {
+            error_log($e->getMessage());
+            throw CacheException::withConnectionErrorFor('Redis');
         } catch (CacheException $e) {
             throw $e;
         } catch (Exception $e) {

diff --git a/Client/RedisJsonClient.php b/Client/RedisJsonClient.php
@@ -18,6 +18,7 @@
 use Koded\Caching\Serializer\{ JsonSerializer, PhpSerializer };
 use Psr\SimpleCache\CacheInterface;
 use Redis;
+use RedisException;
 
 /**
  * Class RedisJsonClient uses the Redis PHP extension to save the cache item as JSON.
@@ -62,7 +63,9 @@ public function __construct(
         try {
             // Because connect() does not throw exception, but E_WARNING
             if (false === @$this->client->connect(...$config->getConnectionParams())) {
+                // @codeCoverageIgnoreStart
                 throw CacheException::withConnectionErrorFor('Redis');
+                // @codeCoverageIgnoreEnd
             }
 
             $this->client->setOption(Redis::OPT_SERIALIZER, $config->getSerializerType());
@@ -72,8 +75,14 @@ public function __construct(
             if ($auth = $config->get('auth')) {
                 $this->client->auth($auth);
             }
+
+        } catch (RedisException $e) {
+            error_log($e->getMessage());
+            throw CacheException::withConnectionErrorFor('Redis');
         } catch (CacheException $e) {
+            // @codeCoverageIgnoreStart
             throw $e;
+            // @codeCoverageIgnoreEnd
         } catch (Exception $e) {
             throw CacheException::generic($e->getMessage(), $e);
         }

diff --git a/ClientFactory.php b/ClientFactory.php
@@ -12,10 +12,16 @@
 
 namespace Koded\Caching;
 
-use Koded\Caching\Client\{ FileClient, MemcachedClient, MemoryClient, NullClient, PredisClient, RedisClient, RedisJsonClient };
-use Koded\Caching\Serializer\{ JsonSerializer, PhpSerializer };
+use Koded\Caching\Client\{FileClient,
+    MemcachedClient,
+    MemoryClient,
+    NullClient,
+    PredisClient,
+    RedisClient,
+    RedisJsonClient};
+use Koded\Caching\Serializer\{JsonSerializer, PhpSerializer};
 use Koded\Stdlib\Interfaces\ConfigurationFactory;
-use Psr\Log\{ LoggerInterface, NullLogger };
+use Psr\Log\{LoggerInterface, NullLogger};
 use Psr\SimpleCache\CacheInterface;
 
 class ClientFactory

diff --git a/Configuration/ConfigFactory.php b/Configuration/ConfigFactory.php
@@ -12,12 +12,13 @@
 
 namespace Koded\Caching\Configuration;
 
-use Koded\Stdlib\{ Arguments, Config, Interfaces\Configuration };
+use Koded\Stdlib\{Arguments, Config};
+use Koded\Stdlib\Interfaces\Configuration;
 
 /**
  * Class ConfigFactory
  *
- * @property int $ttl Default Time-To-Live seconds for the cached items
+ * @property int    $ttl      Default Time-To-Live seconds for the cached items
  * @property string $keyRegex Regex for validating the cache item key
  *
  */

diff --git a/Configuration/PredisConfiguration.php b/Configuration/PredisConfiguration.php
@@ -15,7 +15,7 @@
 use Koded\Stdlib\Immutable;
 use Koded\Stdlib\Interfaces\Configuration;
 
-final class PredisConfiguration  extends Immutable implements Configuration
+final class PredisConfiguration extends Immutable implements Configuration
 {
 
     public function getConnectionParams(): array

diff --git a/Configuration/RedisConfiguration.php b/Configuration/RedisConfiguration.php
@@ -12,7 +12,7 @@
 
 namespace Koded\Caching\Configuration;
 
-use Koded\Caching\{ Cache, CacheException };
+use Koded\Caching\{Cache, CacheException};
 use Koded\Stdlib\Immutable;
 use Koded\Stdlib\Interfaces\Configuration;
 use Redis;

diff --git a/Serializer/JsonSerializer.php b/Serializer/JsonSerializer.php
@@ -2,7 +2,7 @@
 
 namespace Koded\Caching\Serializer;
 
-use Koded\Caching\{ CacheException, CacheSerializer };
+use Koded\Caching\{CacheException, CacheSerializer};
 
 final class JsonSerializer implements CacheSerializer
 {

diff --git a/Tests/Client/FileClientTest.php b/Tests/Client/FileClientTest.php
@@ -33,7 +33,7 @@ public function test_cache_content()
         $client = new FileClient(new FileConfiguration(['dir' => $this->dir->url()]), new NullLogger);
         $client->set('foo', new Arguments(['foo' => 'bar']));
 
-        $raw = $this->dir->getChild('0b/eec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33.php')->getContent();
+        $raw = $this->dir->getChild('0/beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33.php')->getContent();
         $this->assertContains(var_export([
             'timestamp' => 32503593600,
             'key' => 'foo',

diff --git a/Tests/InvalidSerializerTest.php b/Tests/InvalidSerializerTest.php
@@ -24,4 +24,11 @@ public function test_should_fail_on_invalid_serializer_in_configuration()
             'host' => getenv('REDIS_SERVER_HOST'),
         ])))->build());
     }
+
+    protected function setUp()
+    {
+        if (false === extension_loaded('redis')) {
+            $this->markTestSkipped('Redis extension is not loaded.');
+        }
+    }
 }
diff --git a/Tests/RedisJsonConnectionTest.php b/Tests/RedisJsonConnectionTest.php
@@ -16,13 +16,16 @@ public function test_should_throw_exception_on_connection_error()
 
         putenv('CACHE_CLIENT=redis');
 
-        if (false === extension_loaded('redis')) {
-            $this->markTestSkipped('Redis extension is not loaded.');
-        }
-
         new SimpleCache((new ClientFactory(new ConfigFactory([
             'host' => 'invalid-redis-host',
             'serializer' => Cache::SERIALIZER_JSON
         ])))->build());
     }
+
+    protected function setUp()
+    {
+        if (false === extension_loaded('redis')) {
+            $this->markTestSkipped('Redis extension is not loaded.');
+        }
+    }
 }
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.9.0
+1.9.1
diff --git a/composer.json b/composer.json
@@ -25,7 +25,7 @@
     "psr/simple-cache": "~1"
   },
   "autoload": {
-    "psr-0": {
+    "psr-4": {
       "Koded\\Caching\\": ""
     },
     "files": [
@@ -36,14 +36,9 @@
     ]
   },
   "require-dev": {
-    "phpunit/phpunit": "~6",
+    "phpunit/phpunit": "~7",
     "mikey179/vfsStream": "~1",
     "satooshi/php-coveralls": "~1",
     "predis/predis": "dev-master"
-  },
-  "extra": {
-    "branch-alias": {
-      "dev-master": "1.x-dev"
-    }
   }
 }
diff --git a/functions.php b/functions.php
@@ -44,7 +44,7 @@ function simple_cache_factory(string $client = '', array $arguments = []): Simpl
  * Differs from PSR-16 "reserved" characters by adding the ":" to the list.
  * The colon is a wide accepted convention for Redis to separate the key.
  *
- * @param string $key   The cache key
+ * @param string $key The cache key
  *
  * @throws CacheException
  */

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,8 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.0/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.4/phpunit.xsd"
          bootstrap="Tests/autoload.php"
-         stopOnFailure="true"
          verbose="true"
          colors="true">
     <testsuites>