redis 3.3.1 → 4.0.1

data/lib/redis/distributed.rb

@@ -1,4 +1,4 @@
-require "redis/hash_ring"
+require_relative "hash_ring"
 
 class Redis
   class Distributed
@@ -144,8 +144,8 @@ class Redis
     end
 
     # Create a key using the serialized value, previously obtained using DUMP.
-    def restore(key, ttl, serialized_value)
-      node_for(key).restore(key, ttl, serialized_value)
+    def restore(key, ttl, serialized_value, options = {})
+      node_for(key).restore(key, ttl, serialized_value, options)
     end
 
     # Transfer a key from the connected instance to another instance.
@@ -277,13 +277,16 @@ class Redis
       node_for(key).get(key)
     end
 
-    # Get the values of all the given keys.
+    # Get the values of all the given keys as an Array.
     def mget(*keys)
-      raise CannotDistribute, :mget
+      mapped_mget(*keys).values_at(*keys)
     end
 
+    # Get the values of all the given keys as a Hash.
     def mapped_mget(*keys)
-      raise CannotDistribute, :mapped_mget
+      keys.group_by { |k| node_for k }.inject({}) do |results, (node, subkeys)|
+        results.merge! node.mapped_mget(*subkeys)
+      end
     end
 
     # Overwrite part of a string at key starting at the specified offset.
@@ -483,8 +486,8 @@ class Redis
     end
 
     # Remove and return a random member from a set.
-    def spop(key)
-      node_for(key).spop(key)
+    def spop(key, count = nil)
+      node_for(key).spop(key, count)
     end
 
     # Get a random member from a set.
@@ -509,6 +512,16 @@ class Redis
       node_for(key).smembers(key)
     end
 
+    # Scan a set
+    def sscan(key, cursor, options={})
+      node_for(key).sscan(key, cursor, options)
+    end
+
+    # Scan a set and return an enumerator
+    def sscan_each(key, options={}, &block)
+      node_for(key).sscan_each(key, options, &block)
+    end
+
     # Subtract multiple sets.
     def sdiff(*keys)
       ensure_same_node(:sdiff, keys) do |node|

data/lib/redis/hash_ring.rb

@@ -25,7 +25,6 @@ class Redis
       @nodes << node
       @replicas.times do |i|
         key = Zlib.crc32("#{node.id}:#{i}")
-        raise "Node ID collision" if @ring.has_key?(key)
         @ring[key] = node
         @sorted_keys << key
       end
@@ -61,72 +60,29 @@ class Redis
       end
     end
 
-    class << self
-
-      # gem install RubyInline to use this code
-      # Native extension to perform the binary search within the hashring.
-      # There's a pure ruby version below so this is purely optional
-      # for performance.  In testing 20k gets and sets, the native
-      # binary search shaved about 12% off the runtime (9sec -> 8sec).
-      begin
-        require 'inline'
-        inline do |builder|
-          builder.c <<-EOM
-          int binary_search(VALUE ary, unsigned int r) {
-              int upper = RARRAY_LEN(ary) - 1;
-              int lower = 0;
-              int idx = 0;
-
-              while (lower <= upper) {
-                  idx = (lower + upper) / 2;
-
-                  VALUE continuumValue = RARRAY_PTR(ary)[idx];
-                  unsigned int l = NUM2UINT(continuumValue);
-                  if (l == r) {
-                      return idx;
-                  }
-                  else if (l > r) {
-                      upper = idx - 1;
-                  }
-                  else {
-                      lower = idx + 1;
-                  }
-              }
-              if (upper < 0) {
-                upper = RARRAY_LEN(ary) - 1;
-              }
-              return upper;
-          }
-          EOM
-        end
-      rescue Exception
-        # Find the closest index in HashRing with value <= the given value
-        def binary_search(ary, value, &block)
-          upper = ary.size - 1
-          lower = 0
-          idx = 0
-
-          while(lower <= upper) do
-            idx = (lower + upper) / 2
-            comp = ary[idx] <=> value
-
-            if comp == 0
-              return idx
-            elsif comp > 0
-              upper = idx - 1
-            else
-              lower = idx + 1
-            end
-          end
-
-          if upper < 0
-            upper = ary.size - 1
-          end
-          return upper
+    # Find the closest index in HashRing with value <= the given value
+    def self.binary_search(ary, value, &block)
+      upper = ary.size - 1
+      lower = 0
+      idx = 0
+
+      while(lower <= upper) do
+        idx = (lower + upper) / 2
+        comp = ary[idx] <=> value
+
+        if comp == 0
+          return idx
+        elsif comp > 0
+          upper = idx - 1
+        else
+          lower = idx + 1
         end
