Skip to content

Commit 8ab6f97

Browse files
Vladyslav VildanovVladyslav Vildanov
Vladyslav Vildanov
authored and
Vladyslav Vildanov
committed
Added support for new arguments for BITPOS, BITCOUNT commands
1 parent 1cd7809 commit 8ab6f97

File tree

8 files changed

+147
-6
lines changed

8 files changed

+147
-6
lines changed

‎src/ClientContextInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@
4242
* @method $this ttl($key)
4343
* @method $this type($key)
4444
* @method $this append($key, $value)
45-
* @method $this bitcount($key, $start = null, $end = null)
45+
* @method $this bitcount($key, $start = null, $end = null, string $index = 'byte')
4646
* @method $this bitop($operation, $destkey, $key)
4747
* @method $this bitfield($key, $subcommand, ...$subcommandArg)
48-
* @method $this bitpos($key, $bit, $start = null, $end = null)
48+
* @method $this bitpos($key, $bit, $start = null, $end = null, string $index = 'byte')
4949
* @method $this blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)
5050
* @method $this bzpopmax(array $keys, int $timeout)
5151
* @method $this bzpopmin(array $keys, int $timeout)

‎src/ClientInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@
5151
* @method int ttl(string $key)
5252
* @method mixed type(string $key)
5353
* @method int append(string $key, $value)
54-
* @method int bitcount(string $key, $start = null, $end = null)
54+
* @method int bitcount(string $key, $start = null, $end = null, string $index = 'byte')
5555
* @method int bitop($operation, $destkey, $key)
5656
* @method array|null bitfield(string $key, $subcommand, ...$subcommandArg)
57-
* @method int bitpos(string $key, $bit, $start = null, $end = null)
57+
* @method int bitpos(string $key, $bit, $start = null, $end = null, string $index = 'byte')
5858
* @method array blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)
5959
* @method array bzpopmax(array $keys, int $timeout)
6060
* @method array bzpopmin(array $keys, int $timeout)

‎src/Command/Redis/BITCOUNT.php

+5
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,17 @@
1313
namespace Predis\Command\Redis;
1414

1515
use Predis\Command\Command as RedisCommand;
16+
use Predis\Command\Traits\BitByte;
1617

