cells 3.5.6 → 3.6.0

data/CHANGES.textile

@@ -1,3 +1,9 @@
+h2. 3.6.0
+
+h3. Changes
+  * Cells runs with Rails 3.0 and 3.1.
+
+
 h2. 3.5.6
 
 h3. Changes

data/README.rdoc

@@ -16,7 +16,7 @@ And the best: You can have as many cells in your page as you need!
 
 It's a gem!
 
-Rails 3:
+Rails 3.x:
 
   gem install cells
 

data/cells.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency "actionpack",  "~> 3.0.0"
-  s.add_dependency "railties",    "~> 3.0.0"
+  s.add_dependency "actionpack",  "~> 3.0"
+  s.add_dependency "railties",    "~> 3.0"
   
   s.add_development_dependency "shoulda"
   s.add_development_dependency "haml"

data/lib/cell.rb

@@ -70,23 +70,6 @@ module Cell
       @builders ||= []
     end
 
-    # Return the default view path for +state+. Override this if you cell has a differing naming style.
-    def view_for_state(state)
-      "#{cell_name}/#{state}"
-    end
-
-    # Returns all possible view paths for +state+ by invoking #view_for_state on all classes up
-    # the inheritance chain.
-    def find_class_view_for_state(state)
-      return [view_for_state(state)] unless superclass.respond_to?(:find_class_view_for_state)
-
-      superclass.find_class_view_for_state(state) << view_for_state(state)
-    end
-
-    def cell_name # TODO: remove in 3.6.
-      controller_path
-    end
-
     # The cell class constant for +cell_name+.
     def class_from_cell_name(cell_name)
       "#{cell_name}_cell".classify.constantize
@@ -94,11 +77,6 @@ module Cell
   end
 
   module InstanceMethods
-    # Computes all possible paths for +state+ by traversing up the inheritance chain.
-    def possible_paths_for_state(state)
-      self.class.find_class_view_for_state(state).reverse!
-    end
-    
     def state_accepts_args?(state)
       method(state).arity != 0
     end

data/lib/cell/caching.rb

@@ -60,7 +60,7 @@ module Cell
       
       # Computes the complete, namespaced cache key for +state+.
       def state_cache_key(state, key_parts={})
-        expand_cache_key([cell_name, state, key_parts])
+        expand_cache_key([controller_path, state, key_parts])
       end
 
       def expire_cache_key(key, *args)

data/lib/cell/rails.rb

@@ -7,8 +7,13 @@ module Cell
     include AbstractController
     include Rendering, Layouts, Helpers, Callbacks, Translation, Logger
     include ActionController::RequestForgeryProtection
-
-
+    
+    if Cells.rails3_0?
+      require 'cell/rails3_0_strategy'
+    elsif Cells.rails3_1?
+      require 'cell/rails3_1_strategy'
+    end
+    
     class View < ActionView::Base
       def render(*args, &block)
         options = args.first.is_a?(::Hash) ? args.first : {}  # this is copied from #render by intention.
@@ -17,15 +22,8 @@ module Cell
         super
       end
     end
-
-
-    class MissingTemplate < ActionView::ActionViewError
-      def initialize(message, possible_paths)
-        super(message + " and possible paths #{possible_paths}")
-      end
-    end
-
-
+    
+    
     module Rendering
       # Invoke the state method for +state+ which usually renders something nice.
       def render_state(state, *args)
@@ -35,13 +33,15 @@ module Cell
 
 
     module Metal
-      delegate :session, :params, :request, :config, :to => :parent_controller
+      delegate :session, :params, :request, :config, :env, :to => :parent_controller
     end 
     
     
     include Metal
     include Rendering
     include Caching
+    include VersionStrategy
+    
     
     attr_reader :parent_controller
     attr_accessor :options
@@ -60,18 +60,6 @@ module Cell
       @opts    = ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :options)
     end
     
-    def self.view_context_class
-      controller = self
-
-      View.class_eval do
-        include controller._helpers
-        include controller._routes.url_helpers
-      end
-
-
-      @view_context_class ||= View
-    end
-
     def self.controller_path
       @controller_path ||= name.sub(/Cell$/, '').underscore unless anonymous?
     end
@@ -142,22 +130,6 @@ module Cell
     end
 
   private
