cells 3.8.3 → 3.8.4

data/CHANGES.textile

@@ -1,3 +1,9 @@
+h2. 3.8.4
+
+* Added @Cell::Rack@ for request-dependent Cells. This is also the new base class for @Cells::Rails@.
+* Removed deprecation warning from @TestCase#cell@ as it's signature is not deprecated.
+* Added the @base_cell_class@ config option to generator for specifying an alternative base class.
+
 h2. 3.8.3
 
 * Added @Engines.existent_directories_for@ to prevent Rails 3.0 from crashing when it detects engines. 

data/README.rdoc

@@ -190,6 +190,18 @@ In your <tt>routes.rb</tt> file, mount the cell like a Rack app.
 
 Now <tt>Rails::Engine</tt>s can contribute to Cells view paths. By default, any 'app/cells' found inside any Engine is automatically included into Cells view paths. If you need to, you can customize the view paths changing/appending to the <tt>'app/cell_views'</tt> path configuration. See the @Cell::EngineIntegration@ for more details.
 
+== Custom base class
+
+By default, generated cells inherit from <code>Cell::Rails</code>. If you want to change this, specify your new class name in <code>config/application.rb</code>:
+
+    module MyApp
+      class Application < Rails::Application
+        config.generators do |g|
+          g.base_cell_class "ApplicationCell"
+        end
+      end
+    end
+
 == Rails 2.3 note
 
 In order to copy the cells rake tasks to your app, run

data/lib/cell/base.rb

@@ -2,21 +2,36 @@ require 'abstract_controller'
 require 'cell/builder'
 require 'cell/caching'
 require 'cell/rendering'
-require 'cell/rails3_0_strategy' if Cells.rails3_0?
-require 'cell/rails3_1_strategy' if Cells.rails3_1_or_more?
 
 module Cell
   class Base < AbstractController::Base
+    module Utils  # TODO: Move to separate file.
+      def rails3_0?
+        ::ActionPack::VERSION::MINOR == 0
+      end
+      
+      def rails3_1_or_more?
+        ::ActionPack::VERSION::MINOR >= 1
+      end
+      
+      def rails3_2_or_more?  # FIXME: move to tests.
+        ::ActionPack::VERSION::MINOR >= 2
+      end
+    end
+    
     abstract!
     DEFAULT_VIEW_PATHS = [File.join('app', 'cells')]
     
-    extend Builder
+    extend Builder, Utils
     include AbstractController
     include AbstractController::Rendering, Layouts, Helpers, Callbacks, Translation, Logger
     
+    require 'cell/rails3_0_strategy' if rails3_0?
+    require 'cell/rails3_1_strategy' if rails3_1_or_more?
     include VersionStrategy
     include Rendering
-    include Caching
+    #include Caching
+    
     
     class View < ActionView::Base
       def render(*args, &block)

data/lib/cell/rack.rb

@@ -0,0 +1,36 @@
+require 'cell/base'
+
+module Cell
+  # Use Cell::Rack to mount your cell to a rack-route with a working +session+ and +params+ reference
+  # in the cell. This is especially useful when using gems like devise with your cell, without the
+  # entire Cell::Rails overhead.
+  #
+  # The only dependency these kinds of cells have is a rack-compatible request object.
+  #
+  # Example:
+  #
+  #   match "/dashboard/comments" => proc { |env|
+  #     request = ActionDispatch::Request.new(env)
+  #     [ 200, {}, [ Cell::Rack.render_cell_for(:comments, :show, request) ]]
+  #   }
+  class Rack < Base
+    attr_reader :request
+    delegate :session, :params, :to => :request
+    
+    class << self
+      # DISCUSS: i don't like these class methods. maybe a RenderingStrategy?
+      def create_cell(request, *args) # defined in Builder.
+        new(request)
+      end
+      
+      def render_cell_state(cell, state, request, *args) # defined in Rendering.
+        super(cell, state, *args)
+      end
+    end
+    
+    def initialize(request)
+      super()
+      @request = request
+    end
+  end
+end

data/lib/cell/rails.rb

@@ -1,39 +1,24 @@
-require 'cell/base'
+require 'cell/rack'
 
 module Cell
