2004-11-23 20:04:44 -05:00
module ActionView #:nodoc:
class ActionViewError < StandardError #:nodoc:
end
2007-02-20 17:09:12 -05:00
# Action View templates can be written in three ways. If the template file has a +.erb+ (or +.rhtml+) extension then it uses a mixture of ERb
# (included in Ruby) and HTML. If the template file has a +.builder+ (or +.rxml+) extension then Jim Weirich's Builder::XmlMarkup library is used.
2005-11-17 16:28:59 -05:00
# If the template file has a +.rjs+ extension then it will use ActionView::Helpers::PrototypeHelper::JavaScriptGenerator.
2004-11-23 20:04:44 -05:00
#
# = ERb
#
2006-07-09 01:17:41 -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" %>
#
2006-07-09 01:17:41 -04:00
# If you absolutely must write from within a function, you can use the TextHelper#concat
#
# <%- 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" %>
#
# Now the header can pick up on the @page_title variable and use it for outputting a title tag:
#
# <title><%= @page_title %></title>
#
# == Passing local variables to sub templates
#
# 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
#
# These can now be accessed in shared/header with:
#
# 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
#
2005-02-07 09:15:53 -05:00
# Builder templates are a more programmatic alternative to ERb. They are especially useful for generating XML content. An +XmlMarkup+ object
2007-02-20 17:09:12 -05:00
# named +xml+ is automatically made available to templates with a +.builder+ extension.
2004-11-23 20:04:44 -05:00
#
# Here are some basic examples:
#
# xml.em("emphasized") # => <em>emphasized</em>
2007-05-06 00:46:11 -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.
#
# 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"
#
# 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))
#
# 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
#
# JavaScriptGenerator templates end in +.rjs+. 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
# and make updates to the page where the request originated from.
#
# 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.
#
# When an .rjs action is called with +link_to_remote+, the generated JavaScript is automatically evaluated. Example:
#
# link_to_remote :url => {:action => 'delete'}
#
# The subsequently rendered +delete.rjs+ might look like:
#
# page.replace_html 'sidebar', :partial => 'sidebar'
# page.remove "person-#{@person.id}"
# page.visual_effect :highlight, 'user-list'
#
# This refreshes the sidebar, removes a person element and highlights the user list.
#
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
include ERB :: Util
2005-07-23 02:14:10 -04:00
2008-02-05 23:26:40 -05:00
attr_reader :finder
attr_accessor :base_path , :assigns , :template_extension , :first_render
2008-01-21 15:45:04 -05:00
attr_accessor :controller
2005-07-23 02:14:10 -04:00
2007-06-15 19:52:37 -04:00
attr_reader :logger , :response , :headers
2007-03-12 23:49:52 -04:00
attr_internal :cookies , :flash , :headers , :params , :request , :response , :session
2007-04-12 16:25:32 -04:00
attr_writer :template_format
2008-02-02 20:11:42 -05:00
attr_accessor :current_render_extension
2004-11-23 20:04:44 -05:00
2005-07-21 03:14:35 -04:00
# Specify trim mode for the ERB compiler. Defaults to '-'.
2007-03-27 10:04:06 -04:00
# See ERb documentation for suitable values.
2005-07-21 03:14:35 -04:00
@@erb_trim_mode = '-'
cattr_accessor :erb_trim_mode
2005-09-27 12:45:39 -04:00
# Specify whether file modification times should be checked to see if a template needs recompilation
@@cache_template_loading = false
2005-08-29 11:12:48 -04:00
cattr_accessor :cache_template_loading
2007-05-15 02:36:34 -04:00
# Specify whether file extension lookup should be cached, and whether template base path lookup should be cached.
2006-04-06 14:08:31 -04:00
# Should be +false+ for development environments. Defaults to +true+.
@@cache_template_extensions = true
cattr_accessor :cache_template_extensions
2006-03-12 21:11:59 -05:00
# Specify whether RJS responses should be wrapped in a try/catch block
# that alert()s the caught exception (and then re-raises it).
@@debug_rjs = false
cattr_accessor :debug_rjs
2006-11-17 08:10:23 -05:00
@@erb_variable = '_erbout'
cattr_accessor :erb_variable
2007-09-22 20:11:08 -04:00
2007-09-22 22:32:55 -04:00
delegate :request_forgery_protection_token , :to = > :controller
2005-09-27 12:45:39 -04:00
2005-10-16 11:42:03 -04:00
module CompiledTemplates #:nodoc:
2005-09-27 12:45:39 -04:00
# holds compiled template code
end
include CompiledTemplates
2004-11-23 20:04:44 -05:00
2008-01-21 20:46:34 -05:00
# Maps inline templates to their method names
cattr_accessor :method_names
2005-09-27 12:45:39 -04:00
@@method_names = { }
2007-03-27 10:04:06 -04:00
# Map method names to the names passed in local assigns so far
2005-09-27 12:45:39 -04:00
@@template_args = { }
2007-05-15 02:36:34 -04:00
2007-09-24 15:47:45 -04:00
# Cache public asset paths
cattr_reader :computed_public_paths
@@computed_public_paths = { }
2005-09-09 03:27:44 -04:00
class ObjectWrapper < Struct . new ( :value ) #:nodoc:
end
2005-11-13 17:21:19 -05:00
2007-01-28 02:16:55 -05:00
def self . load_helpers #:nodoc:
Dir . entries ( " #{ File . dirname ( __FILE__ ) } /helpers " ) . sort . each do | file |
next unless file =~ / ^([a-z][a-z_]*_helper).rb$ /
require " action_view/helpers/ #{ $1 } "
2005-11-13 17:21:19 -05:00
helper_module_name = $1 . camelize
2007-01-28 02:16:55 -05:00
if Helpers . const_defined? ( helper_module_name )
include Helpers . const_get ( helper_module_name )
end
2004-11-23 20:04:44 -05:00
end
end
2007-02-04 15:47:05 -05:00
def initialize ( view_paths = [ ] , assigns_for_first_render = { } , controller = nil ) #:nodoc:
@assigns = assigns_for_first_render
2005-07-24 12:45:39 -04:00
@assigns_added = nil
2004-11-23 20:04:44 -05:00
@controller = controller
2008-01-21 15:45:04 -05:00
@logger = controller && controller . logger
@finder = TemplateFinder . new ( self , view_paths )
2004-11-23 20:04:44 -05:00
end
# Renders the template present at <tt>template_path</tt>. If <tt>use_full_path</tt> is set to true,
2007-02-04 15:47:05 -05:00
# it's relative to the view_paths array, otherwise it's absolute. The hash in <tt>local_assigns</tt>
2004-11-23 20:04:44 -05:00
# is made available as local variables.
2006-03-27 22:19:27 -05:00
def render_file ( template_path , use_full_path = true , local_assigns = { } ) #:nodoc:
2007-12-05 13:16:04 -05:00
if defined? ( ActionMailer ) && defined? ( ActionMailer :: Base ) && controller . is_a? ( ActionMailer :: Base ) && ! template_path . include? ( " / " )
2007-11-25 22:35:52 -05:00
raise ActionViewError , <<-END_ERROR
Due to changes in ActionMailer , you need to provide the mailer_name along with the template name .
render " user_mailer/signup "
render :file = > " user_mailer/signup "
If you are rendering a subtemplate , you must now use controller - like partial syntax :
render :partial = > 'signup' # no mailer_name necessary
END_ERROR
end
2008-02-05 23:26:40 -05:00
template = Template . new ( self , template_path , use_full_path , local_assigns )
2007-05-24 12:42:10 -04:00
2004-11-23 20:04:44 -05:00
begin
2008-02-05 23:26:40 -05:00
render_template ( template )
2004-11-23 20:04:44 -05:00
rescue Exception = > e
if TemplateError === e
2008-02-05 23:26:40 -05:00
e . sub_template_of ( template . filename )
2004-11-23 20:04:44 -05:00
raise e
else
2008-02-05 23:26:40 -05:00
raise TemplateError . new ( template , @assigns , e )
2004-11-23 20:04:44 -05:00
end
end
end
2007-02-04 15:47:05 -05:00
# Renders the template present at <tt>template_path</tt> (relative to the view_paths array).
2004-11-23 20:04:44 -05:00
# The hash in <tt>local_assigns</tt> is made available as local variables.
2008-03-02 23:01:35 -05:00
def render ( options = { } , local_assigns = { } , & block ) #:nodoc:
2005-06-02 16:12:34 -04:00
if options . is_a? ( String )
2008-03-02 23:01:35 -05:00
render_file ( options , true , local_assigns )
2006-01-23 11:36:40 -05:00
elsif options == :update
update_page ( & block )
2005-06-02 16:12:34 -04:00
elsif options . is_a? ( Hash )
2007-12-10 18:14:47 -05:00
options = options . reverse_merge ( :locals = > { } , :use_full_path = > true )
2005-07-23 02:14:10 -04:00
2008-03-02 23:01:35 -05:00
if partial_layout = options . delete ( :layout )
2007-08-02 16:10:03 -04:00
if block_given?
2008-01-03 10:28:36 -05:00
wrap_content_for_layout capture ( & block ) do
2008-03-02 23:01:35 -05:00
concat ( render ( options . merge ( :partial = > partial_layout ) ) , block . binding )
2008-01-03 10:28:36 -05:00
end
2007-08-02 16:10:03 -04:00
else
2008-01-03 10:28:36 -05:00
wrap_content_for_layout render ( options ) do
2008-03-02 23:01:35 -05:00
render ( options . merge ( :partial = > partial_layout ) )
2008-01-03 10:28:36 -05:00
end
2007-08-02 16:10:03 -04:00
end
elsif options [ :file ]
2005-06-02 16:12:34 -04:00
render_file ( options [ :file ] , options [ :use_full_path ] , options [ :locals ] )
elsif options [ :partial ] && options [ :collection ]
render_partial_collection ( options [ :partial ] , options [ :collection ] , options [ :spacer_template ] , options [ :locals ] )
2005-07-01 14:21:29 -04:00
elsif options [ :partial ]
2005-09-09 03:27:44 -04:00
render_partial ( options [ :partial ] , ActionView :: Base :: ObjectWrapper . new ( options [ :object ] ) , options [ :locals ] )
2005-07-01 14:21:29 -04:00
elsif options [ :inline ]
2008-02-05 23:26:40 -05:00
template = Template . new ( self , options [ :inline ] , false , options [ :locals ] , true , options [ :type ] )
render_template ( template )
2005-06-02 16:12:34 -04:00
end
end
2004-11-23 20:04:44 -05:00
end
2005-07-23 02:14:10 -04:00
2008-02-05 23:26:40 -05:00
def render_template ( template ) #:nodoc:
2008-03-02 23:01:35 -05:00
template . render
2005-08-26 18:37:36 -04:00
end
2004-11-23 20:04:44 -05:00
# Returns true is the file may be rendered implicitly.
def file_public? ( template_path ) #:nodoc:
2005-07-21 03:14:35 -04:00
template_path . split ( '/' ) . last [ 0 , 1 ] != '_'
2004-11-23 20:04:44 -05:00
end
2007-04-12 16:25:32 -04:00
# symbolized version of the :format parameter of the request, or :html by default.
2008-02-29 13:09:23 -05:00
#
# EXCEPTION: If the :format parameter is not set, the Accept header will be examined for
# whether it contains the JavaScript mime type as its first priority. If that's the case,
# it will be used. This ensures that Ajax applications can use the same URL to support both
# JavaScript and non-JavaScript users.
2007-04-01 20:02:11 -04:00
def template_format
2007-05-15 02:36:34 -04:00
return @template_format if @template_format
2008-02-29 13:09:23 -05:00
if controller && controller . respond_to? ( :request )
parameter_format = controller . request . parameters [ :format ]
accept_format = controller . request . accepts . first
case
when parameter_format . blank? && accept_format != :js
@template_format = :html
when parameter_format . blank? && accept_format == :js
@template_format = :js
else
@template_format = parameter_format . to_sym
end
else
@template_format = :html
end
2007-04-12 16:25:32 -04:00
end
2008-03-02 23:01:35 -05:00
private
2008-01-03 10:28:36 -05:00
def wrap_content_for_layout ( content )
original_content_for_layout = @content_for_layout
@content_for_layout = content
returning ( yield ) { @content_for_layout = original_content_for_layout }
end
2006-03-15 21:51:19 -05:00
2007-03-27 10:04:06 -04:00
# Evaluate the local assigns and pushes them to the view.
2005-08-26 18:37:36 -04:00
def evaluate_assigns
2005-07-24 12:45:39 -04:00
unless @assigns_added
2005-07-27 10:17:47 -04:00
assign_variables_from_controller
2005-07-24 12:45:39 -04:00
@assigns_added = true
end
2005-07-21 03:14:35 -04:00
end
2007-03-27 10:04:06 -04:00
# Assigns instance variables from the controller to the view.
2005-07-27 09:55:56 -04:00
def assign_variables_from_controller
@assigns . each { | key , value | instance_variable_set ( " @ #{ key } " , value ) }
end
2008-03-02 23:01:35 -05:00
def execute ( template )
send ( template . method , template . locals ) do | * names |
instance_variable_get " @content_for_ #{ names . first || 'layout' } "
end
2007-12-10 18:14:47 -05:00
end
2004-11-23 20:04:44 -05:00
end
end