2017-07-23 11:36:41 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
2011-05-01 13:39:57 -04:00
|
|
|
module ActionView
|
2017-08-26 20:12:19 -04:00
|
|
|
module Helpers #:nodoc:
|
2011-05-01 13:39:57 -04:00
|
|
|
# = Action View Rendering
|
|
|
|
|
#
|
|
|
|
|
# Implements methods that allow rendering from a view context.
|
|
|
|
|
# In order to use this module, all you need is to implement
|
|
|
|
|
# view_renderer that returns an ActionView::Renderer object.
|
|
|
|
|
module RenderingHelper
|
|
|
|
|
# Returns the result of a render that's dictated by the options hash. The primary options are:
|
|
|
|
|
#
|
2011-10-07 14:23:12 -04:00
|
|
|
# * <tt>:partial</tt> - See <tt>ActionView::PartialRenderer</tt>.
|
2011-05-01 13:39:57 -04:00
|
|
|
# * <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.
|
2014-02-07 13:45:57 -05:00
|
|
|
# * <tt>:plain</tt> - Renders the text passed in out. Setting the content
|
2014-07-16 23:24:52 -04:00
|
|
|
# type as <tt>text/plain</tt>.
|
2014-08-08 17:25:18 -04:00
|
|
|
# * <tt>:html</tt> - Renders the HTML safe string passed in out, otherwise
|
|
|
|
|
# performs HTML escape on the string first. Setting the content type as
|
2014-07-16 23:24:52 -04:00
|
|
|
# <tt>text/html</tt>.
|
2014-02-28 19:39:22 -05:00
|
|
|
# * <tt>:body</tt> - Renders the text passed in, and inherits the content
|
2015-07-17 21:48:00 -04:00
|
|
|
# type of <tt>text/plain</tt> from <tt>ActionDispatch::Response</tt>
|
2014-07-16 23:24:52 -04:00
|
|
|
# object.
|
2011-05-01 13:39:57 -04:00
|
|
|
#
|
2020-03-13 18:52:49 -04:00
|
|
|
# If no <tt>options</tt> hash is passed or if <tt>:update</tt> is specified, then:
|
|
|
|
|
#
|
2021-02-14 12:15:07 -05:00
|
|
|
# If an object responding to +render_in+ is passed, +render_in+ is called on the object,
|
2020-03-13 18:52:49 -04:00
|
|
|
# passing in the current view context.
|
|
|
|
|
#
|
|
|
|
|
# Otherwise, a partial is rendered using the second parameter as the locals hash.
|
2011-05-01 13:39:57 -04:00
|
|
|
def render(options = {}, locals = {}, &block)
|
|
|
|
|
case options
|
|
|
|
|
when Hash
|
2019-02-13 18:35:20 -05:00
|
|
|
in_rendering_context(options) do |renderer|
|
2019-02-11 20:24:24 -05:00
|
|
|
if block_given?
|
|
|
|
|
view_renderer.render_partial(self, options.merge(partial: options[:layout]), &block)
|
|
|
|
|
else
|
|
|
|
|
view_renderer.render(self, options)
|
|
|
|
|
end
|
2011-05-01 13:39:57 -04:00
|
|
|
end
|
|
|
|
|
else
|
2019-05-29 15:03:54 -04:00
|
|
|
if options.respond_to?(:render_in)
|
|
|
|
|
options.render_in(self, &block)
|
|
|
|
|
else
|
|
|
|
|
view_renderer.render_partial(self, partial: options, locals: locals, &block)
|
|
|
|
|
end
|
2011-05-01 13:39:57 -04:00
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Overwrites _layout_for in the context object so it supports the case a block is
|
|
|
|
|
# passed to a partial. Returns the contents that are yielded to a layout, given a
|
|
|
|
|
# name or a block.
|
|
|
|
|
#
|
|
|
|
|
# You can think of a layout as a method that is called with a block. If the user calls
|
|
|
|
|
# <tt>yield :some_name</tt>, the block, by default, returns <tt>content_for(:some_name)</tt>.
|
|
|
|
|
# If the user calls simply +yield+, the default block returns <tt>content_for(:layout)</tt>.
|
|
|
|
|
#
|
|
|
|
|
# The user can override this default by passing a block to the layout:
|
|
|
|
|
#
|
|
|
|
|
# # The template
|
2012-10-29 07:10:53 -04:00
|
|
|
# <%= render layout: "my_layout" do %>
|
2011-05-01 13:39:57 -04:00
|
|
|
# Content
|
|
|
|
|
# <% end %>
|
|
|
|
|
#
|
|
|
|
|
# # The layout
|
|
|
|
|
# <html>
|
|
|
|
|
# <%= yield %>
|
|
|
|
|
# </html>
|
|
|
|
|
#
|
|
|
|
|
# In this case, instead of the default block, which would return <tt>content_for(:layout)</tt>,
|
|
|
|
|
# this method returns the block that was passed in to <tt>render :layout</tt>, and the response
|
|
|
|
|
# would be
|
|
|
|
|
#
|
|
|
|
|
# <html>
|
|
|
|
|
# Content
|
|
|
|
|
# </html>
|
|
|
|
|
#
|
|
|
|
|
# Finally, the block can take block arguments, which can be passed in by +yield+:
|
|
|
|
|
#
|
|
|
|
|
# # The template
|
2012-10-29 07:10:53 -04:00
|
|
|
# <%= render layout: "my_layout" do |customer| %>
|
2011-05-01 13:39:57 -04:00
|
|
|
# Hello <%= customer.name %>
|
|
|
|
|
# <% end %>
|
|
|
|
|
#
|
|
|
|
|
# # 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 would be passed into the block as an argument. The result
|
|
|
|
|
# would be
|
|
|
|
|
#
|
|
|
|
|
# <html>
|
|
|
|
|
# Hello David
|
|
|
|
|
# </html>
|
|
|
|
|
#
|
|
|
|
|
def _layout_for(*args, &block)
|
|
|
|
|
name = args.first
|
|
|
|
|
|
|
|
|
|
if block && !name.is_a?(Symbol)
|
|
|
|
|
capture(*args, &block)
|
|
|
|
|
else
|
|
|
|
|
super
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
2011-10-07 14:23:12 -04:00
|
|
|
end
|
