jodosha-redis-rails 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Luca Guidi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,28 @@
+h1. Redis store for Rails
+
+h2. Installation
+
+Download and install Redis from http://code.google.com/p/redis/
+
+  wget http://redis.googlecode.com/files/redis-0.091.tar.gz
+  tar -zxvf redis-0.091.tar.gz
+  cd redis-0.091
+  make
+
+Install the gems
+
+  sudo gem install ezmobius-redis-rb -s http://gems.github.com
+  sudo gem install jodosha-redis-rails -s http://gems.github.com
+
+h2. How to use with Rails
+
+In your configuration files:
+
+  config.gem "jodosha-redis-rails", :source => "http://gems.github.com"
+  config.cache_store = :redis_store
+
+Start Redis server, then your application.
+
+h2. Copyright
+
+(c) 2009 Luca Guidi - http://lucaguidi.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,29 @@
+$:.unshift 'lib'
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+REDIS_RAILS_VERSION = "0.0.1"
+
+task :default => :spec
+
+desc 'Build and install the gem (useful for development purposes).'
+task :install do
+  system "gem build redis-rails.gemspec"
+  system "sudo gem uninstall redis-rails"
+  system "sudo gem install --local --no-rdoc --no-ri redis-rails-#{REDIS_RAILS_VERSION}.gem"
+  system "rm redis-rails-*.gem"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+desc 'Show the file list for the gemspec file'
+task :files do
+  puts "Files:\n #{Dir['**/*'].reject {|f| File.directory?(f)}.sort.inspect}"
+  puts "Test files:\n #{Dir['spec/**/*_spec.rb'].reject {|f| File.directory?(f)}.sort.inspect}"
+end

data/lib/active_support/cache/redis_store.rb

@@ -0,0 +1,128 @@
+module ActiveSupport
+  module Cache
+    class RedisStore < Store
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new                       # => host: localhost,   port: 6379,  db: 0
+      #   RedisStore.new "example.com"         # => host: example.com, port: 6379,  db: 0
+      #   RedisStore.new "example.com:23682"   # => host: example.com, port: 23682, db: 0
+      #   RedisStore.new "example.com:23682/1" # => host: example.com, port: 23682, db: 1
+      def initialize(*addresses)
+        addresses = extract_addresses(addresses)
+        @data = if addresses.size > 1
+          DistributedMarshaledRedis.new addresses
+        else
+          MarshaledRedis.new addresses.first || {}
+        end
+      end
+
+      def write(key, value, options = nil)
+        super
+        method = options && options[:unless_exist] ? :set_unless_exists : :set
+        @data.send method, key, value, options
+      end
+
+      def read(key, options = nil)
+        super
+        @data.get key, options
+      end
+
+      def delete(key, options = nil)
+        super
+        @data.delete key
+      end
+
+      def exist?(key, options = nil)
+        super
+        @data.key? key
+      end
+
+      # Increment a key in the store.
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.increment "counter"
+      #   cache.read "counter", :raw => true      # => "24"
+      #
+      #   cache.increment "counter", 6
+      #   cache.read "counter", :raw => true      # => "30"
+      #
+      #   cache.increment "a counter"
+      #   cache.read "a counter", :raw => true    # => "1"
+      #
+      #   cache.increment "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "1"
+      def increment(key, amount = 1)
+        log "increment", key, amount
+        @data.incr key, amount
+      end
+
+      # Decrement a key in the store
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.decrement "counter"
+      #   cache.read "counter", :raw => true      # => "22"
+      #
+      #   cache.decrement "counter", 2
+      #   cache.read "counter", :raw => true      # => "20"
+      #
+      #   cache.decrement "a counter"
+      #   cache.read "a counter", :raw => true    # => "-1"
+      #
+      #   cache.decrement "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "-1"
+      def decrement(key, amount = 1)
+        log "decrement", key, amount
+        @data.decr key, amount
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.delete_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        super
+        @data.keys(matcher).each { |key| @data.delete key }
+      end
+
+      # Clear all the data from the store.
+      def clear
+        log "clear", nil, nil
+        @data.flush_db
+      end
+
+      def stats
+        @data.info
+      end
+      
+      private
+        def extract_addresses(addresses)
+          addresses = addresses.flatten.compact
+          addresses.inject([]) do |result, address|
+            host, port = address.split /\:/
+            port, db   = port.split /\// if port
+            address = {}
+            address[:host] = host if host
+            address[:port] = port if port
+            address[:db]  = db.to_i if db
+            result << address
+            result
+          end
+        end
+    end
+  end
+end

data/lib/redis/distributed_marshaled_redis.rb

@@ -0,0 +1,8 @@
+class DistributedMarshaledRedis < DistRedis
+  def initialize(addresses)
+    nodes = addresses.map do |address|
+      MarshaledRedis.new address
+    end
+    @ring = HashRing.new nodes
+  end
+end

data/lib/redis/marshaled_redis.rb

