2004-11-23 20:04:44 -05:00
|
|
|
module ActionView
|
2008-08-21 22:02:10 -04:00
|
|
|
# There's also a convenience method for rendering sub templates within the current controller that depends on a
|
|
|
|
# single object (we call this kind of sub templates for partials). It relies on the fact that partials should
|
|
|
|
# follow the naming convention of being prefixed with an underscore -- as to separate them from regular
|
|
|
|
# templates that could be rendered on their own.
|
2005-04-16 12:08:29 -04:00
|
|
|
#
|
|
|
|
# In a template for Advertiser#account:
|
|
|
|
#
|
2005-06-21 12:59:04 -04:00
|
|
|
# <%= render :partial => "account" %>
|
2005-04-16 12:08:29 -04:00
|
|
|
#
|
2008-08-21 22:02:10 -04:00
|
|
|
# This would render "advertiser/_account.erb" and pass the instance variable @account in as a local variable
|
|
|
|
# +account+ to the template for display.
|
2005-04-16 12:08:29 -04:00
|
|
|
#
|
|
|
|
# In another template for Advertiser#buy, we could have:
|
|
|
|
#
|
2005-06-21 12:59:04 -04:00
|
|
|
# <%= render :partial => "account", :locals => { :account => @buyer } %>
|
2004-11-23 20:04:44 -05:00
|
|
|
#
|
|
|
|
# <% for ad in @advertisements %>
|
2005-06-21 12:59:04 -04:00
|
|
|
# <%= render :partial => "ad", :locals => { :ad => ad } %>
|
2004-11-23 20:04:44 -05:00
|
|
|
# <% end %>
|
|
|
|
#
|
2008-08-21 22:02:10 -04:00
|
|
|
# This would first render "advertiser/_account.erb" with @buyer passed in as the local variable +account+, then
|
|
|
|
# render "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display.
|
2004-11-23 20:04:44 -05:00
|
|
|
#
|
|
|
|
# == Rendering a collection of partials
|
|
|
|
#
|
2008-08-21 22:02:10 -04:00
|
|
|
# The example of partial use describes a familiar pattern where a template needs to iterate over an array and
|
|
|
|
# render a sub template for each of the elements. This pattern has been implemented as a single method that
|
|
|
|
# accepts an array and renders a partial by the same name as the elements contained within. So the three-lined
|
|
|
|
# example in "Using partials" can be rewritten with a single line:
|
2004-11-23 20:04:44 -05:00
|
|
|
#
|
2005-06-21 12:59:04 -04:00
|
|
|
# <%= render :partial => "ad", :collection => @advertisements %>
|
2004-11-23 20:04:44 -05:00
|
|
|
#
|
2008-08-21 22:02:10 -04:00
|
|
|
# This will render "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display. An
|
|
|
|
# iteration counter will automatically be made available to the template with a name of the form
|
|
|
|
# +partial_name_counter+. In the case of the example above, the template would be fed +ad_counter+.
|
2005-07-03 04:05:05 -04:00
|
|
|
#
|
2008-08-21 22:02:10 -04:00
|
|
|
# NOTE: Due to backwards compatibility concerns, the collection can't be one of hashes. Normally you'd also
|
|
|
|
# just keep domain objects, like Active Records, in there.
|
2007-03-13 01:06:41 -04:00
|
|
|
#
|
2004-11-23 20:04:44 -05:00
|
|
|
# == Rendering shared partials
|
|
|
|
#
|
|
|
|
# Two controllers can share a set of partials and render them like this:
|
|
|
|
#
|
2005-06-21 12:59:04 -04:00
|
|
|
# <%= render :partial => "advertisement/ad", :locals => { :ad => @advertisement } %>
|
2004-11-23 20:04:44 -05:00
|
|
|
#
|
2007-02-20 17:09:12 -05:00
|
|
|
# This will render the partial "advertisement/_ad.erb" regardless of which controller this is being called from.
|
2007-08-02 16:10:03 -04:00
|
|
|
#
|
2008-11-19 08:00:16 -05:00
|
|
|
# == Rendering objects with the RecordIdentifier
|
|
|
|
#
|
|
|
|
# Instead of explicitly naming the location of a partial, you can also let the RecordIdentifier do the work if
|
|
|
|
# you're following its conventions for RecordIdentifier#partial_path. Examples:
|
|
|
|
#
|
|
|
|
# # @account is an Account instance, so it uses the RecordIdentifier to replace
|
|
|
|
# # <%= render :partial => "accounts/account", :locals => { :account => @buyer } %>
|
|
|
|
# <%= render :partial => @account %>
|
|
|
|
#
|
|
|
|
# # @posts is an array of Post instances, so it uses the RecordIdentifier to replace
|
|
|
|
# # <%= render :partial => "posts/post", :collection => @posts %>
|
|
|
|
# <%= render :partial => @posts %>
|
|
|
|
#
|
|
|
|
# == Rendering the default case
|
|
|
|
#
|
|
|
|
# If you're not going to be using any of the options like collections or layouts, you can also use the short-hand
|
|
|
|
# defaults of render to render partials. Examples:
|
|
|
|
#
|
|
|
|
# # Instead of <%= render :partial => "account" %>
|
|
|
|
# <%= render "account" %>
|
|
|
|
#
|
|
|
|
# # Instead of <%= render :partial => "account", :locals => { :account => @buyer } %>
|
|
|
|
# <%= render "account", :account => @buyer %>
|
|
|
|
#
|
|
|
|
# # @account is an Account instance, so it uses the RecordIdentifier to replace
|
|
|
|
# # <%= render :partial => "accounts/account", :locals => { :account => @account } %>
|
|
|
|
# <%= render(@account) %>
|
|
|
|
#
|
|
|
|
# # @posts is an array of Post instances, so it uses the RecordIdentifier to replace
|
|
|
|
# # <%= render :partial => "posts/post", :collection => @posts %>
|
|
|
|
# <%= render(@posts) %>
|
|
|
|
#
|
2007-08-02 16:10:03 -04:00
|
|
|
# == Rendering partials with layouts
|
|
|
|
#
|
2008-08-21 22:02:10 -04:00
|
|
|
# Partials can have their own layouts applied to them. These layouts are different than the ones that are
|
|
|
|
# specified globally for the entire action, but they work in a similar fashion. Imagine a list with two types
|
|
|
|
# of users:
|
2007-08-02 16:10:03 -04:00
|
|
|
#
|
2007-09-24 19:01:50 -04:00
|
|
|
# <%# app/views/users/index.html.erb &>
|
2007-08-02 16:10:03 -04:00
|
|
|
# Here's the administrator:
|
|
|
|
# <%= render :partial => "user", :layout => "administrator", :locals => { :user => administrator } %>
|
|
|
|
#
|
|
|
|
# Here's the editor:
|
|
|
|
# <%= render :partial => "user", :layout => "editor", :locals => { :user => editor } %>
|
|
|
|
#
|
2007-09-24 19:01:50 -04:00
|
|
|
# <%# app/views/users/_user.html.erb &>
|
2007-08-02 16:10:03 -04:00
|
|
|
# Name: <%= user.name %>
|
|
|
|
#
|
2007-09-24 19:01:50 -04:00
|
|
|
# <%# app/views/users/_administrator.html.erb &>
|
2007-08-02 16:10:03 -04:00
|
|
|
# <div id="administrator">
|
|
|
|
# Budget: $<%= user.budget %>
|
|
|
|
# <%= yield %>
|
|
|
|
# </div>
|
|
|
|
#
|
2007-09-24 19:01:50 -04:00
|
|
|
# <%# app/views/users/_editor.html.erb &>
|
2007-08-02 16:10:03 -04:00
|
|
|
# <div id="editor">
|
2008-08-17 20:29:24 -04:00
|
|
|
# Deadline: <%= user.deadline %>
|
2007-08-02 16:10:03 -04:00
|
|
|
# <%= yield %>
|
|
|
|
# </div>
|
|
|
|
#
|
|
|
|
# ...this will return:
|
|
|
|
#
|
|
|
|
# Here's the administrator:
|
|
|
|
# <div id="administrator">
|
|
|
|
# Budget: $<%= user.budget %>
|
|
|
|
# Name: <%= user.name %>
|
|
|
|
# </div>
|
|
|
|
#
|
|
|
|
# Here's the editor:
|
|
|
|
# <div id="editor">
|
2008-08-17 20:29:24 -04:00
|
|
|
# Deadline: <%= user.deadline %>
|
2007-08-02 16:10:03 -04:00
|
|
|
# Name: <%= user.name %>
|
|
|
|
# </div>
|
|
|
|
#
|
|
|
|
# You can also apply a layout to a block within any template:
|
|
|
|
#
|
2007-09-24 19:01:50 -04:00
|
|
|
# <%# app/views/users/_chief.html.erb &>
|
2007-08-02 16:10:03 -04:00
|
|
|
# <% render(:layout => "administrator", :locals => { :user => chief }) do %>
|
|
|
|
# Title: <%= chief.title %>
|
|
|
|
# <% end %>
|
|
|
|
#
|
|
|
|
# ...this will return:
|
|
|
|
#
|
|
|
|
# <div id="administrator">
|
|
|
|
# Budget: $<%= user.budget %>
|
|
|
|
# Title: <%= chief.name %>
|
|
|
|
# </div>
|
|
|
|
#
|
2008-05-02 09:45:23 -04:00
|
|
|
# As you can see, the <tt>:locals</tt> hash is shared between both the partial and its layout.
|
2008-08-17 20:29:24 -04:00
|
|
|
#
|
|
|
|
# If you pass arguments to "yield" then this will be passed to the block. One way to use this is to pass
|
|
|
|
# an array to layout and treat it as an enumerable.
|
|
|
|
#
|
|
|
|
# <%# app/views/users/_user.html.erb &>
|
|
|
|
# <div class="user">
|
|
|
|
# Budget: $<%= user.budget %>
|
|
|
|
# <%= yield user %>
|
|
|
|
# </div>
|
|
|
|
#
|
|
|
|
# <%# app/views/users/index.html.erb &>
|
|
|
|
# <% render :layout => @users do |user| %>
|
|
|
|
# Title: <%= user.title %>
|
|
|
|
# <% end %>
|
|
|
|
#
|
|
|
|
# This will render the layout for each user and yield to the block, passing the user, each time.
|
|
|
|
#
|
|
|
|
# You can also yield multiple times in one layout and use block arguments to differentiate the sections.
|
|
|
|
#
|
|
|
|
# <%# app/views/users/_user.html.erb &>
|
|
|
|
# <div class="user">
|
|
|
|
# <%= yield user, :header %>
|
|
|
|
# Budget: $<%= user.budget %>
|
|
|
|
# <%= yield user, :footer %>
|
|
|
|
# </div>
|
|
|
|
#
|
|
|
|
# <%# app/views/users/index.html.erb &>
|
|
|
|
# <% render :layout => @users do |user, section| %>
|
|
|
|
# <%- case section when :header -%>
|
|
|
|
# Title: <%= user.title %>
|
|
|
|
# <%- when :footer -%>
|
|
|
|
# Deadline: <%= user.deadline %>
|
|
|
|
# <%- end -%>
|
|
|
|
# <% end %>
|
2004-11-23 20:04:44 -05:00
|
|
|
module Partials
|
2008-07-23 14:47:30 -04:00
|
|
|
extend ActiveSupport::Memoizable
|
2009-05-28 12:35:36 -04:00
|
|
|
extend ActiveSupport::Concern
|
2009-08-06 22:42:11 -04:00
|
|
|
|
2009-05-12 19:21:34 -04:00
|
|
|
included do
|
2009-08-06 22:42:11 -04:00
|
|
|
attr_accessor :_partial
|
2009-05-12 19:21:34 -04:00
|
|
|
end
|
|
|
|
|
2009-08-06 23:52:13 -04:00
|
|
|
module ClassMethods
|
|
|
|
def _partial_names
|
|
|
|
@_partial_names ||= ActiveSupport::ConcurrentHash.new
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-08-07 00:51:50 -04:00
|
|
|
def render_partial(options)
|
2009-05-12 19:21:34 -04:00
|
|
|
@assigns_added = false
|
2009-08-07 10:33:54 -04:00
|
|
|
# TODO: Handle other details here.
|
|
|
|
self.formats = options[:_details][:formats]
|
2009-08-07 05:32:17 -04:00
|
|
|
_render_partial(options)
|
2009-05-12 19:21:34 -04:00
|
|
|
end
|
2008-07-23 14:47:30 -04:00
|
|
|
|
2009-08-07 05:32:17 -04:00
|
|
|
def _render_partial(options, &block) #:nodoc:
|
2009-01-22 17:18:10 -05:00
|
|
|
options[:locals] ||= {}
|
|
|
|
|
2009-08-06 22:42:11 -04:00
|
|
|
path = partial = options[:partial]
|
|
|
|
|
|
|
|
if partial.respond_to?(:to_ary)
|
2009-08-07 04:40:01 -04:00
|
|
|
return _render_partial_collection(partial, options, &block)
|
2009-08-06 22:42:11 -04:00
|
|
|
elsif !partial.is_a?(String)
|
|
|
|
options[:object] = object = partial
|
2009-08-06 23:52:13 -04:00
|
|
|
path = _partial_path(object)
|
2009-01-22 17:18:10 -05:00
|
|
|
end
|
2009-08-06 22:42:11 -04:00
|
|
|
|
2009-08-07 05:32:17 -04:00
|
|
|
_render_partial_object(_pick_partial_template(path), options, &block)
|
2009-01-22 17:18:10 -05:00
|
|
|
end
|
|
|
|
|
2007-03-13 01:06:41 -04:00
|
|
|
private
|
2009-08-06 23:52:13 -04:00
|
|
|
def _partial_path(object)
|
|
|
|
self.class._partial_names[[controller.class, object.class]] ||= begin
|
|
|
|
name = object.class.model_name
|
|
|
|
if controller_path && controller_path.include?("/")
|
|
|
|
File.join(File.dirname(controller_path), name.partial_path)
|
|
|
|
else
|
|
|
|
name.partial_path
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-08-07 05:32:17 -04:00
|
|
|
def _render_partial_template(template, locals, object, options = {}, &block)
|
|
|
|
options[:_template] = template
|
|
|
|
locals[:object] = locals[template.variable_name] = object
|
|
|
|
locals[options[:as]] = object if options[:as]
|
|
|
|
|
|
|
|
_render_single_template(template, locals, &block)
|
2009-01-22 17:18:10 -05:00
|
|
|
end
|
|
|
|
|
2009-08-07 04:40:01 -04:00
|
|
|
def _render_partial_object(template, options, &block)
|
2009-01-22 17:18:10 -05:00
|
|
|
if options.key?(:collection)
|
2009-08-07 04:40:01 -04:00
|
|
|
_render_partial_collection(options.delete(:collection), options, template, &block)
|
2007-03-13 01:06:41 -04:00
|
|
|
else
|
2009-01-22 17:18:10 -05:00
|
|
|
locals = (options[:locals] ||= {})
|
2009-08-07 05:32:17 -04:00
|
|
|
object = options[:object] || locals[:object] || locals[template.variable_name]
|
2009-08-06 22:42:11 -04:00
|
|
|
|
2009-08-07 05:32:17 -04:00
|
|
|
_render_partial_template(template, locals, object, options, &block)
|
2005-11-16 04:00:23 -05:00
|
|
|
end
|
2005-10-01 15:00:06 -04:00
|
|
|
end
|
2004-11-23 20:04:44 -05:00
|
|
|
|
2009-08-07 04:40:01 -04:00
|
|
|
def _render_partial_collection(collection, options = {}, template = nil, &block) #:nodoc:
|
2009-08-07 10:33:54 -04:00
|
|
|
options[:_template] ||= template
|
|
|
|
|
2009-01-22 17:18:10 -05:00
|
|
|
return nil if collection.blank?
|
2009-08-06 22:42:11 -04:00
|
|
|
|
2009-08-07 05:32:17 -04:00
|
|
|
if options.key?(:spacer_template)
|
|
|
|
spacer = _render_partial(:partial => options[:spacer_template])
|
|
|
|
end
|
2009-08-07 04:40:01 -04:00
|
|
|
|
|
|
|
locals, index = options[:locals] || {}, 0
|
2008-03-31 20:50:09 -04:00
|
|
|
|
2009-01-22 17:18:10 -05:00
|
|
|
collection.map do |object|
|
2009-08-07 04:40:01 -04:00
|
|
|
tmp = template || _pick_partial_template(_partial_path(object))
|
|
|
|
locals[tmp.counter_name] = index
|
2008-07-12 15:33:46 -04:00
|
|
|
index += 1
|
2009-08-06 22:42:11 -04:00
|
|
|
|
2009-08-07 05:32:17 -04:00
|
|
|
_render_partial_template(tmp, locals, object, options, &block)
|
2008-07-12 15:33:46 -04:00
|
|
|
end.join(spacer)
|
2008-03-31 20:50:09 -04:00
|
|
|
end
|
|
|
|
|
2008-08-21 22:24:08 -04:00
|
|
|
def _pick_partial_template(partial_path) #:nodoc:
|
2009-08-07 05:32:17 -04:00
|
|
|
prefix = controller_path unless partial_path.include?(?/)
|
2009-08-07 14:00:12 -04:00
|
|
|
find(partial_path, {:formats => formats}, prefix, true)
|
2005-10-10 16:35:13 -04:00
|
|
|
end
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
end
|