mirror of
https://github.com/predis/predis.git
synced 2026-08-27 18:51:07 +00:00
Extended RedisJson support by implementing JSON.ARRINSERT command (#929)
* 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.ARRINSERT command * Revert changes Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> Co-authored-by: Till Krüss <tillkruss@users.noreply.github.com>
This commit is contained in:
Vladyslav Vildanov
committed by
GitHub
GitHub
parent
1467c5bac0
commit
34f40663ea
@@ -101,6 +101,7 @@ use Predis\Command\CommandInterface;
|
||||
* @method $this hstrlen($key, $field)
|
||||
* @method $this jsonarrappend(string $key, string $path = '$', ...$value)
|
||||
* @method $this jsonarrindex(string $key, string $path, string $value, int $start = 0, int $stop = 0)
|
||||
* @method $this jsonarrinsert(string $key, string $path, int $index, string ...$value)
|
||||
* @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)
|
||||
|
||||
@@ -110,6 +110,7 @@ use Predis\Response\Status;
|
||||
* @method int hstrlen(string $key, string $field)
|
||||
* @method array jsonarrappend(string $key, string $path = '$', ...$value)
|
||||
* @method array jsonarrindex(string $key, string $path, string $value, int $start = 0, int $stop = 0)
|
||||
* @method array jsonarrinsert(string $key, string $path, int $index, string ...$value)
|
||||
* @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)
|
||||
|
||||
@@ -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.arrinsert/
|
||||
*
|
||||
* Insert the json values into the array at path before the index (shifts to the right)
|
||||
*/
|
||||
class JSONARRINSERT extends RedisCommand
|
||||
{
|
||||
public function getId()
|
||||
{
|
||||
return 'JSON.ARRINSERT';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,139 @@
|
||||
<?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 JSONARRINSERT_Test extends PredisCommandTestCase
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedCommand(): string
|
||||
{
|
||||
return JSONARRINSERT::class;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedId(): string
|
||||
{
|
||||
return 'JSONARRINSERT';
|
||||
}
|
||||
|
||||
/**
|
||||
* @group disconnected
|
||||
*/
|
||||
public function testFilterArguments(): void
|
||||
{
|
||||
$arguments = ['key', '$..', 2, 'value'];
|
||||
$expected = ['key', '$..', 2, 'value'];
|
||||
|
||||
$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 $index
|
||||
* @param array $values
|
||||
* @param array $expectedArrayLength
|
||||
* @param string $expectedModifiedArray
|
||||
* @return void
|
||||
* @requiresRedisJsonVersion >= 1.0.0
|
||||
*/
|
||||
public function testInsertElementIntoJsonArrayBeforeGivenIndex(
|
||||
array $jsonArguments,
|
||||
string $key,
|
||||
string $path,
|
||||
int $index,
|
||||
array $values,
|
||||
array $expectedArrayLength,
|
||||
string $expectedModifiedArray
|
||||
): void {
|
||||
$redis = $this->getClient();
|
||||
|
||||
$redis->jsonset(...$jsonArguments);
|
||||
|
||||
$actualResponse = $redis->jsonarrinsert($key, $path, $index, ...$values);
|
||||
|
||||
$this->assertSame($expectedArrayLength, $actualResponse);
|
||||
$this->assertSame($expectedModifiedArray, $redis->jsonget($key));
|
||||
}
|
||||
|
||||
public function jsonProvider(): array
|
||||
{
|
||||
return [
|
||||
'on root level' => [
|
||||
['key', '$', '{"key1":"value1","key2":["value1","value3"]}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
1,
|
||||
['"value2"'],
|
||||
[3],
|
||||
'{"key1":"value1","key2":["value1","value2","value3"]}',
|
||||
],
|
||||
'on nested level' => [
|
||||
['key', '$', '{"key1":{"key2":["value1","value3"]}}'],
|
||||
'key',
|
||||
'$..key2',
|
||||
1,
|
||||
['"value2"'],
|
||||
[3],
|
||||
'{"key1":{"key2":["value1","value2","value3"]}}',
|
||||
],
|
||||
'with both levels matching keys' => [
|
||||
['key', '$', '{"key1":{"key2":["value1","value3"]},"key2":["value1","value3"]}'],
|
||||
'key',
|
||||
'$..key2',
|
||||
1,
|
||||
['"value2"'],
|
||||
[3, 3],
|
||||
'{"key1":{"key2":["value1","value2","value3"]},"key2":["value1","value2","value3"]}',
|
||||
],
|
||||
'with multiple values inserted' => [
|
||||
['key', '$', '{"key1":"value1","key2":["value1","value4"]}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
1,
|
||||
['"value2"', '"value3"'],
|
||||
[4],
|
||||
'{"key1":"value1","key2":["value1","value2","value3","value4"]}',
|
||||
],
|
||||
'with non-array path' => [
|
||||
['key', '$', '{"key1":"value1","key2":"value2"}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
1,
|
||||
['"value2"'],
|
||||
[null],
|
||||
'{"key1":"value1","key2":"value2"}',
|
||||
],
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user