Implement options for ZRANGE, ZRANGEBYSCORE, ZREVRANGE, ZREVRANGEBYSCORE

src/RangeByScoreOptions.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Amp\Redis;
+
+final class RangeByScoreOptions
+{
+    /** @var bool */
+    private $withScores = false;
+    /** @var int|null */
+    private $offset;
+    /** @var int|null */
+    private $count;
+
+    public function withScores(): self
+    {
+        $clone = clone $this;
+        $clone->withScores = true;
+
+        return $clone;
+    }
+
+    public function isWithScores(): bool
+    {
+        return $this->withScores;
+    }
+
+    public function withOffset(int $offset, int $count): self
+    {
+        $clone = clone $this;
+        $clone->offset = $offset;
+        $clone->count = $count;
+
+        return $clone;
+    }
+
+    public function toQuery(): array
+    {
+        $query = [];
+
+        if ($this->withScores() !== false) {
+            $query[] = "WITHSCORES";
+        }
+
+        if ($this->offset !== null) {
+            $query[] = "LIMIT";
+            $query[] = $this->offset;
+            $query[] = $this->count;
+        }
+
+        return $query;
+    }
+}

src/RangeOptions.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Amp\Redis;
+
+final class RangeOptions
+{
+    /** @var bool */
+    private $withScores = false;
+
+    public function isWithScores(): bool
+    {
+        return $this->withScores;
+    }
+
+    public function withScores(): self
+    {
+        $clone = clone $this;
+        $clone->withScores = true;
+
+        return $clone;
+    }
+
+    public function toQuery(): array
+    {
+        $query = [];
+
+        if ($this->withScores() !== false) {
+            $query[] = "WITHSCORES";
+        }
+
+        return $query;
+    }
+}

src/RedisMap.php

@@ -123,7 +123,7 @@ public function setValues(array $data): Promise
     /**
      * @param string $field
      *
-     * @return Promise<string>
+     * @return Promise<string|null>
      *
      * @link https://redis.io/commands/hget
      */

src/RedisSortedSet.php

@@ -42,9 +42,14 @@ public function add(array $data): Promise
      *
      * @return Promise
      */
-    public function getRange(int $start, int $end): Promise
+    public function getRange(int $start, int $end, ?RangeByScoreOptions $options = null): Promise
     {
-        return $this->queryExecutor->execute(['zrange', $this->key, $start, $end]);
+        $query = ['zrange', $this->key, $start, $end];
+        if ($options !== null) {
+            $query = \array_merge($query, $options->toQuery());
+        }
+
+        return $this->queryExecutor->execute($query, $options !== null && $options->isWithScores() ? toFloatMap : null);
     }
 
     /**
@@ -53,9 +58,14 @@ public function getRange(int $start, int $end): Promise
      *
      * @return Promise
      */
-    public function getReverseRange(int $start, int $end): Promise
+    public function getReverseRange(int $start, int $end, ?RangeByScoreOptions $options = null): Promise
     {
-        return $this->queryExecutor->execute(['zrevrange', $this->key, $start, $end]);
+        $query = ['zrevrange', $this->key, $start, $end];
+        if ($options !== null) {
+            $query = \array_merge($query, $options->toQuery());
+        }
+
+        return $this->queryExecutor->execute($query, $options !== null && $options->isWithScores() ? toFloatMap : null);
     }
 
     /**
@@ -64,9 +74,14 @@ public function getReverseRange(int $start, int $end): Promise
      *
      * @return Promise
      */
-    public function getRangeByScore(float $min, float $max): Promise
+    public function getRangeByScore(float $min, float $max, RangeByScoreOptions $options = null): Promise
     {
-        return $this->queryExecutor->execute(['zrangebyscore', $this->key, $min, $max]);
+        $query = ['zrangebyscore', $this->key, $min, $max];
+        if ($options !== null) {
+            $query = \array_merge($query, $options->toQuery());
+        }
+
+        return $this->queryExecutor->execute($query, $options !== null && $options->isWithScores() ? toFloatMap : null);
     }
 
     /**
@@ -75,9 +90,14 @@ public function getRangeByScore(float $min, float $max): Promise
      *
      * @return Promise
      */