@@ -0,0 +1,26 @@
+class MarshaledRedis < Redis
+  def set(key, val, options = nil)
+    val = Marshal.dump val unless raw?(options)
+    super key, val, expires_in(options)
+  end
+
+  def set_unless_exists(key, val, options = nil)
+    val = Marshal.dump val unless raw?(options)
+    super key, val    
+  end
+
+  def get(key, options = nil)
+    result = super key
+    result = Marshal.load result if result && !raw?(options)
+    result
+  end
+  
+  private
+    def raw?(options)
+      options && options[:raw]
+    end
+
+    def expires_in(options)
+      options[:expires_in] if options
+    end
+end

data/lib/redis-rails.rb

@@ -0,0 +1,6 @@
+require "redis"
+require "dist_redis"
+require "activesupport"
+require "redis/marshaled_redis"
+require "redis/distributed_marshaled_redis"
+require "active_support/cache/redis_store"

data/redis-rails.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name               = "redis-rails"
+  s.version            = "0.0.1"
+  s.date               = "2009-04-11"
+  s.summary            = "Redis store for Rails"
+  s.author             = "Luca Guidi"
+  s.email              = "guidi.luca@gmail.com"
+  s.homepage           = "http://lucaguidi.com"
+  s.description        = "Redis store for Rails"
+  s.has_rdoc           = true
+  s.files              = ["MIT-LICENSE", "README.textile", "Rakefile", "lib/active_support/cache/redis_store.rb", "lib/redis-rails.rb", "lib/redis/distributed_marshaled_redis.rb", "lib/redis/marshaled_redis.rb", "redis-rails.gemspec", "spec/active_support/cache/redis_store_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/spec_helper.rb"]
+  s.test_files         = ["spec/active_support/cache/redis_store_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb"]
+  s.extra_rdoc_files   = ["README.textile"]
+end

data/spec/active_support/cache/redis_store_spec.rb