-  class Rails < Base
+  class Rails < Rack
     include ActionController::RequestForgeryProtection
     
     abstract!
-    
-    module Metal
-      delegate :session, :params, :request, :config, :env, :url_options, :to => :parent_controller
-    end
-    
-    include Metal
-    
+    delegate :session, :params, :request, :config, :env, :url_options, :to => :parent_controller
     
     class << self
-      def create_cell(controller, *args)
-        new(controller)
-      end
-      
     private
       # Run builder block in controller instance context.
       def run_builder_block(block, controller, *args)
         controller.instance_exec(*args, &block)
       end
-      
-      def render_cell_state(cell, state, *args)
-        args.shift  # remove the controller instance.
-        cell.render_state(state, *args)
-      end
     end
     
     attr_reader :parent_controller
     
     def initialize(parent_controller)
-      super()
+      super
       @parent_controller = parent_controller
     end
   end

data/lib/cell/rails3_1_strategy.rb

@@ -4,15 +4,16 @@ module Cell
   module VersionStrategy
     extend ActiveSupport::Concern
     
-    include AbstractController::UrlFor  # must be included before _routes is set in Railstie.
+    #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)
+          routes  = _routes # if respond_to?(:_routes)
+          helpers = _helpers# if respond_to?(:_helpers)
+          
+          Cell::Base::View.prepare(routes, helpers)
         end
       end
     end

data/lib/cell/test_case.rb

@@ -110,10 +110,9 @@ module Cell
       # Example:
       #   assert_equal "Doo Dumm Dumm..." cell(:bassist).play
       def cell(name, *args, &block)
-        cell = ::Cell::Rails.create_cell_for(name, @controller, *args)
-        cell.instance_eval &block if block_given?
-        ActiveSupport::Deprecation.warn("Passing options to TestCase#cell is deprecated, please use state-args in #render_cell.", caller) if args.present?
-        cell
+        Cell::Rails.create_cell_for(name, @controller, *args).tap do |cell|
+          cell.instance_eval &block if block_given?
+        end
       end
 
       # Execute the passed +block+ in a real view context of +cell_class+.

data/lib/cells.rb

@@ -64,24 +64,14 @@ module Cells
   # Example:
   #
   #   Cells.setup do |config|
-  #     config.append_view_path << "app/view_models"
+  #     config.append_view_path "app/view_models"
   #   end
   #
   def self.setup
     yield(Cell::Rails)
   end
   
-  def self.rails3_0?
-    ::Rails::VERSION::MINOR == 0
-  end
-  
-  def self.rails3_1_or_more?
-    ::Rails::VERSION::MINOR >= 1
-  end
   
-  def self.rails3_2_or_more?  # FIXME: move to tests.
-    ::Rails::VERSION::MINOR >= 2
-  end
 end
 
 require 'cell/rails'

data/lib/cells/version.rb

@@ -1,3 +1,3 @@
 module Cells
-  VERSION = '3.8.3'
+  VERSION = '3.8.4'
 end

data/lib/generators/cells/base.rb

@@ -6,6 +6,7 @@ module Cells
     class Base < ::Rails::Generators::NamedBase
       class_option :template_engine
       class_option :test_framework
+      class_option :base_cell_class, :type => :string, :default => "Cell::Rails"
 
       argument :actions, :type => :array, :default => [], :banner => "action action"
       check_class_collision :suffix => "Cell"

data/lib/generators/templates/cell.rb

@@ -1,4 +1,4 @@
-class <%= class_name %>Cell < Cell::Rails
+class <%= class_name %>Cell < <%= options.base_cell_class %>
 
 <% for action in actions -%>
   def <%= action %>

data/test/cell_generator_test.rb

@@ -26,6 +26,11 @@ class CellGeneratorTest < Rails::Generators::TestCase
       assert_no_file "app/cells/blog/post.html.slim"
       assert_no_file "app/cells/blog/latest.html.slim"
     end
+
+    should "create cell that inherits from custom cell class if specified" do
+      run_generator %w(Blog --base-cell-class=ApplicationCell)
+      assert_file "app/cells/blog_cell.rb", /class BlogCell < ApplicationCell/
+    end
     
     should "work with namespaces" do
       run_generator %w(Blog::Post latest)

