redis 3.3.1 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4744291b8bc26230044fc12c456951a60c5802c7
-  data.tar.gz: 6eabe9bb60b74aa2408007a72f9a44e831b71a5e
+  metadata.gz: 7e0d0ba2328aca583c0f487729779c2b10b12c7b
+  data.tar.gz: 4a411cfa3512bafe7c2c12ac8a02c02bc87065aa
 SHA512:
-  metadata.gz: 7fb460a3595ed430dbf4dab6f516dcbef029cf1c72350e4e50b7e425e8d94b8d47760d33f58db21bad95852ec97fa7fdba55cfb0858292c221c947516a291f97
-  data.tar.gz: 7cdf461c39d5eede9b295bf987391cd70461cd5adcee945ae243d509f67457ea14aa0ad08ca47efdab8bb8ca315d6bdff94460d6cecc6b981f459081cd93dfbd
+  metadata.gz: 3af7dc63dc7bdc243da306817583db9b6989c21a0714c6652b4a443bfd9c46b2afba0707b028d708a74148bbeedd09d4ec207a0459b3559cb19b95f2f030bb07
+  data.tar.gz: 98d5aed456ebcd3ccdc50980879a3c14be4c8a1874c6febae95579d2fb3828bda2e82b05e62dc6a4966e178993d4a2a20dc3dedd9f8583cd731851eab2f8e164

data/.travis/Gemfile

@@ -2,10 +2,12 @@ source "https://rubygems.org"
 
 gemspec :path => "../"
 
-case ENV["conn"]
+case ENV["DRIVER"]
 when "hiredis"
   gem "hiredis"
 when "synchrony"
   gem "hiredis"
   gem "em-synchrony"
 end
+
+gem 'test-unit', '>= 3.2.5'

data/.travis.yml

@@ -1,87 +1,71 @@
 language: ruby
 
+script: make test
+
 rvm:
-  - 1.8.7
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - jruby-18mode
-  - jruby-19mode
-  - jruby-9.0.5.0
-  - rbx-2
+  - 2.2.2
+  - 2.3.3
+  - 2.4.1
+  - jruby-9
+  - rbx-3
 
 gemfile: ".travis/Gemfile"
 
 sudo: false
 
+before_script:
+- if (ruby -e "exit RUBY_VERSION.to_f >= 2.4"); then export RUBYOPT="--enable-frozen-string-literal"; fi; echo $RUBYOPT
+
 env:
   global:
     - VERBOSE=true
     - TIMEOUT=1
   matrix:
-    - conn=ruby      REDIS_BRANCH=3.0
-    - conn=ruby      REDIS_BRANCH=3.2
-    - conn=hiredis   REDIS_BRANCH=3.0
-    - conn=hiredis   REDIS_BRANCH=3.2
-    - conn=synchrony REDIS_BRANCH=3.0
-    - conn=synchrony REDIS_BRANCH=3.2
-    - conn=ruby      REDIS_BRANCH=unstable
+    - DRIVER=ruby      REDIS_BRANCH=3.0
+    - DRIVER=ruby      REDIS_BRANCH=3.2
+    - DRIVER=hiredis   REDIS_BRANCH=3.0
+    - DRIVER=hiredis   REDIS_BRANCH=3.2
+    - DRIVER=synchrony REDIS_BRANCH=3.0
+    - DRIVER=synchrony REDIS_BRANCH=3.2
+    - DRIVER=ruby      REDIS_BRANCH=unstable
 
 branches:
   only:
+    - staging
+    - trying
     - master
 
 matrix:
   exclude:
     # hiredis
-    - rvm: jruby-18mode
-      gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.0
-    - rvm: jruby-18mode
-      gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.2
-    - rvm: jruby-19mode
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.0
-    - rvm: jruby-19mode
+      env: DRIVER=hiredis REDIS_BRANCH=3.0
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.2
-    - rvm: jruby-9.0.5.0
+      env: DRIVER=hiredis REDIS_BRANCH=3.2
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.0
-    - rvm: jruby-9.0.5.0
+      env: DRIVER=hiredis REDIS_BRANCH=3.0
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.2
+      env: DRIVER=hiredis REDIS_BRANCH=3.2
 
     # synchrony
