cells 3.6.4 → 3.6.5

data/CHANGES.textile

@@ -1,3 +1,12 @@
+h2. 3.6.5
+
+h3. Bugfixes
+  * `Cell::TestCase#invoke` now properly accepts state-args.
+
+h3. Changes
+  * Added the `:if` option to `Base.cache` which allows adding a conditional proc or instance method to the cache definition. If it doesn't return true, caching for that state is skipped. 
+
+
 h2. 3.6.4
 
 h3. Bugfixes

data/lib/cell.rb

@@ -18,8 +18,7 @@ module Cell
       cell = create_cell_for(controller, name, *args)  # DISCUSS: we always save options.
       yield cell if block_given?
       
-      return cell.render_state(state, *args) if cell.state_accepts_args?(state)
-      cell.render_state(state)  # backward-compat.
+      cell.render_state_with_args(state, *args)
     end
     
     # Creates a cell instance. Note that this method calls builders which were attached to the
@@ -77,6 +76,11 @@ module Cell
   end
 
   module InstanceMethods
+    def render_state_with_args(state, *args)  # TODO: remove me in 4.0.
+      return render_state(state, *args) if state_accepts_args?(state)
+      render_state(state)  # backward-compat.
+    end
+    
     def state_accepts_args?(state)
       method(state).arity != 0
     end

data/lib/cell/caching.rb

@@ -19,6 +19,11 @@ module Cell
       #
       #   cache :show, :expires_in => 10.minutes
       #
+      # The +:if+ option lets you define a conditional proc or instance method. If it doesn't
+      # return a true value, caching for that state is skipped.
+      #
+      #   cache :show, :if => proc { |cell, options| options[:enable_cache] }
+      #
       # If you need your own granular cache keys, pass a versioner block.
       #
       #   cache :show do |cell, options|
@@ -40,14 +45,19 @@ module Cell
       def cache(state, *args, &block)
         options = args.extract_options!
         
-        version_procs[state]  = args.first || block
-        cache_options[state]  = options
+        conditional_procs[state] = options.delete(:if)
+        version_procs[state]     = args.first || block
+        cache_options[state]     = options
       end
 
       def version_procs
         @version_procs ||= {}
       end
 
+      def conditional_procs
+        @conditional_procs ||= {}
+      end
+
       def cache_options
         @cache_options ||= {}
       end
@@ -85,7 +95,7 @@ module Cell
     end
 
     def render_state(state, *args)
-      return super(state, *args) unless self.class.cache?(state)
+      return super(state, *args) unless cache?(state, *args)
       
       key     = self.class.state_cache_key(state, call_state_versioner(state, *args))
       options = self.class.cache_options[state]
@@ -95,12 +105,24 @@ module Cell
       end
     end
     
+    def cache?(state, *args)
+      self.class.cache?(state) and call_state_conditional(state, *args)
+    end
+    
   protected
+    def call_proc_or_method(state, method, *args)
+      return method.call(self, *args) if method.kind_of?(Proc)
+      state_accepts_args?(state) ?  send(method, *args) : send(method)
+    end
+    
     def call_state_versioner(state, *args)
-      version_proc = self.class.version_procs[state] or return
-      
-      return version_proc.call(self, *args) if version_proc.kind_of?(Proc)
-      state_accepts_args?(state) ?  send(version_proc, *args) : send(version_proc)
+      method = self.class.version_procs[state] or return
+      call_proc_or_method(state, method, *args)
+    end
+    
+    def call_state_conditional(state, *args)
+      method = self.class.conditional_procs[state] or return true
+      call_proc_or_method(state, method, *args)
     end
     
   end

data/lib/cell/test_case.rb

@@ -124,7 +124,7 @@ module Cell
     attr_reader :last_invoke
 
     def invoke(state, *args)
-      @last_invoke = self.class.controller_class.new(@controller, *args).render_state(state)
+      @last_invoke = self.class.controller_class.new(@controller, *args).render_state_with_args(state, *args)
     end
   end
 end

data/lib/cells/version.rb

@@ -1,3 +1,3 @@
 module Cells
-  VERSION = '3.6.4'
+  VERSION = '3.6.5'
 end

data/test/app/cells/bassist/shout.html.erb

@@ -0,0 +1 @@
+*shouts* <%= @words %>

data/test/app/cells/bassist_cell.rb

@@ -1,3 +1,8 @@
 class BassistCell < Cell::Base
   def play; render; end
-end
+
+  def shout(args)
+    @words = args[:words]
+    render
+  end
+end

data/test/rails/caching_test.rb

@@ -283,5 +283,28 @@ class CachingFunctionalTest < ActiveSupport::TestCase
       assert_equal "1", render_cell(:director, :count, 3)
       assert_equal "2", render_cell(:director, :count, 4)
     end
+    
+    should "be able to use caching conditionally" do
+      @class.cache :count, :if => proc { |cell, int| (int % 2) != 0 }
+      
+      assert_equal "1", render_cell(:director, :count, 1)
+      assert_equal "2", render_cell(:director, :count, 2)
+      assert_equal "1", render_cell(:director, :count, 3)
+      assert_equal "4", render_cell(:director, :count, 4)
+    end
+    
+    should "cache conditionally with an instance method" do
+      @class.cache :count, :if => :odd?
+      @class.class_eval do
+        def odd?(int)
+          (int % 2) != 0
+        end
+      end
+      
+      assert_equal "1", render_cell(:director, :count, 1)
+      assert_equal "2", render_cell(:director, :count, 2)
+      assert_equal "1", render_cell(:director, :count, 3)
+      assert_equal "4", render_cell(:director, :count, 4)
+    end
   end
 end

data/test/test_case_test.rb

@@ -67,6 +67,10 @@ class TestCaseTest < Cell::TestCase
           #assert_equal "Doo", invoke(:play)
         end
         
+        should "provide #invoke accepting args" do
+          assert_equal "*shouts* Listen!\n", invoke(:shout, :words => "Listen!")
+        end
+        
         should "provide assert_select" do
           invoke :promote
           assert_select "a", "vd.com"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 6
-  - 4
-  version: 3.6.4
+  - 5
+  version: 3.6.5
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 +02:00
+date: 2011-08-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -139,6 +139,7 @@ files:
 - test/app/cells/bassist/pose.html.erb
 - test/app/cells/bassist/promote.html.erb
 - test/app/cells/bassist/provoke.html.erb
+- test/app/cells/bassist/shout.html.erb
 - test/app/cells/bassist/sing.html.haml
 - test/app/cells/bassist/slap.html.erb
 - test/app/cells/bassist/yell.en.html.erb