github/rails
1
1
Fork 0
mirror of https://github.com/github/rails.git synced 2026-04-26 03:00:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup around partial rendering

Browse Source 
Signed-off-by: Joshua Peek <josh@joshpeek.com>
This commit is contained in:
Ryan Bates
2008-08-21 21:02:10 -05:00
committed by Joshua Peek
parent e6a66cbd05
commit 1129a24caf
6 changed files with 66 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
actionpack/lib/action_controller/base.rb
View File

@@ -780,9 +780,6 @@ module ActionController #:nodoc:
# render :file => "/path/to/some/template.erb", :layout => true, :status => 404 # render :file => "/path/to/some/template.erb", :layout => true, :status => 404
# render :file => "c:/path/to/some/template.erb", :layout => true, :status => 404 # render :file => "c:/path/to/some/template.erb", :layout => true, :status => 404
# #
# # Renders a template relative to the template root and chooses the proper file extension
# render :file => "some/template", :use_full_path => true
#
# === Rendering text # === Rendering text
# #
# Rendering of text is usually used for tests or for rendering prepared content, such as a cache. By default, text # Rendering of text is usually used for tests or for rendering prepared content, such as a cache. By default, text
@@ -913,21 +910,10 @@ module ActionController #:nodoc:
response.content_type ||= Mime::JSON response.content_type ||= Mime::JSON
render_for_text(json, options[:status]) render_for_text(json, options[:status])
elsif partial = options[:partial] elsif options[:partial]
partial = default_template_name if partial == true options[:partial] = default_template_name if options[:partial] == true
add_variables_to_assigns add_variables_to_assigns
render_for_text(@template.render(options), options[:status])
if collection = options[:collection]
render_for_text(
@template.send!(:render_partial_collection, partial, collection,
options[:spacer_template], options[:locals], options[:as]), options[:status]
)
else
render_for_text(
@template.send!(:render_partial, partial,
options[:object], options[:locals]), options[:status]
)
end
elsif options[:update] elsif options[:update]
add_variables_to_assigns add_variables_to_assigns

2
actionpack/lib/action_controller/rescue.rb
View File

@@ -182,7 +182,7 @@ module ActionController #:nodoc:
@template.instance_variable_set("@rescues_path", File.dirname(rescues_path("stub"))) @template.instance_variable_set("@rescues_path", File.dirname(rescues_path("stub")))
@template.send!(:assign_variables_from_controller) @template.send!(:assign_variables_from_controller)
@template.instance_variable_set("@contents", @template.render(:file => template_path_for_local_rescue(exception), :use_full_path => false)) @template.instance_variable_set("@contents", @template.render(:file => template_path_for_local_rescue(exception)))
response.content_type = Mime::HTML response.content_type = Mime::HTML
render_for_file(rescues_path("layout"), response_code_for_rescue(exception)) render_for_file(rescues_path("layout"), response_code_for_rescue(exception))

4
actionpack/lib/action_controller/templates/rescues/diagnostics.erb
View File

@@ -6,6 +6,6 @@
</h1> </h1>
<pre><%=h @exception.clean_message %></pre> <pre><%=h @exception.clean_message %></pre>
<%= render(:file => @rescues_path + "/_trace.erb", :use_full_path => false) %> <%= render(:file => @rescues_path + "/_trace.erb") %>
<%= render(:file => @rescues_path + "/_request_and_response.erb", :use_full_path => false) %> <%= render(:file => @rescues_path + "/_request_and_response.erb") %>

4
actionpack/lib/action_controller/templates/rescues/template_error.erb
View File

@@ -15,7 +15,7 @@
<% @real_exception = @exception <% @real_exception = @exception
@exception = @exception.original_exception || @exception %> @exception = @exception.original_exception || @exception %>
<%= render(:file => @rescues_path + "/_trace.erb", :use_full_path => false) %> <%= render(:file => @rescues_path + "/_trace.erb") %>
<% @exception = @real_exception %> <% @exception = @real_exception %>
<%= render(:file => @rescues_path + "/_request_and_response.erb", :use_full_path => false) %> <%= render(:file => @rescues_path + "/_request_and_response.erb") %>

43
actionpack/lib/action_view/base.rb
View File

