mirror of
https://github.com/predis/predis.git
synced 2026-08-28 11:09:49 +00:00
Extended RedisJson support by implementing JSON.ARRPOP command (#933)
* 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.ARRPOP command 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
eed7fe6a76
commit
653d62ab40
@@ -103,6 +103,7 @@ use Predis\Command\CommandInterface;
|
||||
* @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 jsonarrlen(string $key, string $path = '$')
|
||||
* @method $this jsonarrpop(string $key, string $path = '$', int $index = -1)
|
||||
* @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)
|
||||
|
||||
@@ -112,6 +112,7 @@ use Predis\Response\Status;
|
||||
* @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 array jsonarrlen(string $key, string $path = '$')
|
||||
* @method array jsonarrpop(string $key, string $path = '$', int $index = -1)
|
||||
* @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.arrpop/
|
||||
*
|
||||
* Remove and return an element from the index in the array
|
||||
*/
|
||||
class JSONARRPOP extends RedisCommand
|
||||
{
|
||||
public function getId()
|
||||
{
|
||||
return 'JSON.ARRPOP';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,123 @@
|
||||
<?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 JSONARRPOP_Test extends PredisCommandTestCase
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedCommand(): string
|
||||
{
|
||||
return JSONARRPOP::class;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedId(): string
|
||||
{
|
||||
return 'JSONARRPOP';
|
||||
}
|
||||
|
||||
/**
|
||||
* @group disconnected
|
||||
*/
|
||||
public function testFilterArguments(): void
|
||||
{
|
||||
$arguments = ['key', '$..', 2];
|
||||
$expected = ['key', '$..', 2];
|
||||
|
||||
$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 $expectedPoppedElements
|
||||
* @param string $expectedModifiedJson
|
||||
* @return void
|
||||
* @requiresRedisJsonVersion >= 1.0.0
|
||||
*/
|
||||
public function testRemovesElementFromIndexOfJsonArray(
|
||||
array $jsonArguments,
|
||||
string $key,
|
||||
string $path,
|
||||
int $index,
|
||||
array $expectedPoppedElements,
|
||||
string $expectedModifiedJson
|
||||
): void {
|
||||
$redis = $this->getClient();
|
||||
|
||||
$redis->jsonset(...$jsonArguments);
|
||||
$actualResponse = $redis->jsonarrpop($key, $path, $index);
|
||||
|
||||
$this->assertSame($expectedPoppedElements, $actualResponse);
|
||||
$this->assertSame($expectedModifiedJson, $redis->jsonget($key));
|
||||
}
|
||||
|
||||
public function jsonProvider(): array
|
||||
{
|
||||
return [
|
||||
'removes last element' => [
|
||||
['key', '$', '{"key1":"value1","key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
-1,
|
||||
['"value2"'],
|
||||
'{"key1":"value1","key2":["value1"]}',
|
||||
],
|
||||
'removes i-element' => [
|
||||
['key', '$', '{"key1":"value1","key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
0,
|
||||
['"value1"'],
|
||||
'{"key1":"value1","key2":["value2"]}',
|
||||
],
|
||||
'removes elements from root and nested levels' => [
|
||||
['key', '$', '{"key1":{"key2":["value1","value2"]},"key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$..key2',
|
||||
-1,
|
||||
['"value2"', '"value2"'],
|
||||
'{"key1":{"key2":["value1"]},"key2":["value1"]}',
|
||||
],
|
||||
'removes element from non-array' => [
|
||||
['key', '$', '{"key1":"value1","key2":"value2"}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
-1,
|
||||
[null],
|
||||
'{"key1":"value1","key2":"value2"}',
|
||||
],
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user