cells 3.4.3 → 3.4.4

data/CHANGES.textile

@@ -1,3 +1,11 @@
+h2. 3.4.4
+
+h3. Changes
+  * Cells.setup now yields Cell::Base, so you can really call append_view_path and friends here.
+  * added Cell::Base.build for streamlining the process of deciders around #render_cell, "see here":http://nicksda.apotomo.de/2010/12/pragmatic-rails-thoughts-on-views-inheritance-view-inheritance-and-rails-304
+  * added TestCase#in_view to test helpers in a real cell view.
+  
+
 h2. 3.4.3
 
 h3. Changes

data/Gemfile

@@ -1,10 +1,11 @@
 source :gemcutter
 gem 'sqlite3-ruby', '1.2.5', :require => 'sqlite3'	# needed in router_test, whatever.
 
-#gem "rails" , :path => "/home/nick/projects/rails"
-gem "rails", '3.0.0' #, :git => "http://github.com/rails/rails.git"
+#gem "rails" , :path => "/home/nick/projects/rayls"
+gem "rails", '~> 3.0'
 gem "haml"
 
 group :test do
   gem "shoulda"
 end
+gem "rack", :git => "git://github.com/rack/rack.git"

data/README.rdoc

@@ -94,6 +94,29 @@ The distinction between partials and views is making things more complex, so why
     = render :view => 'items'
 
 
+== View Inheritance
+
+This is where OOP comes back to your view.
+
+* <b>Inherit code</b> into your cells by deriving more abstract cells.
+* <b>Inherit views</b> from ancesting cells.
+
+=== Builders
+
+Let +render_cell+ take care of creating the right cell. Just configure your super-cell properly.
+
+  class LoginCell < Cell::Rails
+    build do
+      UnauthorizedUserCell unless logged_in?
+    end
+  
+A call to
+
+  render_cell(:login, :box)
+
+will render the configured +UnauthorizedUserCell+ instead of the original +LoginCell+ if the login test fails.
+
+
 == Caching
 
 Cells do strict view caching. No cluttered fragment caching. Add

data/lib/cell.rb

@@ -10,9 +10,52 @@ module Cell
       cell.render_state(state)
     end
     
-    # Creates a cell instance.
+    # Creates a cell instance. Note that this method calls builders which were attached to the
+    # class with Cell::Base.build - this might lead to a different cell being returned.
     def create_cell_for(controller, name, opts={})
-      class_from_cell_name(name).new(controller, opts)
+      build_class_for(controller, class_from_cell_name(name), opts).
+      new(controller, opts)
+    end
+    
+    # Adds a builder to the cell class. Builders are used in #render_cell to find out the concrete
+    # class for rendering. This is helpful if you frequently want to render subclasses according
+    # to different circumstances (e.g. login situations) and you don't want to place these deciders in
+    # your view code.
+    #
+    # Passes the opts hash from #render_cell into the block. The block is executed in controller context. 
+    # Multiple build blocks are ORed, if no builder matches the building cell is used.
+    #
+    # Example:
+    #
+    # Consider two different user box cells in your app.
+    #
+    #   class AuthorizedUserBox < UserInfoBox
+    #   end
+    #
+    #   class AdminUserBox < UserInfoBox
+    #   end
+    #
+    # Now you don't want to have deciders all over your views - use a declarative builder.
+    #
+    #   UserInfoBox.build do |opts|
+    #     AuthorizedUserBox if user_signed_in?
+    #     AdminUserBox if admin_signed_in?
+    #   end
+    #
+    # In your view #render_cell will instantiate the right cell for you now.
+    def build(&block)
+      builders << block
+    end
+    
+    def build_class_for(controller, target_class, opts)
+      target_class.builders.each do |blk|
+        res = controller.instance_exec(opts, &blk) and return res
+      end
+      target_class
+    end
+    
+    def builders
+      @builders ||= []
     end
     
     # Return the default view path for +state+. Override this if you cell has a differing naming style.

data/lib/cell/rails.rb

@@ -48,8 +48,6 @@ module Cell
     include Rendering
     include Caching
     
-    
-    cattr_accessor :url_helpers ### TODO: discuss if we really need that or can handle that in cells.rb already.
     attr_reader :parent_controller
     
     abstract!
@@ -67,12 +65,10 @@ module Cell
       
       View.class_eval do
         include controller._helpers
-        include Cell::Base.url_helpers if Cell::Rails.url_helpers
+        include controller._routes.url_helpers
       end
       
-      
       @view_context_class ||= View
-      ### DISCUSS: copy behaviour from abstract_controller/rendering-line 49? (helpers)
     end
     
     def self.controller_path