-    # Climbs up the inheritance chain, looking for a view for the current +state+.
-    def find_family_view_for_state(state)
-      exception       = nil
-      possible_paths  = possible_paths_for_state(state)
-
-      possible_paths.each do |template_path|
-        begin
-          template = find_template(template_path)
-          return template if template
-        rescue ::ActionView::MissingTemplate => exception
-        end
-      end
-
-      raise MissingTemplate.new(exception.message, possible_paths)
-    end
-    
     # Renders the view belonging to the given state. Will raise ActionView::MissingTemplate
     # if it can't find a view.
     def render_view_for(state, *args)
@@ -168,15 +140,10 @@ module Cell
       if opts[:state]
         opts[:text] = render_state(opts.delete(:state), *args)
       elsif (opts.keys & [:text, :inline, :file]).blank?
-        opts = defaultize_render_options_for(opts, state)
-        opts[:template] = find_family_view_for_state(opts.delete(:view))
+        process_opts_for(opts, state)
       end
       
       render_to_string(opts).html_safe # ActionView::Template::Text doesn't do that for us.
     end
-    
-    def defaultize_render_options_for(opts, state)
-      opts.reverse_merge!(:view => state)
-    end
   end
 end

data/lib/cell/rails3_0_strategy.rb

@@ -0,0 +1,69 @@
+module Cell
+  # Methods to be included in Cell::Rails in 3.0 context, where there's no view inheritance.
+  module VersionStrategy
+    extend ActiveSupport::Concern
+    
+    class MissingTemplate < ActionView::ActionViewError
+      def initialize(message, possible_paths)
+        super(message + " and possible paths #{possible_paths}")
+      end
+    end
+    
+    
+    module ClassMethods
+      def view_context_class
+        controller = self
+
+        Cell::Rails::View.class_eval do
+          include controller._helpers
+          include controller._routes.url_helpers
+        end
+
+        @view_context_class ||= Cell::Rails::View
+      end
+      
+      # Return the default view path for +state+. Override this if you cell has a differing naming style.
+      def view_for_state(state)
+        "#{cell_name}/#{state}"
+      end
+
+      # Returns all possible view paths for +state+ by invoking #view_for_state on all classes up
+      # the inheritance chain.
+      def find_class_view_for_state(state)
+        return [view_for_state(state)] unless superclass.respond_to?(:find_class_view_for_state)
+
+        superclass.find_class_view_for_state(state) << view_for_state(state)
+      end
+
+      def cell_name
+        controller_path
+      end
+    end
+    
+  private
+    # Computes all possible paths for +state+ by traversing up the inheritance chain.
+    def possible_paths_for_state(state)
+      self.class.find_class_view_for_state(state).reverse!
+    end
+    
+    # Climbs up the inheritance chain, looking for a view for the current +state+.
+    def find_family_view_for_state(state)
+      exception       = nil
+      possible_paths  = possible_paths_for_state(state)
+
+      possible_paths.each do |template_path|
+        begin
+          template = find_template(template_path)
+          return template if template
+        rescue ::ActionView::MissingTemplate => exception
+        end
+      end
+
+      raise MissingTemplate.new(exception.message, possible_paths)
+    end
+    
+    def process_opts_for(opts, state)
+      opts[:template] = find_family_view_for_state(opts.delete(:view) || state)
+    end
+  end
+end

data/lib/cell/rails3_1_strategy.rb

@@ -0,0 +1,24 @@
+module Cell
+  # Methods to be included in Cell::Rails in 3.1 context.
+  module VersionStrategy
+    extend ActiveSupport::Concern
+    
+    include AbstractController::UrlFor  # must be included before _routes is set in Railstie.
+    
+    
+    module ClassMethods
+      def view_context_class
+        @view_context_class ||= begin
+          routes  = _routes  #if respond_to?(:_routes)
+          helpers = _helpers #if respond_to?(:_helpers)
+          Cell::Rails::View.prepare(routes, helpers)
+        end
+      end
+    end
+    
+  private    
+    def process_opts_for(opts, state)
+      opts[:action] = opts[:view] || state
+    end
+  end
+end

data/lib/cells.rb

@@ -58,13 +58,6 @@
 # Beside your new class you'd provide a star-sprangled button view in +xmas_cart/order_button.haml+.
 # When rendering the +cart+ state, the states as well as the "missing" views are inherited from ancesting cells,
 # this is pretty DRY and object-oriented, isn't it?
