actionpack 1.9.1 → 1.10.1

data/lib/action_pack/version.rb

@@ -0,0 +1,9 @@
+module ActionPack
+  module Version #:nodoc:
+    MAJOR = 1
+    MINOR = 10
+    TINY  = 1
+    
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/action_view.rb

@@ -31,4 +31,4 @@ ActionView::Base.class_eval do
   include ActionView::Partials
 end
 
-ActionView::Base.load_helpers(File.dirname(__FILE__) + "/action_view/helpers/")
+ActionView::Base.load_helpers(File.dirname(__FILE__) + "/action_view/helpers/")

data/lib/action_view/base.rb

@@ -1,6 +1,7 @@
 require 'erb'
 
 module ActionView #:nodoc:
+
   class ActionViewError < StandardError #:nodoc:
   end
 
@@ -37,7 +38,7 @@ module ActionView #:nodoc:
   # 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
-  # variables defined in using the regular embedding tags. Like this:
+  # variables defined using the regular embedding tags. Like this:
   #
   #   <% @page_title = "A Wonderful Hello" %>
   #   <%= render "shared/header" %>
@@ -59,10 +60,8 @@ module ActionView #:nodoc:
   #
   # == Template caching
   #
-  # The parsing of ERb templates are cached by default, but the reading of them are not. This means that the application by default
-  # will reflect changes to the templates immediatly. If you'd like to sacrifice that immediacy for the speed gain given by also
-  # caching the loading of templates (reading from the file system), you can turn that on with 
-  # <tt>ActionView::Base.cache_template_loading = true</tt>.
+  # 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.
   #
   # == Builder
   #
@@ -118,22 +117,47 @@ module ActionView #:nodoc:
   # More builder documentation can be found at http://builder.rubyforge.org.
   class Base
     include ERB::Util
-    
+
     attr_reader   :first_render
     attr_accessor :base_path, :assigns, :template_extension
     attr_accessor :controller
-    
+
     attr_reader :logger, :params, :response, :session, :headers, :flash
 
-    # Turn on to cache the reading of templates from the file system. Doing so means that you have to restart the server
-    # when changing templates, but that rendering will be faster.
+    # Specify trim mode for the ERB compiler. Defaults to '-'.
+    # See ERB documentation for suitable values.
+    @@erb_trim_mode = '-'
+    cattr_accessor :erb_trim_mode
+
+    # Specify whether file modification times should be checked to see if a template needs recompilation
     @@cache_template_loading = false
     cattr_accessor :cache_template_loading
 
-    @@compiled_erb_templates = {}
-    @@loaded_templates = {}
+    # Specify whether local_assigns should be able to use string keys.
+    # Defaults to +true+. String keys are deprecated and will be removed
+    # shortly.
+    @@local_assigns_support_string_keys = true
+    cattr_accessor :local_assigns_support_string_keys
+
     @@template_handlers = {}
+ 
+    module CompiledTemplates #:nodoc:
+      # holds compiled template code
+    end
+    include CompiledTemplates
+
+    # maps inline templates to their method names 
+    @@method_names = {}
+    # map method names to their compile time
+    @@compile_time = {}
+    # map method names to the names passed in local assigns so far
+    @@template_args = {}
+    # count the number of inline templates
+    @@inline_template_count = 0    
 
+    class ObjectWrapper < Struct.new(:value) #:nodoc:
+    end
+    
     def self.load_helpers(helper_dir)#:nodoc:
       Dir.foreach(helper_dir) do |helper_file| 
         next unless helper_file =~ /_helper.rb$/
@@ -144,13 +168,22 @@ module ActionView #:nodoc:
       end
     end
 
+    # 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.
     def self.register_template_handler(extension, klass)
       @@template_handlers[extension] = klass
     end
 
     def initialize(base_path = nil, assigns_for_first_render = {}, controller = nil)#:nodoc:
       @base_path, @assigns = base_path, assigns_for_first_render
+      @assigns_added = nil
       @controller = controller
+      @logger = controller && controller.logger 
     end
 
     # Renders the template present at <tt>template_path</tt>. If <tt>use_full_path</tt> is set to true, 
@@ -158,19 +191,19 @@ module ActionView #:nodoc:
     # is made available as local variables.
     def render_file(template_path, use_full_path = true, local_assigns = {})
       @first_render      = template_path if @first_render.nil?
