redis-store 1.0.0.1 → 1.1.0.rc

data/Gemfile

@@ -1,34 +1,2 @@
-source :gemcutter
-gem "redis", "~> 2.2.1"
-
-group :development do
-  gem "jeweler"
-  gem "git"
-end
-
-group :development, :test, :rails3 do
-  gem "rack-cache"
-  gem "merb", "1.1.0"
-  gem "rspec", "1.3.0"
-  gem "i18n"
-
-  if RUBY_VERSION > '1.9'
-    gem "methopara" # required by merb.
-  else
-    gem "ruby-debug" # linecache isn't compatible with 1.9.2 yet.
-  end
-end
-
-if ENV["REDIS_STORE_ENV"] == "rails3"
-  group :rails3 do
-    gem "rack", "~> 1.2.1"
-    gem "activesupport", "3.0.5"
-    gem "actionpack", "3.0.5"
-  end
-else
-  group :test do
-    gem "rack", "~> 1.1.0"
-    gem "activesupport", "2.3.11"
-    gem "actionpack", "2.3.11"
-  end
-end
+source 'http://rubygems.org'
+gemspec

data/README.md

@@ -1,238 +1,35 @@
-# Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks
+# Redis stores for Ruby frameworks
 
-## Installation
+__Redis Store__ provides a full set of stores (*Cache*, *I18n*, *Session*, *HTTP Cache*) for all the modern Ruby frameworks like: __Ruby on Rails__, __Sinatra__, __Rack__, __Rack::Cache__ and __I18n__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
 
-### Redis, Option 1: Homebrew
+This is the core for all the other gems, please check the *READMEs* to be informed about the usage.
+
+## Redis Installation
+
+### Option 1: Homebrew
 
 MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install Redis:
 
     brew install redis
 
-### Redis, Option 2: From Source
+### Option 2: From Source
 
