2009-05-13 04:10:37 -04:00
require 'active_support/core_ext/module/attr_internal'
require 'active_support/core_ext/module/delegation'
2004-11-23 20:04:44 -05:00
module ActionView #:nodoc:
class ActionViewError < StandardError #:nodoc:
end
2008-06-15 22:22:27 -04:00
2008-04-19 13:52:14 -04:00
class MissingTemplate < ActionViewError #:nodoc:
2009-04-08 20:32:19 -04:00
attr_reader :path , :action_name
2008-12-21 18:23:53 -05:00
2008-07-12 15:33:46 -04:00
def initialize ( paths , path , template_format = nil )
2008-12-21 18:23:53 -05:00
@path = path
2009-04-08 20:32:19 -04:00
@action_name = path . split ( " / " ) . last . split ( " . " ) [ 0 ... - 1 ] . join ( " . " )
2008-07-12 15:33:46 -04:00
full_template_path = path . include? ( '.' ) ? path : " #{ path } .erb "
2008-12-05 12:24:28 -05:00
display_paths = paths . compact . join ( " : " )
2008-07-12 15:33:46 -04:00
template_type = ( path =~ / layouts /i ) ? 'layout' : 'template'
super ( " Missing #{ template_type } #{ full_template_path } in view path #{ display_paths } " )
end
2008-04-19 13:52:14 -04:00
end
2004-11-23 20:04:44 -05:00
2008-06-15 22:22:27 -04:00
# Action View templates can be written in three ways. If the template file has a <tt>.erb</tt> (or <tt>.rhtml</tt>) extension then it uses a mixture of ERb
# (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.
2008-05-09 05:38:02 -04:00
# If the template file has a <tt>.rjs</tt> extension then it will use ActionView::Helpers::PrototypeHelper::JavaScriptGenerator.
2008-06-15 22:22:27 -04:00
#
2004-11-23 20:04:44 -05:00
# = ERb
2008-06-15 22:22:27 -04:00
#
# You trigger ERb by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> 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>
# <% for person in @people %>
# Name: <%= person.name %><br/>
# <% end %>
#
2006-07-09 01:17:41 -04:00
# The loop is setup in regular embedding tags <% %> and the name is written using the output embedding tag <%= %>. Note that this
2004-11-23 20:04:44 -05: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:
#
# Hi, Mr. <% puts "Frodo" %>
#
2008-05-09 05:38:02 -04:00
# If you absolutely must write from within a function, you can use the TextHelper#concat.
2006-07-09 01:17:41 -04:00
#
# <%- and -%> suppress leading and trailing whitespace, including the trailing newline, and can be used interchangeably with <% and %>.
2004-11-23 20:04:44 -05:00
#
# == Using sub templates
#
# 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>
#
# == 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:
#
2006-10-08 03:46:23 -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 %>
#
2006-10-08 03:46:23 -04: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.
#
2004-11-23 20:04:44 -05:00
# == Template caching
#
2005-08-26 18:37:36 -04: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.
2004-11-23 20:04:44 -05:00
#
# == Builder
#
2008-06-15 22:22:27 -04:00
# Builder templates are a more programmatic alternative to ERb. They are especially useful for generating XML content. An XmlMarkup object
# 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:
#
# xml.em("emphasized") # => <em>emphasized</em>
2008-05-09 05:38:02 -04:00
# xml.em { xml.b("emph & bold") } # => <em><b>emph & bold</b></em>
2004-11-23 20:04:44 -05:00
# xml.a("A Link", "href"=>"http://onestepback.org") # => <a href="http://onestepback.org">A Link</a>
2005-11-17 16:28:59 -05:00
# xml.target("name"=>"compile", "option"=>"fast") # => <target option="fast" name="compile"\>
2004-11-23 20:04:44 -05:00
# # 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:
#
# 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-15 22:22:27 -04:00
#
2004-11-23 20:04:44 -05: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-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
#
# More builder documentation can be found at http://builder.rubyforge.org.
2005-11-17 16:28:59 -05:00
#
# == JavaScriptGenerator
#
2008-06-15 22:22:27 -04:00
# JavaScriptGenerator templates end in <tt>.rjs</tt>. Unlike conventional templates which are used to
# render the results of an action, these templates generate instructions on how to modify an already rendered page. This makes it easy to
# modify multiple elements on your page in one declarative Ajax response. Actions with these templates are called in the background with Ajax
2005-11-17 16:28:59 -05:00
# and make updates to the page where the request originated from.
2008-06-15 22:22:27 -04:00
#
# An instance of the JavaScriptGenerator object named +page+ is automatically made available to your template, which is implicitly wrapped in an ActionView::Helpers::PrototypeHelper#update_page block.
2005-11-17 16:28:59 -05:00
#
2008-05-09 05:38:02 -04:00
# When an <tt>.rjs</tt> action is called with +link_to_remote+, the generated JavaScript is automatically evaluated. Example:
2005-11-17 16:28:59 -05:00
#
# link_to_remote :url => {:action => 'delete'}
#
2008-05-09 05:38:02 -04:00
# The subsequently rendered <tt>delete.rjs</tt> might look like:
2005-11-17 16:28:59 -05:00
#
# page.replace_html 'sidebar', :partial => 'sidebar'
# page.remove "person-#{@person.id}"
2008-06-15 22:22:27 -04:00
# page.visual_effect :highlight, 'user-list'
2005-11-17 16:28:59 -05:00
#
# This refreshes the sidebar, removes a person element and highlights the user list.
2008-06-15 22:22:27 -04:00
#
2007-03-27 10:04:06 -04:00
# See the ActionView::Helpers::PrototypeHelper::GeneratorMethods documentation for more details.
2004-11-23 20:04:44 -05:00
class Base
2009-08-09 02:28:46 -04:00
module Subclasses
end
2009-10-15 17:41:59 -04:00
include Helpers , Rendering , Partials , :: ERB :: Util
def config
self . config = DEFAULT_CONFIG unless @config
@config
end
def config = ( config )
@config = ActiveSupport :: OrderedOptions . new . merge ( config )
end
2009-01-22 17:18:10 -05:00
2008-08-25 22:44:21 -04:00
extend ActiveSupport :: Memoizable
2005-07-23 02:14:10 -04:00
2009-01-22 17:18:10 -05:00
attr_accessor :base_path , :assigns , :template_extension , :formats
2008-01-21 15:45:04 -05:00
attr_accessor :controller
2009-06-17 21:08:45 -04:00
attr_internal :captures
2008-06-02 16:32:58 -04:00
2009-08-15 01:32:40 -04:00
def reset_formats ( formats )
@formats = formats
2009-10-28 08:33:05 -04:00
if defined? ( AbstractController :: HashKey )
2009-08-15 01:32:40 -04:00
# This is expensive, but we need to reset this when the format is updated,
# which currently only happens
Thread . current [ :format_locale_key ] =
2009-10-28 08:33:05 -04:00
AbstractController :: HashKey . get ( self . class , formats , I18n . locale )
2009-08-15 01:32:40 -04:00
end
end
2008-06-19 20:18:07 -04:00
class << self
2009-12-02 23:01:01 -05:00
delegate :erb_trim_mode = , :to = > 'ActionView::Template::Handlers::ERB'
2009-06-17 21:08:45 -04:00
delegate :logger , :to = > 'ActionController::Base' , :allow_nil = > true
2008-06-19 20:18:07 -04:00
end
2005-07-21 03:14:35 -04:00
2008-12-06 21:27:53 -05:00
@@debug_rjs = false
##
# :singleton-method:
2006-03-12 21:11:59 -05:00
# Specify whether RJS responses should be wrapped in a try/catch block
2008-06-15 22:22:27 -04:00
# that alert()s the caught exception (and then re-raises it).
2006-03-12 21:11:59 -05:00
cattr_accessor :debug_rjs
2008-06-02 12:12:00 -04:00
2009-02-12 13:35:14 -05:00
# Specify whether templates should be cached. Otherwise the file we be read everytime it is accessed.
2009-02-28 12:42:15 -05:00
# Automatically reloading templates are not thread safe and should only be used in development mode.
@@cache_template_loading = nil
2009-02-09 15:20:30 -05:00
cattr_accessor :cache_template_loading
2009-10-15 00:16:51 -04:00
# :nodoc:
def self . xss_safe?
true
end
2009-02-12 13:35:14 -05:00
def self . cache_template_loading?
2009-02-28 14:03:41 -05:00
ActionController :: Base . allow_concurrency || ( cache_template_loading . nil? ? ! ActiveSupport :: Dependencies . load? : cache_template_loading )
2009-02-12 13:35:14 -05:00
end
2009-04-29 00:29:29 -04:00
attr_internal :request , :layout
2008-04-21 06:39:46 -04:00
2009-08-09 02:06:08 -04:00
def controller_path
@controller_path || = controller && controller . controller_path
end
2009-01-22 17:18:10 -05:00
2008-04-21 06:39:46 -04:00
delegate :request_forgery_protection_token , :template , :params , :session , :cookies , :response , :headers ,
2009-04-23 18:58:38 -04:00
:flash , :action_name , :controller_name , :to = > :controller
delegate :logger , :to = > :controller , :allow_nil = > true
2008-06-15 22:22:27 -04:00
2009-08-07 14:00:12 -04:00
delegate :find , :to = > :view_paths
2009-01-22 17:18:10 -05:00
2009-07-19 09:12:15 -04:00
include Context
2004-11-23 20:04:44 -05:00
2008-07-12 16:31:50 -04:00
def self . process_view_paths ( value )
ActionView :: PathSet . new ( Array ( value ) )
end
2009-08-09 02:28:46 -04:00
extlib_inheritable_accessor :helpers
2008-08-26 17:17:58 -04:00
attr_reader :helpers
2009-07-19 08:53:02 -04:00
def self . for_controller ( controller )
2009-08-09 02:28:46 -04:00
@views || = { }
# TODO: Decouple this so helpers are a separate concern in AV just like
# they are in AC.
if controller . class . respond_to? ( :_helper_serial )
klass = @views [ controller . class . _helper_serial ] || = Class . new ( self ) do
2009-10-09 06:53:48 -04:00
# Try to make stack traces clearer
2009-10-15 16:35:22 -04:00
class_eval <<-ruby_eval, __FILE__, __LINE__ + 1
def self . name
" ActionView for #{ controller . class } "
end
2009-10-09 06:53:48 -04:00
2009-10-15 16:35:22 -04:00
def inspect
" # < #{ self . class . name } > "
end
ruby_eval
2009-08-09 02:28:46 -04:00
if controller . respond_to? ( :_helpers )
include controller . _helpers
self . helpers = controller . _helpers
end
end
else
klass = self
2009-07-19 08:53:02 -04:00
end
2009-08-09 02:28:46 -04:00
klass . new ( controller . class . view_paths , { } , controller )
2009-07-19 08:53:02 -04:00
end
2009-01-22 17:18:10 -05:00
def initialize ( view_paths = [ ] , assigns_for_first_render = { } , controller = nil , formats = nil ) #:nodoc:
2009-08-15 01:32:40 -04:00
@formats = formats
2009-06-18 15:08:50 -04:00
@assigns = assigns_for_first_render . each { | key , value | instance_variable_set ( " @ #{ key } " , value ) }
2004-11-23 20:04:44 -05:00
@controller = controller
2009-08-09 02:28:46 -04:00
@helpers = self . class . helpers || Module . new
2009-10-07 16:31:20 -04:00
@_content_for = Hash . new { | h , k | h [ k ] = ActionView :: SafeBuffer . new }
2008-06-15 22:22:27 -04:00
self . view_paths = view_paths
2004-11-23 20:04:44 -05:00
end
2009-06-17 19:23:11 -04:00
attr_internal :template
2008-06-15 22:22:27 -04:00
attr_reader :view_paths
def view_paths = ( paths )
2008-07-12 16:31:50 -04:00
@view_paths = self . class . process_view_paths ( paths )
2008-06-15 22:22:27 -04:00
end
2009-03-13 05:36:00 -04:00
def punctuate_body! ( part )
flush_output_buffer
response . body_parts << part
nil
2008-10-28 12:06:08 -04:00
end
2008-08-31 11:45:59 -04:00
2009-05-21 19:35:40 -04:00
# Evaluates the local assigns and controller ivars, pushes them to the view.
def _evaluate_assigns_and_ivars #:nodoc:
2009-06-17 19:23:11 -04:00
if @controller
variables = @controller . instance_variable_names
variables -= @controller . protected_instance_variables if @controller . respond_to? ( :protected_instance_variables )
variables . each { | name | instance_variable_set ( name , @controller . instance_variable_get ( name ) ) }
2008-10-05 08:55:28 -04:00
end
2009-06-17 19:23:11 -04:00
end
2008-10-05 08:55:28 -04:00
2004-11-23 20:04:44 -05:00
end
end