2016-08-06 12:48:35 -04:00
require " active_support/core_ext/module/attr_internal "
require " active_support/core_ext/module/attribute_accessors "
require " active_support/ordered_options "
require " action_view/log_subscriber "
require " action_view/helpers "
require " action_view/context "
require " action_view/template "
require " action_view/lookup_context "
2009-05-13 04:10:37 -04:00
2004-11-23 20:04:44 -05:00
module ActionView #:nodoc:
2010-06-16 14:17:49 -04:00
# = Action View Base
#
2014-09-02 13:09:42 -04:00
# Action View templates can be written in several ways.
2017-01-20 18:02:34 -05:00
# If the template file has a <tt>.erb</tt> extension, then it uses the erubi[https://rubygems.org/gems/erubi]
2014-09-02 13:09:42 -04:00
# template system which can embed Ruby into an HTML document.
# If the template file has a <tt>.builder</tt> extension, then Jim Weirich's Builder::XmlMarkup library is used.
2008-06-15 22:22:27 -04:00
#
2011-04-02 23:47:51 -04:00
# == ERB
2008-06-15 22:22:27 -04:00
#
2016-06-29 11:57:30 -04:00
# You trigger ERB by using embeddings such as <tt><% %></tt>, <tt><% -%></tt>, and <tt><%= %></tt>. The <tt><%= %></tt> tag set is used when you want output. Consider the
2004-11-23 20:04:44 -05:00
# following loop for names:
#
# <b>Names of all the people</b>
2010-12-24 14:41:50 -05:00
# <% @people.each do |person| %>
2004-11-23 20:04:44 -05:00
# Name: <%= person.name %><br/>
# <% end %>
#
2016-06-29 11:57:30 -04:00
# The loop is setup in regular embedding tags <tt><% %></tt>, and the name is written using the output embedding tag <tt><%= %></tt>. Note that this
2011-04-02 23:47:51 -04:00
# is not just a usage suggestion. Regular output functions like print or puts won't work with ERB templates. So this would be wrong:
2004-11-23 20:04:44 -05:00
#
2010-04-05 05:51:26 -04:00
# <%# WRONG %>
2004-11-23 20:04:44 -05:00
# Hi, Mr. <% puts "Frodo" %>
#
2010-04-05 05:51:26 -04:00
# If you absolutely must write from within a function use +concat+.
2006-07-09 01:17:41 -04:00
#
2016-06-29 11:57:30 -04:00
# When on a line that only contains whitespaces except for the tag, <tt><% %></tt> suppresses leading and trailing whitespace,
# including the trailing newline. <tt><% %></tt> and <tt><%- -%></tt> are the same.
# Note however that <tt><%= %></tt> and <tt><%= -%></tt> are different: only the latter removes trailing whitespaces.
2004-11-23 20:04:44 -05:00
#
2010-06-16 14:17:49 -04:00
# === Using sub templates
2004-11-23 20:04:44 -05:00
#
# Using sub templates allows you to sidestep tedious replication and extract common display structures in shared templates. The
# classic example is the use of a header and footer (even though the Action Pack-way would be to use Layouts):
#
# <%= render "shared/header" %>
# Something really specific and terrific
# <%= render "shared/footer" %>
#
# As you see, we use the output embeddings for the render methods. The render call itself will just return a string holding the
# result of the rendering. The output embedding writes it to the current template.
#
# But you don't have to restrict yourself to static includes. Templates can share variables amongst themselves by using instance
2005-10-11 23:43:28 -04:00
# variables defined using the regular embedding tags. Like this:
2004-11-23 20:04:44 -05:00
#
# <% @page_title = "A Wonderful Hello" %>
# <%= render "shared/header" %>
#
2008-05-09 05:38:02 -04:00
# Now the header can pick up on the <tt>@page_title</tt> variable and use it for outputting a title tag:
2004-11-23 20:04:44 -05:00
#
# <title><%= @page_title %></title>
#
2010-06-16 14:17:49 -04:00
# === Passing local variables to sub templates
2008-06-15 22:22:27 -04:00
#
2004-11-23 20:04:44 -05:00
# You can pass local variables to sub templates by using a hash with the variable names as keys and the objects as values:
#
2012-10-29 07:10:53 -04:00
# <%= render "shared/header", { headline: "Welcome", person: person } %>
2004-11-23 20:04:44 -05:00
#
2008-05-09 05:38:02 -04:00
# These can now be accessed in <tt>shared/header</tt> with:
2004-11-23 20:04:44 -05:00
#
# Headline: <%= headline %>
# First name: <%= person.first_name %>
#
2015-02-17 07:53:16 -05:00
# The local variables passed to sub templates can be accessed as a hash using the <tt>local_assigns</tt> hash. This lets you access the
# variables as:
#
# Headline: <%= local_assigns[:headline] %>
#
2015-10-06 13:50:27 -04:00
# This is useful in cases where you aren't sure if the local variable has been assigned. Alternatively, you could also use
2015-02-17 07:53:16 -05:00
# <tt>defined? headline</tt> to first check if the variable has been assigned before using it.
#
2010-06-16 14:17:49 -04:00
# === Template caching
2004-11-23 20:04:44 -05:00
#
2010-11-27 22:16:51 -05:00
# By default, Rails will compile each template to a method in order to render it. When you alter a template,
# Rails will check the file's modification time and recompile it in development mode.
2004-11-23 20:04:44 -05:00
#
# == Builder
#
2011-04-02 23:47:51 -04:00
# Builder templates are a more programmatic alternative to ERB. They are especially useful for generating XML content. An XmlMarkup object
2008-06-15 22:22:27 -04:00
# named +xml+ is automatically made available to templates with a <tt>.builder</tt> extension.
2004-11-23 20:04:44 -05:00
#
# Here are some basic examples:
#
2011-05-10 19:55:31 -04:00
# xml.em("emphasized") # => <em>emphasized</em>
# xml.em { xml.b("emph & bold") } # => <em><b>emph & bold</b></em>
# xml.a("A Link", "href" => "http://onestepback.org") # => <a href="http://onestepback.org">A Link</a>
# xml.target("name" => "compile", "option" => "fast") # => <target option="fast" name="compile"\>
# # NOTE: order of attributes is not specified.
2008-06-15 22:22:27 -04:00
#
2004-11-23 20:04:44 -05:00
# Any method with a block will be treated as an XML markup tag with nested markup in the block. For example, the following:
#
2011-12-05 16:11:20 -05:00
# xml.div do
2004-11-23 20:04:44 -05:00
# xml.h1(@person.name)
# xml.p(@person.bio)
2011-12-05 16:11:20 -05:00
# end
2004-11-23 20:04:44 -05:00
#
# would produce something like:
#
# <div>
# <h1>David Heinemeier Hansson</h1>
# <p>A product of Danish Design during the Winter of '79...</p>
# </div>
#
2016-06-29 11:57:30 -04:00
# Here is a full-length RSS example actually used on Basecamp:
2004-11-23 20:04:44 -05:00
#
# xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do
# xml.channel do
# xml.title(@feed_title)
# xml.link(@url)
# xml.description "Basecamp: Recent items"
# xml.language "en-us"
# xml.ttl "40"
2008-06-15 22:22:27 -04:00
#
2011-08-31 20:52:35 -04:00
# @recent_items.each do |item|
2004-11-23 20:04:44 -05:00
# xml.item do
# xml.title(item_title(item))
# xml.description(item_description(item)) if item_description(item)
# xml.pubDate(item_pubDate(item))
# xml.guid(@person.firm.account.url + @recent_items.url(item))
# xml.link(@person.firm.account.url + @recent_items.url(item))
2008-06-15 22:22:27 -04:00
#
2004-11-23 20:04:44 -05:00
# xml.tag!("dc:creator", item.author_name) if item_has_creator?(item)
# end
# end
# end
# end
2014-06-13 13:12:20 -04:00
#
2014-11-29 16:52:21 -05:00
# For more information on Builder please consult the {source
# code}[https://github.com/jimweirich/builder].
2004-11-23 20:04:44 -05:00
class Base
2011-05-01 13:39:57 -04:00
include Helpers , :: ERB :: Util , Context
2005-07-21 03:14:35 -04:00
2010-05-31 14:48:47 -04:00
# Specify the proc used to decorate input tags that refer to attributes with errors.
cattr_accessor :field_error_proc
2016-08-16 03:30:11 -04:00
@@field_error_proc = Proc . new { | html_tag , instance | " <div class= \" field_with_errors \" > #{ html_tag } </div> " . html_safe }
2010-05-31 14:48:47 -04:00
2011-04-19 06:25:01 -04:00
# How to complete the streaming when an exception occurs.
# This is our best guess: first try to close the attribute, then the tag.
cattr_accessor :streaming_completion_on_exception
2012-04-05 07:32:37 -04:00
@@streaming_completion_on_exception = %( "><script>window.location = "/500.html"</script></html> )
2011-04-19 06:25:01 -04:00
2012-03-28 20:05:26 -04:00
# Specify whether rendering within namespaced controllers should prefix
# the partial paths for ActiveModel objects with the namespace.
# (e.g., an Admin::PostsController would render @post using /admin/posts/_post.erb)
cattr_accessor :prefix_partial_path_with_controller_namespace
@@prefix_partial_path_with_controller_namespace = true
2012-06-15 14:36:09 -04:00
# Specify default_formats that can be rendered.
cattr_accessor :default_formats
2014-01-26 17:05:34 -05:00
# Specify whether an error should be raised for missing translations
cattr_accessor :raise_on_missing_translations
@@raise_on_missing_translations = false
2015-08-05 12:38:43 -04:00
# Specify whether submit_tag should automatically disable on click
cattr_accessor :automatically_disable_submit_tag
@@automatically_disable_submit_tag = true
2010-07-01 18:29:20 -04:00
class_attribute :_routes
2012-01-18 12:05:36 -05:00
class_attribute :logger
2010-04-03 05:30:06 -04:00
2010-03-08 10:32:40 -05:00
class << self
2016-08-06 13:36:34 -04:00
delegate :erb_trim_mode = , to : " ActionView::Template::Handlers::ERB "
2010-12-16 15:37:48 -05:00
def cache_template_loading
ActionView :: Resolver . caching?
end
def cache_template_loading = ( value )
ActionView :: Resolver . caching = value
end
2011-05-04 06:04:29 -04:00
def xss_safe? #:nodoc:
true
end
2009-10-15 00:16:51 -04:00
end
2011-05-01 06:16:31 -04:00
attr_accessor :view_renderer
2011-05-04 06:04:29 -04:00
attr_internal :config , :assigns
2008-04-21 06:39:46 -04:00
2016-08-06 13:36:34 -04:00
delegate :lookup_context , to : :view_renderer
delegate :formats , :formats = , :locale , :locale = , :view_paths , :view_paths = , to : :lookup_context
2009-01-22 17:18:10 -05:00
2010-06-23 08:59:56 -04:00
def assign ( new_assigns ) # :nodoc:
2010-10-10 08:47:11 -04:00
@_assigns = new_assigns . each { | key , value | instance_variable_set ( " @ #{ key } " , value ) }
2010-06-23 08:59:56 -04:00
end
2011-05-04 06:04:29 -04:00
def initialize ( context = nil , assigns = { } , controller = nil , formats = nil ) #:nodoc:
2011-07-08 20:44:31 -04:00
@_config = ActiveSupport :: InheritableOptions . new
2010-10-10 08:47:11 -04:00
2011-05-01 06:37:57 -04:00
if context . is_a? ( ActionView :: Renderer )
@view_renderer = context
2012-04-03 13:45:19 -04:00
else
2011-05-01 06:37:57 -04:00
lookup_context = context . is_a? ( ActionView :: LookupContext ) ?
context : ActionView :: LookupContext . new ( context )
2011-05-03 18:12:11 -04:00
lookup_context . formats = formats if formats
lookup_context . prefixes = controller . _prefixes if controller
@view_renderer = ActionView :: Renderer . new ( lookup_context )
2011-05-01 06:37:57 -04:00
end
2011-05-01 13:39:57 -04:00
2011-05-04 06:04:29 -04:00
assign ( assigns )
assign_controller ( controller )
2011-05-01 13:39:57 -04:00
_prepare_context
2004-11-23 20:04:44 -05:00
end
2010-04-27 18:23:44 -04:00
ActiveSupport . run_load_hooks ( :action_view , self )
2004-11-23 20:04:44 -05:00
end
end