redis-store 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f43972892970b9f94f1e04ac38fc754a503b1896
-  data.tar.gz: fda18462ae2aabe2bf7a3df1b0c2fb3f83aef61d
+  metadata.gz: fcf8af10e3ba000726fa40f3633c0bd725f3c1f1
+  data.tar.gz: c51a300a95250fb34af534d1d3f427122baf919a
 SHA512:
-  metadata.gz: 74d6284f5ca7dbcb5f47cc7b851b7421b7faa08ee8fa7a437f78ad2d6f7325ef54f7022db9c405d9e95708af4444ef53ad67ae21eba4c3a157762431e972cc9b
-  data.tar.gz: 221b8a496bf165cab7ab25cfd3cb426e222cc11e10faa6f6250dfc9d64ec3c381892498d64def2d2de9ee22ed33deb9d433918b10bb64d185195edb40bb58771
+  metadata.gz: f7f5e7c2b314d06103bc76a14cb203bf23815d9b98c2d828d9dad75b7fcaf59761f171daca30ca5e6d780d8bf83107fbd78a8796cdd5215fba0e5f88b8c30133
+  data.tar.gz: e849f9d018d464eb359d0bb17c10e1adbecae028e64eb7e99b81d995373d58f25a35980513eaf9c5177e9a47fa1b426e131b59f546e5acb2e421854cee6f440c

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 *.gem
 tmp/
+stdout

data/.travis.yml

@@ -10,7 +10,6 @@ rvm:
   - 2.2
   - 2.3.0
   - ruby-head
-  - rbx-2
   - jruby-19mode
   - jruby-head
 bundler_args: '--path vendor/bundle'

data/CHANGELOG