-      
+
       if use_full_path
         template_extension = pick_template_extension(template_path)
         template_file_name = full_template_path(template_path, template_extension)
       else
         template_file_name = template_path
-        template_extension = template_path.split(".").last
+        template_extension = template_path.split('.').last
       end
-      
-      template_source = read_template_file(template_file_name)
+
+      template_source = nil # Don't read the source until we know that it is required
 
       begin
-        render_template(template_extension, template_source, local_assigns)
+        render_template(template_extension, template_source, template_file_name, local_assigns)
       rescue Exception => e
         if TemplateError === e
           e.sub_template_of(template_file_name)
@@ -180,7 +213,7 @@ module ActionView #:nodoc:
         end
       end
     end
-    
+
     # Renders the template present at <tt>template_path</tt> (relative to the template_root). 
     # The hash in <tt>local_assigns</tt> is made available as local variables.
     def render(options = {}, old_local_assigns = {})
@@ -189,56 +222,77 @@ module ActionView #:nodoc:
       elsif options.is_a?(Hash)
         options[:locals] ||= {}
         options[:use_full_path] = options[:use_full_path].nil? ? true : options[:use_full_path]
-        
+
         if options[:file]
           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])
         elsif options[:partial]
-          render_partial(options[:partial], options[:object], options[:locals])
+          render_partial(options[:partial], ActionView::Base::ObjectWrapper.new(options[:object]), options[:locals])
         elsif options[:inline]
-          render_template(options[:type] || :rhtml, options[:inline], options[:locals] || {})
+          render_template(options[:type] || :rhtml, options[:inline], nil, options[:locals] || {})
         end
       end
     end
-    
+
     # Renders the +template+ which is given as a string as either rhtml or rxml depending on <tt>template_extension</tt>.
     # The hash in <tt>local_assigns</tt> is made available as local variables.
-    def render_template(template_extension, template, local_assigns = {})
-      send(pick_rendering_method(template_extension), template_extension,
-        template, local_assigns)
+    def render_template(template_extension, template, file_path = nil, local_assigns = {})
+      if handler = @@template_handlers[template_extension]
+        template ||= read_template_file(file_path, template_extension) # Make sure that a lazyily-read template is loaded.
+        delegate_render(handler, template, local_assigns)
+      else
+        compile_and_render_template(template_extension, template, file_path, local_assigns)
+      end
+    end
+
+    # Render the provided template with the given local assigns. If the template has not been rendered with the provided
+    # local assigns yet, or if the template has been updated on disk, then the template will be compiled to a method.
+    #
+
+    # Either, but not both, of template and file_path may be nil. If file_path is given, the template
+    # will only be read if it has to be compiled.
+    #
+    def compile_and_render_template(extension, template = nil, file_path = nil, local_assigns = {})
+      # compile the given template, if necessary
+      if compile_template?(template, file_path, local_assigns)
+        template ||= read_template_file(file_path, extension)
+        compile_template(extension, template, file_path, local_assigns)
+      end
+
+      # Get the method name for this template and run it
+      method_name = @@method_names[file_path || template]
+      evaluate_assigns                                    
+
+      local_assigns = local_assigns.symbolize_keys if @@local_assigns_support_string_keys
+
+      send(method_name, local_assigns) do |*name|
+        instance_variable_get "@content_for_#{name.first || 'layout'}"
+      end
     end
 
     def pick_template_extension(template_path)#:nodoc:
       if match = delegate_template_exists?(template_path)
         match.first
       elsif erb_template_exists?(template_path)
-        "rhtml"
+        'rhtml'
       elsif builder_template_exists?(template_path)
-        "rxml"
+        'rxml'
       else
         raise ActionViewError, "No rhtml, rxml, or delegate template found for #{template_path}"
       end
     end
-    
-    def pick_rendering_method(template_extension)#:nodoc:
-      if @@template_handlers[template_extension]
-        "delegate_render"
-      else
-        (template_extension.to_s == "rxml" ? "rxml" : "rhtml") + "_render"
-      end
-    end
 
     def delegate_template_exists?(template_path)#:nodoc:
       @@template_handlers.find { |k,| template_exists?(template_path, k) }
     end
 
     def erb_template_exists?(template_path)#:nodoc:
