redis-cache 0.0.0 → 1.0.0.rc1

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0.rc1 2011-06-08
+
+  * Initial release.

data/README.rdoc

@@ -0,0 +1,26 @@
+= redis-cache
+
+* https://github.com/antage/redis-cache
+
+== DESCRIPTION
+
+ActiveSupport cache adapter for Redis.
+
+== SYNOPSIS
+
+=== RUBY EXAMPLE
+
+  require "active_support"
+
+  cache = ActiveSupport::Cache.lookup_store :redis_store, { :host => "localhost", :port => "6379", :db => 1, :namespace => "test-ns" }
+  cache.write("abc", "test") # you can use options :expires_in and :raw
+  cache.read("abc")          # should be "test"
+
+=== RAILS EXAMPLE
+
+  # config/environments/production.rb:
+  Rails3::Application.configure do
+    ...
+    config.cache_store = :redis_store, { :host => "localhost", :port => 6379, :db => 1, :namespace => "rails_app" }
+    ...
+  end

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)

data/lib/active_support/cache/redis_store.rb

@@ -0,0 +1,95 @@
+begin
+  require "redis"
+rescue LoadError => e
+  $stderr.puts "You don't have redis installed in your application. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+
+require "active_support/time"
+
+module ActiveSupport
+  module Cache
+    class RedisStore < Store
+      def initialize(options = nil)
+        super(options)
+
+        options = { :logger => self.class.logger }.merge(options || {})
+        @redis = ::Redis.new(options)
+
+        extend Strategy::LocalCache
+      end
+
+      def reconnect
+        @redis and @redis.reconnect
+      end
+
+      def clear(options = nil)
+        @redis.flushdb
+      end
+
+      def increment(name, amount = 1, options = nil)
+        options = merged_options(options)
+        response = instrument(:increment, name, :amount => amount) do
+          @redis.incrby(namespaced_key(name, options), amount)
+        end
+        response
+      end
+
+      def decrement(name, amount = 1, options = nil)
+        options = merged_options(options)
+        response = instrument(:decrement, name, :amount => amount) do
+          @redis.decrby(namespaced_key(name, options), amount)
+        end
+        response
+      end
+
+      def read_multi(*names)
+        options = names.extract_options!
+        options = merged_options(options)
+        keys_to_names = Hash[names.map{|name| [namespaced_key(name, options), name]}]
+        raw_values = @redis.mget(*keys_to_names.keys)
+        values = {}
+        keys_to_names.keys.zip(raw_values).each do |key, value|
+          entry = deserialize_entry(value)
+          values[keys_to_names[key]] = entry.value unless entry.expired?
+        end
+        values
+      end
+
+      protected
+        def read_entry(key, options)
+          deserialize_entry @redis.get(key)
+        end
+
+        def write_entry(key, entry, options)
+          method = options && options[:unless_exist] ? :setnx : :set
+          value = options[:raw] ? entry.value : Marshal.dump(entry)
+
+          @redis.send(method, key, value)
+
+          expires_in = options[:expires_in].to_i
+          if expires_in > 0
+            if !options[:raw]
+              # Set the redis expire a few minutes in the future to support race condition ttls on read
+              expires_in += 5.minutes
+            end
+            @redis.expire(key, expires_in)
+          end
+        end
+
+        def delete_entry(key, options)
+          @redis.del(key)
+        end
+
+      private
+        def deserialize_entry(raw_value)
+          if raw_value
+            entry = Marshal.load(raw_value) rescue raw_value
+            entry.is_a?(Entry) ? entry : Entry.new(entry)
+          else
+            nil
+          end
+        end
+    end
+  end
+end

data/spec/redis_store_spec.rb

