Adds MemoryClient

Author: kodeart

Client/MemoryClient.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the Koded package.
+ *
+ * (c) Mihail Binev <mihail@kodeart.com>
+ *
+ * Please view the LICENSE distributed with this source code
+ * for the full copyright and license information.
+ *
+ */
+
+namespace Koded\Caching\Client;
+
+use Psr\SimpleCache\CacheInterface;
+
+final class MemoryClient implements CacheInterface
+{
+
+    use ClientTrait, MultiplesTrait;
+
+    private $storage = [];
+    private $expiration = [];
+
+    public function get($key, $default = null)
+    {
+        if (isset($this->expiration[$key]) && $this->expiration[$key] < time()) {
+            $this->delete($key);
+
+            return $default;
+        }
+
+        return $this->storage[$key] ?? $default;
+    }
+
+    public function set($key, $value, $ttl = null)
+    {
+        if ($ttl < 0 || $ttl === 0) {
+            return $this->delete($key);
+        }
+
+        if ($ttl > 0) {
+            $this->expiration[$key] = time() + $ttl;
+        }
+
+        $this->storage[$key] = $value;
+
+        return true;
+    }
+
+    public function delete($key)
+    {
+        unset($this->storage[$key], $this->expiration[$key]);
+
+        return false === array_key_exists($key, $this->storage);
+    }
+
+    public function clear()
+    {
+        $this->storage = [];
+        $this->expiration = [];
+
+        return true;
+    }
+
+    public function deleteMultiple($keys)
+    {
+        $deleted = 0;
+        foreach ($keys as $key) {
+            $this->delete($key) && ++$deleted;
+        }
+
+        return count($keys) === $deleted;
+    }
+
+    public function has($key)
+    {
+        return array_key_exists($key, $this->storage);
+    }
+}

ClientFactory.php

@@ -12,7 +12,7 @@
 
 namespace Koded\Caching;
 
-use Koded\Caching\Client\{ FileClient, MemcachedClient, NullClient, PredisClient, RedisClient, RedisJsonClient };
+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 };
@@ -78,6 +78,10 @@ public function build(string $client = ''): CacheInterface
             return new FileClient($config, $this->getLogger($config));
         }
 
+        if ('memory' === $client) {
+            return new MemoryClient;
+        }
+
         return new NullClient;
     }
 

Configuration/MemoryConfiguration.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Koded package.
+ *
+ * (c) Mihail Binev <mihail@kodeart.com>
+ *
+ * Please view the LICENSE distributed with this source code
+ * for the full copyright and license information.
+ *
+ */
+
+namespace Koded\Caching\Configuration;
+
+use Koded\Stdlib\Immutable;
+use Koded\Stdlib\Interfaces\Configuration;
+
+final class MemoryConfiguration extends Immutable implements Configuration
+{
+}

README.md

@@ -252,6 +252,14 @@ function [sys_get_temp_dir()][8] is used to determine where to store the cached
 $cache = simple_cache_factory('file', ['dir' => '/tmp']);
 ```
 
+### MemoryClient
+
+This client will store the cached items in the memory for the duration of the script's lifetime.
+It is useful for development, but not for production.
+
+```php
+$cache = simple_cache_factory('memory');
+```
 
 License
 -------

Tests/Client/MemoryClientTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Koded\Caching\Client;
+
+use Koded\Caching\ClientFactory;
+use Koded\Caching\Configuration\ConfigFactory;
+use Koded\Caching\SimpleCache;
+use Koded\Caching\SimpleCacheTestCaseTrait;
+use PHPUnit\Framework\TestCase;
+
+class MemoryClientTest extends TestCase
+{
+
+    use SimpleCacheTestCaseTrait;
+
+    protected function setUp()
+    {
+        putenv('CACHE_CLIENT=memory');
+
+        $this->cache = new SimpleCache((new ClientFactory(new ConfigFactory))->build());
+    }
+}

Tests/ClientFactoryTest.php

@@ -2,9 +2,7 @@
 
 namespace Koded\Caching;
 
-use Koded\Caching\Client\{
-    FileClient, MemcachedClient, NullClient, PredisClient, RedisClient
-};
+use Koded\Caching\Client\{ FileClient, MemcachedClient, MemoryClient, NullClient, PredisClient, RedisClient };
 use Koded\Caching\Configuration\ConfigFactory;
 use PHPUnit\Framework\TestCase;
 
@@ -56,14 +54,21 @@ public function test_should_create_file_client()
         $this->assertInstanceOf(FileClient::class, $client);
     }
 
+    public function test_should_create_memory_client()
+    {
+        $client = (new ClientFactory(new ConfigFactory))->build('memory');
+        $this->assertInstanceOf(MemoryClient::class, $client);
+    }
+
 
     public function test_non_supported_logger_exception()
     {
         $this->expectException(CacheException::class);
         $this->expectExceptionMessage('The cache logger should be NULL or an instance of Psr\Log\LoggerInterface, Closure given');
 
         (new ClientFactory(new ConfigFactory([
-            'logger' => function() {}
+            'logger' => function() {
+            }
         ])))->build('file');
     }
 }

VERSION

@@ -1 +1 @@
-1.8.0
+1.9.0