+      end
 
+      if upper < 0
+        upper = ary.size - 1
       end
+      return upper
     end
-
   end
 end

data/lib/redis/pipeline.rb

@@ -1,10 +1,4 @@
 class Redis
-  unless defined?(::BasicObject)
-    class BasicObject
-      instance_methods.each { |meth| undef_method(meth) unless meth =~ /\A(__|instance_eval)/ }
-    end
-  end
-
   class Pipeline
     attr_accessor :db
 

data/lib/redis/version.rb

@@ -1,3 +1,3 @@
 class Redis
-  VERSION = "3.3.1"
+  VERSION = "4.0.1"
 end

data/lib/redis.rb

@@ -1,21 +1,8 @@
 require "monitor"
-require "redis/errors"
+require_relative "redis/errors"
 
 class Redis
 
-  def self.deprecate(message, trace = caller[0])
-    $stderr.puts "\n#{message} (in #{trace})"
-  end
-
-  attr :client
-
-  # @deprecated The preferred way to create a new client object is using `#new`.
-  #             This method does not actually establish a connection to Redis,
-  #             in contrary to what you might expect.
-  def self.connect(options = {})
-    new(options)
-  end
-
   def self.current
     @current ||= Redis.new
   end
@@ -119,6 +106,10 @@ class Redis
     end
   end
 
+  def _client
+    @client
+  end
+
   # Authenticate to the server.
   #
   # @param [String] password must match the password specified in the
@@ -143,10 +134,11 @@ class Redis
 
   # Ping the server.
   #
+  # @param [optional, String] message
   # @return [String] `PONG`
-  def ping
+  def ping(message = nil)
     synchronize do |client|
-      client.call([:ping])
+      client.call([:ping, message].compact)
     end
   end
 
@@ -209,6 +201,25 @@ class Redis
     end
   end
 
+  # Manage client connections.
+  #
+  # @param [String, Symbol] subcommand e.g. `kill`, `list`, `getname`, `setname`
+  # @return [String, Hash] depends on subcommand
+  def client(subcommand = nil, *args)
+    synchronize do |client|
+      client.call([:client, subcommand] + args) do |reply|
+        if subcommand.to_s == "list"
+          reply.lines.map do |line|
+            entries = line.chomp.split(/[ =]/)
+            Hash[entries.each_slice(2).to_a]
+          end
+        else
+          reply
+        end
+      end
+    end
+  end
+
   # Return the number of keys in the selected database.
   #
   # @return [Fixnum]
@@ -226,19 +237,31 @@ class Redis
 
   # Remove all keys from all databases.
   #
+  # @param [Hash] options
+  #   - `:async => Boolean`: async flush (default: false)
   # @return [String] `OK`
-  def flushall
+  def flushall(options = nil)
     synchronize do |client|
-      client.call([:flushall])
+      if options && options[:async]
+        client.call([:flushall, :async])
+      else
+        client.call([:flushall])
+      end
     end
   end
 
   # Remove all keys from the current database.
   #
+  # @param [Hash] options
+  #   - `:async => Boolean`: async flush (default: false)
   # @return [String] `OK`
-  def flushdb
+  def flushdb(options = nil)
     synchronize do |client|
-      client.call([:flushdb])
+      if options && options[:async]
+        client.call([:flushdb, :async])
+      else
+        client.call([:flushdb])
+      end
     end
   end
 
@@ -458,10 +481,16 @@ class Redis
   # @param [String] key
   # @param [String] ttl
   # @param [String] serialized_value
+  # @param [Hash] options
+  #   - `:replace => Boolean`: if false, raises an error if key already exists
+  # @raise [Redis::CommandError]
   # @return [String] `"OK"`
-  def restore(key, ttl, serialized_value)
+  def restore(key, ttl, serialized_value, options = {})
+    args = [:restore, key, ttl, serialized_value]
+    args << 'REPLACE' if options[:replace]
+
     synchronize do |client|
-      client.call([:restore, key, ttl, serialized_value])
+      client.call(args)
     end
   end
 