-
-require 'cell/rails'
-require 'cells/railtie'
-require 'cells/rails'
-require 'cell/test_case' if Rails.env == "test"
-require 'cells/rails_compat'  # fixes a bug in Rails <3.0.4. # TODO: remove me as soon as we support 3.1, only.
-
 module Cells
   # Setup your special needs for Cells here. Use this to add new view paths.
   #
@@ -77,6 +70,21 @@ module Cells
   def self.setup
     yield(Cell::Base)
   end
+  
+  def self.rails3_0?
+    ::Rails::VERSION::MINOR == 0
+  end
+  
+  def self.rails3_1?
+    ::Rails::VERSION::MINOR == 1
+  end
 end
 
+require 'cell/rails'
+require 'cells/railtie'
+require 'cells/rails'
+require 'cell/test_case' if Rails.env == "test"
+
+require 'cells/rails_compat'  # fixes a bug in Rails <3.0.4. # TODO: remove me as soon as we support 3.1, only.
+
 Cell::Base = Cell::Rails

data/lib/cells/version.rb

@@ -1,3 +1,3 @@
 module Cells
-  VERSION = '3.5.6'
+  VERSION = '3.6.0'
 end

data/test/app/cells/bassist/play.js.erb

@@ -0,0 +1 @@
+alert("Doo");

data/test/cell_module_test.rb

@@ -134,24 +134,25 @@ class CellModuleTest < ActiveSupport::TestCase
       end
     end
     
-    should "provide possible_paths_for_state" do
-      assert_equal ["bad_guitarist/play", "bassist/play", "cell/rails/play"], cell(:bad_guitarist).possible_paths_for_state(:play)
-    end
-    
-    should "provide Cell.cell_name" do
-      assert_equal 'bassist', cell(:bassist).class.cell_name
+    should "provide class_from_cell_name" do
+      assert_equal BassistCell, ::Cell::Base.class_from_cell_name('bassist')
     end
     
-    should "provide cell_name for modules, too" do
-      class SingerCell < Cell::Base
+    if Cells.rails3_0?
+      should "provide possible_paths_for_state" do
+        assert_equal ["bad_guitarist/play", "bassist/play", "cell/rails/play"], cell(:bad_guitarist).send(:possible_paths_for_state, :play)
       end
       
-      assert_equal "cell_module_test/singer", CellModuleTest::SingerCell.cell_name
-    end
-    
-    
-    should "provide class_from_cell_name" do
-      assert_equal BassistCell, ::Cell::Base.class_from_cell_name('bassist')
+      should "provide Cell.cell_name" do
+        assert_equal 'bassist', cell(:bassist).class.cell_name
+      end
+      
+      should "provide cell_name for modules, too" do
+        class SingerCell < Cell::Base
+        end
+        
+        assert_equal "cell_module_test/singer", CellModuleTest::SingerCell.cell_name
+      end
     end
     
     context "#state_accepts_args?" do

data/test/cells_module_test.rb

@@ -2,20 +2,32 @@ require 'test_helper'
 
 class CellsModuleTest < ActiveSupport::TestCase
   context "Cells" do
-    setup do
-      @old_view_paths = Cell::Base.view_paths.clone
-    end
-    
-    should "provide .setup" do
-      Cells.setup do |c|
-        c.append_view_path "/road/to/nowhere"
+    context "view_paths" do
+      setup do
+        @old_view_paths = Cell::Base.view_paths.clone
+      end
+      
+      teardown do
+        Cell::Base.view_paths = @old_view_paths
       end
       
-      assert_equal "/road/to/nowhere", Cell::Base.view_paths.last.to_s
+      should "provide .setup" do
+        Cells.setup do |c|
+          c.append_view_path "/road/to/nowhere"
+        end
+        
+        assert_equal "/road/to/nowhere", Cell::Base.view_paths.last.to_s
+      end
     end
     
-    teardown do
-      Cell::Base.view_paths = @old_view_paths
+    should "respond to #rails3_1?" do
+      if Rails::VERSION::MINOR == 0
+        assert ! Cells.rails3_1?
+        assert Cells.rails3_0?
+      elsif
+        assert Cells.rails3_1?
+        assert ! Cells.rails3_0?
+      end
     end
   end
 end