data/lib/cell/test_case.rb

@@ -89,6 +89,27 @@ module Cell
         cell.instance_eval &block if block_given?
         cell
       end
+      
+      # Execute the passed +block+ in a real view context of +cell_class+. 
+      # Usually you'd test helpers here.
+      #
+      # Example:
+      #
+      #   assert_equal("<h1>Modularity rocks.</h1>", in_view do content_tag(:h1, "Modularity rocks."))
+      def in_view(cell_class, &block)
+        subject = cell(cell_class, :block => block)
+        setup_test_states_in(subject) # add #in_view to subject cell.
+        subject.render_state(:in_view)
+      end
+      
+    protected
+      def setup_test_states_in(cell)
+        cell.instance_eval do
+          def in_view
+            render :inline => "<%= instance_exec(&block) %>", :locals => {:block => @opts[:block]}
+          end
+        end
+      end
     end
     
     include TestMethods
@@ -97,6 +118,7 @@ module Cell
     include AssertSelect
     
     extend ActionController::TestCase::Behavior::ClassMethods
+    class_attribute :_controller_class
     
     
     attr_reader :last_invoke

data/lib/cells.rb

@@ -66,40 +66,22 @@ require 'cell/rails'
 require 'cell/test_case' if Object.const_defined?("Rails") and Rails.env == "test"
 
 module Cells
-  # Any config should be placed here using +mattr_accessor+.
-
   # Default view paths for Cells.
   DEFAULT_VIEW_PATHS = [
     File.join('app', 'cells'),
     File.join('app', 'cells', 'layouts')
   ]
 
-  class << self
-    # Holds paths in which Cells should look for cell views (i.e. view template files).
-    #
-    # == Default:
-    #
-    #   * +app/cells+
-    #   * +app/cells/layouts+
-    #
-    def self.view_paths
-      ::Cell::Base.view_paths
-    end
-    def self.view_paths=(paths)
-      ::Cell::Base.view_paths = paths
-    end
-  end
-
-  # Cells setup/configuration helper for initializer.
+  # Setup your special needs for Cells here. Use this to add new view paths.
   #
-  # == Usage/Examples:
+  # Example:
   #
   #   Cells.setup do |config|
-  #     config.cell_view_paths << Rails.root.join('lib', 'cells')
+  #     config.append_view_path << "app/view_models"
   #   end
   #
   def self.setup
-    yield(self)
+    yield(Cell::Base)
   end
 end
 
@@ -115,8 +97,6 @@ class Cells::Railtie < Rails::Railtie
     Cell::Rails.class_eval do
       include app.routes.url_helpers
     end
-    
-    Cell::Base.url_helpers = app.routes.url_helpers
   end
   
   rake_tasks do

data/lib/cells/version.rb

@@ -1,3 +1,3 @@
 module Cells
-  VERSION = '3.4.3'
+  VERSION = '3.4.4'
 end

data/test/cell_module_test.rb

@@ -1,5 +1,16 @@
 require 'test_helper'
 
+class MusicianCell < Cell::Base
+  
+end
+
+class PianistCell < MusicianCell
+end
+
+class SingerCell < MusicianCell
+end
+
+
 class CellModuleTest < ActiveSupport::TestCase
   include Cell::TestCase::TestMethods
   
@@ -20,9 +31,88 @@ class CellModuleTest < ActiveSupport::TestCase
         assert_equal "Doo", html
         assert flag
       end
+      
+      
     end
     
+    context "create_cell_for" do
+      should "call the cell's builders, eventually returning a different class" do
+        class DrummerCell < BassistCell
+          build do
+            BassistCell
+          end
+        end
+        
+        assert_instance_of BassistCell, Cell::Base.create_cell_for(@controller, "cell_module_test/drummer", :play)
+      end
+    end
     