@@ -477,8 +506,8 @@ class Redis
   def migrate(key, options)
     host = options[:host] || raise(RuntimeError, ":host not specified")
     port = options[:port] || raise(RuntimeError, ":port not specified")
-    db = (options[:db] || client.db).to_i
-    timeout = (options[:timeout] || client.timeout).to_i
+    db = (options[:db] || @client.db).to_i
+    timeout = (options[:timeout] || @client.timeout).to_i
 
     synchronize do |client|
       client.call([:migrate, host, port, key, db, timeout])
@@ -756,8 +785,6 @@ class Redis
     end
   end
 
-  alias :[]= :set
-
   # Set the time to live in seconds of a key.
   #
   # @param [String] key
@@ -863,8 +890,6 @@ class Redis
     end
   end
 
-  alias :[] :get
-
   # Get the values of all the given keys.
   #
   # @example
@@ -1041,7 +1066,7 @@ class Redis
   # Prepend one or more values to a list, creating the list if it doesn't exist
   #
   # @param [String] key
-  # @param [String, Array] value string value, or array of string values to push
+  # @param [String, Array<String>] value string value, or array of string values to push
   # @return [Fixnum] the length of the list after the push operation
   def lpush(key, value)
     synchronize do |client|
@@ -1063,7 +1088,7 @@ class Redis
   # Append one or more values to a list, creating the list if it doesn't exist
   #
   # @param [String] key
-  # @param [String] value
+  # @param [String, Array<String>] value string value, or array of string values to push
   # @return [Fixnum] the length of the list after the push operation
   def rpush(key, value)
     synchronize do |client|
@@ -1336,13 +1361,18 @@ class Redis
     end
   end
 
-  # Remove and return a random member from a set.
+  # Remove and return one or more random member from a set.
   #
   # @param [String] key
   # @return [String]
-  def spop(key)
+  # @param [Fixnum] count
+  def spop(key, count = nil)
     synchronize do |client|
-      client.call([:spop, key])
+      if count.nil?
+        client.call([:spop, key])
+      else
+        client.call([:spop, key, count])
+      end
     end
   end
 
@@ -1696,6 +1726,30 @@ class Redis
     end
   end
 
+  # Count the members, with the same score in a sorted set, within the given lexicographical range.
+  #
+  # @example Count members matching a
+  #   redis.zlexcount("zset", "[a", "[a\xff")
+  #     # => 1
+  # @example Count members matching a-z
+  #   redis.zlexcount("zset", "[a", "[z\xff")
+  #     # => 26
+  #
+  # @param [String] key
+  # @param [String] min
+  #   - inclusive minimum is specified by prefixing `(`
+  #   - exclusive minimum is specified by prefixing `[`
+  # @param [String] max
+  #   - inclusive maximum is specified by prefixing `(`
+  #   - exclusive maximum is specified by prefixing `[`
+  #
+  # @return [Fixnum] number of members within the specified lexicographical range
+  def zlexcount(key, min, max)
+    synchronize do |client|
+      client.call([:zlexcount, key, min, max])
+    end
+  end
+
   # Return a range of members with the same score in a sorted set, by lexicographical ordering
   #
   # @example Retrieve members matching a
@@ -2695,6 +2749,16 @@ class Redis
     self.class.new(@options)
   end
 
+  def connection
+    {
+      host:     @original_client.host,
+      port:     @original_client.port,
+      db:       @original_client.db,
+      id:       @original_client.id,
+      location: @original_client.location
+    }
+  end
+
   def method_missing(command, *args)
     synchronize do |client|
       client.call([command] + args)
@@ -2766,8 +2830,8 @@ private
 
 end
 
-require "redis/version"
-require "redis/connection"
-require "redis/client"
-require "redis/pipeline"
-require "redis/subscribe"
+require_relative "redis/version"
+require_relative "redis/connection"
+require_relative "redis/client"
+require_relative "redis/pipeline"
+require_relative "redis/subscribe"

data/makefile