-      template_exists?(template_path, "rhtml")
+      template_exists?(template_path, :rhtml)
     end
 
     def builder_template_exists?(template_path)#:nodoc:
-      template_exists?(template_path, "rxml")
+      template_exists?(template_path, :rxml)
     end
 
     def file_exists?(template_path)#:nodoc:
@@ -247,7 +301,7 @@ module ActionView #:nodoc:
 
     # Returns true is the file may be rendered implicitly.
     def file_public?(template_path)#:nodoc:
-      template_path.split("/").last[0,1] != "_"
+      template_path.split('/').last[0,1] != '_'
     end
 
     private
@@ -256,43 +310,133 @@ module ActionView #:nodoc:
       end
 
       def template_exists?(template_path, extension)
-        (cache_template_loading && @@loaded_templates.has_key?(template_path)) ||
-          FileTest.exists?(full_template_path(template_path, extension))
+        file_path = full_template_path(template_path, extension)
+        @@method_names.has_key?(file_path) || FileTest.exists?(file_path)
+      end
+
+      # This method reads a template file.
+      def read_template_file(template_path, extension)
+        File.read(template_path)
       end
 
-      def read_template_file(template_path)
-        unless cache_template_loading && @@loaded_templates[template_path]
-          @@loaded_templates[template_path] = File.read(template_path)
+      def evaluate_assigns
+        unless @assigns_added
+          assign_variables_from_controller
+          @assigns_added = true
         end
+      end
 
-        @@loaded_templates[template_path]
+      def delegate_render(handler, template, local_assigns)
+        handler.new(self).render(template, local_assigns)
+      end
+
+      def assign_variables_from_controller
+        @assigns.each { |key, value| instance_variable_set("@#{key}", value) }
       end
 
-      def evaluate_locals(local_assigns = {})
-        b = binding
 
-        local_assigns.stringify_keys!
-        local_assigns.each { |key, value| eval "#{key} = local_assigns[\"#{key}\"]", b }
-        @assigns.each { |key, value| instance_variable_set "@#{key}", value }
-        xml = Builder::XmlMarkup.new(:indent => 2)
+      # 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
+      
+      # Check whether compilation is necessary.
+      # Compile if the inline template or file has not been compiled yet.
+      # Or 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. 
+      def compile_template?(template, file_name, local_assigns)
+        method_key = file_name || template
+        render_symbol = @@method_names[method_key]
 
-        b
+        if @@compile_time[render_symbol] && supports_local_assigns?(render_symbol, local_assigns)
+          if file_name && !@@cache_template_loading 
+            @@compile_time[render_symbol] < File.mtime(file_name)
+          end
+        else
+          true
+        end
       end
 
-      def rhtml_render(extension, template, local_assigns)
-        b = evaluate_locals(local_assigns)
-        @@compiled_erb_templates[template] ||= ERB.new(template, nil, '-')
-        @@compiled_erb_templates[template].result(b)
+      # Create source code for given template
+      def create_template_source(extension, template, render_symbol, locals)
+        if extension && (extension.to_sym == :rxml)
+          body = "xml = Builder::XmlMarkup.new(:indent => 2)\n" +
+                 "@controller.headers['Content-Type'] ||= 'text/xml'\n" +
+                 template
+        else
+          body = ERB.new(template, nil, @@erb_trim_mode).src
+        end
+
+        @@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 }
+
+        locals_code = ""
+        locals_keys.each do |key|
+          locals_code << "#{key} = local_assigns[:#{key}] if local_assigns.has_key?(:#{key})\n"
+        end
+
+        "def #{render_symbol}(local_assigns)\n#{locals_code}#{body}\nend"
       end
 
-      def rxml_render(extension, template, local_assigns)
-        @controller.headers["Content-Type"] ||= 'text/xml'
-        eval(template, evaluate_locals(local_assigns))
+      def assign_method_name(extension, template, file_name)
+        method_name = '_run_'
+
+        if extension && (extension.to_sym == :rxml)
+          method_name << 'xml_'
+        else
+          method_name << 'html_'
+        end
+
+        if file_name
+          file_path = File.expand_path(file_name)
+          base_path = File.expand_path(@base_path)
+
+          i = file_path.index(base_path)
+          l = base_path.length
+
+          method_name_file_part = i ? file_path[i+l+1,file_path.length-l-1] : file_path.clone
+          method_name_file_part.sub!(/\.r(ht|x)ml$/,'')
+          method_name_file_part.tr!('/:-', '_')
+          method_name_file_part.gsub!(/[^a-zA-Z0-9_]/){|s| s[0].to_s}
+
+          method_name += method_name_file_part
+        else
+          @@inline_template_count += 1
+          method_name << @@inline_template_count.to_s
+        end
+
+        @@method_names[file_name || template] = method_name.intern
       end
 