-    - rvm: 1.8.7
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.0
-    - rvm: 1.8.7
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.2
-    - rvm: jruby-18mode
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.0
-    - rvm: jruby-18mode
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.2
-    - rvm: jruby-19mode
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.0
-    - rvm: jruby-19mode
+      env: DRIVER=synchrony REDIS_BRANCH=3.0
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.2
-    - rvm: jruby-9.0.5.0
+      env: DRIVER=synchrony REDIS_BRANCH=3.2
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.0
-    - rvm: jruby-9.0.5.0
+      env: DRIVER=synchrony REDIS_BRANCH=3.0
+    - rvm: jruby-9
       gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.2
+      env: DRIVER=synchrony REDIS_BRANCH=3.2
   allow_failures:
-    - rvm: rbx-2
+    - rvm: rbx-3
 
 notifications:
   irc:

data/CHANGELOG.md

@@ -1,16 +1,35 @@
-# 4.x (unreleased)
-
-## Planned breaking changes:
-* `Redis#client` will no longer expose the underlying `Redis::Client`;
-  it has not yet been determined how 4.0 will expose the underlying
-  functionality, but we will make every attempt to provide a final minor
-  release of 3.x that provides the new interfaces in order to facilitate
-  a smooth transition.
-
-* Ruby 1.8.7 (and the 1.8 modes of JRuby and Rubinius) will no longer be
-  supported; 1.8.x entered end-of-life in June of 2012 and stopped receiving
-  security updates in June of 2013; continuing to support it would prevent
-  the use of newer features of Ruby.
+# 4.0.1
+
+* `Redis::Distributed` now supports `mget` and `mapped_mget`. See #687.
+
+* `Redis::Distributed` now supports `sscan` and `sscan_each`. See #572.
+
+* `Redis#connection` returns a hash with connection information.
+  You shouldn't need to call `Redis#_client`, ever.
+
+* `Redis#flushdb` and `Redis#flushall` now support the `:async` option. See #706.
+
+
+# 4.0
+
+* Removed `Redis.connect`. Use `Redis.new`.
+
+* Removed `Redis#[]` and `Redis#[]=` aliases.
+
+* Added support for `CLIENT` commands. The lower-level client can be
+  accessed via `Redis#_client`.
+
+* Dropped official support for Ruby < 2.2.2.
+
+# 3.3.3
+
+* Improved timeout handling after dropping Timeout module.
+
+# 3.3.2
+
+* Added support for `SPOP` with COUNT. See #628.
+
+* Fixed connection glitches when using SSL. See #644.
 
 # 3.3.1
 

data/Gemfile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,46 +1,17 @@
 # redis-rb [![Build Status][travis-image]][travis-link] [![Inline docs][inchpages-image]][inchpages-link]
 
-[travis-image]: https://secure.travis-ci.org/redis/redis-rb.png?branch=master
-[travis-link]: http://travis-ci.org/redis/redis-rb
-[travis-home]: http://travis-ci.org/
-[inchpages-image]: http://inch-ci.org/github/redis/redis-rb.png
-[inchpages-link]: http://inch-ci.org/github/redis/redis-rb
+A Ruby client that tries to match [Redis][redis-home]' API one-to-one, while still
+providing an idiomatic interface.
 
-A Ruby client library for [Redis][redis-home].
-
-[redis-home]: http://redis.io
-
-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.
-
-## Upgrading from 2.x to 3.0
-
-Please refer to the [CHANGELOG][changelog-3.0.0] for a summary of the
-most important changes, as well as a full list of changes.
-
-[changelog-3.0.0]: https://github.com/redis/redis-rb/blob/master/CHANGELOG.md#300
 
 ## Getting started
 
-To install **redis-rb**, run the following command:
-
-```
-  gem install redis
-```
-
-Or if you are using **bundler**, add
+Install with:
 
 ```
-  gem 'redis', '~>3.2'
+$ gem install redis
 ```
 
-to your `Gemfile`, and run `bundle install`
-
-As of version 2.0 this client only targets Redis version 2.0 and higher.
-You can use an older version of this client if you need to interface
-with a Redis instance older than 2.0, but this is no longer supported.
-
 You can connect to Redis by instantiating the `Redis` class:
 
 ```ruby
@@ -54,17 +25,15 @@ listening on `localhost`, port 6379. If you need to connect to a remote
 server or a different port, try:
 
 ```ruby