@@ -239,7 +239,7 @@ module ActionView #:nodoc:
local_assigns ||= {} local_assigns ||= {}
if options.is_a?(String) if options.is_a?(String)
render_file(options, nil, local_assigns) render(:file => options, :locals => local_assigns)
elsif options == :update elsif options == :update
update_page(&block) update_page(&block)
elsif options.is_a?(Hash) elsif options.is_a?(Hash)
@@ -262,13 +262,15 @@ module ActionView #:nodoc:
end end
end end
elsif options[:file] elsif options[:file]
render_file(options[:file], nil, options[:locals]) if options[:use_full_path]
elsif options[:partial] && options.has_key?(:collection) ActiveSupport::Deprecation.warn("use_full_path option has been deprecated and has no affect.", caller)
render_partial_collection(options[:partial], options[:collection], options[:spacer_template], options[:locals], options[:as]) end
pick_template(options[:file]).render_template(self, options[:locals])
elsif options[:partial] elsif options[:partial]
render_partial(options[:partial], options[:object], options[:locals]) render_partial(options)
elsif options[:inline] elsif options[:inline]
render_inline(options[:inline], options[:locals], options[:type]) InlineTemplate.new(options[:inline], options[:type]).render(self, options[:locals])
end end
end end
end end
@@ -345,35 +347,6 @@ module ActionView #:nodoc:
memoize :pick_template memoize :pick_template
private private
# Renders the template present at <tt>template_path</tt>. The hash in <tt>local_assigns</tt>
# is made available as local variables.
def render_file(template_path, use_full_path = nil, local_assigns = {}) #:nodoc:
unless use_full_path == nil
ActiveSupport::Deprecation.warn("use_full_path option has been deprecated and has no affect.", caller)
end
if defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base) &&
template_path.is_a?(String) && !template_path.include?("/")
raise ActionViewError, <<-END_ERROR
Due to changes in ActionMailer, you need to provide the mailer_name along with the template name.
render "user_mailer/signup"
render :file => "user_mailer/signup"
If you are rendering a subtemplate, you must now use controller-like partial syntax:
render :partial => 'signup' # no mailer_name necessary
END_ERROR
end
template = pick_template(template_path)
template.render_template(self, local_assigns)
end
def render_inline(text, local_assigns = {}, type = nil)
InlineTemplate.new(text, type).render(self, local_assigns)
end
# Evaluate the local assigns and pushes them to the view. # Evaluate the local assigns and pushes them to the view.
def evaluate_assigns def evaluate_assigns
unless @assigns_added unless @assigns_added

83
actionpack/lib/action_view/partials.rb
View File

