cachedis 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,58 @@
 # Cachedis
 
-Cachedis caches your expensive queries to a Redis instance so the next time you fire it off, it'll load directly from cache instead of being run again. Optionally you can provide a cache expirement time.
+Cachedis caches your expensive queries to a Redis instance so the next time you fire it off, it'll load directly from cache instead of being run again. 
 
-    @cachedis = Cachedis.new
-
-    # performs query the first time, performs cached calls to Redis within the next 60 * 60 seconds
-    @cachedis.cachedis 'name-of-expensive-query', :expire => 60 * 60  do
+    cachedis 'expensive:query', :expire => 60 * 60  do
       Post.all.expensive_operation
     end
 
+## Documentation
+
+You can specify two types of options via constants:
+
+* `CACHEDIS_DEFAULT_OPTIONS`
+    - Passed directly to [redis-rb][rr]
+    - Options like host options, port options, etc.
+* `CACHEDIS_DEFAULT_QUERY_OPTIONS`
+    - Default options for the `cachedis` queries
+    - For instance if you always want queries to expire in an hour:
+        - `CACHEDIS_DEFAULT_QUERY_OPTIONS = { :expire => 60 * 60 * 60}`
+    - Overridden by options passed to `cachedis` directly
+
+`cachedis` takes two arguments in addition to a block which should return whatever you want `cachedis` to cache:
+
+    key, options = {}
+
+The key is the name of the key under which the objects are saved as in Redis. Options are send directly to the Redis instance in along. For instance the option could be expiring the key at a certain time:
+
+    include CachedisInterface
+
+    # expire in an hour using Redis' EXPIRE command
+    cachedis 'users:all:with_avatars', :expire => 60 * 60 * 60 do
+      User.all.with_avatars
+    end
+
+    # expire at unix timestamp with Redis' EXPIREAT command
+    cachedis 'expensive:query', :expireat => Time.new(2012,2,2).to_i do
+      # insert expensive query here
+    end
+
 ## Installation and dependencies
 
-Dependencies are: `redis-rb`
+Dependencies: [redis-rb][rr]
+
+Install: `gem install cachedis`
 
-Install with: `gem install cachedis`
+[Redis](http://redis.io) should be running in the background, start it with `redis-server`.
 
-## Wishlist
+## Wishlist/To do/To consider
 
-* Tight ActiveRecord integration
-* Make expirement optional
-* Serialize using BERT (fall back to YAML)
+* ActiveRecord integration
+    - `Post.all.expensive_operation.cachedis`
+* Make expirement time optional
+* Best serializing?
 * Sexify the API
-    - Make it easier to specialize expirement time (e.g. `:expire => 4.hours`)
+    - Make it easier to specialize expirement time (e.g. `:expire => 4.hours`), or just let this be for ActiveSupport users only?
+* Rename `Cachedis#cachedis`?
+
+[rr]: https://github.com/ezmobius/redis-rb

data/lib/cachedis/version.rb

@@ -1,3 +1,3 @@
 class Cachedis
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/cachedis.rb

@@ -8,17 +8,36 @@ class Cachedis
     redis(options)
   end
 
-  def cachedis(name, options = {}, &block)
+  def cachedis(key, options = {}, &block)
     result = yield
     
-    return redis.get name if redis.exists name
+    return redis.get key if redis.exists key
 
-    redis.set name, result.to_yaml
-    redis.expire name, options[:expire] || 60 * 60 # set expire to user specified or one minute
+    result = result.to_yaml
+    redis.set key, result
+    pass_options_to_redis(options)
+
+    result
   end
 
-  private
   def redis(options = {})
     @redis_instance ||= Redis.new(options)
   end
+
+  private
+  def pass_options_to_redis(options)
+    options.each do |option, argument|
+      arguments = *[argument] if argument.is_a?(Array)
+      redis.send(option, arguments || argument)
+    end
+  end
+end
+
+module CachedisInterface
+  def self.cachedis(name, options = {}, &block)
+    cachedis = Cachedis.new((CACHEDIS_DEFAULT_OPTIONS if defined?(CACHEDIS_DEFAULT_OPTIONS))|| {})
+    
+    query_options = ((CACHEDIS_DEFAULT_QUERY_OPTIONS if defined?(CACHEDIS_OPTIONS)) || {}).merge(options)
+    cachedis.cachedis(name, query_options, &block)
+  end
 end

data/spec/base_spec.rb

@@ -9,8 +9,7 @@ describe Cachedis do
 
   describe 'when setting something' do
     it 'sets without errors' do
-      with_no_cache
-      @cachedis.redis_instance.should_receive(:set).exactly(1).times.and_return(['element', 'element 2'].to_yaml)
+      with_no_cache(['element', 'element 2'])
       
       lambda { 
       @cachedis.cachedis 'expensive-query' do
@@ -31,4 +30,27 @@ describe Cachedis do
       result.should == "query".to_yaml
     end
   end
+
+  describe 'when setting additonal redis parameters' do
+    context 'with one argument' do
+      it 'sets them in redis' do
+        with_no_cache
+
+        @cachedis.redis_instance.should_receive(:expire).exactly(1).times
+
+        @cachedis.cachedis 'name', :expire => 60 * 60 do
+        end
+      end
+    end
+
+    context 'with an array of arguments' do
+      it 'sets them in redis' do
+        with_no_cache
+        @cachedis.redis_instance.should_receive(:rename).exactly(1).times
+
+        @cachedis.cachedis 'name', :rename => ['key', 'otherkey'] do
+        end
+      end
+    end
+  end
 end

data/spec/interface_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe CachedisInterface do
+  include HelperMethods
+
+  describe 'when setting something' do
+    it 'sets without errors' do
+      @mock = mock(Cachedis)
+      Cachedis.should_receive(:new).exactly(1).times.and_return(@mock)
+      @mock.stub!(:cachedis).and_return(['element', 'element 2'])
+      
+      CachedisInterface.cachedis 'expensive-query' do
+        ['element', 'element 2']
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,12 +4,13 @@ require 'cachedis'
 require 'rspec'
 
 module HelperMethods
-  def with_no_cache
-    @cachedis.redis_instance.should_receive(:exists).exactly(1).times.and_return(nil)
+  def with_no_cache(cache = nil)
+    @cachedis.redis.should_receive(:exists).exactly(1).times.and_return(false)
+    @cachedis.redis.should_receive(:set).exactly(1).times.and_return(cache)
   end
 
   def with_cache(cache)
-    @cachedis.redis_instance.should_receive(:exists).exactly(1).times.and_return(true)
-    @cachedis.redis_instance.should_receive(:get).exactly(1).times.and_return(cache.to_yaml)
+    @cachedis.redis.should_receive(:exists).exactly(1).times.and_return(true)
+    @cachedis.redis.should_receive(:get).exactly(1).times.and_return(cache.to_yaml)
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Simon H\xC3\xB8rup Eskildsen"
@@ -76,6 +76,7 @@ files:
 - lib/cachedis.rb
 - lib/cachedis/version.rb
 - spec/base_spec.rb
+- spec/interface_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: ""
@@ -111,4 +112,5 @@ specification_version: 3
 summary: Caches expensive database queries in Redis
 test_files: 
 - spec/base_spec.rb
+- spec/interface_spec.rb
 - spec/spec_helper.rb