kotovalexarian-likes-github
/
rails--rails
mirror of https://github.com/rails/rails.git
1
0
Fork 0
Code Releases Activity
rails--rails/actionpack/lib/action_view/render/rendering.rb

167 lines
6.0 KiB
Ruby
Raw Normal View History

Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
module ActionView
module Rendering
# Returns the result of a render that's dictated by the options hash. The primary options are:
#
# * <tt>:partial</tt> - See ActionView::Partials.
# * <tt>:update</tt> - Calls update_page with the block given.
# * <tt>:file</tt> - Renders an explicit template file (this used to be the old default), add :locals to pass in those.
# * <tt>:inline</tt> - Renders an inline template similar to how it's done in the controller.
# * <tt>:text</tt> - Renders the text passed in out.
#
# If no options hash is passed or :update specified, the default is to render a partial and use the second parameter
# as the locals hash.
Some more AV work: * rename _render_partial to _render_partial_unknown_type to reflect that for this call, we don't know the type. * Merge _render_partial_with_block and _render_partial_with_layout to _render_partial * TODO: Check to see if any more logic can be shared * TODO: See about streamlining block path so we can get rid of @_proc_for_layout * Remove @exempt_from_layout as it is no longer needed
2009-08-07 06:48:28 +00:00
def render(options = {}, locals = {}, &block) #:nodoc:
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
case options
Some more AV work: * rename _render_partial to _render_partial_unknown_type to reflect that for this call, we don't know the type. * Merge _render_partial_with_block and _render_partial_with_layout to _render_partial * TODO: Check to see if any more logic can be shared * TODO: See about streamlining block path so we can get rid of @_proc_for_layout * Remove @exempt_from_layout as it is no longer needed
2009-08-07 06:48:28 +00:00
when String, NilClass
Continue reworking the partial path. * TODO: Review ActionController calling render_template for certain partials. Might we be able to save logic by always delegating to AV's render_partial?
2009-08-07 09:32:17 +00:00
_render_partial(:partial => options, :locals => locals || {})
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
when Hash
layout = options[:layout]
Whitespace
2009-08-07 09:32:54 +00:00
Continue reworking the partial path. * TODO: Review ActionController calling render_template for certain partials. Might we be able to save logic by always delegating to AV's render_partial?
2009-08-07 09:32:17 +00:00
if block_given?
return concat(_render_partial(options.merge(:partial => layout), &block))
elsif options.key?(:partial)
First pass at making partial rendering an Object. More cleanup to come.
2009-08-08 15:26:58 +00:00
return _render_partial(options)
Some more AV work: * rename _render_partial to _render_partial_unknown_type to reflect that for this call, we don't know the type. * Merge _render_partial_with_block and _render_partial_with_layout to _render_partial * TODO: Check to see if any more logic can be shared * TODO: See about streamlining block path so we can get rid of @_proc_for_layout * Remove @exempt_from_layout as it is no longer needed
2009-08-07 06:48:28 +00:00
end
Whitespace
2009-08-07 09:32:54 +00:00
Rename find_by_parts and find_by_parts? to find and exists?
2009-08-07 18:00:12 +00:00
layout = find(layout, {:formats => formats}) if layout
Whitespace
2009-08-07 09:32:54 +00:00
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
if file = options[:file]
Rename find_by_parts and find_by_parts? to find and exists?
2009-08-07 18:00:12 +00:00
template = find(file, {:formats => formats})
Some more AV work: * rename _render_partial to _render_partial_unknown_type to reflect that for this call, we don't know the type. * Merge _render_partial_with_block and _render_partial_with_layout to _render_partial * TODO: Check to see if any more logic can be shared * TODO: See about streamlining block path so we can get rid of @_proc_for_layout * Remove @exempt_from_layout as it is no longer needed
2009-08-07 06:48:28 +00:00
_render_template(template, layout, :locals => options[:locals] || {})
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
elsif inline = options[:inline]
_render_inline(inline, layout, options)
elsif text = options[:text]
_render_text(text, layout, options)
end
when :update
update_page(&block)
end
end
Whitespace
2009-08-07 09:32:54 +00:00
Some more AV refactoring: * remove no longer used _array_like_objects * _render_content_with_layout renamed to _render_content since layout it optional * remove check for optional layout before _render_content
2009-08-07 05:46:21 +00:00
def _render_content(content, layout, locals)
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
return content unless layout
Whitespace
2009-08-07 09:32:54 +00:00
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
locals ||= {}
if controller && layout
Deprecate template, session, assigns, and layout accessors on response object. Instead access them through the controller instance. This mainly affects functional test assertions.
2009-04-29 04:29:29 +00:00
@_layout = layout.identifier
Refactor ActionView::Template ActionView::Template is now completely independent from template storage, which allows different back ends such as the database. ActionView::Template's only responsibility is to take in the template source (passed in from ActionView::Path), compile it, and render it.
2009-04-23 22:58:38 +00:00
logger.info("Rendering template within #{layout.identifier}") if logger
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
end
Whitespace
2009-08-07 09:32:54 +00:00
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
begin
Drive the final stake through @content_for_*'s heart!
2009-06-18 01:08:45 +00:00
old_content, @_content_for[:layout] = @_content_for[:layout], content
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
Drive the final stake through @content_for_*'s heart!
2009-06-18 01:08:45 +00:00
@cached_content_for_layout = @_content_for[:layout]
Replace _render_template_with_layout with _render_template since the layout is optional
2009-08-07 06:18:45 +00:00
_render_single_template(layout, locals)
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
ensure
Drive the final stake through @content_for_*'s heart!
2009-06-18 01:08:45 +00:00
@_content_for[:layout] = old_content
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
end
end
Modify various partial methods to carry along the block that can be passed in with render * _render_single_template, which renders a template without layout * _render_partial_unknown_type, which renders a partial of unknown type (the entry method for most partial rendering; supports strings, objects, and collections) * _render_partial_object, which renders a partial for a single object. * extracted _render_partial_path so it can be used to render the spacer without going through the public render :partial
2009-08-07 08:40:01 +00:00
# You can think of a layout as a method that is called with a block. _layout_for
# returns the contents that are yielded to the layout. If the user calls yield
# :some_name, the block, by default, returns content_for(:some_name). If the user
# calls yield, the default block returns content_for(:layout).
Extract the layout proc into a method, and write documentation explaining what the proc does in various cases.
2009-06-18 01:55:10 +00:00
#
# The user can override this default by passing a block to the layout.
#
# ==== Example
#
# # The template
# <% render :layout => "my_layout" do %>Content<% end %>
#
# # The layout
# <html><% yield %></html>
#
# In this case, instead of the default block, which would return content_for(:layout),
# this method returns the block that was passed in to render layout, and the response
# would be <html>Content</html>.
#
# Finally, the block can take block arguments, which can be passed in by yield.
#
# ==== Example
#
# # The template
Fix typo
2009-06-18 18:14:44 +00:00
# <% render :layout => "my_layout" do |customer| %>Hello <%= customer.name %><% end %>
Extract the layout proc into a method, and write documentation explaining what the proc does in various cases.
2009-06-18 01:55:10 +00:00
#
# # The layout
# <html><% yield Struct.new(:name).new("David") %></html>
#
# In this case, the layout would receive the block passed into <tt>render :layout</tt>,
# and the Struct specified in the layout would be passed into the block. The result
# would be <html>Hello David</html>.
Modify various partial methods to carry along the block that can be passed in with render * _render_single_template, which renders a template without layout * _render_partial_unknown_type, which renders a partial of unknown type (the entry method for most partial rendering; supports strings, objects, and collections) * _render_partial_object, which renders a partial for a single object. * extracted _render_partial_path so it can be used to render the spacer without going through the public render :partial
2009-08-07 08:40:01 +00:00
def _layout_for(names, &block)
with_output_buffer do
# This is due to the potentially ambiguous use of yield when
# a block is passed in to a template *and* there is a content_for()
# of the same name. Suggested solution: require explicit use of content_for
# in these ambiguous cases.
#
# We would be able to continue supporting yield in all non-ambiguous
# cases. Question: should we deprecate yield in favor of content_for
# and reserve yield for cases where there is a yield into a real block?
if @_content_for.key?(names.first) || !block_given?
return @_content_for[names.first || :layout]
else
return yield(names)
end
end
Extract the layout proc into a method, and write documentation explaining what the proc does in various cases.
2009-06-18 01:55:10 +00:00
end
Modify various partial methods to carry along the block that can be passed in with render * _render_single_template, which renders a template without layout * _render_partial_unknown_type, which renders a partial of unknown type (the entry method for most partial rendering; supports strings, objects, and collections) * _render_partial_object, which renders a partial for a single object. * extracted _render_partial_path so it can be used to render the spacer without going through the public render :partial
2009-08-07 08:40:01 +00:00
def _render_single_template(template, locals = {}, &block)
Bring abstract_controller up to date with rails/master Resolved all the conflicts since 2.3.0 -> HEAD. Following is a list of commits that could not be applied cleanly or are obviated with the abstract_controller refactor. They all need to be revisited to ensure that fixes made in 2.3 do not reappear in 3.0: 2259ecf368e6a6715966f69216e3ee86bf1a82a7 AR not available * This will be reimplemented with ActionORM or equivalent 06182ea02e92afad579998aa80144588e8865ac3 implicitly rendering a js response should not use the default layout [#1844 state:resolved] * This will be handled generically 893e9eb99504705419ad6edac14d00e71cef5f12 Improve view rendering performance in development mode and reinstate template recompiling in production [#1909 state:resolved] * We will need to reimplement rails-dev-boost on top of the refactor; the changes here are very implementation specific and cannot be cleanly applied. The following commits are implicated: 199e750d46c04970b5e7684998d09405648ecbd4 3942cb406e1d5db0ac00e03153809cc8dc4cc4db f8ea9f85d4f1e3e6f3b5d895bef6b013aa4b0690 e3b166aab37ddc2fbab030b146eb61713b91bf55 ae9f258e03c9fd5088da12c1c6cd216cc89a01f7 44423126c6f6133a1d9cf1d0832b527e8711d40f 0cb020b4d6d838025859bd60fb8151c8e21b8e84 workaround for picking layouts based on wrong view_paths [#1974 state:resolved] * The specifics of this commit no longer apply. Since it is a two-line commit, we will reimplement this change. 8c5cc66a831aadb159f3daaffa4208064c30af0e make action_controller/layouts pick templates from the current instance's view_paths instead of the class view_paths [#1974 state:resolved] * This does not apply at all. It should be trivial to apply the feature to the reimplemented ActionController::Base. 87e8b162463f13bd50d27398f020769460a770e3 fix HTML fallback for explicit templates [#2052 state:resolved] * There were a number of patches related to this that simply compounded each other. Basically none of them apply cleanly, and the underlying issue needs to be revisited. After discussing the underlying problem with Koz, we will defer these fixes for further discussion.
2009-04-13 22:18:45 +00:00
with_template(template) do
Replace _render_template_with_layout with _render_template since the layout is optional
2009-08-07 06:18:45 +00:00
template.render(self, locals) do |*names|
Modify various partial methods to carry along the block that can be passed in with render * _render_single_template, which renders a template without layout * _render_partial_unknown_type, which renders a partial of unknown type (the entry method for most partial rendering; supports strings, objects, and collections) * _render_partial_object, which renders a partial for a single object. * extracted _render_partial_path so it can be used to render the spacer without going through the public render :partial
2009-08-07 08:40:01 +00:00
_layout_for(names, &block)
Bring abstract_controller up to date with rails/master Resolved all the conflicts since 2.3.0 -> HEAD. Following is a list of commits that could not be applied cleanly or are obviated with the abstract_controller refactor. They all need to be revisited to ensure that fixes made in 2.3 do not reappear in 3.0: 2259ecf368e6a6715966f69216e3ee86bf1a82a7 AR not available * This will be reimplemented with ActionORM or equivalent 06182ea02e92afad579998aa80144588e8865ac3 implicitly rendering a js response should not use the default layout [#1844 state:resolved] * This will be handled generically 893e9eb99504705419ad6edac14d00e71cef5f12 Improve view rendering performance in development mode and reinstate template recompiling in production [#1909 state:resolved] * We will need to reimplement rails-dev-boost on top of the refactor; the changes here are very implementation specific and cannot be cleanly applied. The following commits are implicated: 199e750d46c04970b5e7684998d09405648ecbd4 3942cb406e1d5db0ac00e03153809cc8dc4cc4db f8ea9f85d4f1e3e6f3b5d895bef6b013aa4b0690 e3b166aab37ddc2fbab030b146eb61713b91bf55 ae9f258e03c9fd5088da12c1c6cd216cc89a01f7 44423126c6f6133a1d9cf1d0832b527e8711d40f 0cb020b4d6d838025859bd60fb8151c8e21b8e84 workaround for picking layouts based on wrong view_paths [#1974 state:resolved] * The specifics of this commit no longer apply. Since it is a two-line commit, we will reimplement this change. 8c5cc66a831aadb159f3daaffa4208064c30af0e make action_controller/layouts pick templates from the current instance's view_paths instead of the class view_paths [#1974 state:resolved] * This does not apply at all. It should be trivial to apply the feature to the reimplemented ActionController::Base. 87e8b162463f13bd50d27398f020769460a770e3 fix HTML fallback for explicit templates [#2052 state:resolved] * There were a number of patches related to this that simply compounded each other. Basically none of them apply cleanly, and the underlying issue needs to be revisited. After discussing the underlying problem with Koz, we will defer these fixes for further discussion.
2009-04-13 22:18:45 +00:00
end
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
end
rescue Exception => e
Minor ActionView cleanup
2009-06-18 19:08:50 +00:00
if e.is_a?(TemplateError)
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
e.sub_template_of(template)
raise e
else
raise TemplateError.new(template, assigns, e)
end
end
def _render_inline(inline, layout, options)
Refactor ActionView::Template ActionView::Template is now completely independent from template storage, which allows different back ends such as the database. ActionView::Template's only responsibility is to take in the template source (passed in from ActionView::Path), compile it, and render it.
2009-04-23 22:58:38 +00:00
handler = Template.handler_class_for_extension(options[:type] || "erb")
template = Template.new(options[:inline], "inline #{options[:inline].inspect}", handler, {})
Replace _render_template_with_layout with _render_template since the layout is optional
2009-08-07 06:18:45 +00:00
content = _render_single_template(template, options[:locals] || {})
Some more AV refactoring: * remove no longer used _array_like_objects * _render_content_with_layout renamed to _render_content since layout it optional * remove check for optional layout before _render_content
2009-08-07 05:46:21 +00:00
layout ? _render_content(content, layout, options[:locals]) : content
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
end
def _render_text(text, layout, options)
Some more AV refactoring: * remove no longer used _array_like_objects * _render_content_with_layout renamed to _render_content since layout it optional * remove check for optional layout before _render_content
2009-08-07 05:46:21 +00:00
layout ? _render_content(text, layout, options[:locals]) : text
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
end
Start cleaning up partial path
2009-08-07 04:51:50 +00:00
# This is the API to render a ViewContext's template from a controller.
#
# Internal Options:
# _template:: The Template object to render
# _layout:: The layout, if any, to wrap the Template in
# _partial:: true if the template is a partial
def render_template(options)
Implemented redirects and partial rendering in new base.
2009-05-12 23:21:34 +00:00
@assigns_added = nil
Start cleaning up partial path
2009-08-07 04:51:50 +00:00
template, layout, partial = options.values_at(:_template, :_layout, :_partial)
Replace _render_template_with_layout with _render_template since the layout is optional
2009-08-07 06:18:45 +00:00
_render_template(template, layout, options, partial)
Implemented redirects and partial rendering in new base.
2009-05-12 23:21:34 +00:00
end
Replace _render_template_with_layout with _render_template since the layout is optional
2009-08-07 06:18:45 +00:00
def _render_template(template, layout = nil, options = {}, partial = nil)
logger && logger.info do
msg = "Rendering #{template.identifier}"
msg << " (#{options[:status]})" if options[:status]
msg
end
Drive the final stake through @content_for_*'s heart!
2009-06-18 01:08:45 +00:00
locals = options[:locals] || {}
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
content = if partial
Start cleaning up partial path
2009-08-07 04:51:50 +00:00
_render_partial_object(template, options)
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
else
Replace _render_template_with_layout with _render_template since the layout is optional
2009-08-07 06:18:45 +00:00
_render_single_template(template, locals)
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
end
Whitespace
2009-08-07 09:32:54 +00:00
Some more AV refactoring: * remove no longer used _array_like_objects * _render_content_with_layout renamed to _render_content since layout it optional * remove check for optional layout before _render_content
2009-08-07 05:46:21 +00:00
_render_content(content, layout, locals)
Begin unifying the interface between ActionController and ActionView
2009-01-22 22:18:10 +00:00
end
end
end