redis-store 1.0.0.beta4 → 1.0.0.beta5

data/CHANGELOG

@@ -1,3 +1,12 @@
+*1.0.0 [beta5] (April 2, 2011)*
+
+  * Bump version v1.0.0.beta5
+  * Introducing Rails.cache.reconnect, useful for Unicorn environments. Closes #21
+  * Namespaced i18n backend should strip namespace when lists available locales. Closes #62
+  * how to configure Redis session store in Sinatra [Christian von Kleist]
+  * gracefully handle Connection Refused errors, allows database fall-back on fetch [Michael Kintzer]
+  * Sinatra's API must have changed, its registered not register. [Michael D'Auria]
+
 *1.0.0 [beta4] (December 15, 2010)*
 
   * Bump version v1.0.0.beta4

data/Gemfile

@@ -1,5 +1,5 @@
 source :gemcutter
-gem "redis", ">= 2.0.0"
+gem "redis", "~> 2.2.0"
 
 group :development do
   gem "jeweler"
@@ -7,7 +7,6 @@ group :development do
 end
 
 group :development, :test, :rails3 do
-  gem "rack"
   gem "rack-cache"
   gem "merb", "1.1.0"
   gem "rspec", "1.3.0"
@@ -22,12 +21,14 @@ end
 
 if ENV["REDIS_STORE_ENV"] == "rails3"
   group :rails3 do
-    gem "activesupport", "3.0.3"
-    gem "actionpack", "3.0.3"
+    gem "rack", "~> 1.2.1"
+    gem "activesupport", "3.0.5"
+    gem "actionpack", "3.0.5"
   end
 else
   group :test do
-    gem "activesupport", "2.3.10"
-    gem "actionpack", "2.3.10"
+    gem "rack", "~> 1.1.0"
+    gem "activesupport", "2.3.11"
+    gem "actionpack", "2.3.11"
   end
 end

data/Gemfile.lock

@@ -8,10 +8,10 @@ GEM
       ZenTest (~> 4.3)
     ZenTest (4.4.2)
     abstract (1.0.0)
-    actionpack (2.3.10)
-      activesupport (= 2.3.10)
+    actionpack (2.3.11)
+      activesupport (= 2.3.11)
       rack (~> 1.1.0)
-    activesupport (2.3.10)
+    activesupport (2.3.11)
     addressable (2.2.2)
     bcrypt-ruby (2.1.2)
     columnize (0.3.2)
@@ -143,7 +143,7 @@ GEM
     rake (0.8.7)
     randexp (0.1.5)
       ParseTree
-    redis (2.1.1)
+    redis (2.2.0)
     rspec (1.3.0)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
@@ -167,14 +167,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (= 2.3.10)
-  activesupport (= 2.3.10)
+  actionpack (= 2.3.11)
+  activesupport (= 2.3.11)
   git
   i18n
   jeweler
   merb (= 1.1.0)
-  rack
+  rack (~> 1.1.0)
   rack-cache
-  redis (>= 2.0.0)
+  redis (~> 2.2.0)
   rspec (= 1.3.0)
   ruby-debug

data/README.md

@@ -29,13 +29,13 @@ By default each store try to connect on `localhost` with the port `6379` and the
     password: secret
 
 If you want to specify the `namespace` optional, you have to pass the `db` param too.
-#### __Important__: for now (beta4) `namespace` is only supported for single, non-distributed stores.
+#### __Important__: for now (beta5) `namespace` is only supported for single, non-distributed stores.
 
 ### Hash
 
     { :host => 192.168.1.100, :port => 23682, :db => 13, :namespace => "theplaylist", :password => "secret" }
 
-#### __Important__: for now (beta4) `namespace` is only supported for single, non-distributed stores.
+#### __Important__: for now (beta5) `namespace` is only supported for single, non-distributed stores.
 
 ## Cache store
 
@@ -60,16 +60,16 @@ Provides a cache store for your Ruby web framework of choice.
     # Gemfile
     gem 'rails', '3.0.3'
     gem 'redis'
-    gem 'redis-store', '1.0.0.beta4'
+    gem 'redis-store', '1.0.0.beta5'
 
     # config/environments/production.rb
     config.cache_store = :redis_store, { ... optional configuration ... }
 
