redis 3.3.5 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 729f56810aa501065e2fc203050363713c80ee37
-  data.tar.gz: e7e13fb75618f794a2c742d73d6c8a72699d5e92
+  metadata.gz: 1ec178932a6874e8ac7a4f6cfa4390c8223367ec
+  data.tar.gz: 986e6c5d1729b9ec8f7d66900e5d9ad9437e29f9
 SHA512:
-  metadata.gz: f87e76c751760b7f1feb7c859ea373c41ebf805c104c27e85177cb20a60d42b11c50db2d5a916fb7bfc78b82b13141770a851568aea922ccc1970f4e30ba1dea
-  data.tar.gz: ac4cb236c9c9897d73ead9421e161cf1c7aac2a3c1f77c088b5c52c324cddccda6ab749441093cbcc94ea812e70232f9f9ac1c160a96fd1fbd46d87586d1d7fb
+  metadata.gz: 14db8cb42f08014ebd942c39b5f119a68a8ec50fec046572bb3afc7708634589311b9bea0d4153bfd1d7cb1c46a94a00d77613872b2cb8c10c33f132755cd62d
+  data.tar.gz: efe0db683450fcb30b6d23b8c9448d6925b5c5d95b847f9563405a61cc7e667bbf8aea22642dcc9d8a1b716dc9c8cb55c562c86a08223e020991f69eff7df7f7

data/.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 /tmp/
 /.idea
 /.yardoc
