rails_redis_cache 0.0.1

data/README.rdoc

@@ -0,0 +1 @@
+redis cache for rails3

data/lib/rails_redis_cache.rb

@@ -0,0 +1,72 @@
+require 'active_support'
+require 'base64'
+require 'redis'
+require 'time'
+
+module ActiveSupport
+  module Cache
+    class RailsRedisCache < Store
+      
+      TIME_PREF = "rails_redis_cache_time"
+      VALUE_PREF = "rails_redis_cache_value"
+      
+      attr_reader :redis
+      
+      def initialize(options={})
+        super()
+        @redis = Redis.connect(options)
+      end
+      
+      # ============================= basic store impl ==============================
+      
+      def read_entry(key, options)
+        raw_value = @redis.get "#{VALUE_PREF}_#{key}"
+        return nil unless raw_value
+        
+        time = Time.parse @redis.get("#{TIME_PREF}_#{key}")
+        value = Marshal.load(Base64.decode64(raw_value))
+        ActiveSupport::Cache::Entry.create value, time
+      end
+
+      def write_entry(key, entry, options)
+        value = Base64.encode64(Marshal.dump(entry.value))
+        time = Time.now
+        @redis.mset "#{VALUE_PREF}_#{key}", value, "#{TIME_PREF}_#{key}", time
+        return unless expiry = options[:expires_in]
+        @redis.expire "#{VALUE_PREF}_#{key}", expiry
+        @redis.expire "#{TIME_PREF}_#{key}", expiry
+      end
+
+      def delete_entry(key, options)
+        @redis.del "#{VALUE_PREF}_#{key}", "#{TIME_PREF}_#{key}"
+      end
+      
+      # ============================= optional store impl ==============================
+      
+      def delete_matched(matcher, options = nil)
+        @redis.keys("#{VALUE_PREF}_*").map{|key| key[(VALUE_PREF.size + 1)..-1] }.grep(matcher).each do |key| 
+          delete_entry(key, options)
+        end.size
+      end
+
+      def increment(name, amount = 1, options = nil)
+        write(name, amount + read(name, options).to_i, options)
+      end
+
+      def decrement(name, amount = 1, options = nil)
+        write(name, -1 * amount + read(name, options).to_i, options)
+      end
+
+      def cleanup(options = nil)
+        p value_keys = @redis.keys("#{VALUE_PREF}_*")
+        p time_keys = @redis.keys("#{TIME_PREF}_*")
+        @redis.del *(value_keys + time_keys)
+      end
+
+      def clear(options = nil)
+        cleanup(options)
+      end
+      
+    end
+  end 
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
+require 'test/unit'

data/test/test_rails_redis_cache.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+require 'rails_redis_cache'
+require 'logger'
+
+class TestRailsRedisCache < Test::Unit::TestCase
+  
+  def setup
+    ActiveSupport::Cache::RailsRedisCache.logger = Logger.new(STDOUT)
+    @cache = ActiveSupport::Cache::RailsRedisCache.new(:url => ENV['RAILS_REDIS_CACHE_URL'])
+    @cache.redis.flushdb
+    @value = "entry"
+    @key = "key"
+    @options = {:option => 'any'}
+  end
+
+  def test_delete_no_error
+    @cache.delete(@key, @options)
+  end
+  
+  def test_write_no_error
+    @cache.write(@key, @value, @options)
+  end
+  
+  def test_read_no_error
+    @cache.read(@key, @options)
+  end  
+  
+  def test_read_write
+    @cache.delete(@key, @options)
+    assert_nil(@cache.read(@key, @options))
+    @cache.write(@key, @value, @options)
+    assert_equal(@value, @cache.read(@key, @options))
+  end
+  
+  def test_expires_in
+    @cache.write(@key, @value, :expires_in=>2.seconds)
+    assert_equal(@value, @cache.read(@key, @options))
+    sleep(3)
+    assert_nil(@cache.read(@key, @options))
+  end
+
+  def test_fetch
+    count = 0
+    @cache.fetch(@key, :expires_in=>3.seconds) {count += 1}
+    @cache.fetch(@key) {count += 1}
+    @cache.fetch(@key) {count += 1}
+    assert_equal(count, 1)
+    @cache.delete(@key)
+    @cache.fetch(@key, :expires_in=>0.seconds) {count += 1}
+    assert_equal(count, 2)
+  end
+  
+  def test_fetch_with_proc
+    @cache.fetch(@key, @options, &lambda{@value})
+  end
+  
+  def test_fetch_with_array
+    @cache.fetch(@key, @options){[@value]}
+    assert_equal([@value], @cache.fetch(@key, @options))
+  end
+  
+  def test_delete_matched
+    @cache.write('aaaa', @value, @options)
+    @cache.write('aaa', @value, @options)
+    @cache.write('aa', @value, @options)
+    assert_equal(3, @cache.delete_matched(/aa+/, @options))
+    assert_nil(@cache.read('aaaa', @options))
+    assert_nil(@cache.read('aaa', @options))
+    assert_nil(@cache.read('aa', @options))
+  end
+  
+  def test_create_exist?
+    @cache.write(@key, @value, @options)
+    assert_equal(true, @cache.exist?(@key, @options))
+  end
+
+  def test_delete_exists
+    @cache.write(@key, @value, @options)
+    @cache.delete(@key, @options)
+    assert_equal(false, @cache.exist?(@key, @options))
+  end
+  
+  def test_increment
+    @cache.write(@key, 1)
+    assert_equal(1, @cache.read(@key).to_i)
+    @cache.increment(@key)
+    assert_equal(2, @cache.read(@key).to_i)
+  end
+  
+  def test_decrement
+    @cache.write(@key, 1)
+    assert_equal(1, @cache.read(@key).to_i)
+    @cache.decrement(@key)
+    assert_equal(0, @cache.read(@key).to_i)
+  end
+  
+  def test_cleanup
+    @cache.write(@key, @value)
+    @cache.cleanup
+    assert_equal(0, @cache.redis.dbsize)
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: rails_redis_cache
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Peter Schr\xC3\xB6der"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: -1442725791
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Rails cache store implementation using Redis.
+email: phoetmail@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rails_redis_cache.rb
+- README.rdoc
+- test/test_helper.rb
+- test/test_rails_redis_cache.rb
+has_rdoc: true
+homepage: http://github.com/phoet/rails_redis_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- -a
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails cache store implementation using Redis.
+test_files: 
+- test/test_helper.rb
+- test/test_rails_redis_cache.rb