data/test/cell_module_test.rb

@@ -11,8 +11,8 @@ end
 
 # Used in CellBaseTest.
 class ShouterCell < Cell::Base
-  def sing
-    render
+  def sing(first)
+    first + render
   end
 end
 
@@ -35,7 +35,7 @@ class CellBaseTest < MiniTest::Spec
     describe ".render_cell_for" do
       it "invokes controller-less cell" do
         Cell::Base.view_paths= ["test/app/cells"]
-        assert_equal "AAAaaargh!\n", Cell::Base.render_cell_for(:shouter, :sing)
+        assert_equal "YAAAaaargh!\n", Cell::Base.render_cell_for(:shouter, :sing, "Y")
       end
     end
   end

data/test/rack_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class RackTest < MiniTest::Spec
+  class BassistCell < Cell::Rack
+    def play
+      render :text => request.class
+    end
+    
+    def sing
+      render :text => session[:what]
+    end
+  end
+  
+  describe "Cell::Rack" do
+    before do
+      @request = ActionDispatch::TestRequest.new
+    end
+    
+    it "allows accessing the request object" do
+      assert_equal "ActionDispatch::TestRequest", BassistCell.new(@request).render_state(:play)
+    end
+    
+    it "allows accessing the session object" do
+      @request.session[:what] = "Yo!"
+      assert_equal "Yo!", BassistCell.new(@request).render_state(:sing)
+    end
+    
+    it "works with #render_cell_for" do
+      assert_equal "ActionDispatch::TestRequest", Cell::Rack.render_cell_for("rack_test/bassist", :play, @request)
+    end
+  end
+end

data/test/test_case_test.rb

@@ -34,12 +34,6 @@ class TestCaseTest < Cell::TestCase
       should "accept a block" do
         assert_respond_to cell(:bassist){ def whatever; end }, :whatever
       end
-      
-      should "mark options as deprecated" do
-        assert_deprecated do
-          res = cell(:bassist, :song => "Lockdown")
-        end
-      end
     end
     
     context "#subject_cell" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cells
 version: !ruby/object:Gem::Version
-  version: 3.8.3
+  version: 3.8.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &78710300 !ruby/object:Gem::Requirement
+  requirement: &79267830 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *78710300
+  version_requirements: *79267830
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &78710010 !ruby/object:Gem::Requirement
+  requirement: &79266900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *78710010
+  version_requirements: *79266900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &78709820 !ruby/object:Gem::Requirement
+  requirement: &79266060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78709820
+  version_requirements: *79266060
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &78709590 !ruby/object:Gem::Requirement
+  requirement: &79264770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78709590
+  version_requirements: *79264770
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &78709380 !ruby/object:Gem::Requirement
+  requirement: &79264410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78709380
+  version_requirements: *79264410
 - !ruby/object:Gem::Dependency
   name: slim
-  requirement: &78709170 !ruby/object:Gem::Requirement
+  requirement: &79263450 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78709170
+  version_requirements: *79263450
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &78708950 !ruby/object:Gem::Requirement
+  requirement: &79261530 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78708950
+  version_requirements: *79261530
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &78708700 !ruby/object:Gem::Requirement
+  requirement: &79258660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: 2.8.1
   type: :development
   prerelease: false
-  version_requirements: *78708700
+  version_requirements: *79258660
 description: Cells are view components for Rails. They are lightweight controllers,
   can be rendered in views and thus provide an elegant and fast way for encapsulation
   and component-orientation.
@@ -124,6 +124,7 @@ files:
 - lib/cell/builder.rb
 - lib/cell/caching.rb
 - lib/cell/deprecations.rb
+- lib/cell/rack.rb
 - lib/cell/rails.rb
 - lib/cell/rails3_0_strategy.rb
 - lib/cell/rails3_1_strategy.rb
@@ -216,6 +217,7 @@ files:
 - test/dummy/public/stylesheets/.gitkeep
 - test/dummy/script/rails
 - test/helper_test.rb
+- test/rack_test.rb
 - test/rails/caching_test.rb
 - test/rails/capture_test.rb
 - test/rails/cells_test.rb