@@ -0,0 +1,42 @@
+TEST_FILES   := $(shell find test -name *_test.rb -type f)
+REDIS_BRANCH := unstable
+TMP          := tmp
+BUILD_DIR    := ${TMP}/redis-${REDIS_BRANCH}
+TARBALL      := ${TMP}/redis-${REDIS_BRANCH}.tar.gz
+BINARY       := ${BUILD_DIR}/src/redis-server
+PID_PATH     := ${BUILD_DIR}/redis.pid
+SOCKET_PATH  := ${BUILD_DIR}/redis.sock
+PORT         := 6381
+
+test: ${TEST_FILES}
+	make start
+	env SOCKET_PATH=${SOCKET_PATH} \
+		ruby -v $$(echo $? | tr ' ' '\n' | awk '{ print "-r./" $$0 }') -e ''
+	make stop
+
+${TMP}:
+	mkdir $@
+
+${TARBALL}: ${TMP}
+	wget https://github.com/antirez/redis/archive/${REDIS_BRANCH}.tar.gz -O $@
+
+${BINARY}: ${TARBALL} ${TMP}
+	rm -rf ${BUILD_DIR}
+	mkdir -p ${BUILD_DIR}
+	tar xf ${TARBALL} -C ${TMP}
+	cd ${BUILD_DIR} && make
+
+stop:
+	(test -f ${PID_PATH} && (kill $$(cat ${PID_PATH}) || true) && rm -f ${PID_PATH}) || true
+
+start: ${BINARY}
+	${BINARY}                     \
+		--daemonize  yes            \
+		--pidfile    ${PID_PATH}    \
+		--port       ${PORT}        \
+		--unixsocket ${SOCKET_PATH}
+
+clean:
+	(test -d ${BUILD_DIR} && cd ${BUILD_DIR}/src && make clean distclean) || true
+
+.PHONY: test start stop

data/redis.gemspec

@@ -1,8 +1,4 @@
-# -*- encoding: utf-8 -*-
-
-$:.unshift File.expand_path("../lib", __FILE__)
-
-require "redis/version"
+require "./lib/redis/version"
 
 Gem::Specification.new do |s|
   s.name = "redis"
@@ -15,8 +11,7 @@ Gem::Specification.new do |s|
 
   s.description = <<-EOS
     A Ruby client that tries to match Redis' API one-to-one, while still
-    providing an idiomatic interface. It features thread-safety,
-    client-side sharding, pipelining, and an obsession for performance.
+    providing an idiomatic interface.
   EOS
 
   s.license = "MIT"
@@ -39,6 +34,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
-  s.add_development_dependency("rake", "<11.0.0")
-  s.add_development_dependency("test-unit", "3.1.5")
+  s.required_ruby_version = '>= 2.2.2'
+
+  s.add_development_dependency("test-unit", ">= 3.1.5")
+  s.add_development_dependency("hiredis")
+  s.add_development_dependency("em-synchrony")
 end

data/test/bitpos_test.rb

@@ -1,10 +1,4 @@
-# encoding: UTF-8
-
-require File.expand_path("helper", File.dirname(__FILE__))
-
-unless defined?(Enumerator)
-  Enumerator = Enumerable::Enumerator
-end
+require_relative "helper"
 
 class TestBitpos < Test::Unit::TestCase
 
@@ -13,48 +7,48 @@ class TestBitpos < Test::Unit::TestCase
   def test_bitpos_empty_zero
     target_version "2.9.11" do
       r.del "foo"
-      assert_equal 0, r.bitpos("foo", 0)
+      assert_equal(0, r.bitpos("foo", 0))
     end
   end
 
   def test_bitpos_empty_one
     target_version "2.9.11" do
       r.del "foo"
-      assert_equal -1, r.bitpos("foo", 1)
+      assert_equal(-1, r.bitpos("foo", 1))
     end
   end
 
   def test_bitpos_zero
     target_version "2.9.11" do
       r.set "foo", "\xff\xf0\x00"
-      assert_equal 12, r.bitpos("foo", 0)
+      assert_equal(12, r.bitpos("foo", 0))
     end
   end
 
   def test_bitpos_one
     target_version "2.9.11" do
       r.set "foo", "\x00\x0f\x00"
-      assert_equal 12, r.bitpos("foo", 1)
+      assert_equal(12, r.bitpos("foo", 1))
     end
   end
 
   def test_bitpos_zero_end_is_given
     target_version "2.9.11" do
       r.set "foo", "\xff\xff\xff"