-    public function getReverseRangeByScore(float $min, float $max): Promise
+    public function getReverseRangeByScore(float $min, float $max, RangeByScoreOptions $options = null): Promise
     {
-        return $this->queryExecutor->execute(['ZREVRANGEBYSCORE', $this->key, $min, $max]);
+        $query = ['zrevrangebyscore', $this->key, $min, $max];
+        if ($options !== null) {
+            $query = \array_merge($query, $options->toQuery());
+        }
+
+        return $this->queryExecutor->execute($query, $options !== null && $options->isWithScores() ? toFloatMap : null);
     }
 
     /**
@@ -89,12 +109,12 @@ public function getSize(): Promise
     }
 
     /**
-     * @param int $min
-     * @param int $max
+     * @param float $min
+     * @param float $max
      *
      * @return Promise<int>
      */
-    public function count(int $min, int $max): Promise
+    public function count(float $min, float $max): Promise
     {
         return $this->queryExecutor->execute(['zcount', $this->key, $min, $max]);
     }

src/functions.php

@@ -11,6 +11,7 @@
 const toBool = __NAMESPACE__ . '\toBool';
 const toNull = __NAMESPACE__ . '\toNull';
 const toMap = __NAMESPACE__ . '\toMap';
+const toFloatMap = __NAMESPACE__ . '\toFloatMap';
 
 function toFloat($response): ?float
 {
@@ -46,6 +47,22 @@ function toMap(?array $values): ?array
     return $result;
 }
 
+function toFloatMap(?array $values): ?array
+{
+    if ($values === null) {
+        return null;
+    }
+
+    $size = \count($values);
+    $result = [];
+
+    for ($i = 0; $i < $size; $i += 2) {
+        $result[$values[$i]] = (float)$values[$i + 1];
+    }
+
+    return $result;
+}
+
 function toNull($response): void
 {
     // nothing to do

test/RedisMapTest.php

@@ -20,6 +20,7 @@ public function test(): \Generator
             'rofl' => 'lol',
         ]));
 
+        $this->assertSame(null, yield $map->getValue('does_not_exist'));
         $this->assertSame('bar', yield $map->getValue('foo'));
         $this->assertSame('lol', yield $map->getValue('rofl'));
         $this->assertSame(2, yield $map->getSize());

test/RedisSortedSetTest.php

@@ -28,16 +28,20 @@ public function test(): \Generator
         $this->assertSame(1, yield $set->count(3, 3));
 
         $this->assertSame(['foo'], yield $set->getRange(0, 0));
+        $this->assertSame(['foo' => 1.0], yield $set->getRange(0, 0, (new RangeOptions())->withScores()));
         $this->assertSame(['foo', 'bar'], yield $set->getRange(0, 1));
         $this->assertSame(['bar'], yield $set->getRange(1, 2));
 
         $this->assertSame(['foo'], yield $set->getRangeByScore(1, 2));
+        $this->assertSame(['foo' => 1.0], yield $set->getRangeByScore(1, 2, (new RangeByScoreOptions())->withScores()));
         $this->assertSame(['foo', 'bar'], yield $set->getRangeByScore(1, 4));
 
         $this->assertSame(['bar', 'foo'], yield $set->getReverseRange(0, 1));
+        $this->assertSame(['bar' => 3.0], yield $set->getReverseRange(0, 0, (new RangeOptions())->withScores()));
         $this->assertSame(['foo'], yield $set->getReverseRange(1, 2));
 
         $this->assertSame(['foo'], yield $set->getReverseRangeByScore(2, 1));
+        $this->assertSame(['bar' => 3.0, 'foo' => 1.0], yield $set->getReverseRangeByScore(4, 1, (new RangeByScoreOptions())->withScores()));
         $this->assertSame(['bar', 'foo'], yield $set->getReverseRangeByScore(4, 1));
 
         $this->assertSame(0, yield $set->getRank('foo'));