2009-05-13 08:10:37 +00:00
require 'active_support/core_ext/module/attr_internal'
require 'active_support/core_ext/module/delegation'
2010-02-01 02:32:28 +00:00
require 'active_support/core_ext/class/attribute'
2010-03-18 05:27:48 +00:00
require 'active_support/core_ext/array/wrap'
2010-06-12 20:10:59 +00:00
require 'active_support/ordered_options'
2010-06-24 11:23:43 +00:00
require 'action_view/log_subscriber'
2009-05-13 08:10:37 +00:00
2004-11-24 01:04:44 +00:00
module ActionView #:nodoc:
2010-06-16 18:17:49 +00:00
# = Action View Base
#
2011-03-29 20:19:47 +00:00
# Action View templates can be written in several ways. If the template file has a <tt>.erb</tt> (or <tt>.rhtml</tt>) extension then it uses a mixture of ERb
2008-06-16 02:22:27 +00:00
# (included in Ruby) and HTML. If the template file has a <tt>.builder</tt> (or <tt>.rxml</tt>) extension then Jim Weirich's Builder::XmlMarkup library is used.
#
2011-04-03 03:47:51 +00:00
# == ERB
2008-06-16 02:22:27 +00:00
#
2011-04-03 03:47:51 +00:00
# You trigger ERB by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> tag set is used when you want output. Consider the
2004-11-24 01:04:44 +00:00
# following loop for names:
#
# <b>Names of all the people</b>
2010-12-24 19:41:50 +00:00
# <% @people.each do |person| %>
2004-11-24 01:04:44 +00:00
# Name: <%= person.name %><br/>
# <% end %>
#
2006-07-09 05:17:41 +00:00
# The loop is setup in regular embedding tags <% %> and the name is written using the output embedding tag <%= %>. Note that this
2011-04-03 03:47:51 +00: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-24 01:04:44 +00:00
#
2010-04-05 09:51:26 +00:00
# <%# WRONG %>
2004-11-24 01:04:44 +00:00
# Hi, Mr. <% puts "Frodo" %>
#
2010-04-05 09:51:26 +00:00
# If you absolutely must write from within a function use +concat+.
2006-07-09 05:17:41 +00:00
#
# <%- and -%> suppress leading and trailing whitespace, including the trailing newline, and can be used interchangeably with <% and %>.
2004-11-24 01:04:44 +00:00
#
2010-06-16 18:17:49 +00:00
# === Using sub templates
2004-11-24 01:04:44 +00: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-12 03:43:28 +00:00
# variables defined using the regular embedding tags. Like this:
2004-11-24 01:04:44 +00:00
#
# <% @page_title = "A Wonderful Hello" %>
# <%= render "shared/header" %>
#
2008-05-09 09:38:02 +00:00
# Now the header can pick up on the <tt>@page_title</tt> variable and use it for outputting a title tag:
2004-11-24 01:04:44 +00:00
#
# <title><%= @page_title %></title>
#
2010-06-16 18:17:49 +00:00
# === Passing local variables to sub templates
2008-06-16 02:22:27 +00:00
#
2004-11-24 01:04:44 +00:00
# You can pass local variables to sub templates by using a hash with the variable names as keys and the objects as values:
#
2006-10-08 07:46:23 +00:00
# <%= render "shared/header", { :headline => "Welcome", :person => person } %>
2004-11-24 01:04:44 +00:00
#
2008-05-09 09:38:02 +00:00
# These can now be accessed in <tt>shared/header</tt> with:
2004-11-24 01:04:44 +00:00
#
# Headline: <%= headline %>
# First name: <%= person.first_name %>
#
2006-10-08 07:46:23 +00:00
# If you need to find out whether a certain local variable has been assigned a value in a particular render call,
# you need to use the following pattern:
#
# <% if local_assigns.has_key? :headline %>
# Headline: <%= headline %>
# <% end %>
#
# Testing using <tt>defined? headline</tt> will not work. This is an implementation restriction.
#
2010-06-16 18:17:49 +00:00
# === Template caching
2004-11-24 01:04:44 +00:00
#
2010-11-28 03:16:51 +00: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-24 01:04:44 +00:00
#
# == Builder
#
2011-04-03 03:47:51 +00:00
# Builder templates are a more programmatic alternative to ERB. They are especially useful for generating XML content. An XmlMarkup object
2008-06-16 02:22:27 +00:00
# named +xml+ is automatically made available to templates with a <tt>.builder</tt> extension.
2004-11-24 01:04:44 +00:00
#
# Here are some basic examples:
#
2011-05-10 23:55:31 +00: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-16 02:22:27 +00:00
#
2004-11-24 01:04:44 +00:00
# Any method with a block will be treated as an XML markup tag with nested markup in the block. For example, the following:
#
# xml.div {
# xml.h1(@person.name)
# xml.p(@person.bio)
# }
#
# would produce something like:
#
# <div>
# <h1>David Heinemeier Hansson</h1>
# <p>A product of Danish Design during the Winter of '79...</p>
# </div>
#
# A full-length RSS example actually used on Basecamp:
#
# 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-16 02:22:27 +00:00
#
2004-11-24 01:04:44 +00:00
# for item in @recent_items
# 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-16 02:22:27 +00:00
#
2004-11-24 01:04:44 +00:00
# xml.tag!("dc:creator", item.author_name) if item_has_creator?(item)
# end
# end
# end
# end
#
# More builder documentation can be found at http://builder.rubyforge.org.
class Base
2011-05-01 17:39:57 +00:00
include Helpers , :: ERB :: Util , Context
2005-07-21 07:14:35 +00:00
2010-05-31 18:48:47 +00:00
# Specify the proc used to decorate input tags that refer to attributes with errors.
cattr_accessor :field_error_proc
@@field_error_proc = Proc . new { | html_tag , instance | " <div class= \" field_with_errors \" > #{ html_tag } </div> " . html_safe }
2011-04-19 10:25:01 +00: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
@@streaming_completion_on_exception = %( "><script type="text/javascript">window.location = "/500.html"</script></html> )
2010-03-08 15:32:40 +00:00
class_attribute :helpers
2010-07-01 22:29:20 +00:00
class_attribute :_routes
2010-04-03 09:30:06 +00:00
2010-03-08 15:32:40 +00:00
class << self
delegate :erb_trim_mode = , :to = > 'ActionView::Template::Handlers::ERB'
delegate :logger , :to = > 'ActionController::Base' , :allow_nil = > true
2010-12-16 20:37:48 +00:00
def cache_template_loading
ActionView :: Resolver . caching?
end
def cache_template_loading = ( value )
ActionView :: Resolver . caching = value
end
2011-05-04 10:04:29 +00:00
def process_view_paths ( value )
value . is_a? ( PathSet ) ?
value . dup : ActionView :: PathSet . new ( Array . wrap ( value ) )
end
def xss_safe? #:nodoc:
true
end
# This method receives routes and helpers from the controller
# and return a subclass ready to be used as view context.
def prepare ( routes , helpers ) #:nodoc:
Class . new ( self ) do
if routes
include routes . url_helpers
include routes . mounted_helpers
end
if helpers
include helpers
self . helpers = helpers
end
end
end
2009-10-15 04:16:51 +00:00
end
2011-05-01 10:16:31 +00:00
attr_accessor :view_renderer
2011-05-04 10:04:29 +00:00
attr_internal :config , :assigns
2008-04-21 10:39:46 +00:00
2011-05-01 10:37:57 +00:00
delegate :lookup_context , :to = > :view_renderer
2010-10-10 09:03:18 +00:00
delegate :formats , :formats = , :locale , :locale = , :view_paths , :view_paths = , :to = > :lookup_context
2009-01-22 22:18:10 +00:00
2010-06-23 12:59:56 +00:00
def assign ( new_assigns ) # :nodoc:
2010-10-10 12:47:11 +00:00
@_assigns = new_assigns . each { | key , value | instance_variable_set ( " @ #{ key } " , value ) }
2010-06-23 12:59:56 +00:00
end
2011-05-04 10:04:29 +00:00
def initialize ( context = nil , assigns = { } , controller = nil , formats = nil ) #:nodoc:
2011-07-09 00:44:31 +00:00
@_config = ActiveSupport :: InheritableOptions . new
2010-10-10 12:47:11 +00:00
2011-05-01 10:37:57 +00:00
# Handle all these for backwards compatibility.
# TODO Provide a new API for AV::Base and deprecate this one.
if context . is_a? ( ActionView :: Renderer )
@view_renderer = context
elsif
lookup_context = context . is_a? ( ActionView :: LookupContext ) ?
context : ActionView :: LookupContext . new ( context )
2011-05-03 22:12:11 +00:00
lookup_context . formats = formats if formats
lookup_context . prefixes = controller . _prefixes if controller
@view_renderer = ActionView :: Renderer . new ( lookup_context )
2011-05-01 10:37:57 +00:00
end
2011-05-01 17:39:57 +00:00
2011-05-04 10:04:29 +00:00
assign ( assigns )
assign_controller ( controller )
2011-05-01 17:39:57 +00:00
_prepare_context
2004-11-24 01:04:44 +00:00
end
2010-04-27 22:23:44 +00:00
ActiveSupport . run_load_hooks ( :action_view , self )
2004-11-24 01:04:44 +00:00
end
end