Merge pull request #381 from joshuaflanagan/scan_return_vals

Improve return values for zscan and hscan

Author: djanowski

lib/redis.rb

@@ -2271,7 +2271,7 @@ def evalsha(*args)
     _eval(:evalsha, args)
   end
 
-  def _scan(command, cursor, options = {})
+  def _scan(command, cursor, options = {}, &block)
     # SSCAN/ZSCAN/HSCAN need a key to work on
     args = []
 
@@ -2289,7 +2289,7 @@ def _scan(command, cursor, options = {})
     args.concat(["COUNT", count]) if count
 
     synchronize do |client|
-      client.call([command] + args)
+      client.call([command] + args, &block)
     end
   end
 
@@ -2322,9 +2322,11 @@ def scan(cursor, options={})
   #   - `:match => String`: only return keys matching the pattern
   #   - `:count => Integer`: return count keys at most per iteration
   #
-  # @return [String, Array<String>] the next cursor and all found keys
+  # @return [String, Array<[String, String]>] the next cursor and all found keys
   def hscan(key, cursor, options={})
-    _scan(:hscan, cursor, options.merge(:key => key))
+    _scan(:hscan, cursor, options.merge(:key => key)) do |reply|
+      [reply[0], reply[1].each_slice(2).to_a]
+    end
   end
 
   # Scan a sorted set
@@ -2337,9 +2339,12 @@ def hscan(key, cursor, options={})
   #   - `:match => String`: only return keys matching the pattern
   #   - `:count => Integer`: return count keys at most per iteration
   #
-  # @return [String, Array<String>] the next cursor and all found scores and members
+  # @return [String, Array<[String, Float]>] the next cursor and all found
+  #   members and scores
   def zscan(key, cursor, options={})
-    _scan(:zscan, cursor, options.merge(:key => key))
+    _scan(:zscan, cursor, options.merge(:key => key)) do |reply|
+      [reply[0], reply[1].each_slice(2).map{|k,s| [k, _floatify(s)]}]
+    end
   end
 
   # Scan a set

test/scanning_test.rb

@@ -98,15 +98,15 @@ def test_hscan_with_encoding
         assert_equal enc.to_s, r.object("encoding", "hash")
 
         cursor = 0
-        all_keys   = []
+        all_key_values   = []
         loop {
-          cursor, keys = r.hscan "hash", cursor
-          all_keys += keys
+          cursor, key_values = r.hscan "hash", cursor
+          all_key_values.concat key_values
           break if cursor == "0"
         }
 
         keys2 = []
-        all_keys.each_slice(2) do |k, v|
+        all_key_values.each do |k, v|
           assert_equal "key:#{v}", k
           keys2 << k
         end
@@ -132,16 +132,17 @@ def test_zscan_with_encoding
         assert_equal enc.to_s, r.object("encoding", "zset")
 
         cursor = 0
-        all_keys   = []
+        all_key_scores   = []
         loop {
-          cursor, keys = r.zscan "zset", cursor
-          all_keys += keys
+          cursor, key_scores = r.zscan "zset", cursor
+          all_key_scores.concat  key_scores
           break if cursor == "0"
         }
 
         keys2 = []
-        all_keys.each_slice(2) do |k, v|
-          assert_equal "key:#{v}", k
+        all_key_scores.each do |k, v|
+          assert_equal true, v.is_a?(Float)
+          assert_equal "key:#{Integer(v)}", k
           keys2 << k
         end