data/test/dummy/config/routes.rb

@@ -1,4 +1,4 @@
-Dummy::Application.routes.draw do |map|
+Dummy::Application.routes.draw do
   match ':controller(/:action(/:id(.:format)))'
   root :to => 'musician#index'
 end

data/test/rails/cells_test.rb

@@ -91,43 +91,25 @@ class RailsCellsTest < ActiveSupport::TestCase
       assert_equal({:song => "Lockdown"}, cell(:bassist, :song => "Lockdown").options)
     end
     
-    context "invoking defaultize_render_options_for" do
-      should "set default values" do
-        options = cell(:bassist).send(:defaultize_render_options_for, {}, :play)
+    if Cells.rails3_0?
+      puts "rails-3.0"
+      context "invoking find_family_view_for_state" do
+        should "raise an error when a template is missing" do
+          assert_raises ActionView::MissingTemplate do
+            cell(:bassist).find_template("bassist/playyy")
+          end
+          
+          #puts "format: #{cell(:bassist).find_template("bassist/play.js").formats.inspect}"
+        end
         
-        assert_equal :play, options[:view]
-      end
-      
-      should "allow overriding defaults" do
-        assert cell(:bassist).send(:defaultize_render_options_for, {:view => :slap}, :play)[:view] == :slap
-      end
-    end
-    
-    context "invoking find_family_view_for_state" do
-      should "raise an error when a template is missing" do
-        assert_raises ActionView::MissingTemplate do
-          cell(:bassist).find_template("bassist/playyy")
+        should "return play.html.erb" do
+          assert_equal "bassist/play", cell(:bassist).send(:find_family_view_for_state, :play).virtual_path
         end
         
-        puts "format: #{cell(:bassist).find_template("bassist/play.js").formats.inspect}"
-      end
-      
-      should "return play.html.erb" do
-        assert_equal "bassist/play", cell(:bassist).send(:find_family_view_for_state, :play).virtual_path
-      end
-      
-      should "find inherited play.html.erb" do
-        assert_equal "bassist/play", cell(:bad_guitarist).send(:find_family_view_for_state, :play).virtual_path
-      end
-      
-      should_eventually "find the EN-version if i18n instructs" do
-        swap I18n, :locale => :en do
-          assert_equal "bassist/yell.en.html.erb", cell(:bassist).find_family_view_for_state(:yell).virtual_path
+        should "find inherited play.html.erb" do
+          assert_equal "bassist/play", cell(:bad_guitarist).send(:find_family_view_for_state, :play).virtual_path
         end
       end
-      
-      
-      should_eventually "return an already cached family view"
     end
     
     context "delegation" do
@@ -156,16 +138,5 @@ class RailsCellsTest < ActiveSupport::TestCase
         assert_equal({"song" => "Creatures"}, cell(:bassist, "song" => "Lockdown").params)
       end
     end
-    
-    
-    # DISCUSS: do we really need that test anymore?
-    should "precede cell ivars over controller ivars" do
-      @controller.instance_variable_set(:@note, "E")
-      BassistCell.class_eval do
-        def slap; @note = "A"; render; end
-      end
-      assert_equal "Boing in A", render_cell(:bassist, :slap)
-    end
-    
   end   
 end

data/test/rails/render_test.rb

@@ -12,6 +12,13 @@ class RailsRenderTest < ActiveSupport::TestCase
       assert_equal "Doo", render_cell(:bassist, :play)
     end
     
+    should "accept :format" do
+      BassistCell.class_eval do
+        def play; render :format => :js; end
+      end
+      assert_equal "alert(\"Doo\");", render_cell(:bassist, :play)
+    end
+    
     should "also render alternative engines, like haml" do
       BassistCell.class_eval do
         def sing; render; end
@@ -106,11 +113,19 @@ class RailsRenderTest < ActiveSupport::TestCase
         def groove; render; end
       end
       
