Remove hard dependency on Predis + allow other Redis lib

Author: MacFJA

.unused.dist.php

@@ -28,6 +28,7 @@
         'enlightn/security-checker', // QA tool
         'php-parallel-lint/php-parallel-lint', // QA tool
         'sebastian/phpcpd', // QA tool
+        'ukko/phpredis-phpdoc' // Stubs
     ],
     'excludeDirectories' => [],
     'scanFiles' => [],

README.md

@@ -12,10 +12,38 @@ composer require macfja/redisearch
 
 ## Usage
 
+### Get a Redis client
+
+This lib can use several connector for Redis:
+ - [Predis](https://github.com/predis/predis/wiki) - Pure PHP implementation
+ - [Phpredis](https://github.com/phpredis/phpredis) - PHP extension
+ - [Phpiredis](https://github.com/nrk/phpiredis) - PHP extension depending on [hiredis](https://github.com/redis/hiredis)
+
+You can pick the connector depending of your need.
+
+```php
+$clientFacade = new \MacFJA\RediSearch\Redis\Client\ClientFacade();
+
+// With Predis
+$client = $clientFacade->getClient(new \Predis\Client(/* ... */));
+
+// With Phpredis extension
+$client = $clientFacade->getClient(new Redis([/* ... */]));
+
+// With Phpiredis extension
+$client = $clientFacade->getClient(phpiredis_connect($host));
+```
+
+You can add your own implementation, all you need is to implement the interface `\MacFJA\RediSearch\Redis\Client` and add it to the client facace with:
+```php
+$clientFacade = new \MacFJA\RediSearch\Redis\Client\ClientFacade();
+$clientFacade->addFactory(\MyVendor\MyPackage\MyRedisClient::class);
+```
+
 ### Create a new index
 
 ```php
-$client = new \Predis\Client(/* ... */);
+$client = /* ... */;
 $builder = new \MacFJA\RediSearch\IndexBuilder();
 
 // Field can be create in advance
@@ -38,9 +66,9 @@ This will give you a new instance of the builder with the configured data.
 ### Add a document
 
 ```php
-$client = new \Predis\Client(/* ... */);
+$client = /* ... */;
 $index = new \MacFJA\RediSearch\Index('person', $client);
-$index->addFromArray([
+$index->addDocumentFromArray([
     'firstname' => 'Joe',
     'lastname' => 'Doe',
     'age' => 30,
@@ -51,15 +79,15 @@ $index->addFromArray([
 ### Search
 
 ```php
-$client = new \Predis\Client(/* ... */);
+$client = /* ... */;
 $search = new \MacFJA\RediSearch\Redis\Command\Search();
 
 $search
     ->setIndex('person')
     ->setQuery('Doe')
     ->setHighlight(['lastname'])
     ->setWithScores();
-$results = $client->executeCommand($search);
+$results = $client->execute($search);
 ```
 
 #### Create a search query
@@ -96,9 +124,8 @@ use MacFJA\RediSearch\Redis\Command\AggregateCommand\GroupByOption;
 use MacFJA\RediSearch\Redis\Command\AggregateCommand\ReduceOption;
 use MacFJA\RediSearch\Redis\Command\Search;
 use MacFJA\RediSearch\Redis\Command\SugGet;
-use Predis\Client;
 
-$client = new Client(/* ... */);
+$client = /* ... */;
 
 $query = '@age:[(17 +inf] %john%';
 $search = new Search();
@@ -123,13 +150,7 @@ $suggestion->setDictionary('names')
     ->setPrefix('john')
     ->setFuzzy();
 
-$result = $client->pipeline()
-    ->executeCommand($search)
-    ->executeCommand($stats)
-    ->executeCommand($aggregate)
-    ->executeCommand($suggestion)
-    ->execute()
-;
+$result = $client->pipeline($search, $stats, $aggregate, $suggestion);
 
 // $result[0] is the search result
 // $result[1] is the first aggregation result

composer.json

@@ -19,7 +19,6 @@
         "php": "^7.2",
         "ext-intl": "*",
         "composer/semver": "^3.2",
-        "predis/predis": "^1.1",
         "respect/validation": "^2.0"
     },
     "require-dev": {
@@ -31,11 +30,18 @@
         "phpmd/phpmd": "^2.10",
         "phpstan/phpstan": "^0.12.92",
         "phpunit/phpunit": "^8.5",
+        "predis/predis": "^1.1",
         "roave/security-advisories": "dev-latest",
         "rskuipers/php-assumptions": "^0.8.0",
         "sebastian/phpcpd": "^4.1",
+        "ukko/phpredis-phpdoc": "dev-master",
         "vimeo/psalm": "^4.7"
     },
+    "suggest": {
+        "ext-phpiredis": "To use Phpiredis extension implementation",
+        "ext-phpredis": "To use Phpredis extension implementation",
+        "predis/predis": "To use Predis implementation"
+    },
     "config": {
         "platform": {
             "php": "7.2"

composer.lock

@@ -3,6 +3,9 @@ parameters:
     paths:
         - src
         - tests
+    excludePaths:
+        analyse:
+            - tests/psalm/stubs/phpiredis.php
     ignoreErrors:
         - '#Method MacFJA\\RediSearch\\Redis\\Command\\\w+::getLanguageOptions\(\) should return#'
         - '#uses generic trait MacFJA\\RediSearch\\Redis\\Command\\Option\\DecoratedOptionTrait but does not specify its types: T#'

phpstan.neon

@@ -12,4 +12,8 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+    <stubs>
+        <file name="vendor/ukko/phpredis-phpdoc/src/Redis.php"/>
+        <file name="tests/psalm/stubs/phpiredis.php"/>
+    </stubs>
 </psalm>