1718
/**
1819
* @see http://redis.io/commands/bitcount
20+
*
21+
* Count the number of set bits (population counting) in a string.
1922
*/
2023
class BITCOUNT extends RedisCommand
2124
{
25+
use BitByte;
26+
2227
/**
2328
* {@inheritdoc}
2429
*/

‎src/Command/Redis/BITPOS.php

+5
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,17 @@
1313
namespace Predis\Command\Redis;
1414

1515
use Predis\Command\Command as RedisCommand;
16+
use Predis\Command\Traits\BitByte;
1617

1718
/**
1819
* @see http://redis.io/commands/bitpos
20+
*
21+
* Return the position of the first bit set to 1 or 0 in a string.
1922
*/
2023
class BITPOS extends RedisCommand
2124
{
25+
use BitByte;
26+
2227
/**
2328
* {@inheritdoc}
2429
*/

‎src/Command/Traits/BitByte.php

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Traits;
14+
15+
trait BitByte
16+
{
17+
private static $argumentEnum = [
18+
'bit' => 'BIT',
19+
'byte' => 'BYTE',
20+
];
21+
22+
public function setArguments(array $arguments)
23+
{
24+
$value = array_pop($arguments);
25+
26+
if (in_array(strtoupper($value), self::$argumentEnum, true)) {
27+
$arguments[] = self::$argumentEnum[$value];
28+
} else {
29+
$arguments[] = $value;
30+
}
31+
32+
parent::setArguments($arguments);
33+
}
34+
}

‎tests/Predis/Command/Redis/BITCOUNT_Test.php

+20-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ protected function getExpectedId(): string
3939
*/
4040
public function testFilterArguments(): void
4141
{
42-
$arguments = ['key', 0, 10];
43-
$expected = ['key', 0, 10];
42+
$arguments = ['key', 0, 10, 'bit'];
43+
$expected = ['key', 0, 10, 'BIT'];
4444

4545
$command = $this->getCommand();
4646
$command->setArguments($arguments);
@@ -79,6 +79,24 @@ public function testReturnsNumberOfBitsSet(): void
7979
$this->assertSame(3, $redis->bitcount('key', 2, 4), 'Count bits set (with range)');
8080
}
8181

82+
/**
83+
* @group connected
84+
* @requiresRedisVersion >= 7.0.0
85+
*/
86+
public function testReturnsNumberOfBitsSetWithExplicitBitByteArgument(): void
87+
{
88+
$redis = $this->getClient();
89+
90+
$redis->setbit('key', 1, 1);
91+
$redis->setbit('key', 10, 1);
92+
$redis->setbit('key', 16, 1);
93+
$redis->setbit('key', 22, 1);
94+
$redis->setbit('key', 32, 1);
95+
96+
$this->assertSame(2, $redis->bitcount('key', 0, 10, 'bit'), 'Count bits set (without range)');
97+
$this->assertSame(1, $redis->bitcount('key', 0, 4, 'bit'), 'Count bits set (with range)');
98+
}
99+
82100
/**
83101
* @group connected
84102
* @requiresRedisVersion >= 2.6.0

‎tests/Predis/Command/Redis/BITPOS_Test.php

+19
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,25 @@ public function testReturnsBitPosition(): void
7979
$this->assertSame(-1, $redis->bitpos('key', 1, 5, 10), 'Get position of first bit set to 1 - specific range');
8080
}
8181

82+
/**
83+
* @group connected
84+
* @requiresRedisVersion >= 7.0.0
85+
*/
86+
public function testReturnsBitPositionWithExplicitBitByteArgument(): void
87+
{
88+
$redis = $this->getClient();
89+
90+
$redis->setbit('key', 10, 0);
91+
$this->assertSame(0, $redis->bitpos('key', 0, 0, 10, 'bit'), 'Get position of first bit set to 0 - full range');
92+
$this->assertSame(-1, $redis->bitpos('key', 1, 0, 10, 'bit'), 'Get position of first bit set to 1 - full range');
93+
$this->assertSame(-1, $redis->bitpos('key', 1, 5, 10, 'bit'), 'Get position of first bit set to 1 - specific range');
94+
95+
$redis->setbit('key', 5, 1);
96+
$this->assertSame(0, $redis->bitpos('key', 0, 0, 5, 'bit'), 'Get position of first bit set to 0 - full range');
97+
$this->assertSame(5, $redis->bitpos('key', 1, 0, 5, 'bit'), 'Get position of first bit set to 1 - full range');
98+
$this->assertSame(5, $redis->bitpos('key', 1, 5, 10, 'bit'), 'Get position of first bit set to 1 - specific range');
99+
}
100+
82101
/**
83102
* @group connected
84103
* @requiresRedisVersion >= 2.8.7

‎tests/Predis/Command/Traits/BitByteTest.php

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Traits;
14+
15+
use Predis\Command\Command as RedisCommand;
16+
use PredisTestCase;
17+
18+
class BitByteTest extends PredisTestCase
19+
{
20+
private $testClass;
21+
22+
protected function setUp(): void
23+
{
24+
$this->testClass = new class() extends RedisCommand {
25+
use BitByte;
26+
27+
public function getId()
28+
{
29+
return 'test';
30+
}
31+
};
32+
}
33+
34+
/**
35+
* @dataProvider argumentsProvider
36+
* @param array $actualArguments
37+
* @param array $expectedArguments
38+
* @return void
39+
*/
40+
public function testReturnsCorrectArguments(array $actualArguments, array $expectedArguments): void
41+
{
42+
$this->testClass->setArguments($actualArguments);
43+
44+
$this->assertSame($expectedArguments, $this->testClass->getArguments());
45+
}
46+
47+
public function argumentsProvider(): array
48+
{
49+
return [
50+
'with correct enum value' => [
51+
['bit'],
52+
['BIT'],
53+
],
54+
'with incorrect enum value' => [
55+
['value'],
56+
['value'],
57+
],
58+
];
59+
}
60+
}

0 commit comments

Comments
 (0)