@@ -1,3 +1,56 @@
+# Changelog
+
+## 1.3.0
+
+Breaking Changes
+
+* None
+
+Added
+
+* Add support for marshalling mset
+
+Fixed
+
+* Set :raw => true if marshalling
+* Forward new Hash, not nil, when options are unset
+
+## 1.2.0
+
+Breaking Changes
+
+* None
+
+Added
+
+* Allow changing namespaces on the fly
+* Begin testing against ruby 2.3.0
+
+Fixed
+
+* Use batched deletes for flushdb with a namespace
+* pass set command options to redis
+* bump rbx 2
+* fix setex marshalling for distributed store
+* changes to new url
+* :warning: shadowing outer local variable - key, pattern, value
+* :warning: `*' interpreted as argument prefix
+* Removed duplicated method ttl
+
+## 1.1.7
+
+Breaking Changes
+
+* None
+
+Added
+
+* Added redis_version and supports_redis_version? methods to Store and DistributedStore
+
+Fixed
+
+* Handle minor and patch version correctly as they may be multiple digits
+
 *1.1.6 (July 16, 2015)*
 
 https://github.com/redis-store/redis-store/compare/v1.1.5...v1.1.6
@@ -95,7 +148,7 @@ https://github.com/redis-store/redis-store/compare/v1.1.4...v1.1.5
     - redis-i18n 0.6.0.rc2
     - redis-rack-cache 1.1.rc3
     - redis-rails 3.1.3.rc4
-    - redis-sinatra 1.3.1.rc2 
+    - redis-sinatra 1.3.1.rc2
   * Remove redis-actionpack dependency on redis-rack-cache [Matt Horan]
 
 *1.1.0 [rc2] (February 3, 2012)*
@@ -144,7 +197,7 @@ https://github.com/redis-store/redis-store/compare/v1.1.4...v1.1.5
   * Use strict dependencies.
   * READMEs and Licenses
   * redis-actionpack now depends on redis-rack-cache
-  * Redis::Factory.convert_to_redis_client_options => Redis::Factory.resolve. 
+  * Redis::Factory.convert_to_redis_client_options => Redis::Factory.resolve.
   * Don't use autoload
   * Make redis-rack-cache tests to pass again
   * Target Rack::Cache 1.1 for redis-rack-cache
@@ -172,7 +225,7 @@ https://github.com/redis-store/redis-store/compare/v1.1.4...v1.1.5
   * Moved Rake test tasks into lib/tasks/redis.tasks.rb, in order to DRY Rake
   * Testing: Use relative paths when referring to pid files
   * Autoload modules
-  * Moved Rake test tasks under lib/ in order to make them accessible to all 
+  * Moved Rake test tasks under lib/ in order to make them accessible to all
   * Let the Redis::DistributedStore test to pass
   * Let Redis Rake tasks to work again
   * Run tests without dtach

data/README.md

@@ -1,7 +1,5 @@
 # Redis stores for Ruby frameworks
 
-[![Build Status](https://travis-ci.org/redis-store/redis-store.svg?branch=master)](https://travis-ci.org/redis-store/redis-store)
-
 __Redis Store__ provides a full set of stores (*Cache*, *I18n*, *Session*, *HTTP Cache*) for modern Ruby frameworks like: __Ruby on Rails__, __Sinatra__, __Rack__, __Rack::Cache__ and __I18n__. It supports object marshalling, timeouts, single or multiple nodes, and namespaces.
 
 Please check the *README* file of each gem for usage and installation guidelines.
@@ -33,7 +31,17 @@ If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" rub
 
 ## Contributors
 
-  * Matt Horan ([@mhoran](https://github.com/mhoran))
+https://github.com/redis-store/redis-store/graphs/contributors
+
+## Versioning
+
+The **redis-store** family of gems uses [Semantic Versioning](http://semver.org), meaning gems depending on **redis-store**
+can be reliably inclusive of any version between the current and the next major. We recommend the following dependency
+in your library's gemspec:
+
+```ruby
+s.add_dependency 'redis-store', '>= 1.4', '< 2'
+```
 
 ## Status
 
@@ -43,4 +51,4 @@ If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" rub
 
 ## Copyright
 
-2009 - 2013 Luca Guidi - [http://lucaguidi.com](http://lucaguidi.com), released under the MIT license
+2009 - 2013 Luca Guidi - [http://lucaguidi.com](http://lucaguidi.com), released under the MIT license.

data/lib/redis-store.rb

@@ -1,13 +1 @@
-require 'redis'
 require 'redis/store'
-require 'redis/store/factory'
-require 'redis/distributed_store'
-require 'redis/store/namespace'
-require 'redis/store/marshalling'
-require 'redis/store/version'
-require 'redis/store/redis_version'
-
-class Redis
-  class Store < self
-  end
-end

data/lib/redis/store.rb

@@ -1,3 +1,10 @@
+require 'redis'
+require 'redis/store/factory'
+require 'redis/distributed_store'
+require 'redis/store/namespace'
+require 'redis/store/serialization'
+require 'redis/store/version'
+require 'redis/store/redis_version'
 require 'redis/store/ttl'
 require 'redis/store/interface'
 require 'redis/store/redis_version'
@@ -8,6 +15,24 @@ class Redis
 
     def initialize(options = { })
       super
+
+      unless options[:marshalling].nil?
+        puts %(
+          DEPRECATED: You are passing the :marshalling option, which has been
+          replaced with `serializer: Marshal` to support pluggable serialization
+          backends. To disable serialization (much like disabling marshalling),
+          pass `serializer: nil` in your configuration.
+
+          The :marshalling option will be removed for redis-store 2.0.
+        )
+      end
+
+      @serializer = options.key?(:serializer) ? options[:serializer] : Marshal
+
+      unless options[:marshalling].nil?
+        @serializer = options[:marshalling] ? Marshal : nil
+      end
+
       _extend_marshalling options
       _extend_namespace   options
     end
@@ -23,8 +48,7 @@ class Redis
 
     private
       def _extend_marshalling(options)
-        @marshalling = !(options[:marshalling] === false) # HACK - TODO delegate to Factory
-        extend Marshalling if @marshalling
+        extend Serialization unless @serializer.nil?
       end
 
       def _extend_namespace(options)

data/lib/redis/store/factory.rb

@@ -50,7 +50,14 @@ class Redis
         if options.key?(:key_prefix) && !options.key?(:namespace)
           options[:namespace] = options.delete(:key_prefix) # RailsSessionStore
         end
-        options[:raw] = !options[:marshalling]
+        options[:raw] = case
+                        when options.key?(:serializer)
+                          options[:serializer].nil?
+                        when options.key?(:marshalling)
+                          !options[:marshalling]
+                        else
+                          false
+                        end
         options
       end
 
@@ -71,7 +78,7 @@ class Redis
         options = {
           :host     => uri.hostname,
           :port     => uri.port || DEFAULT_PORT, 
-          :password => uri.password
+          :password => uri.password.nil? ? nil : CGI::unescape(uri.password.to_s)
         }
 
         options[:db]        = db.to_i   if db

data/lib/redis/store/namespace.rb

@@ -46,8 +46,8 @@ class Redis
       def mget(*keys)
         options = (keys.pop if keys.last.is_a? Hash) || {}
         if keys.any?
-          # Marshalling gets extended before Namespace does, so we need to pass options further
-          if singleton_class.ancestors.include? Marshalling
+          # 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)
           else
             super(*keys.map {|key| interpolate(key) })

data/lib/redis/store/{marshalling.rb → serialization.rb}

@@ -1,6 +1,6 @@
 class Redis
   class Store < self
-    module Marshalling
+    module Serialization
       def set(key, value, options = nil)
         _marshal(value, options) { |v| super encode(key), encode(v), options }
       end
@@ -36,11 +36,11 @@ class Redis
 
       private
         def _marshal(val, options)
-          yield marshal?(options) ? Marshal.dump(val) : val
+          yield marshal?(options) ? @serializer.dump(val) : val
         end
 
         def _unmarshal(val, options)
-          unmarshal?(val, options) ? Marshal.load(val) : val
+          unmarshal?(val, options) ? @serializer.load(val) : val
         end
 
         def marshal?(options)

data/lib/redis/store/version.rb

@@ -1,5 +1,5 @@
 class Redis
   class Store < self
-    VERSION = '1.3.0'
+    VERSION = '1.4.0'
   end
 end

data/redis-store.gemspec

@@ -19,13 +19,14 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.license       = 'MIT'
 
-  s.add_dependency 'redis', '>= 2.2'
+  s.add_dependency 'redis', '>= 2.2', '< 4'
 
   s.add_development_dependency 'rake',     '~> 10'
   s.add_development_dependency 'bundler',  '~> 1.3'
   s.add_development_dependency 'mocha',    '~> 0.14.0'
   s.add_development_dependency 'minitest', '~> 5'
   s.add_development_dependency 'git',      '~> 1.2'
+  s.add_development_dependency 'pry-nav',  '~> 0.2.4'
+  s.add_development_dependency 'pry',      '~> 0.10.4'
   s.add_development_dependency 'redis-store-testing'
-end
-
+end

data/test/redis/store/factory_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'json'
 
 describe "Redis::Store::Factory" do
   describe ".create" do
@@ -41,12 +42,55 @@ describe "Redis::Store::Factory" do
         store.instance_variable_get(:@client).password.must_equal("secret")
       end
 
-      it "allows/disable marshalling" do
-        store = Redis::Store::Factory.create :marshalling => false
-        store.instance_variable_get(:@marshalling).must_equal(false)
+      it 'uses empty password' do
+        store = Redis::Store::Factory.create :password => ''
+        store.instance_variable_get(:@client).password.must_equal('')
+      end
+
+      it 'uses nil password' do
+        store = Redis::Store::Factory.create :password => nil
+        assert_nil(store.instance_variable_get(:@client).password)
+      end
+
+      it "disables serialization" do
+        store = Redis::Store::Factory.create :serializer => nil
+        store.instance_variable_get(:@serializer).must_be_nil
         store.instance_variable_get(:@options)[:raw].must_equal(true)
       end
 
+      it "configures pluggable serialization backend" do
+        store = Redis::Store::Factory.create :serializer => JSON
+        store.instance_variable_get(:@serializer).must_equal(JSON)
+        store.instance_variable_get(:@options)[:raw].must_equal(false)
+      end
+
+      describe 'with stdout disabled' do
+        before do
+          @original_stderr = $stderr
+          @original_stdout = $stdout
+
+          $stderr = Tempfile.new('stderr')
+          $stdout = Tempfile.new('stdout')
+        end
+
+        it "disables marshalling and provides deprecation warning" do
+          store = Redis::Store::Factory.create :marshalling => false
+          store.instance_variable_get(:@serializer).must_be_nil
+          store.instance_variable_get(:@options)[:raw].must_equal(true)
+        end
+
+        it "enables marshalling but provides warning to use :serializer instead" do
+          store = Redis::Store::Factory.create :marshalling => true
+          store.instance_variable_get(:@serializer).must_equal(Marshal)
+          store.instance_variable_get(:@options)[:raw].must_equal(false)
+        end
+
+        after do
+          $stderr = @original_stderr
+          $stdout = @original_stdout
+        end
+      end
+
       it "should instantiate a Redis::DistributedStore store" do
         store = Redis::Store::Factory.create(
           {:host => "localhost", :port => 6379},
@@ -86,6 +130,21 @@ describe "Redis::Store::Factory" do
         store.instance_variable_get(:@client).password.must_equal("secret")
       end
 
+      it 'uses specified password with special characters' do
+        store = Redis::Store::Factory.create 'redis://:pwd%40123@127.0.0.1:6379/0/theplaylist'
+        store.instance_variable_get(:@client).password.must_equal('pwd@123')
+      end
+
+      it 'uses empty password' do
+        store = Redis::Store::Factory.create 'redis://:@127.0.0.1:6379/0/theplaylist'
+        store.instance_variable_get(:@client).password.must_equal('')
+      end
+
+      it 'uses nil password' do
+        store = Redis::Store::Factory.create 'redis://127.0.0.1:6379/0/theplaylist'
+        assert_nil(store.instance_variable_get(:@client).password)
+      end
+
       it "correctly uses specified ipv6 host" do
         store = Redis::Store::Factory.create "redis://[::1]:6380"
         store.to_s.must_equal("Redis Client connected to [::1]:6380 against DB 0")

data/test/redis/store/namespace_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 describe "Redis::Store::Namespace" do
   def setup
     @namespace = "theplaylist"
-    @store  = Redis::Store.new :namespace => @namespace, :marshalling => false # TODO remove mashalling option
+    @store  = Redis::Store.new :namespace => @namespace, :serializer => nil
     @client = @store.instance_variable_get(:@client)
     @rabbit = "bunny"
     @default_store = Redis::Store.new
@@ -38,7 +38,7 @@ describe "Redis::Store::Namespace" do
     @store.set 'def', 'fed'
 
     @store.flushdb
-    @store.get('def').must_equal(nil)
+    @store.get('def').must_be_nil
     @default_store.get('abc').must_equal('cba')
   end
 
@@ -74,7 +74,7 @@ describe "Redis::Store::Namespace" do
     r2 = dyn_store.get 'key'
     $ns = "ns1"
     r1 = dyn_store.get 'key'
-    r1.must_equal('x') && r2.must_equal('y') && r3.must_equal(nil)
+    r1.must_equal('x') && r2.must_equal('y') && r3.must_be_nil
   end
 
   it "namespaces setex and ttl" do
@@ -90,7 +90,7 @@ describe "Redis::Store::Namespace" do
   end
 
   describe 'method calls' do
-    let(:store){Redis::Store.new :namespace => @namespace, :marshalling => false}
+    let(:store){Redis::Store.new :namespace => @namespace, :serializer => nil}
     let(:client){store.instance_variable_get(:@client)}
 
     it "should namespace get" do

data/test/redis/store/{marshalling_test.rb → serialization_test.rb}

@@ -1,8 +1,8 @@
 require 'test_helper'
 
-describe "Redis::Marshalling" do
+describe "Redis::Serialization" do
   def setup
-    @store = Redis::Store.new :marshalling => true
+    @store = Redis::Store.new serializer: Marshal
     @rabbit = OpenStruct.new :name => "bunny"
     @white_rabbit = OpenStruct.new :color => "white"
     @store.set "rabbit", @rabbit

data/test/test_helper.rb

@@ -3,6 +3,7 @@ require 'minitest/autorun'
 require 'mocha/setup'
 require 'redis'
 require 'redis-store'
+require 'pry'
 
 $DEBUG = ENV["DEBUG"] === "true"
 

metadata

@@ -1,111 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: redis-store
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2017-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: redis-store-testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for
@@ -116,8 +150,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - MIT-LICENSE
@@ -128,18 +162,18 @@ files:
 - lib/redis/store.rb
 - lib/redis/store/factory.rb
 - lib/redis/store/interface.rb
-- lib/redis/store/marshalling.rb
 - lib/redis/store/namespace.rb
 - lib/redis/store/redis_version.rb
+- lib/redis/store/serialization.rb
 - lib/redis/store/ttl.rb
 - lib/redis/store/version.rb
 - redis-store.gemspec
 - test/redis/distributed_store_test.rb
 - test/redis/store/factory_test.rb
 - test/redis/store/interface_test.rb
-- test/redis/store/marshalling_test.rb
 - test/redis/store/namespace_test.rb
 - test/redis/store/redis_version_test.rb
+- test/redis/store/serialization_test.rb
 - test/redis/store/ttl_test.rb
 - test/redis/store/version_test.rb
 - test/redis/store_test.rb
@@ -154,17 +188,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: redis-store
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Redis stores for Ruby frameworks
@@ -172,9 +206,9 @@ test_files:
 - test/redis/distributed_store_test.rb
 - test/redis/store/factory_test.rb
 - test/redis/store/interface_test.rb
-- test/redis/store/marshalling_test.rb
 - test/redis/store/namespace_test.rb
 - test/redis/store/redis_version_test.rb
+- test/redis/store/serialization_test.rb
 - test/redis/store/ttl_test.rb
 - test/redis/store/version_test.rb
 - test/redis/store_test.rb