+    context "calling build" do
+      setup do
+        @controller.class_eval do
+          attr_accessor :bassist
+        end
+        
+        MusicianCell.build do
+          BassistCell if bassist
+        end
+      end
+      
+      teardown do
+        MusicianCell.class_eval do
+          @builders = false
+        end
+      end
+      
+      should "execute the block in controller context" do
+        @controller.bassist = true
+        assert_equal BassistCell,  Cell::Base.build_class_for(@controller, MusicianCell, {})
+      end
+      
+      should "limit the builder to the receiving class" do
+        assert_equal PianistCell,   Cell::Base.build_class_for(@controller, PianistCell, {})   # don't inherit anything.
+        @controller.bassist = true
+        assert_equal BassistCell,   Cell::Base.build_class_for(@controller, MusicianCell, {})
+      end
+      
+      should "chain build blocks and execute them by ORing them in the same order" do
+        MusicianCell.build do
+          PianistCell unless bassist
+        end
+        
+        MusicianCell.build do
+          UnknownCell # should never be executed.
+        end
+        
+        assert_equal PianistCell, Cell::Base.build_class_for(@controller, MusicianCell, {})  # bassist is false.
+        @controller.bassist = true
+        assert_equal BassistCell, Cell::Base.build_class_for(@controller, MusicianCell, {})
+      end
+      
+      should "use the original cell if no builder matches" do
+        assert_equal MusicianCell, Cell::Base.build_class_for(@controller, MusicianCell, {})  # bassist is false.
+      end
+      
+      should "stop at the first builder returning a valid cell" do
+        
+      end
+      
+      should "pass options to the block" do
+        BassistCell.build do |opts|
+          SingerCell if opts[:sing_the_song]
+        end
+        assert_equal BassistCell, Cell::Base.build_class_for(@controller, BassistCell, {})
+        assert_equal SingerCell,  Cell::Base.build_class_for(@controller, BassistCell, {:sing_the_song => true})
+      end
+      
+      should "create the original target class if no block matches" do
+        assert_equal PianistCell, Cell::Base.build_class_for(@controller, PianistCell, {})
+      end
+      
+      should "builders should return an empty array per default" do
+        assert_equal [], PianistCell.builders
+      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)

data/test/cells_module_test.rb

@@ -0,0 +1,21 @@
+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"
+      end
+      
+      assert_equal "/road/to/nowhere", Cell::Base.view_paths.last.to_s
+    end
+    
+    teardown do
+      Cell::Base.view_paths = @old_view_paths
+    end
+  end
+end

data/test/rails/view_test.rb

@@ -5,18 +5,16 @@ class RailsViewTest < ActiveSupport::TestCase
   
   context "A cell view" do
     context "calling render :partial" do
-      should "render the cell partial in bassist/dii" do
-        BassistCell.class_eval do
-          def compose; @partial = "dii"; render; end
-        end
-        assert_equal "Dumm Dii", render_cell(:bassist, :compose)
+      should "render the local cell partial in bassist/dii" do
+        assert_equal("Dii", in_view(:bassist) do
+          render :partial => 'dii'
+        end)
       end
       
-      should "render the cell partial in bad_guitarist/dii" do
-        BassistCell.class_eval do
-          def compose; @partial = "bad_guitarist/dii"; render; end
-        end
-        assert_equal "Dumm Dooom", render_cell(:bassist, :compose)
+      should "render the foreign cell partial in bad_guitarist/dii" do
+        assert_equal("Dooom", in_view(:bassist) do
+          render :partial => "bad_guitarist/dii"
+        end)
       end
     end
     

data/test/test_case_test.rb

@@ -49,7 +49,7 @@ class TestCaseTest < Cell::TestCase
         assert_equal SingerCell, SingerCellTest.new(:cell_test).class.controller_class
       end
       
-      context "with invoke" do
+      context "with #invoke" do
         setup do
           self.class.tests BassistCell
         end
@@ -73,6 +73,24 @@ class TestCaseTest < Cell::TestCase
           assert_select "a", "vd.com"
         end
       end
+      
+      context "#setup_test_states_in" do
+        should "add the :in_view state" do
+          c = cell(:bassist, :block => lambda{"Cells rock."})
+          assert_not c.respond_to?(:in_view)
+          
+          setup_test_states_in(c)
+          assert_equal "Cells rock.", c.render_state(:in_view)
+        end
+      end
+      
+      context "#in_view" do
+        should "execute the block in a real view" do
+          content = "Cells rule."
+          @test.setup
+          assert_equal("<h1>Cells rule.</h1>", @test.in_view(:bassist) do content_tag("h1", content) end)
+        end
+      end
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 4
-  - 3
-  version: 3.4.3
+  - 4
+  version: 3.4.4
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 +01:00
+date: 2011-01-02 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -88,6 +88,7 @@ files:
 - test/dummy/app/views/musician/hamlet.html.haml
 - test/dummy/app/views/musician/featured.html.erb
 - test/dummy/app/helpers/application_helper.rb
+- test/cells_module_test.rb
 - test/test_case_test.rb
 - test/helper_test.rb
 - test/cell_module_test.rb
@@ -184,6 +185,7 @@ test_files:
 - test/dummy/app/views/musician/hamlet.html.haml
 - test/dummy/app/views/musician/featured.html.erb
 - test/dummy/app/helpers/application_helper.rb
+- test/cells_module_test.rb
 - test/test_case_test.rb
 - test/helper_test.rb
 - test/cell_module_test.rb