@@ -0,0 +1,151 @@
+require "active_support"
+
+describe "ActiveSupport::Cache::RedisStore" do
+  let!(:redis_options) do
+    {
+      :host => "localhost",
+      :port => 6379,
+      :db => 0
+    }
+  end
+
+  context "ActiveSupport::Cache.lookup_store :redis_store with options" do
+    subject { lambda { ActiveSupport::Cache.lookup_store :redis_store, redis_options } }
+
+    it "should not raise any exceptions" do
+      should_not raise_error
+    end
+
+    it "should return instance of ActiveSupport::Cache::RedisStore" do
+      subject.call.should be_instance_of(ActiveSupport::Cache::RedisStore)
+    end
+  end
+
+  context "instance" do
+    let!(:store) { ActiveSupport::Cache.lookup_store :redis_store, redis_options }
+
+    before(:each) do
+      store.clear
+    end
+    
+    context "#clear" do
+      before(:each) do
+        store.write("abc_entity", "test")
+        store.clear
+      end
+
+      it "should clear store" do
+        store.read("abc_entity").should be_nil
+      end
+    end
+    
+    context "with key 'abc' consisting 'test'" do
+      before(:each) do
+        store.write("abc", "test")
+      end
+
+      it "should be #exist?" do
+        store.exist?("abc").should be_true
+      end
+      
+      it "should return 'test' when #read('abc')" do
+        store.read("abc").should == "test"
+      end
+    end
+    
+    context "with keys 'a1', 'a2', 'a3', #read_multi('a1', 'a2', 'a3')" do
+      before(:each) do
+        store.write("a1", "test1")
+        store.write("a2", "test2")
+        store.write("a3", "test3")
+      end
+
+      subject { store.read_multi("a1", "a2", "a3") }
+
+      (1..3).each do |i|
+        it "should have key 'a#{i}'" do
+          should be_has_key("a#{i}")
+        end
+
+        it "#['a#{i}'] should == 'test#{i}'" do
+          subject["a#{i}"].should == "test#{i}"
+        end
+      end
+    end
+
+    context "with raw value 5 in key 'abc'" do
+      before(:each) do
+        store.write("abc", 5, :raw => true)
+      end
+
+      it "#read('abc') should return 5 as String" do
+        store.read("abc").should be_instance_of(String)
+        store.read("abc").should == "5"
+      end
+    end
+
+    context "with crazy key characters" do
+      let(:crazy_key) { "#/:*(<+=> )&$%@?;'\"\'`~- \t" }
+
+      it "should write the key and should not raise any exceptions" do
+        lambda { store.write(crazy_key, "test") }.should_not raise_error
+      end
+
+      it "should read the key and should not raise any exceptions" do
+        lambda { store.read(crazy_key) }.should_not raise_error
+      end
+    end
+
+    context "with raw key 'abc' == 5" do
+      before(:each) do
+        store.write("abc", 5, :raw => true)
+      end
+
+      it "#increment('abc', 2) should return 7 and change key 'abc' to 7" do
+        store.increment("abc", 2).should == 7
+        store.read("abc").to_i.should == 7
+      end
+
+      it "#decrement('abc', 2) should return 3 and change key 'abc' to 3" do
+        store.decrement("abc", 2).should == 3
+        store.read("abc").to_i.should == 3
+      end
+    end
+
+    context "#delete('abc')" do
+      before(:each) do
+        store.write("abc", "test")
+      end
+
+      it "should delete key" do
+        store.delete("abc")
+        store.exist?("abc").should be_false
+      end
+    end
+
+    context "#fetch('abc', ...)" do
+      before(:each) do
+        store.write("abc", true)
+      end
+      
+      it "should fetch value from cache" do
+        store.fetch("abc") { false }.should be_true
+      end
+    end
+  end
+
+  context "instances with different namespaces" do
+    let(:store_ns1) { ActiveSupport::Cache.lookup_store :redis_store, redis_options.merge(:namespace => "ns1") }
+    let(:store_ns2) { ActiveSupport::Cache.lookup_store :redis_store, redis_options.merge(:namespace => "ns2") }
+
+    before(:each) do
+      store_ns1.write("abc", "test1")
+      store_ns2.write("abc", "test2")
+    end
+
+    it "shouldn't inteferent each to other" do
+      store_ns1.read("abc").should == "test1"
+      store_ns2.read("abc").should == "test2"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "rspec"
+
+RSpec.configure do |c|
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: redis-cache
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.0
+  prerelease: 6
+  version: 1.0.0.rc1
 platform: ruby
 authors: 
 - Anton Ageev
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 +04:00
-default_executable: 
+date: 2011-06-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -30,11 +29,33 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 2.2.0
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  version_requirements: *id004
 description: 
 email: 
 - antage@gmail.com
@@ -45,13 +66,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gitignore
-- Gemfile
+- README.rdoc
+- History.txt
 - Rakefile
 - lib/redis-cache.rb
-- redis-cache.gemspec
-has_rdoc: true
-homepage: ""
+- lib/active_support/cache/redis_store.rb
+- spec/spec_helper.rb
+- spec/redis_store_spec.rb
+homepage: https://github.com/antage/redis-cache
 licenses: []
 
 post_install_message: 
@@ -68,15 +90,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: ActiveSupport cache adapter for Redis
-test_files: []
-
+test_files: 
+- spec/spec_helper.rb
+- spec/redis_store_spec.rb

data/.gitignore

@@ -1,5 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-.rvmrc

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in redis-cache.gemspec
-gemspec

data/redis-cache.gemspec

@@ -1,20 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name        = "redis-cache"
-  s.version     = "0.0.0"
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Anton Ageev"]
-  s.email       = ["antage@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{ActiveSupport cache adapter for Redis}
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_dependency "activesupport", ">= 3.0.0"
-  s.add_dependency "redis", "~> 2.2.0"
-end