2004-11-23 20:04:44 -05:00
require 'erb'
2007-10-07 05:15:26 -04:00
require 'builder'
2004-11-23 20:04:44 -05:00
2007-09-18 07:56:04 -04:00
class ERB
module Util
HTML_ESCAPE = { '&' = > '&' , '"' = > '"' , '>' = > '>' , '<' = > '<' }
def html_escape ( s )
s . to_s . gsub ( / [& \ "><] / ) { | special | HTML_ESCAPE [ special ] }
end
end
end
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
2005-04-17 07:38:01 -04:00
attr_reader :first_render
2004-11-23 20:04:44 -05:00
attr_accessor :base_path , :assigns , :template_extension
2007-06-15 19:52:37 -04:00
attr_accessor :controller , :view_paths
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
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
2005-10-17 11:51:07 -04:00
# Specify whether local_assigns should be able to use string keys.
2005-10-17 14:25:03 -04:00
# Defaults to +true+. String keys are deprecated and will be removed
2005-10-17 11:51:07 -04:00
# shortly.
@@local_assigns_support_string_keys = true
cattr_accessor :local_assigns_support_string_keys
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
2006-03-26 16:50:22 -05:00
@@template_handlers = HashWithIndifferentAccess . new
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
2007-03-27 10:04:06 -04:00
# Maps inline templates to their method names
2005-09-27 12:45:39 -04:00
@@method_names = { }
2007-03-27 10:04:06 -04:00
# Map method names to their compile time
2005-09-27 12:45:39 -04:00
@@compile_time = { }
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-03-27 10:04:06 -04:00
# Count the number of inline templates
2006-03-19 23:01:10 -05:00
@@inline_template_count = 0
2007-03-27 10:04:06 -04:00
# Maps template paths without extension to their file extension returned by pick_template_extension.
# If for a given path, path.ext1 and path.ext2 exist on the file system, the order of extensions
# used by pick_template_extension determines whether ext1 or ext2 will be stored.
2006-03-19 23:01:10 -05:00
@@cached_template_extension = { }
2007-05-15 02:36:34 -04:00
# Maps template paths / extensions to
@@cached_base_paths = { }
2007-09-24 15:47:45 -04:00
# Cache public asset paths
cattr_reader :computed_public_paths
@@computed_public_paths = { }
2007-05-15 02:36:34 -04:00
@@templates_requiring_setup = Set . new ( %w( builder rxml rjs ) )
2005-08-26 18:37:36 -04:00
2007-04-12 16:25:32 -04:00
# Order of template handers checked by #file_exists? depending on the current #template_format
2007-05-15 02:36:34 -04:00
DEFAULT_TEMPLATE_HANDLER_PREFERENCE = [ :erb , :rhtml , :builder , :rxml , :javascript , :delegate ]
2007-04-12 16:25:32 -04:00
TEMPLATE_HANDLER_PREFERENCES = {
2007-05-15 02:36:34 -04:00
:js = > [ :javascript , :erb , :rhtml , :builder , :rxml , :delegate ] ,
:xml = > [ :builder , :rxml , :erb , :rhtml , :javascript , :delegate ] ,
:delegate = > [ :delegate ]
2007-04-12 16:25:32 -04:00
}
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
2005-10-16 11:42:03 -04:00
# Register a class that knows how to handle template files with the given
# extension. This can be used to implement new template types.
# The constructor for the class must take the ActiveView::Base instance
# as a parameter, and the class must implement a #render method that
# takes the contents of the template to render as well as the Hash of
# local assigns available to the template. The #render method ought to
# return the rendered template as a string.
2005-02-19 12:22:37 -05:00
def self . register_template_handler ( extension , klass )
2007-04-12 16:25:32 -04:00
TEMPLATE_HANDLER_PREFERENCES [ extension . to_sym ] = TEMPLATE_HANDLER_PREFERENCES [ :delegate ]
2005-02-19 12:22:37 -05:00
@@template_handlers [ extension ] = klass
end
2007-02-04 15:47:05 -05:00
def initialize ( view_paths = [ ] , assigns_for_first_render = { } , controller = nil ) #:nodoc:
2007-06-15 19:52:37 -04:00
@view_paths = view_paths . respond_to? ( :find ) ? view_paths : [ * view_paths ] . compact
2007-02-04 15:47:05 -05:00
@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
2005-07-21 03:14:35 -04:00
@logger = controller && controller . logger
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:
2006-03-19 23:01:10 -05:00
@first_render || = template_path
2007-02-05 00:39:23 -05:00
template_path_without_extension , template_extension = path_and_extension ( template_path )
2004-11-23 20:04:44 -05:00
if use_full_path
2006-03-11 20:56:55 -05:00
if template_extension
template_file_name = full_template_path ( template_path_without_extension , template_extension )
else
2006-03-19 23:01:10 -05:00
template_extension = pick_template_extension ( template_path ) . to_s
2007-05-15 02:36:34 -04:00
unless template_extension
2007-06-15 19:52:37 -04:00
raise ActionViewError , " No #{ template_handler_preferences . to_sentence } template found for #{ template_path } in #{ view_paths . inspect } "
2007-05-15 02:36:34 -04:00
end
2006-03-11 20:56:55 -05:00
template_file_name = full_template_path ( template_path , template_extension )
2007-04-08 12:53:37 -04:00
template_extension = template_extension . gsub ( / ^ \ w+ \ . / , '' ) # strip off any formats
2006-03-11 20:56:55 -05:00
end
2004-11-23 20:04:44 -05:00
else
template_file_name = template_path
end
2005-07-23 02:14:10 -04:00
2005-08-26 18:37:36 -04:00
template_source = nil # Don't read the source until we know that it is required
2004-11-23 20:04:44 -05:00
2007-05-24 12:42:10 -04:00
if template_file_name . blank?
2007-06-15 19:52:37 -04:00
raise ActionViewError , " Couldn't find template file for #{ template_path } in #{ view_paths . inspect } "
2007-05-24 12:42:10 -04:00
end
2004-11-23 20:04:44 -05:00
begin
2005-07-21 03:14:35 -04:00
render_template ( template_extension , template_source , template_file_name , local_assigns )
2004-11-23 20:04:44 -05:00
rescue Exception = > e
if TemplateError === e
e . sub_template_of ( template_file_name )
raise e
else
2007-04-08 12:53:37 -04:00
raise TemplateError . new ( find_base_path_for ( " #{ template_path_without_extension } . #{ template_extension } " ) || view_paths . first , template_file_name , @assigns , template_source , 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.
2006-03-27 22:19:27 -05:00
def render ( options = { } , old_local_assigns = { } , & block ) #:nodoc:
2005-06-02 16:12:34 -04:00
if options . is_a? ( String )
render_file ( options , true , old_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-02-20 17:09:12 -05:00
options = options . reverse_merge ( :type = > :erb , :locals = > { } , :use_full_path = > true )
2005-07-23 02:14:10 -04:00
2007-08-02 16:10:03 -04:00
if options [ :layout ]
path , partial_name = partial_pieces ( options . delete ( :layout ) )
if block_given?
@content_for_layout = capture ( & block )
concat ( render ( options . merge ( :partial = > " #{ path } / #{ partial_name } " ) ) , block . binding )
else
@content_for_layout = render ( options )
render ( options . merge ( :partial = > " #{ path } / #{ partial_name } " ) )
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 ]
2006-11-02 14:21:53 -05:00
render_template ( options [ :type ] , options [ :inline ] , nil , options [ :locals ] )
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
2007-02-20 17:09:12 -05:00
# Renders the +template+ which is given as a string as either erb or builder depending on <tt>template_extension</tt>.
2004-11-23 20:04:44 -05:00
# The hash in <tt>local_assigns</tt> is made available as local variables.
2006-03-27 22:19:27 -05:00
def render_template ( template_extension , template , file_path = nil , local_assigns = { } ) #:nodoc:
2005-08-26 18:37:36 -04:00
if handler = @@template_handlers [ template_extension ]
template || = read_template_file ( file_path , template_extension ) # Make sure that a lazyily-read template is loaded.
2005-07-21 03:14:35 -04:00
delegate_render ( handler , template , local_assigns )
else
2005-08-26 18:37:36 -04:00
compile_and_render_template ( template_extension , template , file_path , local_assigns )
end
end
2005-09-27 12:45:39 -04:00
# Render the provided template with the given local assigns. If the template has not been rendered with the provided
2005-08-26 18:37:36 -04:00
# local assigns yet, or if the template has been updated on disk, then the template will be compiled to a method.
#
2005-09-27 12:45:39 -04:00
# Either, but not both, of template and file_path may be nil. If file_path is given, the template
2005-08-26 18:37:36 -04:00
# will only be read if it has to be compiled.
#
2006-03-27 22:19:27 -05:00
def compile_and_render_template ( extension , template = nil , file_path = nil , local_assigns = { } ) #:nodoc:
2006-10-08 03:46:23 -04:00
# convert string keys to symbols if requested
local_assigns = local_assigns . symbolize_keys if @@local_assigns_support_string_keys
2005-09-27 12:45:39 -04:00
# compile the given template, if necessary
if compile_template? ( template , file_path , local_assigns )
2005-08-26 18:37:36 -04:00
template || = read_template_file ( file_path , extension )
2005-09-27 12:45:39 -04:00
compile_template ( extension , template , file_path , local_assigns )
2005-07-21 03:14:35 -04:00
end
2005-08-26 18:37:36 -04:00
2005-09-27 12:45:39 -04:00
# Get the method name for this template and run it
method_name = @@method_names [ file_path || template ]
2006-06-29 16:14:33 -04:00
evaluate_assigns
2005-09-28 05:06:34 -04:00
2005-09-27 12:45:39 -04:00
send ( method_name , local_assigns ) do | * name |
2005-09-01 17:51:27 -04:00
instance_variable_get " @content_for_ #{ name . first || 'layout' } "
end
2004-11-23 20:04:44 -05:00
end
2007-05-15 02:36:34 -04:00
# Gets the full template path with base path for the given template_path and extension.
#
# full_template_path('users/show', 'html.erb')
# # => '~/rails/app/views/users/show.html.erb
#
def full_template_path ( template_path , extension )
if @@cache_template_extensions
( @@cached_base_paths [ template_path ] || = { } ) [ extension . to_s ] = find_full_template_path ( template_path , extension )
else
find_full_template_path ( template_path , extension )
end
end
# Gets the extension for an existing template with the given template_path.
# Returns the format with the extension if that template exists.
#
# pick_template_extension('users/show')
# # => 'html.erb'
#
# pick_template_extension('users/legacy')
# # => "rhtml"
#
2004-11-23 20:04:44 -05:00
def pick_template_extension ( template_path ) #:nodoc:
2006-04-06 14:08:31 -04:00
if @@cache_template_extensions
2007-05-15 02:36:34 -04:00
( @@cached_template_extension [ template_path ] || = { } ) [ template_format ] || = find_template_extension_for ( template_path )
2006-04-06 14:08:31 -04:00
else
2007-04-12 16:25:32 -04:00
find_template_extension_for ( template_path )
2006-04-06 14:08:31 -04:00
end
2004-11-23 20:04:44 -05:00
end
2005-07-23 02:14:10 -04:00
2005-02-19 12:22:37 -05:00
def delegate_template_exists? ( template_path ) #:nodoc:
2007-04-12 16:25:32 -04:00
delegate = @@template_handlers . find { | k , | template_exists? ( template_path , k ) }
delegate && delegate . first . to_sym
2004-11-23 20:04:44 -05:00
end
2007-04-12 16:25:32 -04:00
2004-11-23 20:04:44 -05:00
def erb_template_exists? ( template_path ) #:nodoc:
2007-05-15 02:36:34 -04:00
template_exists? ( template_path , :erb )
2004-11-23 20:04:44 -05:00
end
2007-04-12 16:25:32 -04:00
2004-11-23 20:04:44 -05:00
def builder_template_exists? ( template_path ) #:nodoc:
2007-05-15 02:36:34 -04:00
template_exists? ( template_path , :builder )
2004-11-23 20:04:44 -05:00
end
2007-04-12 16:25:32 -04:00
def rhtml_template_exists? ( template_path ) #:nodoc:
2007-05-15 02:36:34 -04:00
template_exists? ( template_path , :rhtml )
2005-11-17 16:28:59 -05:00
end
2004-11-23 20:04:44 -05:00
2007-04-12 16:25:32 -04:00
def rxml_template_exists? ( template_path ) #:nodoc:
2007-05-15 02:36:34 -04:00
template_exists? ( template_path , :rxml )
2007-04-12 16:25:32 -04:00
end
def javascript_template_exists? ( template_path ) #:nodoc:
2007-05-15 02:36:34 -04:00
template_exists? ( template_path , :rjs )
2007-04-01 20:02:11 -04:00
end
2004-11-23 20:04:44 -05:00
def file_exists? ( template_path ) #:nodoc:
2006-03-15 21:51:19 -05:00
template_file_name , template_file_extension = path_and_extension ( template_path )
2006-03-11 20:56:55 -05:00
if template_file_extension
2007-05-15 02:36:34 -04:00
template_exists? ( template_file_name , template_file_extension )
2006-03-11 20:56:55 -05:00
else
2007-05-15 02:36:34 -04:00
pick_template_extension ( template_path )
2005-11-17 16:28:59 -05:00
end
2004-11-23 20:04:44 -05:00
end
# 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.
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
format = controller && controller . respond_to? ( :request ) && controller . request . parameters [ :format ]
@template_format = format . blank? ? :html : format . to_sym
2007-04-12 16:25:32 -04:00
end
def template_handler_preferences
TEMPLATE_HANDLER_PREFERENCES [ template_format ] || DEFAULT_TEMPLATE_HANDLER_PREFERENCE
2007-04-01 20:02:11 -04:00
end
2004-11-23 20:04:44 -05:00
private
2007-05-15 02:36:34 -04:00
def find_full_template_path ( template_path , extension )
2007-02-04 15:47:05 -05:00
file_name = " #{ template_path } . #{ extension } "
base_path = find_base_path_for ( file_name )
2007-05-15 02:36:34 -04:00
base_path . blank? ? " " : " #{ base_path } / #{ file_name } "
2004-11-23 20:04:44 -05:00
end
2007-03-27 10:04:06 -04:00
# Asserts the existence of a template.
2004-11-23 20:04:44 -05:00
def template_exists? ( template_path , extension )
2005-09-27 12:45:39 -04:00
file_path = full_template_path ( template_path , extension )
2007-05-15 02:36:34 -04:00
! file_path . blank? && @@method_names . has_key? ( file_path ) || FileTest . exists? ( file_path )
2004-11-23 20:04:44 -05:00
end
2007-04-01 20:02:11 -04:00
# Splits the path and extension from the given template_path and returns as an array.
2006-03-15 21:51:19 -05:00
def path_and_extension ( template_path )
template_path_without_extension = template_path . sub ( / \ .( \ w+)$ / , '' )
[ template_path_without_extension , $1 ]
end
2007-02-04 15:47:05 -05:00
2007-02-05 00:39:23 -05:00
# Returns the view path that contains the given relative template path.
2007-02-04 15:47:05 -05:00
def find_base_path_for ( template_file_name )
2007-06-15 19:52:37 -04:00
view_paths . find { | p | File . file? ( File . join ( p , template_file_name ) ) }
2007-02-04 15:47:05 -05:00
end
2007-03-27 10:04:06 -04:00
2007-04-07 22:32:25 -04:00
# Returns the view path that the full path resides in.
def extract_base_path_from ( full_path )
2007-06-15 19:52:37 -04:00
view_paths . find { | p | full_path [ 0 .. p . size - 1 ] == p }
2007-04-07 22:32:25 -04:00
end
2007-03-27 10:04:06 -04:00
# Determines the template's file extension, such as rhtml, rxml, or rjs.
2007-04-12 16:25:32 -04:00
def find_template_extension_for ( template_path )
2007-05-15 02:36:34 -04:00
find_template_extension_from_handler ( template_path , true ) || find_template_extension_from_handler ( template_path )
end
def find_template_extension_from_handler ( template_path , formatted = nil )
checked_template_path = formatted ? " #{ template_path } . #{ template_format } " : template_path
template_handler_preferences . each do | template_type |
extension =
case template_type
when :javascript
template_exists? ( checked_template_path , :rjs ) && :rjs
when :delegate
delegate_template_exists? ( checked_template_path )
else
template_exists? ( checked_template_path , template_type ) && template_type
end
if extension
return formatted ? " #{ template_format } . #{ extension } " : extension . to_s
end
2006-04-06 14:08:31 -04:00
end
2007-05-15 02:36:34 -04:00
nil
2006-04-06 14:08:31 -04:00
end
2006-03-15 21:51:19 -05:00
2005-09-27 12:45:39 -04:00
# This method reads a template file.
2005-07-21 03:14:35 -04:00
def read_template_file ( template_path , extension )
2005-08-26 18:37:36 -04:00
File . read ( template_path )
end
2005-07-23 02:27:52 -04: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
def delegate_render ( handler , template , local_assigns )
handler . new ( self ) . render ( template , local_assigns )
2004-11-23 20:04:44 -05:00
end
2005-07-27 09:55:56 -04:00
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
2005-09-27 12:45:39 -04:00
# Return true if the given template was compiled for a superset of the keys in local_assigns
def supports_local_assigns? ( render_symbol , local_assigns )
local_assigns . empty? ||
( ( args = @@template_args [ render_symbol ] ) && local_assigns . all? { | k , _ | args . has_key? ( k ) } )
end
2006-06-29 16:14:33 -04:00
2007-03-27 10:04:06 -04:00
# Method to check whether template compilation is necessary.
# The template will be compiled if the inline template or file has not been compiled yet,
# if local_assigns has a new key, which isn't supported by the compiled code yet,
# or if the file has changed on disk and checking file mods hasn't been disabled.
2005-09-27 12:45:39 -04:00
def compile_template? ( template , file_name , local_assigns )
2005-11-17 16:28:59 -05:00
method_key = file_name || template
2005-09-27 12:45:39 -04:00
render_symbol = @@method_names [ method_key ]
2005-09-28 05:06:34 -04:00
2007-05-27 15:16:09 -04:00
compile_time = @@compile_time [ render_symbol ]
if compile_time && supports_local_assigns? ( render_symbol , local_assigns )
2006-11-20 04:04:26 -05:00
if file_name && ! @@cache_template_loading
2007-05-27 15:16:09 -04:00
template_changed_since? ( file_name , compile_time )
2005-09-27 12:45:39 -04:00
end
else
true
end
end
2007-03-27 10:04:06 -04:00
# Method to handle checking a whether a template has changed since last compile; isolated so that templates
# not stored on the file system can hook and extend appropriately.
2006-11-20 04:04:26 -05:00
def template_changed_since? ( file_name , compile_time )
2007-05-27 15:16:09 -04:00
lstat = File . lstat ( file_name )
compile_time < lstat . mtime ||
( lstat . symlink? && compile_time < File . stat ( file_name ) . mtime )
2006-11-20 04:04:26 -05:00
end
2007-03-27 10:04:06 -04:00
# Method to create the source code for a given template.
2005-09-27 12:45:39 -04:00
def create_template_source ( extension , template , render_symbol , locals )
2005-11-17 16:28:59 -05:00
if template_requires_setup? ( extension )
body = case extension . to_sym
2007-02-20 17:09:12 -05:00
when :rxml , :builder
2007-03-06 04:46:04 -05:00
" controller.response.content_type ||= Mime::XML \n " +
2005-11-17 16:28:59 -05:00
" xml = Builder::XmlMarkup.new(:indent => 2) \n " +
2007-04-20 17:44:08 -04:00
template +
" \n xml.target! \n "
2005-11-17 16:28:59 -05:00
when :rjs
2007-03-06 04:46:04 -05:00
" controller.response.content_type ||= Mime::JS \n " +
2005-11-17 16:28:59 -05:00
" update_page do |page| \n #{ template } \n end "
end
2005-09-27 12:45:39 -04:00
else
body = ERB . new ( template , nil , @@erb_trim_mode ) . src
end
2005-09-28 05:06:34 -04:00
2005-09-27 12:45:39 -04:00
@@template_args [ render_symbol ] || = { }
locals_keys = @@template_args [ render_symbol ] . keys | locals
@@template_args [ render_symbol ] = locals_keys . inject ( { } ) { | h , k | h [ k ] = true ; h }
2005-09-28 05:06:34 -04:00
2006-09-05 23:38:11 -04:00
locals_code = " "
2005-10-17 11:51:07 -04:00
locals_keys . each do | key |
2006-10-08 03:46:23 -04:00
locals_code << " #{ key } = local_assigns[: #{ key } ] \n "
2005-09-27 12:45:39 -04:00
end
2005-09-28 05:06:34 -04:00
2005-09-27 12:45:39 -04:00
" def #{ render_symbol } (local_assigns) \n #{ locals_code } #{ body } \n end "
end
2007-03-27 10:04:06 -04:00
def template_requires_setup? ( extension ) #:nodoc:
2007-05-15 02:36:34 -04:00
@@templates_requiring_setup . include? extension . to_s
2005-11-17 16:28:59 -05:00
end
2006-06-29 17:45:12 -04:00
def assign_method_name ( extension , template , file_name )
method_key = file_name || template
@@method_names [ method_key ] || = compiled_method_name ( extension , template , file_name )
end
2006-06-29 16:14:33 -04:00
def compiled_method_name ( extension , template , file_name )
2006-06-29 17:45:12 -04:00
[ '_run' , extension , compiled_method_name_file_path_segment ( file_name ) ] . compact . join ( '_' ) . to_sym
2006-06-29 16:14:33 -04:00
end
2005-09-28 05:06:34 -04:00
2006-06-29 16:14:33 -04:00
def compiled_method_name_file_path_segment ( file_name )
2005-09-27 12:45:39 -04:00
if file_name
2006-06-29 16:52:00 -04:00
s = File . expand_path ( file_name )
s . sub! ( / ^ #{ Regexp . escape ( File . expand_path ( RAILS_ROOT ) ) } / , '' ) if defined? ( RAILS_ROOT )
s . gsub! ( / ([^a-zA-Z0-9_]) / ) { $1 [ 0 ] . to_s }
s
2005-09-27 12:45:39 -04:00
else
2006-06-29 16:14:33 -04:00
( @@inline_template_count += 1 ) . to_s
2005-09-27 12:45:39 -04:00
end
end
2007-03-27 10:04:06 -04:00
# Compile and evaluate the template's code
2005-09-27 12:45:39 -04:00
def compile_template ( extension , template , file_name , local_assigns )
2006-06-29 17:45:12 -04:00
render_symbol = assign_method_name ( extension , template , file_name )
2005-09-27 12:45:39 -04:00
render_source = create_template_source ( extension , template , render_symbol , local_assigns . keys )
2005-09-28 05:06:34 -04:00
2005-09-27 12:45:39 -04:00
line_offset = @@template_args [ render_symbol ] . size
2005-11-17 16:28:59 -05:00
if extension
case extension . to_sym
2007-02-20 17:09:12 -05:00
when :builder , :rxml , :rjs
2005-11-17 16:28:59 -05:00
line_offset += 2
end
end
2005-09-27 12:45:39 -04:00
begin
2005-10-13 17:58:20 -04:00
unless file_name . blank?
2005-10-15 15:05:15 -04:00
CompiledTemplates . module_eval ( render_source , file_name , - line_offset )
2005-09-27 12:45:39 -04:00
else
2005-10-13 17:58:20 -04:00
CompiledTemplates . module_eval ( render_source , 'compiled-template' , - line_offset )
2005-09-27 12:45:39 -04:00
end
2006-08-30 23:16:28 -04:00
rescue Exception = > e # errors from template code
2005-09-27 12:45:39 -04:00
if logger
logger . debug " ERROR: compiling #{ render_symbol } RAISED #{ e } "
logger . debug " Function body: #{ render_source } "
logger . debug " Backtrace: #{ e . backtrace . join ( " \n " ) } "
end
2005-09-28 05:06:34 -04:00
2007-04-08 12:53:37 -04:00
raise TemplateError . new ( extract_base_path_from ( file_name ) || view_paths . first , file_name || template , @assigns , template , e )
2005-09-27 12:45:39 -04:00
end
@@compile_time [ render_symbol ] = Time . now
2006-06-29 21:56:29 -04:00
# logger.debug "Compiled template #{file_name || template}\n ==> #{render_symbol}" if logger
2005-09-27 12:45:39 -04:00
end
2004-11-23 20:04:44 -05:00
end
end
2007-03-12 23:49:52 -04:00
require 'action_view/template_error'