redis-store 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 343594d8b51298be4a1d5c015a64d04fe1939c12
-  data.tar.gz: 3ee360fae5b291f77f56175cc34e18e635af655d
+SHA256:
+  metadata.gz: 10e6007fb1a0708fe88d7627a23a2b5e8e0303e9ee81ec886d27a5c6fdb7ed07
+  data.tar.gz: 9415f933dae0284fe8114cf6d350561bc23c58bcf9f1182d734f36fdf8436707
 SHA512:
-  metadata.gz: '0906711b266addefc485ddad054c70eb1d25ccfdc8162c9c9225229d1e26be1c66361ef1704a86e8e7e17419ef961c6aec3c85156275794f956921964b599c2e'
-  data.tar.gz: 4aa88e8de4f00b29e20dd4f93bbaf4f21a18850e6cedebfb93fcbb3b98190b2cc2fd327f4aceb8dc24c66896f66095a24706b94fec31eff078ecd6440e2a9a7c
+  metadata.gz: 69a4d72561bf0b9da2c88cc7a32d37a7ca06bb758a60d338bc4c12added10c1549f818f6e0e68af3854e0911a92f591c3c3094455d731f7a48d1cb1b47a9a700
+  data.tar.gz: da5fee4e7926a6032ca82fa7ee924c0a676124bffb55c84d5f553f066eb0ca47678cad583403ccc5979d04b7ddcdeb98652edf906472db364713baf483bc64e3

data/.gitignore

@@ -2,3 +2,5 @@ Gemfile.lock
 *.gem
 tmp/
 stdout
+# Gemfile locks generated by Appraisals
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -1,19 +1,35 @@
 language: ruby
 sudo: false
 cache: bundler
+notifications:
+  webhooks: https://www.travisbuddy.com
+  on_success: never
+
+# 1.9.3 has Bundler 1.7.6 with the "undefined method `spec' for nil" bug
 before_install: gem install bundler
-script: 'bundle exec rake'
+
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3
+  - 2.4
   - ruby-head
   - jruby-head
-bundler_args: '--path vendor/bundle'
+
+gemfile:
+  - gemfiles/redis_3_x.gemfile
+  - gemfiles/redis_4_x.gemfile
 
 matrix:
   allow_failures:
     - rvm: jruby-head
     - rvm: ruby-head
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/redis_4_x.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/redis_4_x.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/redis_4_x.gemfile

data/Appraisals

