Merge pull request #43 from MacFJA/fix-predis-2

Add Predis v2 compatibility

Author: MacFJA

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Documentation on paginated responses
 - Throw custom exception is client is missing
+- Add compatibility for Predis version 2.x
+- (dev) Add `make clean` to remove all generated files
 
 ### Fixed
 
@@ -18,6 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Rework paginated responses
+- Add warning for Predis commands initialization
+- (dev) Remove deprecated `--no-suggest` option of Composer in the `Makefile`
 
 ### Deprecated
 

Makefile

@@ -1,4 +1,4 @@
-.PHONY: analyze fix-code test test-with-integration coverage coverage-with-integration validation integration-test integration-coverage
+.PHONY: analyze fix-code clean test test-with-integration coverage coverage-with-integration validation integration-test integration-coverage
 
 analyze: | vendor
 	$(COMPOSER) exec -v parallel-lint -- src
@@ -11,6 +11,13 @@ analyze: | vendor
 	$(COMPOSER) exec -v phpstan -- analyse
 	$(COMPOSER) exec -v psalm -- src
 
+clean:
+	rm -rf composer.phar
+	rm -rf vendor/
+	rm -rf composer.lock
+	rm -rf .php-cs-fixer.cache
+	rm -rf .phpunit.result.cache
+
 fix-code: | vendor
 	$(COMPOSER) normalize
 	$(COMPOSER) exec -v php-cs-fixer -- fix -v
@@ -39,7 +46,7 @@ integration-coverage: | vendor
 validation: fix-code analyze test-with-integration coverage-with-integration
 
 vendor: composer.json
-	$(COMPOSER) install --optimize-autoloader --no-suggest --prefer-dist
+	$(COMPOSER) install --optimize-autoloader --prefer-dist
 	touch vendor
 
 composer.phar:

README.md

@@ -182,7 +182,7 @@ $result = $client->pipeline($search, $stats, $aggregate, $suggestion);
 // $result[3] is the suggestion result
 ```
 
-### Use Predis shorthand syntax
+### Use Predis (v1.x) shorthand syntax
 
 ```php
 $client = new \Predis\Client(/* ... */);
@@ -225,4 +225,4 @@ See [CONTRIBUTING](CONTRIBUTING.md) for more information.
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -39,7 +39,7 @@
         "phpmd/phpmd": "^2.10",
         "phpstan/phpstan": "^1.2.0",
         "phpunit/phpunit": "^8.5 || ^9.3",
-        "predis/predis": "^1.1",
+        "predis/predis": "^1.1 || ^2.0",
         "ptrofimov/tinyredisclient": "^1.1",
         "redisent/redisent": "dev-master",
         "roave/security-advisories": "dev-latest",

phpstan.neon

@@ -13,4 +13,5 @@ parameters:
         - '#Method MacFJA\\RediSearch\\tests\\Redis.+::dataProvider\(\) return type has no value type specified in iterable type (array|Generator).#'
         -
             message: '#Call to an undefined method MacFJA\\RediSearch\\Redis\\Command\\Option\\CommandOption::set\w+\(\).#'
-            path: src/Redis/Command/Option/GroupedOption.php
+            path: src/Redis/Command/Option/GroupedOption.php
+        - '#Predis\\Profile\\RedisProfile#'

src/Redis/Client/PredisClient.php

@@ -26,14 +26,19 @@
 use MacFJA\RediSearch\Redis\Command;
 use Predis\ClientContextInterface;
 use Predis\ClientInterface;
+use Predis\Command\CommandInterface;
 use Predis\Command\RawCommand;
+use Predis\Command\RawFactory;
 use RuntimeException;
 
 class PredisClient extends AbstractClient
 {
     /** @var ClientInterface */
     private $redis;
 
+    /** @var null|RawFactory */
+    private static $rawFactory;
+
     /**
      * @codeCoverageIgnore
      */
@@ -51,7 +56,7 @@ private function __construct(ClientInterface $redis)
 
     public function execute(Command $command)
     {
-        $rawResponse = $this->redis->executeCommand(new RawCommand(array_merge([$command->getId()], $command->getArguments())));
+        $rawResponse = $this->redis->executeCommand(self::createRawCommand(array_merge([$command->getId()], $command->getArguments())));
 
         return $command->parseResponse($rawResponse);
     }
@@ -82,7 +87,7 @@ public static function make($redis): Client
      */
     public function executeRaw(...$args)
     {
-        return $this->redis->executeCommand(new RawCommand($args));
+        return $this->redis->executeCommand(self::createRawCommand($args));
     }
 
     protected function doPipeline(Command ...$commands): array
@@ -91,8 +96,27 @@ protected function doPipeline(Command ...$commands): array
 
         return $this->redis->pipeline(static function (ClientContextInterface $pipeline) use ($commands): void {
             foreach ($commands as $command) {
-                $pipeline->executeCommand(new RawCommand(array_merge([$command->getId()], $command->getArguments())));
+                $pipeline->executeCommand(self::createRawCommand(array_merge([$command->getId()], $command->getArguments())));
             }
         });
     }
+
+    /**
+     * @param array<float|int|string> $args
+     * @codeCoverageIgnore
+     */
+    private static function createRawCommand(array $args): CommandInterface
+    {
+        if (class_exists(RawFactory::class)) {
+            if (null === self::$rawFactory) {
+                self::$rawFactory = new RawFactory();
+            }
+            $commandID = array_shift($args);
+
+            return self::$rawFactory->create((string) $commandID, $args);
+        }
+
+        // @phpstan-ignore-next-line
+        return new RawCommand($args);
+    }
 }

src/Redis/Initializer.php

@@ -21,6 +21,7 @@
 
 namespace MacFJA\RediSearch\Redis;
 
+use MacFJA\RediSearch\Redis\Client\AbstractClient;
 use MacFJA\RediSearch\Redis\Client\Rediska\RediskaRediSearchCommand;
 use MacFJA\RediSearch\Redis\Command\Aggregate;
 use MacFJA\RediSearch\Redis\Command\AliasAdd;
@@ -59,9 +60,19 @@ class Initializer
 {
     /**
      * @codeCoverageIgnore
+     * @psalm-suppress UndefinedDocblockClass
+     * @psalm-suppress UndefinedClass
+     *
+     * @param RedisProfile $profile
      */
-    public static function registerCommandsPredis(RedisProfile $profile): void
+    public static function registerCommandsPredis($profile): void
     {
+        if (!$profile instanceof RedisProfile) {
+            false === AbstractClient::$disableNotice
+            && trigger_error(sprintf('The parameter $profile must be an instance of %s, which is only available in Predis 1.x.', RedisProfile::class), E_USER_WARNING);
+
+            return;
+        }
         $profile->defineCommand('ftaggregate', Aggregate::class);
         $profile->defineCommand('ftaliasadd', AliasAdd::class);
         $profile->defineCommand('ftaliasdel', AliasDel::class);