2004-11-24 01:04:44 +00:00
|
|
|
module ActionView
|
2007-03-13 05:06:41 +00: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 16:08:29 +00:00
|
|
|
#
|
|
|
|
# In a template for Advertiser#account:
|
|
|
|
#
|
2005-06-21 16:59:04 +00:00
|
|
|
# <%= render :partial => "account" %>
|
2005-04-16 16:08:29 +00:00
|
|
|
#
|
2007-03-13 05:06:41 +00:00
|
|
|
# This would render "advertiser/_account.erb" and pass the instance variable @account in as a local variable +account+ to
|
2005-04-16 16:08:29 +00:00
|
|
|
# the template for display.
|
|
|
|
#
|
|
|
|
# In another template for Advertiser#buy, we could have:
|
|
|
|
#
|
2005-06-21 16:59:04 +00:00
|
|
|
# <%= render :partial => "account", :locals => { :account => @buyer } %>
|
2004-11-24 01:04:44 +00:00
|
|
|
#
|
|
|
|
# <% for ad in @advertisements %>
|
2005-06-21 16:59:04 +00:00
|
|
|
# <%= render :partial => "ad", :locals => { :ad => ad } %>
|
2004-11-24 01:04:44 +00:00
|
|
|
# <% end %>
|
|
|
|
#
|
2007-03-13 05:06:41 +00:00
|
|
|
# This would first render "advertiser/_account.erb" with @buyer passed in as the local variable +account+, then render
|
2007-02-20 22:09:12 +00:00
|
|
|
# "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display.
|
2004-11-24 01:04:44 +00:00
|
|
|
#
|
|
|
|
# == Rendering a collection of partials
|
|
|
|
#
|
2005-02-07 14:15:53 +00:00
|
|
|
# The example of partial use describes a familiar pattern where a template needs to iterate over an array and render a sub
|
2004-11-24 01:04:44 +00:00
|
|
|
# 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:
|
|
|
|
#
|
2005-06-21 16:59:04 +00:00
|
|
|
# <%= render :partial => "ad", :collection => @advertisements %>
|
2004-11-24 01:04:44 +00:00
|
|
|
#
|
2007-02-20 22:09:12 +00:00
|
|
|
# This will render "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display. An iteration counter
|
2007-03-13 05:06:41 +00:00
|
|
|
# will automatically be made available to the template with a name of the form +partial_name_counter+. In the case of the
|
2004-11-24 01:04:44 +00:00
|
|
|
# example above, the template would be fed +ad_counter+.
|
2005-07-03 08:05:05 +00: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 05:06:41 +00:00
|
|
|
#
|
2004-11-24 01:04:44 +00:00
|
|
|
# == Rendering shared partials
|
|
|
|
#
|
|
|
|
# Two controllers can share a set of partials and render them like this:
|
|
|
|
#
|
2005-06-21 16:59:04 +00:00
|
|
|
# <%= render :partial => "advertisement/ad", :locals => { :ad => @advertisement } %>
|
2004-11-24 01:04:44 +00:00
|
|
|
#
|
2007-02-20 22:09:12 +00:00
|
|
|
# This will render the partial "advertisement/_ad.erb" regardless of which controller this is being called from.
|
2007-08-02 20:10:03 +00:00
|
|
|
#
|
|
|
|
# == Rendering partials with layouts
|
|
|
|
#
|
|
|
|
# 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-09-24 23:01:50 +00:00
|
|
|
# <%# app/views/users/index.html.erb &>
|
2007-08-02 20:10:03 +00: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 23:01:50 +00:00
|
|
|
# <%# app/views/users/_user.html.erb &>
|
2007-08-02 20:10:03 +00:00
|
|
|
# Name: <%= user.name %>
|
|
|
|
#
|
2007-09-24 23:01:50 +00:00
|
|
|
# <%# app/views/users/_administrator.html.erb &>
|
2007-08-02 20:10:03 +00:00
|
|
|
# <div id="administrator">
|
|
|
|
# Budget: $<%= user.budget %>
|
|
|
|
# <%= yield %>
|
|
|
|
# </div>
|
|
|
|
#
|
2007-09-24 23:01:50 +00:00
|
|
|
# <%# app/views/users/_editor.html.erb &>
|
2007-08-02 20:10:03 +00:00
|
|
|
# <div id="editor">
|
|
|
|
# Deadline: $<%= user.deadline %>
|
|
|
|
# <%= 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">
|
|
|
|
# Deadline: $<%= user.deadline %>
|
|
|
|
# Name: <%= user.name %>
|
|
|
|
# </div>
|
|
|
|
#
|
|
|
|
# You can also apply a layout to a block within any template:
|
|
|
|
#
|
2007-09-24 23:01:50 +00:00
|
|
|
# <%# app/views/users/_chief.html.erb &>
|
2007-08-02 20:10:03 +00: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>
|
|
|
|
#
|
|
|
|
# As you can see, the :locals hash is shared between both the partial and its layout.
|
2004-11-24 01:04:44 +00:00
|
|
|
module Partials
|
2007-03-13 05:06:41 +00:00
|
|
|
private
|
2007-09-03 00:18:30 +00:00
|
|
|
def render_partial(partial_path, object_assigns = nil, local_assigns = nil) #:nodoc:
|
2007-05-18 00:36:14 +00:00
|
|
|
case partial_path
|
|
|
|
when String, Symbol, NilClass
|
|
|
|
path, partial_name = partial_pieces(partial_path)
|
2008-01-27 01:03:56 +00:00
|
|
|
full_partial_path = File.join(path, "_#{partial_name}")
|
2007-09-03 00:18:30 +00:00
|
|
|
object = extracting_object(partial_name, object_assigns)
|
2007-05-18 00:36:14 +00:00
|
|
|
local_assigns = local_assigns ? local_assigns.clone : {}
|
|
|
|
add_counter_to_local_assigns!(partial_name, local_assigns)
|
|
|
|
add_object_to_local_assigns!(partial_name, local_assigns, object)
|
2005-04-16 16:06:29 +00:00
|
|
|
|
2007-11-14 09:39:27 +00:00
|
|
|
if logger && logger.debug?
|
2008-01-27 01:03:56 +00:00
|
|
|
ActionController::Base.benchmark("Rendered #{full_partial_path}", Logger::DEBUG, false) do
|
|
|
|
render(full_partial_path, local_assigns)
|
2007-05-18 00:36:14 +00:00
|
|
|
end
|
|
|
|
else
|
2008-01-27 01:03:56 +00:00
|
|
|
render(full_partial_path, local_assigns)
|
2007-03-13 05:06:41 +00:00
|
|
|
end
|
2008-01-16 02:01:57 +00:00
|
|
|
when ActionView::Helpers::FormBuilder
|
|
|
|
builder_partial_path = partial_path.class.to_s.demodulize.underscore.sub(/_builder$/, '')
|
|
|
|
render_partial(builder_partial_path, object_assigns, (local_assigns || {}).merge(builder_partial_path.to_sym => partial_path))
|
2007-11-12 15:02:12 +00:00
|
|
|
when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::Associations::HasManyThroughAssociation
|
2007-05-18 00:36:14 +00:00
|
|
|
if partial_path.any?
|
|
|
|
path = ActionController::RecordIdentifier.partial_path(partial_path.first)
|
|
|
|
collection = partial_path
|
2008-02-08 22:04:06 +00:00
|
|
|
render_partial_collection(path, collection, nil, local_assigns)
|
2007-05-18 00:36:14 +00:00
|
|
|
else
|
|
|
|
""
|
|
|
|
end
|
2007-03-13 05:06:41 +00:00
|
|
|
else
|
2007-05-18 00:36:14 +00:00
|
|
|
render_partial(
|
|
|
|
ActionController::RecordIdentifier.partial_path(partial_path),
|
2008-02-08 22:04:06 +00:00
|
|
|
partial_path, local_assigns)
|
2005-11-16 09:00:23 +00:00
|
|
|
end
|
2005-10-01 19:00:06 +00:00
|
|
|
end
|
2004-11-24 01:04:44 +00:00
|
|
|
|
2007-03-13 05:06:41 +00:00
|
|
|
def render_partial_collection(partial_name, collection, partial_spacer_template = nil, local_assigns = nil) #:nodoc:
|
|
|
|
collection_of_partials = Array.new
|
|
|
|
counter_name = partial_counter_name(partial_name)
|
|
|
|
local_assigns = local_assigns ? local_assigns.clone : {}
|
|
|
|
collection.each_with_index do |element, counter|
|
|
|
|
local_assigns[counter_name] = counter
|
|
|
|
collection_of_partials.push(render_partial(partial_name, element, local_assigns))
|
|
|
|
end
|
2004-11-24 01:04:44 +00:00
|
|
|
|
2007-03-13 05:06:41 +00:00
|
|
|
return " " if collection_of_partials.empty?
|
2005-05-13 16:27:36 +00:00
|
|
|
|
2007-03-13 05:06:41 +00:00
|
|
|
if partial_spacer_template
|
|
|
|
spacer_path, spacer_name = partial_pieces(partial_spacer_template)
|
|
|
|
collection_of_partials.join(render("#{spacer_path}/_#{spacer_name}"))
|
|
|
|
else
|
|
|
|
collection_of_partials.join
|
|
|
|
end
|
2004-11-24 01:04:44 +00:00
|
|
|
end
|
2007-03-13 05:06:41 +00:00
|
|
|
|
|
|
|
alias_method :render_collection_of_partials, :render_partial_collection
|
|
|
|
|
2004-11-24 01:04:44 +00:00
|
|
|
def partial_pieces(partial_path)
|
|
|
|
if partial_path.include?('/')
|
|
|
|
return File.dirname(partial_path), File.basename(partial_path)
|
|
|
|
else
|
2005-02-15 01:45:35 +00:00
|
|
|
return controller.class.controller_path, partial_path
|
2004-11-24 01:04:44 +00:00
|
|
|
end
|
|
|
|
end
|
2004-12-12 11:48:01 +00:00
|
|
|
|
|
|
|
def partial_counter_name(partial_name)
|
2007-07-01 00:04:03 +00:00
|
|
|
"#{partial_variable_name(partial_name)}_counter".intern
|
|
|
|
end
|
|
|
|
|
|
|
|
def partial_variable_name(partial_name)
|
2008-02-03 12:11:30 +00:00
|
|
|
@@partial_variable_names ||= {}
|
|
|
|
@@partial_variable_names[partial_name] ||=
|
|
|
|
partial_name.split('/').last.split('.').first.intern
|
2004-12-12 11:48:01 +00:00
|
|
|
end
|
2007-03-13 05:06:41 +00:00
|
|
|
|
2007-09-03 00:18:30 +00:00
|
|
|
def extracting_object(partial_name, object_assigns)
|
2007-07-01 00:04:03 +00:00
|
|
|
variable_name = partial_variable_name(partial_name)
|
2007-09-03 00:18:30 +00:00
|
|
|
if object_assigns.nil?
|
2007-07-01 00:04:03 +00:00
|
|
|
controller.instance_variable_get("@#{variable_name}")
|
2005-04-16 16:06:29 +00:00
|
|
|
else
|
2007-09-03 00:18:30 +00:00
|
|
|
object_assigns
|
2005-04-16 16:06:29 +00:00
|
|
|
end
|
|
|
|
end
|
2007-03-13 05:06:41 +00:00
|
|
|
|
2005-04-16 16:06:29 +00:00
|
|
|
def add_counter_to_local_assigns!(partial_name, local_assigns)
|
|
|
|
counter_name = partial_counter_name(partial_name)
|
|
|
|
local_assigns[counter_name] = 1 unless local_assigns.has_key?(counter_name)
|
|
|
|
end
|
2005-11-16 09:00:23 +00:00
|
|
|
|
2005-10-10 20:35:13 +00:00
|
|
|
def add_object_to_local_assigns!(partial_name, local_assigns, object)
|
2007-07-01 00:04:03 +00:00
|
|
|
variable_name = partial_variable_name(partial_name)
|
2007-10-25 21:32:01 +00:00
|
|
|
|
|
|
|
local_assigns[:object] ||=
|
|
|
|
local_assigns[variable_name] ||=
|
|
|
|
if object.is_a?(ActionView::Base::ObjectWrapper)
|
|
|
|
object.value
|
|
|
|
else
|
|
|
|
object
|
|
|
|
end || controller.instance_variable_get("@#{variable_name}")
|
2005-10-10 20:35:13 +00:00
|
|
|
end
|
2004-11-24 01:04:44 +00:00
|
|
|
end
|
|
|
|
end
|