simple_redis_cache 0.0.1 → 0.0.2

data/README.markdown

@@ -1,9 +1,54 @@
 SimpleRedisCache
 ================
 
-_SimpeRedisCache_ is a simple ruby module allowing for caching the result of a block in redis for a given time period.
+Easily cache the result of a block within redis for a given time period.
 
-Let's cache something for 1 minut
+Let's cache something for 1 minute
 
 ```ruby
-    cache('hello', :ttl=>1){ 'world' }
+    class MyClass
+
+      include SimpleRedisCache
+
+      def hello
+        cache('hello', :ttl=>60){ 'world' }
+      end
+    end
+```
+
+Call it straight from the module instead and this time cache it forever.
+
+```ruby
+    SimpleRedisCache.cache('hello') { 'world' }
+```
+
+Maybe we should cache something worth while.  If the result of the block is not a string, make sure to convert it to one.
+
+```ruby
+  require 'json'
+
+  JSON.parse(cache('20_perm_4', :ttl=>120){ (0..20).to_a.permutation(4).to_a.to_json })
+```
+
+Notice we serialize to json inside the block and from json outside the block.  Of course converting an enormous array
+to and from JSON is slower than the permutation so maybe it's not the best example.  Replace the above with an expensive
+databse calculation and it makes more sense.
+
+
+The above uses the default _Redis.new_ instance running on _127.0.0.1:6379_
+
+Let's configure a different redis instance.
+
+```ruby
+  SimpleRedisCache::Config.redis =  Redis.new(:host => "10.0.1.1", :port => 6380)
+```
+
+My benchmarks show this is faster than your current cache.
+
+
+But why would I use this?
+------------------------
+Because you already depend on redis through _Resque_.
+
+
+

data/lib/simple_redis_cache.rb

@@ -2,12 +2,11 @@ require 'redis'
 
 module SimpleRedisCache
 
-  def redis=(redis)
-    @redis = redis
-  end
+  extend self
+
 
   def redis
-    @redis ||= Redis.new
+    Config.redis
   end
 
   def cache(key, opts={}, &block)
@@ -18,4 +17,15 @@ module SimpleRedisCache
     value
   end
 
+  module Config
+
+    def self.redis=(redis)
+      @redis = redis
+    end
+
+    def self.redis
+      @redis ||= Redis.new
+    end
+  end
+
 end

data/lib/simple_redis_cache/version.rb

@@ -1,3 +1,3 @@
 module SimpleRedisCache
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/simple_redis_cache_test.rb

@@ -11,27 +11,48 @@ class SimpleRedisCacheTest < Test::Unit::TestCase
   end
 
 
-
   def test_expire_block
-    cache('hello', :ttl=>1){ 'world' }
+    cache('hello', :ttl=>1) { 'world' }
     sleep(2)
     assert_nil(redis['hello'])
   end
 
   def test_cache
-    cache('hello'){ 'world' }
+    cache('hello') { 'world' }
     assert_equal(redis['hello'], 'world')
   end
 
   def test_cache_with_expire_block
-    assert_equal('world', cache('hello', :ttl=>1000){ 'world' })
+    assert_equal('world', cache('hello', :ttl=>1000) { 'world' })
   end
 
   def test_block_is_only_executed_once
     @index = 0
-    2.times{ cache('hello'){ @index+=1 } }
+    2.times { cache('hello') { @index+=1 } }
     assert_equal(@index, 1)
   end
 
+  class MyClass
+    include SimpleRedisCache
+  end
+
+
+  def test_config_singleton_redis
+    shared_redis                   = Redis.new
+    SimpleRedisCache::Config.redis = shared_redis
+    assert_same(shared_redis.object_id, MyClass.new.redis.object_id)
+  end
+
+  def test_cache_on_module_method
+    SimpleRedisCache.cache('hello') { 'world' }
+    assert_equal(redis['hello'], 'world')
+  end
+
+  require 'json'
+  def test_cache_permutations
+    assert_equal( (0..20).to_a.permutation(3).to_a, JSON.parse(cache('20_perm_4'){ (0..20).to_a.permutation(3).to_a.to_json }) )
+  end
+
+
 
 end

metadata

@@ -2,7 +2,7 @@
 name: simple_redis_cache
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - kbaum
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 Z
+date: 2011-05-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: redis
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: simple_redis_cache
-rubygems_version: 1.7.2
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
 summary: simple api for caching strings in redis and passing a time to live