-      e = assert_raise Cell::Rails::MissingTemplate do
-        render_cell(:bad_guitarist, :groove)
+      if Cells.rails3_0?
+        e = assert_raise Cell::Rails::MissingTemplate do
+          render_cell(:bad_guitarist, :groove)
+        end
+        
+        assert_includes e.message, "Missing template cell/rails/groove with {:handlers=>[:erb, :rjs, :builder, :rhtml, :rxml, :haml], :formats=>[:html, :text, :js, :css, :ics, :csv, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json], :locale=>[:en, :en]} in view paths"
+      else  # 3.1
+        e = assert_raise ActionView::MissingTemplate do
+          render_cell(:bad_guitarist, :groove)
+        end
+        
+        assert_includes e.message, "Missing template bad_guitarist/groove, bassist/groove with {:handlers=>[:erb, :builder, :haml], :formats=>[:html, :text, :js, :css, :ics, :csv, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json], :locale=>[:en, :en]}. Searched in:\n  "
       end
-      
-      assert_includes e.message, "Missing template cell/rails/groove with {:handlers=>[:erb, :rjs, :builder, :rhtml, :rxml, :haml], :formats=>[:html, :text, :js, :css, :ics, :csv, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json], :locale=>[:en, :en]} in view paths"
     end
     
     should "render instance variables from the cell" do

data/test/rails/router_test.rb

@@ -1,8 +1,14 @@
+require 'test_helper'
+
 module ApplicationTests
   class RouterTest < ActionController::TestCase
     tests MusicianController
 
     context "A Rails app" do
+      should "pass url_helpers to the cell instance" do
+        assert_equal "/", BassistCell.new(@controller).root_path
+      end
+      
       should "allow cells to use url_helpers" do
         BassistCell.class_eval do
           def promote; render; end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 3
-  - 5
   - 6
-  version: 3.5.6
+  - 0
+  version: 3.6.0
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 +01:00
+date: 2011-06-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,7 @@ dependencies:
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,8 +42,7 @@ dependencies:
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -106,6 +104,8 @@ files:
 - lib/cell.rb
 - lib/cell/caching.rb
 - lib/cell/rails.rb
+- lib/cell/rails3_0_strategy.rb
+- lib/cell/rails3_1_strategy.rb
 - lib/cell/test_case.rb
 - lib/cells.rb
 - lib/cells/cells.rake
@@ -127,7 +127,6 @@ files:
 - lib/generators/templates/view.haml
 - lib/generators/templates/view.slim
 - lib/generators/test_unit/cell_generator.rb
-- test/active_helper_test.rb
 - test/app/cells/bad_guitarist/_dii.html.erb
 - test/app/cells/bad_guitarist_cell.rb
 - test/app/cells/bassist/_dii.html.erb

data/test/active_helper_test.rb

@@ -1,57 +0,0 @@
-require 'test_helper'
-
-### DISCUSS: how can we limit that test to systems where ActiveHelper's around?
-
-class ActiveHelperTest < ActiveSupport::TestCase
-  context "The Cell::Base class" do
-    setup do
-      class FingeringHelper < ActiveHelper::Base
-        provides :finger
-      end
-      
-      class SlappingHelper < ActiveHelper::Base
-        provides :slap
-      end
-    end
-    
-    should_eventually "respond to active_helper" do
-      assert_respond_to Cell::Base, :active_helper
-    end
-    
-    should_eventually "store helper constants from active_helper" do
-      @cell = Class.new(BassistCell)
-      @cell.active_helper SlappingHelper
-      assert_equal [SlappingHelper], @cell.active_helpers
-    end
-    
-    should_eventually "inherit helper constants from active_helper" do
-      @base_cell = Class.new(BassistCell)
-      @base_cell.active_helper SlappingHelper
-      @cell = Class.new(@base_cell)
-      @cell.active_helper FingeringHelper
-      assert_equal [SlappingHelper, FingeringHelper], @cell.active_helpers
-    end
-    
-    
-    context "An Cell::View::Base instance" do
-      should_eventually "respond to use" do
-        # we didn't extend the view at this point.
-        @view = bassist_mock.setup_action_view
-        assert_respond_to @view, :use
-      end
-      
-    end
-    
-    context "The view rendered by the cell" do
-      should_eventually "respond to used helper methods" do
-        @cell = bassist_mock
-        @cell.class.active_helper SlappingHelper
-        
-        @view = @cell.setup_action_view
-        @cell.prepare_action_view_for(@view, {})
-        
-        assert_respond_to @view, :slap # from the SlappingHelper
-      end
-    end
-  end
-end