-For advanced configurations scenarios please visit [the wiki](http://wiki.github.com/jodosha/redis-store/rails).
+For advanced configurations scenarios please visit [the wiki](https://github.com/jodosha/redis-store/wiki/Frameworks-Configuration).
 
 ### Merb
 
-    dependency "redis-store", "1.0.0.beta4"
+    dependency "redis-store", "1.0.0.beta5"
     dependency("merb-cache", merb_gems_version) do
       Merb::Cache.setup do
         register(:redis, Merb::Cache::RedisStore, :servers => ["127.0.0.1:6379"])
@@ -83,10 +83,14 @@ For advanced configurations scenarios please visit [the wiki](http://wiki.github
     class MyApp < Sinatra::Base
       register Sinatra::Cache
       get "/hi" do
-        cache.fetch("greet") { "Hello, World!" }
+        settings.cache.fetch("greet") { "Hello, World!" }
       end
     end
 
+Keep in mind that the above fetch will return "OK" on success, not the return of the block.
+
+For advanced configurations scenarios please visit [the wiki](https://github.com/jodosha/redis-store/wiki/Frameworks-Configuration).
+
 ## Rack::Session
 
 Provides a Redis store for Rack::Session. See [http://rack.rubyforge.org/doc/Rack/Session.html](http://rack.rubyforge.org/doc/Rack/Session.html)
@@ -146,16 +150,16 @@ Provides a Redis store for Rack::Session. See [http://rack.rubyforge.org/doc/Rac
     # Gemfile
     gem 'rails', '3.0.3'
     gem 'redis'
-    gem 'redis-store', '1.0.0.beta4'
+    gem 'redis-store', '1.0.0.beta5'
 
     # config/initializers/session_store.rb
     MyApp::Application.config.session_store :redis_session_store
 
-For advanced configurations scenarios please visit [the wiki](http://wiki.github.com/jodosha/redis-store/rails).
+For advanced configurations scenarios please visit [the wiki](https://github.com/jodosha/redis-store/wiki/Frameworks-Configuration).
 
 ### Merb
 
-    dependency "redis-store", "1.0.0.beta4"
+    dependency "redis-store", "1.0.0.beta5"
     Merb::Config.use do |c|
       c[:session_store] = "redis"
     end
@@ -169,7 +173,7 @@ For advanced configurations scenarios please visit [the wiki](http://wiki.github
     require "redis-store"
 
     class MyApp < Sinatra::Base
-      use Rack::Session::Redis
+      use Rack::Session::Redis, :redis_server => 'redis://127.0.0.1:6379/0' # Redis server on localhost port 6379, database 0
 
       get "/" do
         session[:visited_at] = DateTime.now.to_s # This is stored in Redis
@@ -177,6 +181,8 @@ For advanced configurations scenarios please visit [the wiki](http://wiki.github
       end
     end
 
+For advanced configurations scenarios please visit [the wiki](https://github.com/jodosha/redis-store/wiki/Frameworks-Configuration).
+
 ## Rack::Cache
 
 Provides a Redis store for HTTP caching. See [http://github.com/rtomayko/rack-cache](http://github.com/rtomayko/rack-cache)
@@ -198,6 +204,10 @@ Provides a Redis store for HTTP caching. See [http://github.com/rtomayko/rack-ca
 
 The backend accepts the uri string and hash options.
 
+## Unicorn
+
+Use `Rails.cache.reconnect` in your Unicorn hooks, in order to force the client reconnection.
+
 ## Running specs
 
     gem install jeweler bundler

data/Rakefile

@@ -28,7 +28,7 @@ end
 namespace :spec do
   desc "Run all the examples by starting a detached Redis instance"
   task :suite => :prepare do
-    invoke_with_redis_cluster "spec:run"
+    invoke_with_redis_replication "spec:run"
   end
 
   Spec::Rake::SpecTask.new(:run) do |t|
@@ -39,7 +39,7 @@ end
 
 desc "Run all examples with RCov"
 task :rcov => :prepare do
-  invoke_with_redis_cluster "rcov_run"
+  invoke_with_redis_replication "rcov_run"
 end
 
 Spec::Rake::SpecTask.new(:rcov_run) do |t|

data/VERSION

@@ -1 +1 @@
-1.0.0.beta4
+1.0.0.beta5

data/lib/active_support/cache/redis_store.rb

@@ -107,6 +107,8 @@ module ::RedisStore
         def write_entry(key, entry, options)
           method = options && options[:unless_exist] ? :setnx : :set
           @data.send method, key, entry, options
+        rescue Errno::ECONNREFUSED => e
+          false
         end
 
         def read_entry(key, options)
@@ -114,10 +116,14 @@ module ::RedisStore
           if entry
             entry.is_a?(ActiveSupport::Cache::Entry) ? entry : ActiveSupport::Cache::Entry.new(entry)
           end
+        rescue Errno::ECONNREFUSED => e
+          nil
         end
 
         def delete_entry(key, options)
           @data.del key
+        rescue Errno::ECONNREFUSED => e
+          false
         end
 
         # Add the namespace defined in the options to a pattern designed to match keys.
@@ -221,6 +227,11 @@ module ActiveSupport
       def stats
         @data.info
       end
+
+      # Force client reconnection, useful Unicorn deployed apps.
+      def reconnect
+        @data.reconnect
+      end
     end
   end
 end

data/lib/cache/sinatra/redis_store.rb

@@ -4,6 +4,7 @@ module Sinatra
       def register(app)
         app.set :cache, RedisStore.new
       end
+      alias_method :registered, :register
     end
 
     class RedisStore

data/lib/redis/distributed_store.rb

@@ -14,6 +14,10 @@ class Redis
       ring.nodes
     end
 
+    def reconnect
+      nodes.each {|node| node.reconnect }
+    end
+
     def set(key, value, options = nil)
       node_for(key).set(key, value, options)
     end

data/lib/redis/store.rb

@@ -12,6 +12,10 @@ class Redis
       defined?(::Rails) && ::Rails::VERSION::MAJOR == 3
     end
 
+    def reconnect
+      @client.reconnect
+    end
+
     def to_s
       "Redis Client connected to #{@client.host}:#{@client.port} against DB #{@client.db}"
     end

data/lib/redis/store/namespace.rb

@@ -26,7 +26,7 @@ class Redis
       end
 
       def keys(pattern = "*")
-        namespace(pattern) { |pattern| super(pattern) }
+        namespace(pattern) { |pattern| super(pattern).map{|key| strip_namespace(key) } }
       end
 
       def del(*keys)
@@ -47,7 +47,15 @@ class Redis
         end
 
         def interpolate(key)
-          key.match(%r{^#{@namespace}\:}) ? key : "#{@namespace}:#{key}"
+          key.match(namespace_regexp) ? key : "#{@namespace}:#{key}"
+        end
+
+        def strip_namespace(key)
+          key.gsub namespace_regexp, ""
+        end
+
+        def namespace_regexp
+          @namespace_regexp ||= %r{^#{@namespace}\:}
         end
     end
   end

data/lib/redis/store/version.rb

@@ -4,7 +4,7 @@ class Redis
       MAJOR = 1
       MINOR = 0
       TINY  = 0
-      BUILD = "beta4"
+      BUILD = "beta5"
 
       STRING = [MAJOR, MINOR, TINY, BUILD].join('.')
     end

data/redis-store.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{redis-store}
-  s.version = "1.0.0.beta4"
+  s.version = "1.0.0.beta5"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luca Guidi"]
-  s.date = %q{2010-12-15}
+  s.date = %q{2011-04-02}
   s.description = %q{Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks.}
   s.email = %q{guidi.luca@gmail.com}
   s.extra_rdoc_files = [
@@ -46,9 +46,9 @@ Gem::Specification.new do |s|
     "spec/active_support/cache/redis_store_spec.rb",
     "spec/cache/merb/redis_store_spec.rb",
     "spec/cache/sinatra/redis_store_spec.rb",
-    "spec/config/master.conf",
-    "spec/config/single.conf",
-    "spec/config/slave.conf",
+    "spec/config/node-one.conf",
+    "spec/config/node-two.conf",
+    "spec/config/redis.conf",
     "spec/i18n/backend/redis_spec.rb",
     "spec/rack/cache/entitystore/pony.jpg",
     "spec/rack/cache/entitystore/redis_spec.rb",
@@ -60,6 +60,7 @@ Gem::Specification.new do |s|
     "spec/redis/store/marshalling_spec.rb",
     "spec/redis/store/namespace_spec.rb",
     "spec/redis/store/version_spec.rb",
+    "spec/redis/store_spec.rb",
     "spec/spec_helper.rb",
     "tasks/redis.tasks.rb"
   ]
@@ -82,6 +83,7 @@ Gem::Specification.new do |s|
     "spec/redis/store/marshalling_spec.rb",
     "spec/redis/store/namespace_spec.rb",
     "spec/redis/store/version_spec.rb",
+    "spec/redis/store_spec.rb",
     "spec/spec_helper.rb"
   ]
 
@@ -90,10 +92,9 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<redis>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<redis>, ["~> 2.2.0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<git>, [">= 0"])
-      s.add_development_dependency(%q<rack>, [">= 0"])
       s.add_development_dependency(%q<rack-cache>, [">= 0"])
       s.add_development_dependency(%q<merb>, ["= 1.1.0"])
       s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
@@ -101,10 +102,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<ruby-debug>, [">= 0"])
       s.add_runtime_dependency(%q<redis>, [">= 2.0.0"])
     else
-      s.add_dependency(%q<redis>, [">= 2.0.0"])
+      s.add_dependency(%q<redis>, ["~> 2.2.0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<git>, [">= 0"])
-      s.add_dependency(%q<rack>, [">= 0"])
       s.add_dependency(%q<rack-cache>, [">= 0"])
       s.add_dependency(%q<merb>, ["= 1.1.0"])
       s.add_dependency(%q<rspec>, ["= 1.3.0"])
@@ -113,10 +113,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<redis>, [">= 2.0.0"])
     end
   else
-    s.add_dependency(%q<redis>, [">= 2.0.0"])
+    s.add_dependency(%q<redis>, ["~> 2.2.0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<git>, [">= 0"])
-    s.add_dependency(%q<rack>, [">= 0"])
     s.add_dependency(%q<rack-cache>, [">= 0"])
     s.add_dependency(%q<merb>, ["= 1.1.0"])
     s.add_dependency(%q<rspec>, ["= 1.3.0"])

data/spec/active_support/cache/redis_store_spec.rb

@@ -39,6 +39,12 @@ module ActiveSupport
         store.should be_kind_of(Redis::DistributedStore)
       end
 
+      it "should force reconnection" do
+        data = @store.instance_variable_get(:@data)
+        data.should_receive(:reconnect)
+        @store.reconnect
+      end
+
       it "should read the data" do
         with_store_management do |store|
           store.read("rabbit").should === @rabbit

data/spec/config/{master.conf → node-one.conf}

@@ -20,7 +20,8 @@ daemonize no
 # default. You can specify a custom pid file location here.
 pidfile /var/run/redis.pid
 
-# Accept connections on the specified port, default is 6379
+# Accept connections on the specified port, default is 6379.
+# If port 0 is specified Redis will not listen on a TCP socket.
 port 6380
 
 # If you want you can bind a single interface, if the bind option is not
@@ -28,6 +29,12 @@ port 6380
 #
 # bind 127.0.0.1
 
+# Specify the path for the unix socket that will be used to listen for
+# incoming connections. There is no default, so Redis will not listen
+# on a unix socket when not specified.
+#
+# unixsocket /tmp/redis.sock
+
 # Close the connection after a client is idle for N seconds (0 to disable)
 timeout 300
 
@@ -37,13 +44,23 @@ timeout 300
 # verbose (many rarely useful info, but not a mess like the debug level)
 # notice (moderately verbose, what you want in production probably)
 # warning (only very important / critical messages are logged)
-loglevel debug
+loglevel verbose
 
 # Specify the log file name. Also 'stdout' can be used to force
 # Redis to log on the standard output. Note that if you use standard
 # output for logging but daemonize, logs will be sent to /dev/null
 logfile stdout
 
+# To enable logging to the system logger, just set 'syslog-enabled' to yes,
+# and optionally update the other syslog parameters to suit your needs.
+# syslog-enabled no
+
+# Specify the syslog identity.
+# syslog-ident redis
+
+# Specify the syslog facility.  Must be USER or between LOCAL0-LOCAL7.
+# syslog-facility local0
+
 # Set the number of databases. The default database is DB 0, you can select
 # a different one on a per-connection basis using SELECT <dbid> where
 # dbid is a number between 0 and 'databases'-1
@@ -76,7 +93,7 @@ save 60 10000
 rdbcompression yes
 
 # The filename where to dump the DB
-dbfilename tmp/master-dump.rdb
+dbfilename tmp/node-one-dump.rdb
 
 # The working directory.
 #
@@ -104,6 +121,19 @@ dir ./
 #
 # masterauth <master-password>
 
+# When a slave lost the connection with the master, or when the replication
+# is still in progress, the slave can act in two different ways:
+#
+# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
+#    still reply to client requests, possibly with out of data data, or the
+#    data set may just be empty if this is the first synchronization.
+#
+# 2) if slave-serve-stale data is set to 'no' the slave will reply with
+#    an error "SYNC with master in progress" to all the kind of commands
+#    but to INFO and SLAVEOF.
+#
+slave-serve-stale-data yes
+
 ################################## SECURITY ###################################
 
 # Require clients to issue AUTH <PASSWORD> before processing any other
@@ -119,6 +149,22 @@ dir ./
 #
 # requirepass foobared
 
+# Command renaming.
+#
+# It is possilbe to change the name of dangerous commands in a shared
+# environment. For instance the CONFIG command may be renamed into something
+# of hard to guess so that it will be still available for internal-use
+# tools but not available for general clients.
+#
+# Example:
+#
+# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
+#
+# It is also possilbe to completely kill a command renaming it into
+# an empty string:
+#
+# rename-command CONFIG ""
+
 ################################### LIMITS ####################################
 
 # Set the max number of connected clients at the same time. By default there
@@ -148,6 +194,37 @@ dir ./
 #
 # maxmemory <bytes>
 
+# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
+# is reached? You can select among five behavior:
+# 
+# volatile-lru -> remove the key with an expire set using an LRU algorithm
+# allkeys-lru -> remove any key accordingly to the LRU algorithm
+# volatile-random -> remove a random key with an expire set
+# allkeys->random -> remove a random key, any key
+# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
+# noeviction -> don't expire at all, just return an error on write operations
+# 
+# Note: with all the kind of policies, Redis will return an error on write
+#       operations, when there are not suitable keys for eviction.
+#
+#       At the date of writing this commands are: set setnx setex append
+#       incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
+#       sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
+#       zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
+#       getset mset msetnx exec sort
+#
+# The default is:
+#
+# maxmemory-policy volatile-lru
+
+# LRU and minimal TTL algorithms are not precise algorithms but approximated
+# algorithms (in order to save memory), so you can select as well the sample
+# size to check. For instance for default Redis will check three keys and
+# pick the one that was used less recently, you can change the sample size
+# using the following configuration directive.
+#
+# maxmemory-samples 3
+
 ############################## APPEND ONLY MODE ###############################
 
 # By default Redis asynchronously dumps the dataset on disk. If you can live
@@ -195,6 +272,26 @@ appendonly no
 appendfsync everysec
 # appendfsync no
 
+# When the AOF fsync policy is set to always or everysec, and a background
+# saving process (a background save or AOF log background rewriting) is
+# performing a lot of I/O against the disk, in some Linux configurations
+# Redis may block too long on the fsync() call. Note that there is no fix for
+# this currently, as even performing fsync in a different thread will block
+# our synchronous write(2) call.
+#
+# In order to mitigate this problem it's possible to use the following option
+# that will prevent fsync() from being called in the main process while a
+# BGSAVE or BGREWRITEAOF is in progress.
+#
+# This means that while another child is saving the durability of Redis is
+# the same as "appendfsync none", that in pratical terms means that it is
+# possible to lost up to 30 seconds of log in the worst scenario (with the
+# default Linux settings).
+# 
+# If you have latency problems turn this to "yes". Otherwise leave it as
+# "no" that is the safest pick from the point of view of durability.
+no-appendfsync-on-rewrite no
+
 ################################ VIRTUAL MEMORY ###############################
 
 # Virtual Memory allows Redis to work with datasets bigger than the actual
@@ -269,17 +366,25 @@ vm-max-threads 4
 
 ############################### ADVANCED CONFIG ###############################
 
-# Glue small output buffers together in order to send small replies in a
-# single TCP packet. Uses a bit more CPU but most of the times it is a win
-# in terms of number of queries per second. Use 'yes' if unsure.
-glueoutputbuf yes
-
 # Hashes are encoded in a special way (much more memory efficient) when they
 # have at max a given numer of elements, and the biggest element does not
 # exceed a given threshold. You can configure this limits with the following
 # configuration directives.
-hash-max-zipmap-entries 64
-hash-max-zipmap-value 512
+hash-max-zipmap-entries 512
+hash-max-zipmap-value 64
+
+# Similarly to hashes, small lists are also encoded in a special way in order
+# to save a lot of space. The special representation is only used when
+# you are under the following limits:
+list-max-ziplist-entries 512
+list-max-ziplist-value 64
+
+# Sets have a special encoding in just one case: when a set is composed
+# of just strings that happens to be integers in radix 10 in the range
+# of 64 bit signed integers.
+# The following configuration setting sets the limit in the size of the
+# set in order to use this special memory saving encoding.
+set-max-intset-entries 512
 
 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
 # order to help rehashing the main Redis hash table (the one mapping top-level