+/.bundle
 /coverage/*
 /doc/
 /examples/sentinel/sentinel.conf
@@ -14,3 +15,5 @@ Gemfile.lock
 /redis/*
 /test/db
 /test/test.conf
+appendonly.aof
+temp-rewriteaof-*.aof

data/.travis/Gemfile

@@ -2,10 +2,17 @@ source "https://rubygems.org"
 
 gemspec :path => "../"
 
-case ENV["conn"]
+# Using jruby-openssl 0.10.0, we get NPEs in jruby tests: https://github.com/redis/redis-rb/issues/756
+platform :jruby do
+  gem 'jruby-openssl', '<0.10.0'
+end
+
+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,59 @@
 language: ruby
+cache:
+    directories:
+      - tmp/cache
+before_install:
+  - gem update --system 2.6.14
+  - gem --version
+
+script: make
 
 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
+  - 2.5.0
+  - jruby-9.1.17.0
 
 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
+    - TIMEOUT=9
   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=4.0
 
 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
-      gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.0
-    - rvm: jruby-19mode
-      gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.2
-    - rvm: jruby-9.0.5.0
-      gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.0
-    - rvm: jruby-9.0.5.0
-      gemfile: .travis/Gemfile
-      env: conn=hiredis REDIS_BRANCH=3.2
+    - rvm: jruby-9.1.17.0
+      env: DRIVER=hiredis   REDIS_BRANCH=3.0
+    - rvm: jruby-9.1.17.0
+      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
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.0
-    - rvm: jruby-19mode
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.2
-    - rvm: jruby-9.0.5.0
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.0
-    - rvm: jruby-9.0.5.0
-      gemfile: .travis/Gemfile
-      env: conn=synchrony REDIS_BRANCH=3.2
-  allow_failures:
-    - rvm: rbx-2
+    - rvm: jruby-9.1.17.0
+      env: DRIVER=synchrony REDIS_BRANCH=3.0
+    - rvm: jruby-9.1.17.0
+      env: DRIVER=synchrony REDIS_BRANCH=3.2
 
 notifications:
   irc:

data/CHANGELOG.md

@@ -1,8 +1,51 @@
+# 4.0.3
+
+* Fix raising command error for first command in pipeline. See #788.
+* Fix the gemspec to stop exposing a `build` executable. See #785.
+* Add `:reconnect_delay` and `:reconnect_delay_max` options. See #778.
+
+# 4.0.2
+
+* Added `Redis#unlink`. See #766.
+
+* `Redis.new` now accept a custom connector via `:connector`. See #591.
+
+* `Redis#multi` no longer perform empty transactions. See #747.
+
+* `Redis#hdel` now accepts hash keys as multiple arguments like `#del`. See #755.
+
+* Allow to skip SSL verification. See #745.
+
+* Add Geo commands: `geoadd`, `geohash`, `georadius`, `georadiusbymember`, `geopos`, `geodist`. See #730.
+
+# 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.5
 
 * Fixed Ruby 1.8 compatibility after backporting `Redis#connection`. See #719.
 
-# 3.3.4
+# 3.3.4 (yanked)
 
 * `Redis#connection` returns a hash with connection information.
   You shouldn't need to call `Redis#_client`, ever.
@@ -13,7 +56,7 @@
 
 # 3.3.2
 
-* Added support for SPOP with COUNT. See #628.
+* Added support for `SPOP` with COUNT. See #628.
 
 * Fixed connection glitches when using SSL. See #644.
 

data/Gemfile

@@ -1,4 +1,8 @@
-# encoding: utf-8
 source 'https://rubygems.org'
 
 gemspec
+
+# Using jruby-openssl 0.10.0, we get NPEs in jruby tests: https://github.com/redis/redis-rb/issues/756
+platform :jruby do
+  gem 'jruby-openssl', '<0.10.0'
+end

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
@@ -211,7 +176,7 @@ it can't connect to the server a `Redis::CannotConnectError` error will be raise
 ```ruby
 begin
   redis.ping
-rescue Exception => e
+rescue StandardError => e
   e.inspect
 # => #<Redis::CannotConnectError: Timed out connecting to Redis on 10.0.1.1:6380>
 
@@ -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/bin/build

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+TARBALL = ARGV[0]
+
+require 'digest/sha1'
+require 'fileutils'
+
+class Builder
+  def initialize(redis_branch, tmp_dir)
+    @redis_branch = redis_branch
+    @tmp_dir = tmp_dir
+    @build_dir = File.join(@tmp_dir, "cache", "redis-#{redis_branch}")
+  end
+
+  def run
+    download_tarball
+    if old_checkum != checksum
+      build
+      update_checksum
+    end
+    0
+  end
+
+  def download_tarball
+    command!('wget', tarball_url, '-O', tarball_path)
+  end
+
+  def tarball_path
+    File.join(@tmp_dir, "redis-#{@redis_branch}.tar.gz")
+  end
+
+  def tarball_url
+    "https://github.com/antirez/redis/archive/#{@redis_branch}.tar.gz"
+  end
+
+  def build
+    FileUtils.rm_rf(@build_dir)
+    FileUtils.mkdir_p(@build_dir)
+    command!('tar', 'xf', tarball_path, '-C', File.expand_path('../', @build_dir))
+    Dir.chdir(@build_dir) do
+      command!('make')
+    end
+  end
+
+  def update_checksum
+    File.write(checksum_path, checksum)
+  end
+
+  def old_checkum
+    File.read(checksum_path)
+  rescue Errno::ENOENT
+    nil
+  end
+
+  def checksum_path
+    File.join(@build_dir, 'build.checksum')
+  end
+
+  def checksum
+    @checksum ||= Digest::SHA1.file(tarball_path).hexdigest
+  end
+
+  def command!(*args)
+    puts "$ #{args.join(' ')}"
+    unless system(*args)
+      raise "Command failed with status #{$?.exitstatus}"
+    end
+  end
+end
+
+exit Builder.new(ARGV[0], ARGV[1]).run

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"
 
@@ -18,12 +18,12 @@ class Redis
       :id => nil,
       :tcp_keepalive => 0,
       :reconnect_attempts => 1,
+      :reconnect_delay => 0,
+      :reconnect_delay_max => 0.5,
       :inherit_socket => false
     }
 
-    def options
-      Marshal.load(Marshal.dump(@options))
-    end
+    attr_reader :options
 
     def scheme
       @options[:scheme]
@@ -86,11 +86,14 @@ class Redis
 
       @pending_reads = 0
 
-      if options.include?(:sentinels)
-        @connector = Connector::Sentinel.new(@options)
-      else
-        @connector = Connector.new(@options)
-      end
+      @connector =
+        if options.include?(:sentinels)
+          Connector::Sentinel.new(@options)
+        elsif options.include?(:connector) && options[:connector].respond_to?(:new)
+          options.delete(:connector).new(@options)
+        else
+          Connector.new(@options)
+        end
     end
 
     def connect
@@ -152,9 +155,12 @@ class Redis
     end
 
     def call_pipeline(pipeline)
+      commands = pipeline.commands
+      return [] if commands.empty?
+
       with_reconnect pipeline.with_reconnect? do
         begin
-          pipeline.finish(call_pipelined(pipeline.commands)).tap do
+          pipeline.finish(call_pipelined(commands)).tap do
             self.db = pipeline.db if pipeline.db
           end
         rescue ConnectionError => e
@@ -185,13 +191,10 @@ class Redis
         exception = nil
 
         process(commands) do
-          result[0] = read
-
-          @reconnect = false
-
-          (commands.size - 1).times do |i|
+          commands.size.times do |i|
             reply = read
-            result[i + 1] = reply
+            result[i] = reply
+            @reconnect = false
             exception = reply if exception.nil? && reply.is_a?(CommandError)
           end
         end
@@ -336,10 +339,12 @@ class Redis
       @connection = @options[:driver].connect(@options)
       @pending_reads = 0
     rescue TimeoutError,
+           SocketError,
            Errno::ECONNREFUSED,
            Errno::EHOSTDOWN,
            Errno::EHOSTUNREACH,
            Errno::ENETUNREACH,
+           Errno::ENOENT,
            Errno::ETIMEDOUT
 
       raise CannotConnectError, "Error connecting to Redis on #{location} (#{$!.class})"
@@ -369,6 +374,10 @@ class Redis
         disconnect
 
         if attempts <= @options[:reconnect_attempts] && @reconnect
+          sleep_t = [(@options[:reconnect_delay] * 2**(attempts-1)),
+                     @options[:reconnect_delay_max]].min
+
+          Kernel.sleep(sleep_t)
           retry
         else
           raise
@@ -445,6 +454,10 @@ class Redis
       options[:read_timeout]    = Float(options[:read_timeout])
       options[:write_timeout]   = Float(options[:write_timeout])
 
+      options[:reconnect_attempts] = options[:reconnect_attempts].to_i
+      options[:reconnect_delay] = options[:reconnect_delay].to_f
+      options[:reconnect_delay_max] = options[:reconnect_delay_max].to_f
+
       options[:db] = options[:db].to_i
       options[:driver] = _parse_driver(options[:driver]) || Connection.drivers.last
 
@@ -478,11 +491,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