@@ -0,0 +1,8 @@
+
+appraise "redis_3_x" do
+  gem "redis", "~> 3.0"
+end
+
+appraise "redis_4_x" do
+  gem "redis", "~> 4.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 1.5.0
+
+Breaking Changes
+
+* None
+
+Added
+
+* [Support for Redis v4 and above](https://github.com/redis-store/redis-store/pull/292)
+* [Support for distributed mget/read_multi in Redis v4](https://github.com/redis-store/redis-store/pull/282)
+* [Tests for Namespace#flushdb](https://github.com/redis-store/redis-store/pull/299)
+* [Support for UNIX Socket path connections](https://github.com/redis-store/redis-store/pull/298)
+* [HashRing configuration for DistributedStore](https://github.com/redis-store/redis-store/pull/304)
+
+Fixed
+
+* [Inefficient use of KEYS when calling FLUSHDB without a namespace](https://github.com/redis-store/redis-store/pull/297)
+
 ## 1.4.1
 
 Breaking Changes

data/Gemfile

@@ -1,2 +1,7 @@
 source 'https://rubygems.org'
+
+if RUBY_VERSION < '2'
+  gem 'redis', '< 4'
+end
+
 gemspec

data/Rakefile

@@ -2,3 +2,11 @@ require 'bundler/setup'
 require 'rake'
 require 'bundler/gem_tasks'
 require 'redis-store/testing/tasks'
+require 'appraisal'
+
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default do
+    sh "appraisal install && rake appraisal default"
+  end
+end

data/gemfiles/redis_3_x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redis", "~> 3.0"
+
+gemspec path: "../"

data/gemfiles/redis_4_x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redis", "~> 4.0"
+
+gemspec path: "../"

data/lib/redis/distributed_store.rb

@@ -6,12 +6,12 @@ class Redis
     attr_reader :ring
 
     def initialize(addresses, options = { })
-      nodes = addresses.map do |address|
-        ::Redis::Store.new _merge_options(address, options)
-      end
-
       _extend_namespace options
-      @ring = Redis::HashRing.new nodes
+      @ring = options[:ring] || Redis::HashRing.new([], options[:replicas] || Redis::HashRing::POINTS_PER_SERVER)
+
+      addresses.each do |address|
+        @ring.add_node(::Redis::Store.new _merge_options(address, options))
+      end
     end
 
     def nodes

data/lib/redis/store.rb

@@ -42,8 +42,17 @@ class Redis
     end
 
     def to_s
-      h = @client.host
-      "Redis Client connected to #{/:/ =~ h ? '['+h+']' : h}:#{@client.port} against DB #{@client.db}"
+      "Redis Client connected to #{location} against DB #{@client.db}"
+    end
+
+    def location
+      if @client.path
+        @client.path
+      else
+        h = @client.host
+        h = "[#{h}]" if h.include?(":")
+        "#{h}:#{@client.port}"
+      end
     end
 
     private

data/lib/redis/store/factory.rb

@@ -62,27 +62,33 @@ class Redis
       end
 
       def self.host_options?(options)
-        if options.keys.any? {|n| [:host, :db, :port].include?(n) }
-          options
-        else
-          nil # just to be clear
-        end
+        options.keys.any? {|n| [:host, :db, :port, :path].include?(n) }
       end
 
       def self.extract_host_options_from_uri(uri)
         uri = URI.parse(uri)
-        _, db, namespace = if uri.path
-                             uri.path.split(/\//)
-                           end
-
-        options = {
-          :host     => uri.hostname,
-          :port     => uri.port || DEFAULT_PORT, 
-          :password => uri.password.nil? ? nil : CGI::unescape(uri.password.to_s)
-        }
-
-        options[:db]        = db.to_i   if db
-        options[:namespace] = namespace if namespace
+        if uri.scheme == "unix"
+          options = { :path => uri.path }
+        else
+          _, db, namespace = if uri.path
+                               uri.path.split(/\//)
+                             end
+
+          options = {
+            :host     => uri.hostname,
+            :port     => uri.port || DEFAULT_PORT,
+            :password => uri.password.nil? ? nil : CGI::unescape(uri.password.to_s)
+          }
+
+          options[:db]        = db.to_i   if db
+          options[:namespace] = namespace if namespace
+        end
+        if uri.query
+          query = Hash[URI.decode_www_form(uri.query)]
+          query.each do |(key, value)|
+            options[key.to_sym] = value
+          end
+        end
 
         options
       end

data/lib/redis/store/namespace.rb

@@ -47,14 +47,14 @@ class Redis
         super(*keys.map {|key| interpolate(key) }) if keys.any?
       end
 
-      def mget(*keys)
+      def mget(*keys, &blk)
         options = (keys.pop if keys.last.is_a? Hash) || {}
         if keys.any?
           # Serialization gets extended before Namespace does, so we need to pass options further
           if singleton_class.ancestors.include? Serialization
-            super(*keys.map {|key| interpolate(key) }, options)
+            super(*keys.map {|key| interpolate(key) }, options, &blk)
           else
-            super(*keys.map {|key| interpolate(key) })
+            super(*keys.map {|key| interpolate(key) }, &blk)
           end
         end
       end
@@ -72,6 +72,7 @@ class Redis
       end
 
       def flushdb
+        return super unless namespace_str
         keys.each_slice(FLUSHDB_BATCH_SIZE) { |key_slice| del(*key_slice) }
       end
 

data/lib/redis/store/serialization.rb

@@ -17,10 +17,11 @@ class Redis
         _unmarshal super(key), options
       end
 
-      def mget(*keys)
+      def mget(*keys, &blk)
         options = keys.pop if keys.last.is_a?(Hash)
-        super(*keys).map do |result|
-          _unmarshal result, options
+        super(*keys) do |reply|
+          reply.map! { |value| _unmarshal value, options }
+          blk ? blk.call(reply) : reply
         end
       end
 

data/lib/redis/store/version.rb

@@ -1,5 +1,5 @@
 class Redis
   class Store < self
-    VERSION = '1.4.1'
+    VERSION = '1.5.0'
   end
 end

data/redis-store.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry-nav',  '~> 0.2.4'
   s.add_development_dependency 'pry',      '~> 0.10.4'
   s.add_development_dependency 'redis-store-testing'
+  s.add_development_dependency 'appraisal', '~> 2.0'
 end

data/test/redis/distributed_store_test.rb

@@ -39,6 +39,50 @@ describe "Redis::DistributedStore" do
     @dmr.get("rabbit").must_equal(@rabbit)
   end
 
+  it "mget" do
+    @dmr.set "rabbit2", @white_rabbit
+    begin
+      @dmr.mget "rabbit", "rabbit2" do |rabbits|
+        rabbit, rabbit2 = rabbits
+        rabbits.length.must_equal(2)
+        rabbit.must_equal(@rabbit)
+        rabbit2.must_equal(@white_rabbit)
+      end
+    rescue Redis::Distributed::CannotDistribute
+      # Not supported on redis-rb < 4, and hence Ruby < 2.2.
+    end
+  end
+
+  it "mapped_mget" do
+    @dmr.set "rabbit2", @white_rabbit
+    begin
+      result = @dmr.mapped_mget("rabbit", "rabbit2")
+      result.keys.must_equal %w[ rabbit rabbit2 ]
+      result["rabbit"].must_equal @rabbit
+      result["rabbit2"].must_equal @white_rabbit
+    rescue Redis::Distributed::CannotDistribute
+      # Not supported on redis-rb < 4, and hence Ruby < 2.2.
+    end
+  end
+
+  it "passes through ring replica options" do
+    dmr = Redis::DistributedStore.new [
+                                    {:host => "localhost", :port => "6380", :db => 0},
+                                    {:host => "localhost", :port => "6381", :db => 0}
+                                ], replicas: 1024
+    dmr.ring.replicas.must_equal 1024
+  end
+
+  it "uses a custom ring object" do
+    my_ring = Redis::HashRing.new
+    dmr = Redis::DistributedStore.new [
+                                          {:host => "localhost", :port => "6380", :db => 0},
+                                          {:host => "localhost", :port => "6381", :db => 0}
+                                      ], ring: my_ring
+    dmr.ring.must_equal my_ring
+    dmr.ring.nodes.length.must_equal 2
+  end
+
   describe '#redis_version' do
     it 'returns redis version' do
       @dmr.nodes.first.expects(:redis_version)

data/test/redis/store/factory_test.rb

@@ -22,6 +22,11 @@ describe "Redis::Store::Factory" do
         store.to_s.must_equal("Redis Client connected to localhost:6380 against DB 0")
       end
 
+      it "uses specified path" do
+        store = Redis::Store::Factory.create :path => "/var/run/redis.sock"
+        store.to_s.must_equal("Redis Client connected to /var/run/redis.sock against DB 0")
+      end
+
       it "uses specified db" do
         store = Redis::Store::Factory.create :host => "localhost", :port => 6380, :db => 13
         store.to_s.must_equal("Redis Client connected to localhost:6380 against DB 13")
@@ -115,6 +120,11 @@ describe "Redis::Store::Factory" do
         store.to_s.must_equal("Redis Client connected to 127.0.0.1:6380 against DB 0")
       end
 
+      it "uses specified path" do
+        store = Redis::Store::Factory.create "unix:///var/run/redis.sock"
+        store.to_s.must_equal("Redis Client connected to /var/run/redis.sock against DB 0")
+      end
+
       it "uses specified db" do
         store = Redis::Store::Factory.create "redis://127.0.0.1:6380/13"
         store.to_s.must_equal("Redis Client connected to 127.0.0.1:6380 against DB 13")
@@ -125,6 +135,16 @@ describe "Redis::Store::Factory" do
         store.to_s.must_equal("Redis Client connected to 127.0.0.1:6379 against DB 0 with namespace theplaylist")
       end
 
+      it "uses specified via query namespace" do
+        store = Redis::Store::Factory.create "redis://127.0.0.1:6379/0?namespace=theplaylist"
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6379 against DB 0 with namespace theplaylist")
+      end
+
+      it "uses specified namespace with path" do
+        store = Redis::Store::Factory.create "unix:///var/run/redis.sock?db=2&namespace=theplaylist"
+        store.to_s.must_equal("Redis Client connected to /var/run/redis.sock against DB 2 with namespace theplaylist")
+      end
+
       it "uses specified password" do
         store = Redis::Store::Factory.create "redis://:secret@127.0.0.1:6379/0/theplaylist"
         store.instance_variable_get(:@client).password.must_equal("secret")

data/test/redis/store/namespace_test.rb

@@ -139,8 +139,18 @@ describe "Redis::Store::Namespace" do
     end
 
     it "should namespace mget" do
-       client.expects(:call).with([:mget, "#{@namespace}:rabbit", "#{@namespace}:white_rabbit"])
-       store.mget "rabbit", "white_rabbit"
+      client.expects(:call).with([:mget, "#{@namespace}:rabbit", "#{@namespace}:white_rabbit"]).returns(%w[ foo bar ])
+      store.mget "rabbit", "white_rabbit" do |result|
+        result.must_equal(%w[ foo bar ])
+      end
+    end
+
+    it "should namespace mapped_mget" do
+      client.expects(:process).with([[:mget, "#{@namespace}:rabbit", "#{@namespace}:white_rabbit"]]).returns(%w[ foo bar ])
+      result = store.mapped_mget "rabbit", "white_rabbit"
+      result.keys.must_equal %w[ rabbit white_rabbit ]
+      result["rabbit"].must_equal "foo"
+      result["white_rabbit"].must_equal "bar"
     end
 
     it "should namespace expire" do
@@ -157,5 +167,20 @@ describe "Redis::Store::Namespace" do
       client.expects(:call).with([:watch,"#{@namespace}:rabbit"]).once
       store.watch("rabbit")
     end
+
+    it "wraps flushdb with appropriate KEYS * calls" do
+      client.expects(:call).with([:flushdb]).never
+      client.expects(:call).with([:keys,"#{@namespace}:*"]).once.returns(["rabbit"])
+      client.expects(:call).with([:del,"#{@namespace}:rabbit"]).once
+      store.flushdb
+    end
+
+    it "skips flushdb wrapping if the namespace is nil" do
+      client.expects(:call).with([:flushdb])
+      client.expects(:call).with([:keys]).never
+      store.with_namespace(nil) do
+        store.flushdb
+      end
+    end
   end
 end

data/test/redis/store/serialization_test.rb

@@ -97,28 +97,39 @@ describe "Redis::Serialization" do
     @store.get("rabbit", :raw => true).must_equal(%(#<OpenStruct color="white">))
   end
 
-  it "doesn't unmarshal on multi get" do
+  it "unmarshals on multi get" do
     @store.set "rabbit2", @white_rabbit
-    rabbits = @store.mget "rabbit", "rabbit2"
-    rabbit, rabbit2 = rabbits
-    rabbits.length.must_equal(2)
-    rabbit.must_equal(@rabbit)
-    rabbit2.must_equal(@white_rabbit)
+    @store.mget "rabbit", "rabbit2" do |rabbits|
+      rabbit, rabbit2 = rabbits
+      rabbits.length.must_equal(2)
+      rabbit.must_equal(@rabbit)
+      rabbit2.must_equal(@white_rabbit)
+    end
+  end
+
+  it "unmarshals on mapped_mget" do
+    @store.set "rabbit2", @white_rabbit
+    result = @store.mapped_mget("rabbit", "rabbit2")
+    result.keys.must_equal %w[ rabbit rabbit2 ]
+    result["rabbit"].must_equal @rabbit
+    result["rabbit2"].must_equal @white_rabbit
   end
 
   if RUBY_VERSION.match /1\.9/
     it "doesn't unmarshal on multi get if raw option is true" do
       @store.set "rabbit2", @white_rabbit
-      rabbit, rabbit2 = @store.mget "rabbit", "rabbit2", :raw => true
-      rabbit.must_equal("\x04\bU:\x0FOpenStruct{\x06:\tnameI\"\nbunny\x06:\x06EF")
-      rabbit2.must_equal("\x04\bU:\x0FOpenStruct{\x06:\ncolorI\"\nwhite\x06:\x06EF")
+      @store.mget "rabbit", "rabbit2", :raw => true do |rabbit, rabbit2|
+        rabbit.must_equal("\x04\bU:\x0FOpenStruct{\x06:\tnameI\"\nbunny\x06:\x06EF")
+        rabbit2.must_equal("\x04\bU:\x0FOpenStruct{\x06:\ncolorI\"\nwhite\x06:\x06EF")
+      end
     end
   else
     it "doesn't unmarshal on multi get if raw option is true" do
       @store.set "rabbit2", @white_rabbit
-      rabbit, rabbit2 = @store.mget "rabbit", "rabbit2", :raw => true
-      rabbit.must_include("\x04\bU:\x0FOpenStruct{\x06:\tname")
-      rabbit2.must_include("\x04\bU:\x0FOpenStruct{\x06:\ncolor")
+      @store.mget "rabbit", "rabbit2", :raw => true do |rabbit, rabbit2|
+        rabbit.must_include("\x04\bU:\x0FOpenStruct{\x06:\tname")
+        rabbit2.must_include("\x04\bU:\x0FOpenStruct{\x06:\ncolor")
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-store
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -142,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for
   Ruby web frameworks.
 email:
@@ -152,11 +166,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
+- gemfiles/redis_3_x.gemfile
+- gemfiles/redis_4_x.gemfile
 - lib/redis-store.rb
 - lib/redis/distributed_store.rb
 - lib/redis/store.rb
@@ -198,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: redis-store
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Redis stores for Ruby frameworks