Extended RedisJson support by implementing JSON.NUMINCRBY command (#919)

* Added CommandResolver, moved resolve command logic there, added ClientConfiguration object * Fixed test, added dependecies * Added resolved command to commands array * Used aggregation approach for modules * Added decorator to check Redis JSON module version * Added support for JSON.SET and JSON.GET commands * Added separate workflow for redis-stack tests * Changed docker imange name to correct one * Fixed indentation * Added test coverage for JSON.GET command * Changed module version resolving using annotations mapping * Re-written CommandResolver test * Update ClientInterface.php * Changes to CI, readme, removed unused modules from configuration * Fixed build badge URL * Refactored annotation check to be generic for each module * Fixed bug with incorrect tests skip * Added CommandResolver, moved resolve command logic there, added ClientConfiguration object * Fixed test, added dependecies * Added resolved command to commands array * Used aggregation approach for modules * Added decorator to check Redis JSON module version * Added support for JSON.SET and JSON.GET commands * Added separate workflow for redis-stack tests * Changed docker imange name to correct one * Fixed indentation * Added test coverage for JSON.GET command * Changed module version resolving using annotations mapping * Re-written CommandResolver test * Update ClientInterface.php * Changes to CI, readme, removed unused modules from configuration * Fixed build badge URL * Refactored annotation check to be generic for each module * Fixed bug with incorrect tests skip * Fixed naming issue with nxXx argument * Removed redundant trait * Fixed NxXxArgument test * Added support for JSON.NUMINCRBY command Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> Co-authored-by: Till Krüss <tillkruss@users.noreply.github.com>
2026-08-30 04:02:22 +00:00 · 2023-01-26 15:57:23 +02:00
parent 7ca3a05598
commit 1ee196134e
4 changed files with 145 additions and 0 deletions
@@ -101,6 +101,7 @@ use Predis\Command\CommandInterface;
 * @method $this hstrlen($key, $field)
 * @method $this jsondel(string $key, string $path = '$')
 * @method $this jsonget(string $key, string $indent = '', string $newline = '', string $space = '', string ...$paths)
+ * @method $this jsonnumincrby(string $key, string $path, int $value)
 * @method $this jsonmget(array $keys, string $path)
 * @method $this jsonobjkeys(string $key, string $path = '$')
 * @method $this jsonobjlen(string $key, string $path = '$')
@@ -110,6 +110,7 @@ use Predis\Response\Status;
 * @method int               hstrlen(string $key, string $field)
 * @method int               jsondel(string $key, string $path = '$')
 * @method string            jsonget(string $key, string $indent = '', string $newline = '', string $space = '', string ...$paths)
+ * @method string            jsonnumincrby(string $key, string $path, int $value)
 * @method array             jsonmget(array $keys, string $path)
 * @method array             jsonobjkeys(string $key, string $path = '$')
 * @method array             jsonobjlen(string $key, string $path = '$')
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\Json;
+
+use Predis\Command\Command as RedisCommand;
+
+/**
+ * @see https://redis.io/commands/json.numincrby/
+ *
+ * Increment the number value stored at path by number
+ */
+class JSONNUMINCRBY extends RedisCommand
+{
+    public function getId()
+    {
+        return 'JSON.NUMINCRBY';
+    }
+}
@@ -0,0 +1,115 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\Json;
+
+use Predis\Command\Redis\PredisCommandTestCase;
+
+class JSONNUMINCRBY_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return JSONNUMINCRBY::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'JSONNUMINCRBY';
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testFilterArguments(): void
+    {
+        $arguments = ['key', '$..', 5];
+        $expected = ['key', '$..', 5];
+
+        $command = $this->getCommand();
+        $command->setArguments($arguments);
+
+        $this->assertSame($expected, $command->getArguments());
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testParseResponse(): void
+    {
+        $this->assertSame(1, $this->getCommand()->parseResponse(1));
+    }
+
+    /**
+     * @group connected
+     * @dataProvider jsonProvider
+     * @param  array  $jsonArguments
+     * @param  string $key
+     * @param  string $path
+     * @param  int    $value
+     * @param  string $expectedIncrementedResponse
+     * @return void
+     * @requiresRedisJsonVersion >= 1.0.0
+     */
+    public function testIncrementJsonNumericOnGivenValue(
+        array $jsonArguments,
+        string $key,
+        string $path,
+        int $value,
+        string $expectedIncrementedResponse
+    ): void {
+        $redis = $this->getClient();
+
+        $redis->jsonset(...$jsonArguments);
+
+        $this->assertSame($expectedIncrementedResponse, $redis->jsonnumincrby($key, $path, $value));
+    }
+
+    public function jsonProvider(): array
+    {
+        return [
+            'on root level' => [
+                ['key', '$', '{"key1":"value1","key2":1}'],
+                'key',
+                '$.key2',
+                1,
+                '[2]',
+            ],
+            'on nested level' => [
+                ['key', '$', '{"key1":{"key2":5}}'],
+                'key',
+                '$..key2',
+                3,
+                '[8]',
+            ],
+            'on both levels' => [
+                ['key', '$', '{"key1":{"key2":5},"key2":4}'],
+                'key',
+                '$..key2',
+                2,
+                '[6,7]',
+            ],
+            'with non-numeric' => [
+                ['key', '$', '{"key1":{"key2":[1,2,3]}}'],
+                'key',
+                '$..key2',
+                2,
+                '[null]',
+            ],
+        ];
+    }
+}