-redis = Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
+redis = Redis.new(host: "10.0.1.1", port: 6380, db: 15)
 ```
 
 You can also specify connection options as a [`redis://` URL][redis-url]:
 
 ```ruby
-redis = Redis.new(:url => "redis://:p4ssw0rd@10.0.1.1:6380/15")
+redis = Redis.new(url: "redis://:p4ssw0rd@10.0.1.1:6380/15")
 ```
 
-[redis-url]: http://www.iana.org/assignments/uri-schemes/prov/redis
-
 By default, the client will try to read the `REDIS_URL` environment variable
 and use that as URL to connect to. The above statement is therefore equivalent
 to setting this environment variable and calling `Redis.new` without arguments.
@@ -72,13 +41,13 @@ to setting this environment variable and calling `Redis.new` without arguments.
 To connect to Redis listening on a Unix socket, try:
 
 ```ruby
-redis = Redis.new(:path => "/tmp/redis.sock")
+redis = Redis.new(path: "/tmp/redis.sock")
 ```
 
 To connect to a password protected Redis instance, use:
 
 ```ruby
-redis = Redis.new(:password => "mysecret")
+redis = Redis.new(password: "mysecret")
 ```
 
 The Redis class exports methods that are named identical to the commands
@@ -86,8 +55,6 @@ they execute. The arguments these methods accept are often identical to
 the arguments specified on the [Redis website][redis-commands]. For
 instance, the `SET` and `GET` commands can be called like this:
 
-[redis-commands]: http://redis.io/commands
-
 ```ruby
 redis.set("mykey", "hello world")
 # => "OK"
@@ -96,24 +63,22 @@ redis.get("mykey")
 # => "hello world"
 ```
 
-All commands, their arguments and return values are documented, and
-available on [rdoc.info][rdoc].
-
-[rdoc]: http://rdoc.info/github/redis/redis-rb/
+All commands, their arguments, and return values are documented and
+available on [RubyDoc.info][rubydoc].
 
 ## Sentinel support
 