-      def delegate_render(extension, template, local_assigns)
-        delegator = @@template_handlers[extension].new(self)
-        delegator.render(template, local_assigns)
+      def compile_template(extension, template, file_name, local_assigns)
+        method_key = file_name || template
+
+        render_symbol = @@method_names[method_key] || assign_method_name(extension, template, file_name)
+        render_source = create_template_source(extension, template, render_symbol, local_assigns.keys)
+
+        line_offset = @@template_args[render_symbol].size
+        line_offset += 2 if extension && (extension.to_sym == :rxml)
+
+        begin
+          unless file_name.blank?
+            CompiledTemplates.module_eval(render_source, file_name, -line_offset)
+          else
+            CompiledTemplates.module_eval(render_source, 'compiled-template', -line_offset)
+          end
+        rescue Object => e
+          if logger
+            logger.debug "ERROR: compiling #{render_symbol} RAISED #{e}"
+            logger.debug "Function body: #{render_source}"
+            logger.debug "Backtrace: #{e.backtrace.join("\n")}"
+          end
+
+          raise TemplateError.new(@base_path, method_key, @assigns, template, e)
+        end
+
+        @@compile_time[render_symbol] = Time.now
+        # logger.debug "Compiled template #{method_key}\n  ==> #{render_symbol}" if logger
       end
   end
 end

data/lib/action_view/compiled_templates.rb

@@ -0,0 +1,70 @@
+
+module ActionView
+
+  # CompiledTemplates modules hold methods that have been compiled.
+  # Templates are compiled into these methods so that they do not need to be
+  # re-read and re-parsed each request.
+  #
+  # Each template may be compiled into one or more methods. Each method accepts a given
+  # set of parameters which is used to implement local assigns passing.
+  #
+  # To use a compiled template module, create a new instance and include it into the class
+  # in which you want the template to be rendered.
+  class CompiledTemplates < Module
+    attr_reader :method_names
+
+    def initialize
+      @method_names = Hash.new do |hash, key|
+        hash[key] = "__compiled_method_#{(hash.length + 1)}"
+      end
+      @mtimes = {}
+    end
+    
+    # Return the full key for the given identifier and argument names
+    def full_key(identifier, arg_names)
+      [identifier, arg_names]
+    end
+
+    # Return the selector for this method or nil if it has not been compiled
+    def selector(identifier, arg_names)
+      key = full_key(identifier, arg_names)
+      method_names.key?(key) ? method_names[key] : nil
+    end
+    alias :compiled? :selector
+
+    # Return the time at which the method for the given identifier and argument names was compiled.
+    def mtime(identifier, arg_names)
+      @mtimes[full_key(identifier, arg_names)]
+    end
+    
+    # Compile the provided source code for the given argument names and with the given initial line number.
+    # The identifier should be unique to this source.
+    #
+    # The file_name, if provided will appear in backtraces. If not provded, the file_name defaults
+    # to the identifier.
+    #
+    # This method will return the selector for the compiled version of this method.
+    def compile_source(identifier, arg_names, source, initial_line_number = 0, file_name = nil)
+      file_name ||= identifier
+      name = method_names[full_key(identifier, arg_names)]
+      arg_desc = arg_names.empty? ? '' : "(#{arg_names * ', '})"
+      fake_file_name = "#{file_name}#{arg_desc}" # Include the arguments for this version (for now)
+      
+      method_def = wrap_source(name, arg_names, source)
+      
+      begin
+        module_eval(method_def, fake_file_name, initial_line_number)
+        @mtimes[full_key(identifier, arg_names)] = Time.now
+      rescue Object => e
+        e.blame_file! identifier
+        raise
+      end
+      name
+    end
+    
+    # Wrap the provided source in a def ... end block.
+    def wrap_source(name, arg_names, source)
+      "def #{name}(#{arg_names * ', '})\n#{source}\nend"
+    end
+  end
+end