@@ -1,14 +1,15 @@
module ActionView module ActionView
# There's also a convenience method for rendering sub templates within the current controller that depends on a single object # There's also a convenience method for rendering sub templates within the current controller that depends on a
# (we call this kind of sub templates for partials). It relies on the fact that partials should follow the naming convention of being # single object (we call this kind of sub templates for partials). It relies on the fact that partials should
# prefixed with an underscore -- as to separate them from regular templates that could be rendered on their own. # follow the naming convention of being prefixed with an underscore -- as to separate them from regular
# templates that could be rendered on their own.
# #
# In a template for Advertiser#account: # In a template for Advertiser#account:
# #
# <%= render :partial => "account" %> # <%= render :partial => "account" %>
# #
# This would render "advertiser/_account.erb" and pass the instance variable @account in as a local variable +account+ to # This would render "advertiser/_account.erb" and pass the instance variable @account in as a local variable
# the template for display. # +account+ to the template for display.
# #
# In another template for Advertiser#buy, we could have: # In another template for Advertiser#buy, we could have:
# #
@@ -18,24 +19,24 @@ module ActionView
# <%= render :partial => "ad", :locals => { :ad => ad } %> # <%= render :partial => "ad", :locals => { :ad => ad } %>
# <% end %> # <% end %>
# #
# This would first render "advertiser/_account.erb" with @buyer passed in as the local variable +account+, then render # This would first render "advertiser/_account.erb" with @buyer passed in as the local variable +account+, then
# "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display. # render "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display.
# #
# == Rendering a collection of partials # == Rendering a collection of partials
# #
# The example of partial use describes a familiar pattern where a template needs to iterate over an array and render a sub # The example of partial use describes a familiar pattern where a template needs to iterate over an array and
# template for each of the elements. This pattern has been implemented as a single method that accepts an array and renders # render a sub template for each of the elements. This pattern has been implemented as a single method that
# a partial by the same name as the elements contained within. So the three-lined example in "Using partials" can be rewritten # accepts an array and renders a partial by the same name as the elements contained within. So the three-lined
# with a single line: # example in "Using partials" can be rewritten with a single line:
# #
# <%= render :partial => "ad", :collection => @advertisements %> # <%= render :partial => "ad", :collection => @advertisements %>
# #
# This will render "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display. An iteration counter # This will render "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display. An
# will automatically be made available to the template with a name of the form +partial_name_counter+. In the case of the # iteration counter will automatically be made available to the template with a name of the form
# example above, the template would be fed +ad_counter+. # +partial_name_counter+. In the case of the example above, the template would be fed +ad_counter+.
# #
# NOTE: Due to backwards compatibility concerns, the collection can't be one of hashes. Normally you'd also just keep domain objects, # NOTE: Due to backwards compatibility concerns, the collection can't be one of hashes. Normally you'd also
# like Active Records, in there. # just keep domain objects, like Active Records, in there.
# #
# == Rendering shared partials # == Rendering shared partials
# #
@@ -47,8 +48,9 @@ module ActionView
# #
# == Rendering partials with layouts # == Rendering partials with layouts
# #
# Partials can have their own layouts applied to them. These layouts are different than the ones that are specified globally # Partials can have their own layouts applied to them. These layouts are different than the ones that are
# for the entire action, but they work in a similar fashion. Imagine a list with two types of users: # specified globally for the entire action, but they work in a similar fashion. Imagine a list with two types
# of users:
# #
# <%# app/views/users/index.html.erb &> # <%# app/views/users/index.html.erb &>
# Here's the administrator: # Here's the administrator:
@@ -139,36 +141,51 @@ module ActionView
extend ActiveSupport::Memoizable extend ActiveSupport::Memoizable
private private
def render_partial(partial_path, object_assigns = nil, local_assigns = {}) #:nodoc: def render_partial(options = {}) #:nodoc:
local_assigns ||= {} local_assigns = options[:locals] || {}
case partial_path case partial_path = options[:partial]
when String, Symbol, NilClass when String, Symbol, NilClass
pick_template(find_partial_path(partial_path)).render_partial(self, object_assigns, local_assigns) if options.has_key?(:collection)
render_partial_collection(options)
else
pick_template(find_partial_path(partial_path)).render_partial(self, options[:object], local_assigns)
end
when ActionView::Helpers::FormBuilder when ActionView::Helpers::FormBuilder
builder_partial_path = partial_path.class.to_s.demodulize.underscore.sub(/_builder$/, '') 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)) render_partial(
:partial => builder_partial_path,
:object => options[:object],
:locals => local_assigns.merge(builder_partial_path.to_sym => partial_path)
)
when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope
if partial_path.any? if partial_path.any?
collection = partial_path render_partial(:collection => partial_path, :locals => local_assigns)
render_partial_collection(nil, collection, nil, local_assigns)
else else
"" ""
end end
else else
render_partial(ActionController::RecordIdentifier.partial_path(partial_path, controller.class.controller_path), partial_path, local_assigns) object = partial_path
render_partial(
:partial => ActionController::RecordIdentifier.partial_path(object, controller.class.controller_path),
:object => object,
:locals => local_assigns
)
end end
end end
def render_partial_collection(partial_path, collection, partial_spacer_template = nil, local_assigns = {}, as = nil) #:nodoc: def render_partial_collection(options = {}) #:nodoc:
return nil if collection.blank? return nil if options[:collection].blank?
local_assigns = local_assigns ? local_assigns.clone : {} partial = options[:partial]
spacer = partial_spacer_template ? render(:partial => partial_spacer_template) : '' spacer = options[:spacer_template] ? render(:partial => options[:spacer_template]) : ''
local_assigns = options[:locals] ? options[:locals].clone : {}
as = options[:as]
index = 0 index = 0
collection.map do |object| options[:collection].map do |object|
_partial_path ||= partial_path || ActionController::RecordIdentifier.partial_path(object, controller.class.controller_path) _partial_path ||= partial ||
ActionController::RecordIdentifier.partial_path(object, controller.class.controller_path)
path = find_partial_path(_partial_path) path = find_partial_path(_partial_path)
template = pick_template(path) template = pick_template(path)
local_assigns[template.counter_name] = index local_assigns[template.counter_name] = index
@@ -178,7 +195,7 @@ module ActionView
end.join(spacer) end.join(spacer)
end end
def find_partial_path(partial_path) def find_partial_path(partial_path) #:nodoc:
if partial_path.include?('/') if partial_path.include?('/')
File.join(File.dirname(partial_path), "_#{File.basename(partial_path)}") File.join(File.dirname(partial_path), "_#{File.basename(partial_path)}")
elsif respond_to?(:controller) elsif respond_to?(:controller)