rails_redis_cache 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,6 +1,6 @@
 == About
 
-Cache store implementation for Rails 3 using the key value store Redis.
+Cache store implementation for Rails 3 using the key value store Redis[http://code.google.com/p/redis].
 
 == Usage
 
@@ -12,11 +12,17 @@ In the environment.rb or environments-files write:
   
   config.cache_store = ActiveSupport::Cache::RailsRedisCache.new(:url => ENV['RAILS_REDIS_CACHE_URL'])
 
-== Installing Redis
+Using the cache is simple:
+
+  @tweets = cache("tweets", :expires_in => 30.seconds){ Twitter::Search.new(...) }
+
+== Installing Redis with homebrew
 
 Using a local Redis server for testing is simple:
 
   brew install redis
   redis-server
 
+== Changelog
 
+See CHANGELOG file for further information.

data/lib/rails_redis_cache.rb

@@ -4,7 +4,22 @@ require 'redis'
 require 'time'
 
 module ActiveSupport
-  module Cache
+  module Cache    
+    
+    # RailsRedisCache is Rails 3 cache store implementation using the key value store Redis.
+    # 
+    # Author::    Peter Schröder  (mailto:phoetmail@googlemail.com)
+    # 
+    # ==Usage
+    # 
+    # Add the gem to your Gemfile
+    # 
+    #   gem "rails_redis_cache"
+    # 
+    # and configure the cache store
+    # 
+    #   config.cache_store = ActiveSupport::Cache::RailsRedisCache.new(:url => ENV['RAILS_REDIS_CACHE_URL'])
+    # 
     class RailsRedisCache < Store
       
       TIME_PREF = "rails_redis_cache_time"
@@ -12,35 +27,23 @@ module ActiveSupport
       
       attr_reader :redis
       
+      # Initializes the cache store and opens a connection to Redis.
+      # 
+      #   ActiveSupport::Cache::RailsRedisCache.new(:url => ENV['RAILS_REDIS_CACHE_URL'])
+      # 
+      # ==== Options:
+      # 
+      # [url] the url to the Redis instance
+      # 
+      # ==== More Options:
+      # 
+      # Have a look at redis-rb and Rails docs for further options
+      # 
       def initialize(options={})
         super(options)
         @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)
@@ -67,6 +70,33 @@ module ActiveSupport
         cleanup(options)
       end
       
+      # ============================= basic store impl ==============================
+      
+      protected
+      
+      def read_entry(key, options)
+        raw_value = @redis.get "#{VALUE_PREF}_#{key}"
+        return nil unless raw_value
+        
+        raw_time = @redis.get("#{TIME_PREF}_#{key}")
+        time = raw_time.nil? ? nil : Time.parse(raw_time)
+        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
+            
     end
   end 
 end

data/test/test_rails_redis_cache.rb

@@ -99,5 +99,11 @@ class TestRailsRedisCache < Test::Unit::TestCase
     @cache.cleanup
     assert_equal(0, @cache.redis.dbsize)
   end
+  
+  def test_edge_case_with_missing_time_key
+    @cache.write(@key, @value)
+    @cache.redis.del "#{ActiveSupport::Cache::RailsRedisCache::TIME_PREF}_#{@key}"
+    assert_equal(@value, @cache.read(@key))
+  end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_redis_cache
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - "Peter Schr\xC3\xB6der"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-10 00:00:00 +02:00
+date: 2010-08-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 867219037
+        hash: 680265570
         segments: 
         - 3
         - 0