itrigga-cache 0.2.1 → 0.3.0

data/README.rdoc

@@ -27,6 +27,40 @@ This will
 - render the content
 - cache the *rendered* output
 - set the :content_type according to the pasted in value (defaults to 'text/html')
+
+== Content-type, respond_to and response status codes
+With controller caching, there are a couple of gotchas. 
+- If you need to return a non-200 HTTP status code, set it in @status
+- The cached value will be the *return value* of the block
+- respond_to doesn't return anything - so it can break the nice and simple pattern
+
+So, if you're not using an explicit render statement, you'll need to render_to_string as the last action of your cache block:
+
+def tracker_stats
+  with_controller_cache( :key=>default_cache_key ) {
+    do_some_stuff_that_takes_a_long_time
+    @title = "#{@client.name} Tracker Stats"
+    @header = "#{@client.name} Tracker Stats"
+
+    render_to_string # <- this will be the cached value
+  }
+end 
+
+If you're using respond_to, you need to do it like this:
+
+with_controller_cache(opts) do
+	respond_to do |format|
+		format.html{
+			@content = render_to_string
+		}
+		format.js {
+			@content_type = 'text/javascript'
+			@content = render_to_string
+		}
+	end
+	@content
+end
+
 To bypass the cache just have the "freshen" => true key in the params (ie as a query string param). This will force fresh the cache
 
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/itrigga/cache/cache.rb

@@ -4,7 +4,7 @@ require 'trigga/param_fu'
 module Itrigga
   module Cache
     
-    @@ITRIGGA_CACHE_TYPE = :filecache
+    @default_cache_type = :filecache
     
     def self.included(base)
       base.extend(ClassMethods)
@@ -14,8 +14,8 @@ module Itrigga
     end
     
     def self.setup!(opts ={})
+      @default_cache_type = opts[:backend] if opts[:backend]
       if opts[:backend] == :memcached
-        @@ITRIGGA_CACHE_TYPE = :memcached
         Itrigga::Cache::Memcache.setup!(opts)       
       else
         Itrigga::Cache::Filecache.setup!(opts)
@@ -23,7 +23,7 @@ module Itrigga
     end
     
     def self.instance(opts = {})
-      case ( opts[:backend] ||= @@ITRIGGA_CACHE_TYPE )
+      case ( opts[:backend] ||= @default_cache_type )
         when :memcached          
           Itrigga::Cache::Memcache.instance
         when :filecache
@@ -102,7 +102,7 @@ module Itrigga
       
       def get_from_cache(key, opts = {})
         return nil unless caching_enabled?(opts)
-        cache_log "get_from_cache key: #{key},  opts: #{opts.inspect}" #if opts[:debug]
+        cache_log "get_from_cache key: #{key},  opts: #{opts.inspect}" if opts[:debug]
         begin
           Itrigga::Cache.instance(opts).get key
         rescue Memcached::NotFound => not_found
@@ -119,7 +119,7 @@ module Itrigga
       def set_to_cache(key, value, opts = {})
         raise "Cache not Enabled" unless caching_enabled?(opts)
               
-        cache_log "set_to_cache key: #{key}, value: #{value}, opts: #{opts.inspect}"# if opts[:debug]
+        cache_log "set_to_cache key: #{key}, value: #{value}, opts: #{opts.inspect}" if opts[:debug]
         begin
           Itrigga::Cache.instance(opts).set key, value, opts
         rescue Exception => e
@@ -182,7 +182,7 @@ module Itrigga
           @content ||= render_to_string unless performed?
         end
         
-        render(:text=>@content, :content_type=>( @content_type || "text/html")) unless performed?
+        render(:text=>@content, :content_type=>( @content_type || "text/html"), :status=>@status) unless performed?
         
         @content
         

data/spec/itrigga-cache_spec.rb

@@ -20,6 +20,7 @@ end
 
 describe Itrigga::Cache do
   before do
+    Itrigga::Cache.setup!(:backend=>:filecache)
     @klass = TriggaCacheTestClass.new
     @klass.stub!(:cache_log) # stub out the logging method in tests
   end
@@ -61,6 +62,10 @@ describe Itrigga::Cache do
   end
   
   describe "instance" do    
+    before(:each) do
+      Itrigga::Cache.setup!(:backend=>:filecache)
+    end
+    
     it "should initialize the memcache client" do
       Itrigga::Cache::Memcache.should_receive(:instance).and_return(@instance = mock("Instance"))
       Itrigga::Cache.instance(:backend => :memcached).should == @instance
@@ -71,9 +76,15 @@ describe Itrigga::Cache do
       Itrigga::Cache.instance(:backend => :filecache).should == @instance
     end
       
-  
-    it "should return the default @@ITRIGGA_CACHE_TYPE" do
-      Itrigga::Cache::Filecache.should_receive(:instance).and_return(@instance = mock("Instance", :cache => "a cache"))
+    context "when no backend given" do
+      it "should call instance on the default @@ITRIGGA_CACHE_TYPE" do
+        Itrigga::Cache::Filecache.should_receive(:instance).and_return(@instance = mock("Instance", :cache => "a cache"))
+        Itrigga::Cache.instance()
+      end
+    end
+      
+    it "should return the subclass instance" do
+      Itrigga::Cache::Filecache.stub!(:instance).and_return(@instance = mock("Instance", :cache => "a cache"))
       Itrigga::Cache.instance().should == @instance
     end
   end
@@ -169,11 +180,17 @@ describe Itrigga::Cache do
     before do
       Itrigga::Cache.stub!(:instance).and_return(@cache = mock("Cache"))
       @cache.stub!(:get).and_return("funky")
+      @cache.stub!(:enabled).and_return(true)
     end
     
-    it "should return nil if caching disabled" do
-      Itrigga::Cache.should_receive(:instance).and_return(nil)
-      @klass.class.send("get_from_cache","monkeys").should == nil
+    context "if caching disabled" do
+      before(:each) do
+        @cache.stub!(:enabled).and_return(false)
+      end
+      it "should return nil" do
+        @klass.class.send("get_from_cache","monkeys").should == nil
+      end
+    
     end
     
     it "should call get with the key" do
@@ -198,6 +215,7 @@ describe Itrigga::Cache do
     before do
       Itrigga::Cache.stub!(:instance).and_return(@cache = mock("Cache"))
       @cache.stub!(:set)
+      @cache.stub!(:enabled).and_return(true)
     end
         
     describe "when no timeout" do
@@ -357,10 +375,19 @@ describe Itrigga::Cache do
       end
       
       it "should call render" do
-        @controller.should_receive(:render).with(:text => "content", :content_type => "text/html")
+        @controller.should_receive(:render).with(hash_including(:text => "content", :content_type => "text/html"))
         @controller.with_controller_cache(@opts) { "content" }
       end
       
+      
+      it "should call render with status set from the instance variable @status" do
+        @controller.should_receive(:render).with(hash_including(:status => 418))
+        @controller.send(:instance_variable_set, "@status", 418)
+        @controller.with_controller_cache(@opts) { 
+          "content" 
+        }
+      end
+      
       it "should return the content" do
         @controller.with_controller_cache(@opts) { "content" }.should == "content"
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: itrigga-cache
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Al Davidson