-      assert_equal 24, r.bitpos("foo", 0)
-      assert_equal 24, r.bitpos("foo", 0, 0)
-      assert_equal -1, r.bitpos("foo", 0, 0, -1)
+      assert_equal(24, r.bitpos("foo", 0))
+      assert_equal(24, r.bitpos("foo", 0, 0))
+      assert_equal(-1, r.bitpos("foo", 0, 0, -1))
     end
   end
 
   def test_bitpos_one_intervals
     target_version "2.9.11" do
       r.set "foo", "\x00\xff\x00"
-      assert_equal 8,  r.bitpos("foo", 1, 0, -1)
-      assert_equal 8,  r.bitpos("foo", 1, 1, -1)
-      assert_equal -1, r.bitpos("foo", 1, 2, -1)
-      assert_equal -1, r.bitpos("foo", 1, 2, 200)
-      assert_equal 8,  r.bitpos("foo", 1, 1, 1)
+      assert_equal(8,  r.bitpos("foo", 1, 0, -1))
+      assert_equal(8,  r.bitpos("foo", 1, 1, -1))
+      assert_equal(-1, r.bitpos("foo", 1, 2, -1))
+      assert_equal(-1, r.bitpos("foo", 1, 2, 200))
+      assert_equal(8,  r.bitpos("foo", 1, 1, 1))
     end
   end
 

data/test/blocking_commands_test.rb

@@ -1,7 +1,5 @@
-# encoding: UTF-8
-
-require File.expand_path("helper", File.dirname(__FILE__))
-require "lint/blocking_commands"
+require_relative "helper"
+require_relative "lint/blocking_commands"
 
 class TestBlockingCommands < Test::Unit::TestCase
 
@@ -17,7 +15,7 @@ class TestBlockingCommands < Test::Unit::TestCase
       yield(r)
       t2 = Time.now
 
-      assert timeout == r.client.timeout
+      assert timeout == r._client.timeout
       assert delay <= (t2 - t1)
     end
   end

data/test/client_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path("helper", File.dirname(__FILE__))
+require_relative "helper"
 
 class TestClient < Test::Unit::TestCase
 

data/test/command_map_test.rb

@@ -1,6 +1,4 @@
-# encoding: UTF-8
-
-require File.expand_path("helper", File.dirname(__FILE__))
+require_relative "helper"
 
 class TestCommandMap < Test::Unit::TestCase
 
@@ -11,7 +9,7 @@ class TestCommandMap < Test::Unit::TestCase
 
     assert_equal 2, r.incr("counter")
 
-    r.client.command_map[:incr] = :decr
+    r._client.command_map[:incr] = :decr
 
     assert_equal 1, r.incr("counter")
   end
@@ -23,7 +21,7 @@ class TestCommandMap < Test::Unit::TestCase
       r.idontexist("key")
     end
 
-    r.client.command_map[:idontexist] = :get
+    r._client.command_map[:idontexist] = :get
 
     assert_equal "value", r.idontexist("key")
   end

data/test/commands_on_hashes_test.rb

@@ -1,7 +1,5 @@
-# encoding: UTF-8
-
-require File.expand_path("helper", File.dirname(__FILE__))
-require "lint/hashes"
+require_relative "helper"
+require_relative "lint/hashes"
 
 class TestCommandsOnHashes < Test::Unit::TestCase
 

data/test/commands_on_hyper_log_log_test.rb

@@ -1,7 +1,5 @@
-# encoding: UTF-8
-
-require File.expand_path("helper", File.dirname(__FILE__))
-require "lint/hyper_log_log"
+require_relative "helper"
+require_relative "lint/hyper_log_log"
 
 class TestCommandsOnHyperLogLog < Test::Unit::TestCase
 
@@ -18,4 +16,4 @@ class TestCommandsOnHyperLogLog < Test::Unit::TestCase
     end
   end
 
-end
+end

data/test/commands_on_lists_test.rb

@@ -1,7 +1,5 @@
-# encoding: UTF-8
-
-require File.expand_path("helper", File.dirname(__FILE__))
-require "lint/lists"
+require_relative "helper"
+require_relative "lint/lists"
 
 class TestCommandsOnLists < Test::Unit::TestCase
 

data/test/commands_on_sets_test.rb

@@ -1,7 +1,5 @@
-# encoding: UTF-8
-
-require File.expand_path("helper", File.dirname(__FILE__))
-require "lint/sets"
+require_relative "helper"
+require_relative "lint/sets"
 
 class TestCommandsOnSets < Test::Unit::TestCase