Merge pull request #1 from Micro-PHP/v1.0

v1.0 review
Micro-PHP · Dec 24, 2022 · f4a524e · f4a524e
2 parents 9728903 + aded395
commit f4a524e
Show file tree

Hide file tree

Showing 13 changed files with 378 additions and 36 deletions.
diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
     "description": "Micro Framework: Redis component",
     "type": "library",
     "license": "MIT",
-    "version": "0.1",
+    "version": "1.0",
     "autoload": {
         "psr-4": {
             "Micro\\Plugin\\Redis\\": "src/"
@@ -16,6 +16,6 @@
         }
     ],
     "require": {
-        "php": ">=8.0"
+        "micro/kernel": "^1"
     }
 }
diff --git a/src/Business/Redis/RedisBuilder.php b/src/Business/Redis/RedisBuilder.php
@@ -4,28 +4,30 @@
 
 use Micro\Plugin\Redis\Configuration\ClientOptionsConfigurationInterface;
 use Micro\Plugin\Redis\Configuration\RedisClientConfigurationInterface;
+use Micro\Plugin\Redis\Redis\RedisInterface;
 use Micro\Plugin\Redis\RedisPluginConfigurationInterface;
-use \Redis;
+use Redis;
 
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
 class RedisBuilder implements RedisBuilderInterface
 {
     /**
      * @param RedisPluginConfigurationInterface $pluginConfiguration
      * @param RedisFactoryInterface $redisFactory
      */
     public function __construct(
-    private RedisPluginConfigurationInterface $pluginConfiguration,
-    private RedisFactoryInterface $redisFactory
+        private readonly RedisPluginConfigurationInterface $pluginConfiguration,
+        private readonly RedisFactoryInterface $redisFactory
     )
     {
     }
 
     /**
-     * @param string $redisAlias
-     *
-     * @return Redis
+     * {@inheritDoc}
      */
-    public function create(string $redisAlias): Redis
+    public function create(string $redisAlias): RedisInterface
     {
         $clientConfiguration = $this->pluginConfiguration->getClientConfiguration($redisAlias);
         $redis               = $this->redisFactory->create();
@@ -36,11 +38,12 @@ public function create(string $redisAlias): Redis
     }
 
     /**
-     * @param Redis $redis
+     * @param RedisInterface $redis
      * @param RedisClientConfigurationInterface $configuration
+     *
      * @return void
      */
-    protected function initialize(Redis $redis, RedisClientConfigurationInterface $configuration): void
+    protected function initialize(RedisInterface $redis, RedisClientConfigurationInterface $configuration): void
     {
         $connectionMethod = $this->getConnectionMethod($configuration);
 
@@ -63,18 +66,20 @@ protected function initialize(Redis $redis, RedisClientConfigurationInterface $c
     }
 
     /**
-     * @param Redis $redis
+     * @param RedisInterface $redis
      * @param ClientOptionsConfigurationInterface $configuration
+     *
      * @return void
      */
-    protected function setOptions(Redis $redis, ClientOptionsConfigurationInterface $configuration): void
+    protected function setOptions(RedisInterface $redis, ClientOptionsConfigurationInterface $configuration): void
     {
         $redis->setOption(Redis::OPT_SERIALIZER, $this->getRedisOptionValue($configuration->serializer()));
         $redis->setOption(Redis::OPT_PREFIX, $configuration->prefix());
     }
 
     /**
      * @param string $redisOption
+     *
      * @return int
      */
     protected function getRedisOptionValue(string $redisOption): int
@@ -84,6 +89,7 @@ protected function getRedisOptionValue(string $redisOption): int
 
     /**
      * @param RedisClientConfigurationInterface $configuration
+     *
      * @return string
      */
     protected function getConnectionMethod(RedisClientConfigurationInterface $configuration): string
@@ -93,6 +99,7 @@ protected function getConnectionMethod(RedisClientConfigurationInterface $config
 
     /**
      * @param RedisClientConfigurationInterface $configuration
+     *
      * @return string|null
      */
     protected function getPersistentId(RedisClientConfigurationInterface $configuration): ?string

diff --git a/src/Business/Redis/RedisBuilderFactory.php b/src/Business/Redis/RedisBuilderFactory.php
@@ -11,8 +11,8 @@ class RedisBuilderFactory implements RedisBuilderFactoryInterface
      * @param RedisFactoryInterface $redisFactory
      */
     public function __construct(
-    private RedisPluginConfigurationInterface $configuration,
-    private RedisFactoryInterface $redisFactory
+        private readonly RedisPluginConfigurationInterface $configuration,
+        private readonly RedisFactoryInterface $redisFactory
     )
     {
     }

diff --git a/src/Business/Redis/RedisBuilderInterface.php b/src/Business/Redis/RedisBuilderInterface.php
@@ -2,11 +2,13 @@
 
 namespace Micro\Plugin\Redis\Business\Redis;
 
+use Micro\Plugin\Redis\Redis\RedisInterface;
+
 interface RedisBuilderInterface
 {
     /**
      * @param string $redisAlias
-     * @return \Redis
+     * @return RedisInterface
      */
-    public function create(string $redisAlias): \Redis;
+    public function create(string $redisAlias): RedisInterface;
 }
diff --git a/src/Business/Redis/RedisFactory.php b/src/Business/Redis/RedisFactory.php
@@ -2,13 +2,19 @@
 
 namespace Micro\Plugin\Redis\Business\Redis;
 
+
+use Micro\Plugin\Redis\Redis\Decorator\BaseRedisDecorator;
+use Micro\Plugin\Redis\Redis\RedisInterface;
+
 class RedisFactory implements RedisFactoryInterface
 {
     /**
-     * @return \Redis
+     * {@inheritDoc}
      */
-    public function create(): \Redis
+    public function create(): RedisInterface
     {
-        return new \Redis();
+        $redis = new \Redis();
+
+        return new BaseRedisDecorator($redis);
     }
 }
diff --git a/src/Business/Redis/RedisFactoryInterface.php b/src/Business/Redis/RedisFactoryInterface.php
@@ -2,10 +2,12 @@
 
 namespace Micro\Plugin\Redis\Business\Redis;
 
+use Micro\Plugin\Redis\Redis\RedisInterface;
+
 interface RedisFactoryInterface
 {
     /**
-     * @return \Redis
+     * @return RedisInterface
      */
-    public function create(): \Redis;
+    public function create(): RedisInterface;
 }
diff --git a/src/Business/Redis/RedisManager.php b/src/Business/Redis/RedisManager.php
@@ -2,28 +2,27 @@
 
 namespace Micro\Plugin\Redis\Business\Redis;
 
-use \Redis;
+use Micro\Plugin\Redis\Redis\RedisInterface;
 
 class RedisManager implements RedisManagerInterface
 {
-
     /**
-     * @var array<string, Redis>
+     * @var array<string, RedisInterface>
      */
     private array $redisCollection;
 
     /**
      * @param RedisBuilderFactoryInterface $redisBuilderFactory
      */
-    public function __construct(private RedisBuilderFactoryInterface $redisBuilderFactory)
+    public function __construct(private readonly RedisBuilderFactoryInterface $redisBuilderFactory)
     {
         $this->redisCollection = [];
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getClient(string $clientName): Redis
+    public function getClient(string $clientName): RedisInterface
     {
         if(!array_key_exists($clientName, $this->redisCollection)) {
             $this->redisCollection[$clientName] = $this->redisBuilderFactory

diff --git a/src/Business/Redis/RedisManagerInterface.php b/src/Business/Redis/RedisManagerInterface.php
@@ -2,11 +2,14 @@
 
 namespace Micro\Plugin\Redis\Business\Redis;
 
+use Micro\Plugin\Redis\Redis\RedisInterface;
+
 interface RedisManagerInterface
 {
     /**
      * @param string $clientName
-     * @return \Redis
+     *
+     * @return RedisInterface
      */
-    public function getClient(string $clientName): \Redis;
+    public function getClient(string $clientName): RedisInterface;
 }
diff --git a/src/Redis/Decorator/BaseRedisDecorator.php b/src/Redis/Decorator/BaseRedisDecorator.php
@@ -0,0 +1,170 @@
+<?php
+
+namespace Micro\Plugin\Redis\Redis\Decorator;
+
+
+use Micro\Plugin\Redis\Redis\RedisInterface;
+
+class BaseRedisDecorator implements RedisInterface
+{
+    /**
+     * @param RedisInterface $redis
+     */
+    public function __construct(private readonly \Redis $redis)
+    {
+    }
+
+    /**
+     * @param string $host          can be a host, or the path to a unix domain socket
+     * @param int $port          optional
+     * @param float $timeout       value in seconds (optional, default is 0 meaning unlimited)
+     * @param string|null $persistentId  identity for the requested persistent connection
+     * @param int $retryInterval retry interval in milliseconds.
+     * @param float $readTimeout   value in seconds (optional, default is 0 meaning unlimited)
+     *
+     * @return bool
+     */
+    public function connect(string $host,
+                            int    $port = 6379,
+                            float  $timeout = 0.0,
+                            string $persistentId = null,
+                            int    $retryInterval = 0,
+                            float  $readTimeout = 0.0): bool
+    {
+        return $this->redis->connect(
+            $host,
+            $port,
+            $timeout,
+            $persistentId,
+            $retryInterval,
+            $readTimeout,
+        );
+    }
+
+    /**
+     * @param string $host          can be a host, or the path to a unix domain socket
+     * @param int $port          optional
+     * @param float $timeout       value in seconds (optional, default is 0 meaning unlimited)
+     * @param string|null $persistentId  identity for the requested persistent connection
+     * @param int $retryInterval retry interval in milliseconds.
+     * @param float $readTimeout   value in seconds (optional, default is 0 meaning unlimited)
+     *
+     * @return bool
+     */
+    public function pconnect(string $host,
+                             int    $port = 6379,
+                             float  $timeout = 0.0,
+                             string $persistentId = null,
+                             int    $retryInterval = 0,
+                             float  $readTimeout = 0.0): bool
+    {
+        return $this->redis->pconnect(
+            $host,
+            $port,
+            $timeout,
+            $persistentId,
+            $retryInterval,
+            $readTimeout
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function subscribe(array $channels, array|string|callable $callback): mixed
+    {
+        return $this->redis->subscribe($channels, $callback);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function unsubscribe(array $channels): mixed
+    {
+        return $this->prepareReturnResult($this->redis->rawCommand('UNSUBSCRIBE', ''));
+        //return $this->redis->unsubscribe($channels);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function publish(string $channel, string $message): int|RedisInterface
+    {
+        return $this->prepareReturnResult($this->redis->publish($channel, $message));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function pubsub(string $keyword, array|string $argument): array|int|RedisInterface
+    {
+        return $this->prepareReturnResult($this->redis->pubsub($keyword, $argument));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function setex(string $key, int $expire, mixed $value): bool|RedisInterface
+    {
+        return $this->prepareReturnResult($this->redis->setex($key, $expire, $value));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function setOption(int $option, mixed $value): bool
+    {
+        return $this->redis->setOption($option, $value);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function set(string $key, mixed $data, int $timeout = null): bool|self
+    {
+        return $this->prepareReturnResult($this->redis->set($key, $data, $timeout));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function del($key1, ...$otherKeys): int|self
+    {
+        return $this->prepareReturnResult($this->redis->del($key1, ...$otherKeys));
+    }
+
+    /**
+     * @param mixed $result
+     * @return mixed
+     */
+    protected function prepareReturnResult(mixed $result): mixed
+    {
+        if(!$result) {
+           return $result;
+        }
+
+        if($result instanceof \Redis) {
+            return $this;
+        }
+
+        return $result;
+    }
+
+    /**
+     * @param string $name
+     * @param array $arguments
+     *
+     * @return mixed
+     */
+    public function __call(string $name, array $arguments): mixed
+    {
+        if(!method_exists($this->redis, $name)) {
+            throw new \BadMethodCallException(sprintf(
+                'Method "%s" is not exists in the "%s"',
+                $name, get_class($this->redis)
+            ));
+         }
+
+        return $this->prepareReturnResult($this->redis->{$name}(...$arguments));
+    }
+}