-Download and install Redis from [http://code.google.com/p/redis/](http://code.google.com/p/redis/)
+Download and install Redis from [http://redis.io](http://redis.io/)
 
-    wget http://redis.googlecode.com/files/redis-2.0.0.tar.gz
-    tar -zxf redis-2.0.0.tar.gz
-    mv redis-2.0.0 redis
+	wget http://redis.googlecode.com/files/redis-2.4.5.tar.gz
+    tar -zxf redis-2.4.5.tar.gz
+    mv redis-2.4.5 redis
     cd redis
     make
 
-### Install the Gem
-
-Assuming you're using RVM or on Windows, install the gem with:
-
-    gem install redis-store
-
-## Options
-You can specify the Redis configuration details using a URI or a hash.  By default the gem will attempt to connect to `localhost` port `6379` and the db `0`.
-
-### Set by URI
-
-For example
-
-    "redis://:secret@192.168.1.100:23682/13/theplaylist"
-
-Made up of the following:
-
-    host: 192.168.1.100
-    port: 23682
-    db: 13
-    namespace: theplaylist
-    password: secret
-
-If you want to specify the `namespace` option, you have to pass the `db` param too.
-#### __Important__: `namespace` is only supported for single, non-distributed stores.
-
-### Set by Hash
-
-    { :host => 192.168.1.100, :port => 23682, :db => 13, :namespace => "theplaylist", :password => "secret" }
-
-#### __Important__: `namespace` is only supported for single, non-distributed stores.
-
-## Cache store
-
-Provides a cache store for your Ruby web framework of choice.
-
-### Rails 2.x
-
-    config.gem "redis-store"
-    config.cache_store = :redis_store
-
-### Rails 2.x (with Bundler)
-
-    # Gemfile
-    gem "redis-store"
-
-    # in your configuration
-    config.gem "redis-store"
-    config.cache_store = :redis_store, { ... optional configuration ... }
-
-### Rails 3.x
-
-    # Gemfile
-    gem 'redis'
-    gem 'redis-store', '1.0.0.1'
-
-    # config/environments/production.rb
-    config.cache_store = :redis_store, { ... optional configuration ... }
-
-For advanced configurations scenarios please visit [the wiki](https://github.com/jodosha/redis-store/wiki/Frameworks-Configuration).
-
-### Merb
-
-    dependency "redis-store", "1.0.0.1"
-    dependency("merb-cache", merb_gems_version) do
-      Merb::Cache.setup do
-        register(:redis, Merb::Cache::RedisStore, :servers => ["127.0.0.1:6379"])
-      end
-    end
-
-### Sinatra
-
-    require "sinatra"
-    require "redis-store"
-    class MyApp < Sinatra::Base
-      register Sinatra::Cache
-      get "/hi" do
-        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)
-
-### Rack application
-
-    require "rack"
-    require "redis-store"
-    require "application"
-    use Rack::Session::Redis
-    run Application.new
-
-### Rails 2.x
-
-    # config/environment.rb
-    config.gem "redis-store"
-
-    # then configure as following:
-
-    # config/environments/*.rb
-    config.cache_store = :redis_store
-
-    # or
-
-    # config/initializers/session_store.rb
-    ActionController::Base.session = {
-      :key         => APPLICATION['session_key'],
-      :secret      => APPLICATION['session_secret'],
-      :key_prefix  => Rails.env
-    }
-
-    ActionController::Base.session_store = :redis_session_store
-
-### Rails 2.x (with Bundler)
-
-    # Gemfile
-    gem "redis-store"
-
-    # then configure as following:
-
-    # config/environments/*.rb
-    config.cache_store = :redis_store
-
-    # or
-
-    # config/initializers/session_store.rb
-    ActionController::Base.session = {
-      :key         => APPLICATION['session_key'],
-      :secret      => APPLICATION['session_secret'],
-      :key_prefix  => Rails.env
-    }
-
-    ActionController::Base.session_store = :redis_session_store
-
-### Rails 3.x
-
-    # Gemfile
-    gem 'rails', '3.0.3'
-    gem 'redis'
-    gem 'redis-store', '1.0.0.1'
-
-    # config/initializers/session_store.rb
-    MyApp::Application.config.session_store :redis_session_store
-
-For advanced configurations scenarios please visit [the wiki](https://github.com/jodosha/redis-store/wiki/Frameworks-Configuration).
-
-### Merb
-
-    dependency "redis-store", "1.0.0.1"
-    Merb::Config.use do |c|
-      c[:session_store] = "redis"
-    end
-    Merb::BootLoader.before_app_loads do
-      Merb::SessionContainer.subclasses << "Merb::RedisSession"
-    end
-
-### Sinatra
-
-    require "sinatra"
-    require "redis-store"
-
-    class MyApp < Sinatra::Base
-      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
-        "Hello, visitor."
-      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)
-
-    require "rack"
-    require "rack/cache"
-    require "redis-store"
-    require "application"
-    use Rack::Cache,
-      :metastore   => 'redis://localhost:6379/0/metastore',
-      :entitystore => 'redis://localhost:6380/0/entitystore'
-    run Application.new
-
-## I18n
-
-    require "i18n"
-    require "redis-store"
-    I18n.backend = I18n::Backend::Redis.new
-
-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
+## Running tests
 
-    gem install jeweler bundler
     git clone git://github.com/jodosha/redis-store.git
-    cd redis-store
-    bundle install
-    REDIS_STORE_ENV=rails3 bundle install # to install Rails 3 gems
-    rake dtach:install
-    rake redis:install
-    rake
-    REDIS_STORE_ENV=rails3 rake # to test against Rails 3
+	cd redis-store/redis-store
+	gem install bundler --pre # required version: 1.1.rc
+	ruby ci/run.rb
 
-If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle install`
+If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" ruby ci/run.rb`
 
 ## Copyright
 

data/Rakefile

@@ -1,60 +1,13 @@
-$:.unshift 'lib'
-require 'rubygems'
+require 'bundler'
+Bundler.setup
 require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
-
-task :default => "spec:suite"
+require 'bundler/gem_tasks'
 
 begin
-  require "jeweler"
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name        = "#{ENV["GEM_PREFIX"]}redis-store"
-    gemspec.summary     = "Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks."
-    gemspec.description = "Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks."
-    gemspec.email       = "guidi.luca@gmail.com"
-    gemspec.homepage    = "http://github.com/jodosha/redis-store"
-    gemspec.authors     = [ "Luca Guidi" ]
-    gemspec.executables = [ ]
-    gemspec.add_dependency "redis", ">= 2.0.0"
-  end
-
-  Jeweler::GemcutterTasks.new
+  require 'rdoc/task'
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
-
-namespace :spec do
-  desc "Run all the examples by starting a detached Redis instance"
-  task :suite => :prepare do
-    invoke_with_redis_replication "spec:run"
-  end
-
-  Spec::Rake::SpecTask.new(:run) do |t|
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.spec_opts = %w(-fs --color)
-  end
-end
-
-desc "Run all examples with RCov"
-task :rcov => :prepare do
-  invoke_with_redis_replication "rcov_run"
-end
-
-Spec::Rake::SpecTask.new(:rcov_run) do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.rcov = true
-end
-
-task :prepare do
-  `mkdir -p tmp && rm tmp/*.rdb`
-end
-
-namespace :bundle do
-  task :clean do
-    system "rm -rf ~/.bundle/ ~/.gem/ .bundle/ Gemfile.lock"
-  end
+  require 'rake/rdoctask'
 end
 
-load "tasks/redis.tasks.rb"
+load 'tasks/redis.tasks.rb'
+task :default => 'redis:test:suite'

data/lib/redis-store.rb

@@ -1,45 +1,12 @@
-require "redis"
-require "redis/distributed"
-require "redis/factory"
-require "redis/store/interface"
-require "redis/store/ttl"
-require "redis/store/namespace"
-require "redis/store/marshalling"
-require "redis/store/version"
-require "redis/store"
-require "redis/distributed_store"
-
-# Cache store
-if defined?(Sinatra)
-  require "cache/sinatra/redis_store"
-elsif defined?(Merb)
-  # HACK for cyclic dependency: redis-store is required before merb-cache
-  module Merb; module Cache; class AbstractStore; end end end
-  require "cache/merb/redis_store"
-elsif defined?(ActiveSupport)
-  require "active_support/cache/redis_store"
-end
-
-# Rack::Session
-if defined?(Rack::Session)
-  require "rack/session/abstract/id"
-  require "rack/session/redis"
-  if defined?(Merb)
-    require "rack/session/merb"
+require 'redis'
+require 'redis/store'
+require 'redis/factory'
+require 'redis/distributed_store'
+require 'redis/store/namespace'
+require 'redis/store/marshalling'
+require 'redis/store/version'
+
+class Redis
+  class Store < self
   end
-end
-
-if defined?(Rails)
-  require "action_controller/session/redis_session_store"
-end
-
-# Rack::Cache
-if defined?(Rack::Cache)
-  require "rack/cache/key"
-  require "rack/cache/redis_metastore"
-  require "rack/cache/redis_entitystore"
-end
-
-if defined?(I18n)
-  require "i18n/backend/redis"
-end
+end

data/lib/redis/distributed_store.rb

@@ -1,10 +1,13 @@
+require 'redis/distributed'
+
 class Redis
   class DistributedStore < Distributed
+    @@timeout = 5
     attr_reader :ring
 
     def initialize(addresses, options = { })
       nodes = addresses.map do |address|
-        ::Redis::Store.new address
+        ::Redis::Store.new _merge_options(address, options)
       end
       _extend_namespace options
       @ring = Redis::HashRing.new nodes
@@ -35,5 +38,9 @@ class Redis
         @namespace = options[:namespace]
         extend ::Redis::Store::Namespace if @namespace
       end
+
+      def _merge_options(address, options)
+        address.merge(:timeout => options[:timeout] || @@timeout)
+      end
   end
 end

data/lib/redis/factory.rb

@@ -1,8 +1,10 @@
+require 'uri'
+
 class Redis
   class Factory
     def self.create(*redis_client_options)
       redis_client_options = redis_client_options.flatten.compact.inject([]) do |result, address|
-        result << convert_to_redis_client_options(address)
+        result << resolve(address)
         result
       end
       if redis_client_options.size > 1
@@ -12,32 +14,26 @@ class Redis
       end
     end
 
-    def self.convert_to_redis_client_options(address_or_options)
-      if address_or_options.is_a?(Hash)
-        options = address_or_options.dup
+    def self.resolve(uri) #:api: private
+      if uri.is_a?(Hash)
+        options = uri.dup
         options[:namespace] ||= options.delete(:key_prefix) # RailsSessionStore
         options
       else
-        if address_or_options =~ /redis\:\/\//
-          require 'uri'
-          uri = URI.parse address_or_options
-          _, db, namespace = if uri.path
-            uri.path.split /\//
-          end
-        else
-          warn "[DEPRECATION] `#{address_or_options}` is deprecated. Please use `redis://#{address_or_options}` instead."
-          address_or_options, password = address_or_options.split(/\@/).reverse
-          password = password.gsub(/\:/, "") if password
-          host, port = address_or_options.split /\:/
-          port, db, namespace = port.split /\// if port
+        uri = URI.parse(uri)
+        _, db, namespace = if uri.path
+          uri.path.split /\//
         end
 
-        options = {}
-        options[:host] = host || uri && uri.host
-        options[:port] = port || uri && uri.port
-        options[:db]  = db.to_i if db
+        options = {
+          :host     => uri.host,
+          :port     => uri.port,
+          :password => uri.password
+        }
+
+        options[:db]        = db.to_i   if db
         options[:namespace] = namespace if namespace
-        options[:password]  = password || uri && uri.password
+
         options
       end
     end