redis 3.0.4 → 3.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWE3ZTkzYTU5MjZkMWY5YmQ0YTM0NmQ1NWY2ZTVmZTljNmZmYzE1Yg==
+  data.tar.gz: !binary |-
+    OTY0NWU0ZTA3YzdiNTdhOTdiMmQzMzk2NWQ1ZjBkN2M2N2MxMGEzYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDA2NjI0ZWE0YjM2NDc4MmE0MTZmODIyN2Q5MDgxMDc1NGFiODhiM2M1NGEy
+    MGI1ODA2NzhmMDQ3OGY5ZGJhNzM3MzI0MjMyZGFkM2FjNDM3YzdlNTlkMjFh
+    OTM0ZjQyNTc5OGMwOTkwNGQxZWYyY2E3ODk5Mzc0YmY1ODEzOWE=
+  data.tar.gz: !binary |-
+    MGYyMzA5MDg1YTU1ZTcyYjVkMDljZjU4OGFhMDc1MTg3NzhhMjkzZDQyZjk5
+    MTVmZjJhNmRiZDc0NjE3ODgzMTE5NTMyZGM3YjM0ZjMzMzkyYjA3MjNmYWYx
+    MzZjNTk2NzRiOGMzYmYyODZkYzZjZjE5YWU0OTc2MWUwMTAyODk=

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-# 3.0.4 (unreleased)
+# 3.0.5
+
+* Fix calling #select from a pipeline (#309).
+
+* Added method `Redis#connected?`.
+
+* Added support for `MIGRATE` (Redis 2.6).
+
+* Support extended SET command (#343, thanks to @benubois).
+
+# 3.0.4
 
 * Ensure #watch without a block returns "OK" (#332).
 

data/README.md

@@ -33,7 +33,7 @@ require "redis"
 redis = Redis.new
 ```
 
-This assumes Redis was started with a default configuration, and it
+This assumes Redis was started with a default configuration, and is
 listening on `localhost`, port 6379. If you need to connect to a remote
 server or a different port, try:
 
@@ -205,8 +205,9 @@ against the following interpreters and drivers:
 * MRI 1.8.7 (drivers: ruby, hiredis)
 * MRI 1.9.2 (drivers: ruby, hiredis, synchrony)
 * MRI 1.9.3 (drivers: ruby, hiredis, synchrony)
-* JRuby 1.6 (1.8 mode) (drivers: ruby)
-* JRuby 1.6 (1.9 mode) (drivers: ruby)
+* MRI 2.0.0 (drivers: ruby, hiredis, synchrony)
+* JRuby 1.7 (1.8 mode) (drivers: ruby)
+* JRuby 1.7 (1.9 mode) (drivers: ruby)
 
 ## Contributors
 

data/lib/redis.rb

@@ -27,7 +27,7 @@ class Redis
   include MonitorMixin
 
   def initialize(options = {})
-    @client = Client.new(options)
+    @original_client = @client = Client.new(options)
 
     super() # Monitor#initialize
   end
@@ -48,6 +48,11 @@ class Redis
     with_reconnect(false, &blk)
   end
 
+  # Test whether or not the client is connected
+  def connected?
+    @original_client.connected?
+  end
+
   # Authenticate to the server.
   #
   # @param [String] password must match the password specified in the
@@ -381,6 +386,26 @@ class Redis
     end
   end
 
+  # Transfer a key from the connected instance to another instance.
+  #
+  # @param [String] key
+  # @param [Hash] options
+  #   - `:host => String`: host of instance to migrate to
+  #   - `:port => Integer`: port of instance to migrate to
+  #   - `:db => Integer`: database to migrate to (default: same as source)
+  #   - `:timeout => Integer`: timeout (default: same as connection timeout)
+  # @return [String] `"OK"`
+  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
+
+    synchronize do |client|
+      client.call([:migrate, host, port, key, db, timeout])
+    end
+  end
+
   # Delete one or more keys.
   #
   # @param [String, Array<String>] keys
@@ -430,7 +455,7 @@ class Redis
   #     # => "OK"
   #   redis.exists "foo"
   #     # => true
-  #   resis.get "foo"
+  #   redis.get "foo"
   #     # => "bar"
   #
   # @param [String] key
@@ -624,10 +649,33 @@ class Redis
   #
   # @param [String] key
   # @param [String] value
-  # @return `"OK"`
-  def set(key, value)
+  # @param [Hash] options
+  #   - `:ex => Fixnum`: Set the specified expire time, in seconds.
+  #   - `:px => Fixnum`: Set the specified expire time, in milliseconds.
+  #   - `:nx => true`: Only set the key if it does not already exist.
+  #   - `:xx => true`: Only set the key if it already exist.
+  # @return [String, Boolean] `"OK"` or true, false if `:nx => true` or `:xx => true`
+  def set(key, value, options = {})
+    args = []
+
+    ex = options[:ex]
+    args.concat(["EX", ex]) if ex
+
+    px = options[:px]
+    args.concat(["PX", px]) if px
+
+    nx = options[:nx]
+    args.concat(["NX"]) if nx
+
+    xx = options[:xx]
+    args.concat(["XX"]) if xx
+
     synchronize do |client|
-      client.call([:set, key, value.to_s])
+      if nx || xx
+        client.call([:set, key, value.to_s] + args, &_boolify_set)
+      else
+        client.call([:set, key, value.to_s] + args)
+      end
     end
   end
 
@@ -2231,7 +2279,7 @@ class Redis
 
   def inspect
     synchronize do |client|
-      "#<Redis client v#{Redis::VERSION} for #{client.id}>"
+      "#<Redis client v#{Redis::VERSION} for #{@original_client.id}>"
     end
   end
 
@@ -2252,6 +2300,16 @@ private
     }
   end
 
+  def _boolify_set
+    lambda { |value|
+      if value && "OK" == value
+        true
+      else
+        false
+      end
+    }
+  end
+
   def _hashify
     lambda { |array|
       hash = Hash.new

data/lib/redis/client.rb

@@ -118,7 +118,9 @@ class Redis
     def call_pipeline(pipeline)
       with_reconnect pipeline.with_reconnect? do
         begin
-          pipeline.finish(call_pipelined(pipeline.commands))
+          pipeline.finish(call_pipelined(pipeline.commands)).tap do
+            self.db = pipeline.db if pipeline.db
+          end
         rescue ConnectionError => e
           return nil if pipeline.shutdown?
           # Assume the pipeline was sent in one piece, but execution of
@@ -190,7 +192,7 @@ class Redis
     end
 
     def connected?
-      connection && connection.connected?
+      !! (connection && connection.connected?)
     end
 
     def disconnect
@@ -388,18 +390,11 @@ class Redis
       driver = driver.to_s if driver.is_a?(Symbol)
 
       if driver.kind_of?(String)
-        case driver
-        when "ruby"
-          require "redis/connection/ruby"
-          driver = Connection::Ruby
-        when "hiredis"
-          require "redis/connection/hiredis"
-          driver = Connection::Hiredis
-        when "synchrony"
-          require "redis/connection/synchrony"
-          driver = Connection::Synchrony
-        else
-          raise "Unknown driver: #{driver}"
+        begin
+          require "redis/connection/#{driver}"
+          driver = Connection.const_get(driver.capitalize)
+        rescue LoadError, NameError
+          raise RuntimeError, "Cannot load driver #{driver.inspect}"
         end
       end
 

data/lib/redis/distributed.rb

@@ -17,8 +17,8 @@ class Redis
 
     def initialize(node_configs, options = {})
       @tag = options.delete(:tag) || /^\{(.+?)\}/
+      @ring = options.delete(:ring) || HashRing.new
       @default_options = options
-      @ring = HashRing.new
       node_configs.each { |node_config| add_node(node_config) }
       @subscribed_node = nil
     end
@@ -147,6 +147,11 @@ class Redis
       node_for(key).restore(key, ttl, serialized_value)
     end
 
+    # Transfer a key from the connected instance to another instance.
+    def migrate(key, options)
+      raise CannotDistribute, :migrate
+    end
+
     # Delete a key.
     def del(*args)
       keys_per_node = args.group_by { |key| node_for(key) }
@@ -229,8 +234,8 @@ class Redis
     end
 
     # Set the string value of a key.
-    def set(key, value)
-      node_for(key).set(key, value)
+    def set(key, value, options = {})
+      node_for(key).set(key, value, options)
     end
 
     # Set the time to live in seconds of a key.

data/lib/redis/pipeline.rb

@@ -6,6 +6,8 @@ class Redis
   end
 
   class Pipeline
+    attr_accessor :db
+
     attr :futures
 
     def initialize
@@ -38,6 +40,7 @@ class Redis
     def call_pipeline(pipeline)
       @shutdown = true if pipeline.shutdown?
       @futures.concat(pipeline.futures)
+      @db = pipeline.db
       nil
     end
 

data/lib/redis/version.rb

@@ -1,3 +1,3 @@
 class Redis
-  VERSION = "3.0.4"
+  VERSION = "3.0.5"
 end

data/test/commands_on_value_types_test.rb

@@ -96,4 +96,36 @@ class TestCommandsOnValueTypes < Test::Unit::TestCase
       assert_equal "FLUSHALL", redis.flushall
     end
   end
+
+  def test_migrate
+    redis_mock(:migrate => lambda { |*args| args }) do |redis|
+      options = { :host => "localhost", :port => 1234 }
+
+      assert_raise(RuntimeError, /host not specified/) do
+        redis.migrate("foo", options.reject { |key, _| key == :host })
+      end
+
+      assert_raise(RuntimeError, /port not specified/) do
+        redis.migrate("foo", options.reject { |key, _| key == :port })
+      end
+
+      default_db = redis.client.db.to_i
+      default_timeout = redis.client.timeout.to_i
+
+      # Test defaults
+      actual = redis.migrate("foo", options)
+      expected = ["localhost", "1234", "foo", default_db.to_s, default_timeout.to_s]
+      assert_equal expected, actual
+
+      # Test db override
+      actual = redis.migrate("foo", options.merge(:db => default_db + 1))
+      expected = ["localhost", "1234", "foo", (default_db + 1).to_s, default_timeout.to_s]
+      assert_equal expected, actual
+
+      # Test timeout override
+      actual = redis.migrate("foo", options.merge(:timeout => default_timeout + 1))
+      expected = ["localhost", "1234", "foo", default_db.to_s, (default_timeout + 1).to_s]
+      assert_equal expected, actual
+    end
+  end
 end

data/test/distributed_commands_on_value_types_test.rb

@@ -84,4 +84,12 @@ class TestDistributedCommandsOnValueTypes < Test::Unit::TestCase
 
     assert_equal [0], r.dbsize
   end
+
+  def test_migrate
+    r.set("foo", "s1")
+
+    assert_raise Redis::Distributed::CannotDistribute do
+      r.migrate("foo", {})
+    end
+  end
 end

data/test/helper.rb

@@ -149,6 +149,10 @@ module Helper
         yield _new_client(options.merge(:port => port))
       end
     end
+
+    def assert_in_range(range, value)
+      assert range.include?(value), "expected #{value} to be in #{range.inspect}"
+    end
   end
 
   module Client
@@ -166,7 +170,7 @@ module Helper
     end
 
     def _new_client(options = {})
-      Redis.new(_format_options(options))
+      Redis.new(_format_options(options).merge(:driver => ENV["conn"]))
     end
   end
 
@@ -188,7 +192,7 @@ module Helper
     end
 
     def _new_client(options = {})
-      Redis::Distributed.new(NODES, _format_options(options))
+      Redis::Distributed.new(NODES, _format_options(options).merge(:driver => ENV["conn"]))
     end
   end
 end

data/test/internals_test.rb

@@ -67,6 +67,17 @@ class TestInternals < Test::Unit::TestCase
     assert_equal 1, Redis.current.client.db
   end
 
+  def test_redis_connected?
+    fresh_client = _new_client
+    assert !fresh_client.connected?
+
+    fresh_client.ping
+    assert fresh_client.connected?
+
+    fresh_client.quit
+    assert !fresh_client.connected?
+  end
+
   def test_default_id_with_host_and_port
     redis = Redis.new(OPTIONS.merge(:host => "host", :port => "1234", :db => 0))
     assert_equal "redis://host:1234/0", redis.client.id

data/test/lint/strings.rb

@@ -47,6 +47,43 @@ module Lint
       end
     end
 
+    def test_set_with_ex
+      return if version < "2.6.12"
+
+      r.set("foo", "bar", :ex => 2)
+      assert_in_range 0..2, r.ttl("foo")
+    end
+
+    def test_set_with_px
+      return if version < "2.6.12"
+
+      r.set("foo", "bar", :px => 2000)
+      assert_in_range 0..2, r.ttl("foo")
+    end
+
+    def test_set_with_nx
+      return if version < "2.6.12"
+
+      r.set("foo", "qux", :nx => true)
+      assert !r.set("foo", "bar", :nx => true)
+      assert_equal "qux", r.get("foo")
+
+      r.del("foo")
+      assert r.set("foo", "bar", :nx => true)
+      assert_equal "bar", r.get("foo")
+    end
+
+    def test_set_with_xx
+      return if version < "2.6.12"
+
+      r.set("foo", "qux")
+      assert r.set("foo", "bar", :xx => true)
+      assert_equal "bar", r.get("foo")
+
+      r.del("foo")
+      assert !r.set("foo", "bar", :xx => true)
+    end
+
     def test_setex
       assert r.setex("foo", 1, "bar")
       assert_equal "bar", r.get("foo")

data/test/lint/value_types.rb

@@ -2,10 +2,6 @@ module Lint
 
   module ValueTypes
 
-    def assert_in_range(range, value)
-      assert range.include?(value), "expected #{value} to be in #{range.inspect}"
-    end
-
     def test_exists
       assert_equal false, r.exists("foo")
 

data/test/pipelining_commands_test.rb

@@ -204,4 +204,41 @@ class TestPipeliningCommands < Test::Unit::TestCase
 
     assert_equal "bar", r.get("foo")
   end
+
+  def test_pipeline_select
+    r.select 1
+    r.set("db", "1")
+
+    r.pipelined do |p|
+      p.select 2
+      p.set("db", "2")
+    end
+
+    r.select 1
+    assert_equal "1", r.get("db")
+
+    r.select 2
+    assert_equal "2", r.get("db")
+  end
+
+  def test_pipeline_select_client_db
+    r.select 1
+    r.pipelined do |p2|
+      p2.select 2
+    end
+
+    assert_equal 2, r.client.db
+  end
+
+  def test_nested_pipeline_select_client_db
+    r.select 1
+    r.pipelined do |p2|
+      p2.select 2
+      p2.pipelined do |p3|
+        p3.select 3
+      end
+    end
+
+    assert_equal 3, r.client.db
+  end
 end

data/test/support/redis_mock.rb

@@ -98,6 +98,11 @@ module RedisMock
           break :exit
         elsif response == :close
           break :close
+        elsif response.is_a?(Array)
+          session.write("*%d\r\n" % response.size)
+          response.each do |e|
+            session.write("$%d\r\n%s\r\n" % [e.length, e])
+          end
         else
           session.write(response)
           session.write("\r\n") unless response.end_with?("\r\n")

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis
 version: !ruby/object:Gem::Version
-  version: 3.0.4
-  prerelease: 
+  version: 3.0.5
 platform: ruby
 authors:
 - Ezra Zygmuntowicz
@@ -17,12 +16,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +28,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -141,27 +138,26 @@ files:
 - test/url_param_test.rb
 homepage: https://github.com/redis/redis-rb
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby client library for Redis
 test_files:
 - test/blocking_commands_test.rb