-The client is able to perform automatic failovers by using [Redis
+The client is able to perform automatic failover by using [Redis
 Sentinel](http://redis.io/topics/sentinel).  Make sure to run Redis 2.8+
 if you want to use this feature.
 
 To connect using Sentinel, use:
 
 ```ruby
-SENTINELS = [{:host => "127.0.0.1", :port => 26380},
-             {:host => "127.0.0.1", :port => 26381}]
+SENTINELS = [{ host: "127.0.0.1", port: 26380 },
+             { host: "127.0.0.1", port: 26381 }]
 
-redis = Redis.new(:url => "redis://mymaster", :sentinels => SENTINELS, :role => :master)
+redis = Redis.new(url: "redis://mymaster", sentinels: SENTINELS, role: :master)
 ```
 
 * The master name identifies a group of Redis instances composed of a master
@@ -374,37 +339,28 @@ redis = Redis.new(:driver => :synchrony)
 
 ## Testing
 
-This library is tested using [Travis][travis-home], where it is tested
-against the following interpreters and drivers:
-
-* MRI 1.8.7 (drivers: ruby, hiredis)
-* MRI 1.9.3 (drivers: ruby, hiredis, synchrony)
-* MRI 2.0 (drivers: ruby, hiredis, synchrony)
-* MRI 2.1 (drivers: ruby, hiredis, synchrony)
-* MRI 2.2 (drivers: ruby, hiredis, synchrony)
-* MRI 2.3 (drivers: ruby, hiredis, synchrony)
-* JRuby 1.7 (1.8 mode) (drivers: ruby)
-* JRuby 1.7 (1.9 mode) (drivers: ruby)
+This library is tested against recent Ruby and Redis versions.
+Check [Travis][travis-link] for the exact versions supported.
 
 ## Contributors
 
-(ordered chronologically with more than 5 commits, see `git shortlog -sn` for
-all contributors)
-
-* Ezra Zygmuntowicz
-* Taylor Weibley
-* Matthew Clark
-* Brian McKinney
-* Luca Guidi
-* Salvatore Sanfilippo
-* Chris Wanstrath
-* Damian Janowski
-* Michel Martens
-* Nick Quaranto
-* Pieter Noordhuis
-* Ilya Grigorik
+Several people contributed to redis-rb, but we would like to especially
+mention Ezra Zygmuntowicz. Ezra introduced the Ruby community to many
+new cool technologies, like Redis. He wrote the first version of this
+client and evangelized Redis in Rubyland. Thank you, Ezra.
 
 ## Contributing
 
 [Fork the project](https://github.com/redis/redis-rb) and send pull
 requests. You can also ask for help at `#redis-rb` on Freenode.
+
+
+[inchpages-image]: https://inch-ci.org/github/redis/redis-rb.svg
+[inchpages-link]:  https://inch-ci.org/github/redis/redis-rb
+[redis-commands]:  https://redis.io/commands
+[redis-home]:      https://redis.io
+[redis-url]:       http://www.iana.org/assignments/uri-schemes/prov/redis
+[travis-home]:     https://travis-ci.org/
+[travis-image]:    https://secure.travis-ci.org/redis/redis-rb.svg?branch=master
+[travis-link]:     https://travis-ci.org/redis/redis-rb
+[rubydoc]:         http://www.rubydoc.info/gems/redis

data/benchmarking/logging.rb

@@ -54,7 +54,7 @@ benchmark "Default options (no logger)" do
 end
 
 logging_redises.each do |redis|
-  logger = redis.client.logger
+  logger = redis._client.logger
 
   case logger
   when Logger

data/bors.toml

@@ -0,0 +1,14 @@
+# Gate on Travis CI
+status = ["continuous-integration/travis-ci/push"]
+
+# Set bors's timeout to 6 hours
+#
+# bors's timeout should always be twice a long as the test suite takes.
+# This is to allow Travis to fast-fail a test; if one of the builders
+# immediately reports a failure, then bors will move on to the next batch,
+# leaving the slower builders to work through the already-doomed run and
+# the next one.
+#
+# At the time it was written, a run had taken 3 hours.
+# bors's default timeout is 4 hours.
+timeout_sec = 14400

data/lib/redis/client.rb

@@ -1,4 +1,4 @@
-require "redis/errors"
+require_relative "errors"
 require "socket"
 require "cgi"
 
@@ -21,9 +21,7 @@ class Redis
       :inherit_socket => false
     }
 
-    def options
-      Marshal.load(Marshal.dump(@options))
-    end
+    attr_reader :options
 
     def scheme
       @options[:scheme]
@@ -340,6 +338,7 @@ class Redis
            Errno::EHOSTDOWN,
            Errno::EHOSTUNREACH,
            Errno::ENETUNREACH,
+           Errno::ENOENT,
            Errno::ETIMEDOUT
 
       raise CannotConnectError, "Error connecting to Redis on #{location} (#{$!.class})"
@@ -451,12 +450,12 @@ class Redis
       case options[:tcp_keepalive]
       when Hash
         [:time, :intvl, :probes].each do |key|
-          unless options[:tcp_keepalive][key].is_a?(Fixnum)
-            raise "Expected the #{key.inspect} key in :tcp_keepalive to be a Fixnum"
+          unless options[:tcp_keepalive][key].is_a?(Integer)
+            raise "Expected the #{key.inspect} key in :tcp_keepalive to be an Integer"
           end
         end
 
-      when Fixnum
+      when Integer
         if options[:tcp_keepalive] >= 60
           options[:tcp_keepalive] = {:time => options[:tcp_keepalive] - 20, :intvl => 10, :probes => 2}
 
@@ -478,11 +477,16 @@ class Redis
 
       if driver.kind_of?(String)
         begin
-          require "redis/connection/#{driver}"
-          driver = Connection.const_get(driver.capitalize)
-        rescue LoadError, NameError
-          raise RuntimeError, "Cannot load driver #{driver.inspect}"
+          require_relative "connection/#{driver}"
+        rescue LoadError, NameError => e
+          begin
+            require "connection/#{driver}"
+          rescue LoadError, NameError => e
+            raise RuntimeError, "Cannot load driver #{driver.inspect}: #{e.message}"
+          end
         end
+
+        driver = Connection.const_get(driver.capitalize)
       end
 
       driver

data/lib/redis/connection/command_helper.rb

@@ -30,14 +30,8 @@ class Redis
 
     protected
 
-      if defined?(Encoding::default_external)
-        def encode(string)
-          string.force_encoding(Encoding::default_external)
-        end
-      else
-        def encode(string)
-          string
-        end
+      def encode(string)
+        string.force_encoding(Encoding.default_external)
       end
     end
   end

data/lib/redis/connection/hiredis.rb

@@ -1,5 +1,5 @@
-require "redis/connection/registry"
-require "redis/errors"
+require_relative "registry"
+require_relative "../errors"
 require "hiredis/connection"
 require "timeout"
 

data/lib/redis/connection/ruby.rb

@@ -1,6 +1,6 @@
-require "redis/connection/registry"
-require "redis/connection/command_helper"
-require "redis/errors"
+require_relative "registry"
+require_relative "command_helper"
+require_relative "../errors"
 require "socket"
 require "timeout"
 
@@ -10,31 +10,17 @@ rescue LoadError
   # Not all systems have OpenSSL support
 end
 
-if RUBY_VERSION < "1.9.3"
-  class String
-    # Ruby 1.8.7 does not have byteslice, but it handles encodings differently anyway.
-    # We can simply slice the string, which is a byte array there.
-    def byteslice(*args)
-      slice(*args)
-    end
-  end
-end
-
 class Redis
   module Connection
     module SocketMixin
 
       CRLF = "\r\n".freeze
 
-      # Exceptions raised during non-blocking I/O ops that require retrying the op
-      NBIO_EXCEPTIONS = [Errno::EWOULDBLOCK, Errno::EAGAIN]
-      NBIO_EXCEPTIONS << IO::WaitReadable if RUBY_VERSION >= "1.9.3"
-
       def initialize(*args)
         super(*args)
 
         @timeout = @write_timeout = nil
-        @buffer = ""
+        @buffer = "".dup
       end
 
       def timeout=(timeout)
@@ -78,12 +64,18 @@ class Redis
         begin
           read_nonblock(nbytes)
 
-        rescue *NBIO_EXCEPTIONS
+        rescue IO::WaitReadable
           if IO.select([self], nil, nil, @timeout)
             retry
           else
             raise Redis::TimeoutError
           end
+        rescue IO::WaitWritable
+          if IO.select(nil, [self], nil, @timeout)
+            retry
+          else
+            raise Redis::TimeoutError
+          end
         end
 
       rescue EOFError
@@ -94,12 +86,18 @@ class Redis
         begin
           write_nonblock(data)
 
-        rescue *NBIO_EXCEPTIONS
+        rescue IO::WaitWritable
           if IO.select(nil, [self], nil, @write_timeout)
             retry
           else
             raise Redis::TimeoutError
           end
+        rescue IO::WaitReadable
+          if IO.select([self], nil, nil, @write_timeout)
+            retry
+          else
+            raise Redis::TimeoutError
+          end
         end
 
       rescue EOFError

data/lib/redis/connection/synchrony.rb

@@ -1,6 +1,6 @@
-require "redis/connection/command_helper"
-require "redis/connection/registry"
-require "redis/errors"
+require_relative "command_helper"
+require_relative "registry"
+require_relative "../errors"
 require "em-synchrony"
 require "hiredis/reader"
 
@@ -72,7 +72,15 @@ class Redis
 
       def self.connect(config)
         if config[:scheme] == "unix"
-          conn = EventMachine.connect_unix_domain(config[:path], RedisClient)
+          begin
+            conn = EventMachine.connect_unix_domain(config[:path], RedisClient)
+          rescue RuntimeError => e
+            if e.message == "no connection"
+              raise Errno::ECONNREFUSED
+            else
+              raise e
+            end
+          end
         elsif config[:scheme] == "rediss" || config[:ssl]
           raise NotImplementedError, "SSL not supported by synchrony driver"
         else

data/lib/redis/connection.rb

@@ -1,4 +1,4 @@
-require "redis/connection/registry"
+require_relative "connection/registry"
 
 # If a connection driver was required before this file, the array
 # Redis::Connection.drivers will contain one or more classes. The last driver
@@ -6,4 +6,4 @@ require "redis/connection/registry"
 # the plain Ruby driver as our default. Another driver can be required at a
 # later point in time, causing it to be the last element of the #drivers array
 # and therefore be chosen by default.
-require "redis/connection/ruby" if Redis::Connection.drivers.empty?
+require_relative "connection/ruby" if Redis::Connection.drivers.empty?