@@ -0,0 +1,132 @@
+require File.join(File.dirname(__FILE__), "/../../spec_helper")
+
+module ActiveSupport
+  module Cache
+    describe "RedisStore" do
+      before(:each) do
+        @store  = RedisStore.new
+        @rabbit = OpenStruct.new :name => "bunny"
+        @white_rabbit = OpenStruct.new :color => "white"
+        @store.write  "rabbit", @rabbit
+        @store.delete "counter"
+      end
+
+      it "should accept connection params" do
+        redis = instantiate_store
+        redis.instance_variable_get(:@db).should == 0
+        redis.host.should == "localhost"
+        redis.port.should == "6379"
+
+        redis = instantiate_store "redis.com"
+        redis.host.should == "redis.com"
+        
+        redis = instantiate_store "redis.com:6380"
+        redis.host.should == "redis.com"
+        redis.port.should == "6380"
+
+        redis = instantiate_store "redis.com:6380/23"
+        redis.instance_variable_get(:@db).should == 23
+        redis.host.should == "redis.com"
+        redis.port.should == "6380"
+      end
+
+      it "should instantiate a ring" do
+        store = RedisStore.new
+        store.instance_variable_get(:@data).should be_kind_of(MarshaledRedis)
+        store = RedisStore.new "localhost:6379/0", "localhost:6379/1"
+        store.instance_variable_get(:@data).should be_kind_of(DistributedMarshaledRedis)
+      end
+
+      it "should read the data" do
+        @store.read("rabbit").should === @rabbit
+      end
+
+      it "should write the data" do
+        @store.write "rabbit", @white_rabbit
+        @store.read("rabbit").should === @white_rabbit
+      end
+
+      # it "should write the data with expiration time" do
+      #   @store.write "rabbit", @white_rabbit, :expires_in => 1.second
+      #   @store.read("rabbit").should === @white_rabbit ; sleep 2
+      #   @store.read("rabbit").should be_nil
+      # end
+
+      it "should not write data if :unless_exist option is true" do
+        @store.write "rabbit", @white_rabbit, :unless_exist => true
+        @store.read("rabbit").should === @rabbit
+      end
+
+      it "should read raw data" do
+        @store.read("rabbit", :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\nbunny"
+      end
+
+      it "should write raw data" do
+        @store.write "rabbit", @white_rabbit, :raw => true
+        @store.read("rabbit", :raw => true).should == %(#<OpenStruct color="white">)
+      end
+
+      it "should delete data" do
+        @store.delete "rabbit"
+        @store.read("rabbit").should be_nil
+      end
+
+      it "should delete matched data" do
+        @store.delete_matched "rabb*"
+        @store.read("rabbit").should be_nil
+      end
+
+      it "should verify existence of an object in the store" do
+        @store.exist?("rabbit").should be_true
+        @store.exist?("rab-a-dub").should be_false
+      end
+
+      it "should increment a key" do
+        3.times { @store.increment "counter" }
+        @store.read("counter", :raw => true).to_i.should == 3
+      end
+
+      it "should decrement a key" do
+        3.times { @store.increment "counter" }
+        2.times { @store.decrement "counter" }
+        @store.read("counter", :raw => true).to_i.should == 1
+      end
+
+      it "should increment a key by given value" do
+        @store.increment "counter", 3
+        @store.read("counter", :raw => true).to_i.should == 3
+      end
+
+      it "should decrement a key by given value" do
+        3.times { @store.increment "counter" }
+        @store.decrement "counter", 2
+        @store.read("counter", :raw => true).to_i.should == 1
+      end
+
+      it "should clear the store" do
+        @store.clear
+        @store.instance_variable_get(:@data).keys("*").should be_empty
+      end
+
+      it "should return store stats" do
+        @store.stats.should_not be_empty
+      end
+
+      # it "should fetch data" do
+      #   @store.fetch("rabbit").should == @rabbit
+      #   @store.fetch("rab-a-dab").should be_nil
+      #   @store.fetch("rab-a-dab") { "Flora de Cana" }
+      #   @store.fetch("rab-a-dab").should === "Flora de Cana"
+      #   @store.fetch("rabbit", :force => true).should be_nil # force cache miss
+      #   @store.fetch("rabbit", :force => true, :expires_in => 1.second) { @white_rabbit }
+      #   @store.fetch("rabbit").should === @white_rabbit ; sleep 2
+      #   @store.fetch("rabbit").should be_nil
+      # end
+      
+      private
+        def instantiate_store(address = nil)
+          RedisStore.new(address).instance_variable_get(:@data)
+        end
+    end
+  end
+end

data/spec/redis/distributed_marshaled_redis_spec.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "DistributedMarshaledRedis" do
+  before(:each) do
+    @dmr = DistributedMarshaledRedis.new [{:db => 0}, {:db => 1}]
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    @dmr.set "rabbit", @rabbit
+  end
+
+  after(:all) do
+    @dmr.ring.nodes.each { |server| server.flush_db }
+  end
+
+  it "should accept connection params" do
+    dmr = DistributedMarshaledRedis.new [ :host => "redis.com", :port => "3680", :db => 1 ]
+    dmr.ring.should have(1).node
+    mr = dmr.ring.nodes.first
+    mr.host.should == "redis.com"
+    mr.port.should == "3680"
+    mr.instance_variable_get(:@db).should == 1
+  end
+
+  it "should set an object" do
+    @dmr.set "rabbit", @white_rabbit
+    @dmr.get("rabbit").should == @white_rabbit
+  end
+
+  it "should get an object" do
+    @dmr.get("rabbit").should == @rabbit
+  end
+end

data/spec/redis/marshaled_redis_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "MarshaledRedis" do
+  before(:each) do
+    @mr = MarshaledRedis.new
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    @mr.set    "rabbit", @rabbit
+    @mr.delete "rabbit2"
+  end
+
+  it "should unmarshal an object on get" do
+    @mr.get("rabbit").should === @rabbit
+  end
+
+  it "should marshal object on set" do
+    @mr.set "rabbit", @white_rabbit
+    @mr.get("rabbit").should === @white_rabbit
+  end
+
+  it "should not unmarshal object on get if raw option is true" do
+    @mr.get("rabbit", :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\nbunny"
+  end
+
+  it "should not marshal object on set if raw option is true" do
+    @mr.set "rabbit", @white_rabbit, :raw => true
+    @mr.get("rabbit", :raw => true).should == %(#<OpenStruct color="white">)
+  end
+
+  it "should not set an object if already exist" do
+    @mr.set_unless_exists "rabbit", @white_rabbit
+    @mr.get("rabbit").should === @rabbit
+  end
+
+  it "should marshal object on set_unless_exists" do
+    @mr.set_unless_exists "rabbit2", @white_rabbit
+    @mr.get("rabbit2").should === @white_rabbit
+  end
+
+  it "should not marshal object on set_unless_exists if raw option is true" do
+    @mr.set_unless_exists "rabbit2", @white_rabbit, :raw => true
+    @mr.get("rabbit2", :raw => true).should == %(#<OpenStruct color="white">)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$: << File.join(File.dirname(__FILE__), "/../lib")
+require "rubygems"
+require "ostruct"
+require "spec"
+require "redis"
+require "redis-rails"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: jodosha-redis-rails
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Luca Guidi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Redis store for Rails
+email: guidi.luca@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/active_support/cache/redis_store.rb
+- lib/redis-rails.rb
+- lib/redis/distributed_marshaled_redis.rb
+- lib/redis/marshaled_redis.rb
+- redis-rails.gemspec
+- spec/active_support/cache/redis_store_spec.rb
+- spec/redis/distributed_marshaled_redis_spec.rb
+- spec/redis/marshaled_redis_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://lucaguidi.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Redis store for Rails
+test_files: 
+- spec/active_support/cache/redis_store_spec.rb
+- spec/redis/distributed_marshaled_redis_spec.rb
+- spec/redis/marshaled_redis_spec.rb