eactionpack 2.1.2

data/lib/action_view/inline_template.rb

@@ -0,0 +1,20 @@
+module ActionView #:nodoc:
+  class InlineTemplate < Template #:nodoc:
+    
+    def initialize(view, source, locals = {}, type = nil)
+      @view = view
+      @finder = @view.finder
+      
+      @source = source
+      @extension = type
+      @locals = locals || {}
+      
+      @handler = self.class.handler_class_for_extension(@extension).new(@view)
+    end
+    
+    def method_key
+      @source
+    end
+    
+  end
+end

data/lib/action_view/partial_template.rb

@@ -0,0 +1,70 @@
+module ActionView #:nodoc:
+  class PartialTemplate < Template #:nodoc:
+    
+    attr_reader :variable_name, :object
+    
+    def initialize(view, partial_path, object = nil, locals = {})
+      @path, @variable_name = extract_partial_name_and_path(view, partial_path)
+      super(view, @path, true, locals)
+      add_object_to_local_assigns!(object)
+
+      # This is needed here in order to compile template with knowledge of 'counter'
+      initialize_counter
+      
+      # Prepare early. This is a performance optimization for partial collections
+      prepare!
+    end
+    
+    def render
+      ActionController::Base.benchmark("Rendered #{@path}", Logger::DEBUG, false) do
+        @handler.render(self)
+      end
+    end
+    
+    def render_member(object)
+      @locals[:object] = @locals[@variable_name] = object
+      
+      template = render_template
+      @locals[@counter_name] += 1
+      @locals.delete(@variable_name)
+      @locals.delete(:object)
+      
+      template
+    end
+    
+    def counter=(num)
+      @locals[@counter_name] = num
+    end
+
+    private
+
+    def add_object_to_local_assigns!(object)
+      @locals[:object] ||=
+        @locals[@variable_name] ||=
+          if object.is_a?(ActionView::Base::ObjectWrapper)
+            object.value
+          else
+            object
+          end || @view.controller.instance_variable_get("@#{variable_name}")
+    end
+    
+    def extract_partial_name_and_path(view, partial_path)
+      path, partial_name = partial_pieces(view, partial_path)
+      [File.join(path, "_#{partial_name}"), partial_name.split('/').last.split('.').first.to_sym] 
+    end
+    
+    def partial_pieces(view, partial_path)
+      if partial_path.include?('/')
+        return File.dirname(partial_path), File.basename(partial_path)
+      else
+        return view.controller.class.controller_path, partial_path
+      end
+    end
+    
+    def initialize_counter
+      @counter_name ||= "#{@variable_name}_counter".to_sym
+      @locals[@counter_name] = 0
+    end
+    
+  end
+end

data/lib/action_view/partials.rb

@@ -0,0 +1,158 @@
+module ActionView
+  # There's also a convenience method for rendering sub templates within the current controller that depends on a single object
+  # (we call this kind of sub templates for partials). It relies on the fact that partials should follow the naming convention of being
+  # prefixed with an underscore -- as to separate them from regular templates that could be rendered on their own.
+  #
+  # In a template for Advertiser#account:
+  #
+  #  <%= render :partial => "account" %>
+  #
+  # This would render "advertiser/_account.erb" and pass the instance variable @account in as a local variable +account+ to
+  # the template for display.
+  #
+  # In another template for Advertiser#buy, we could have:
+  #
+  #   <%= render :partial => "account", :locals => { :account => @buyer } %>
+  #
+  #   <% for ad in @advertisements %>
+  #     <%= render :partial => "ad", :locals => { :ad => ad } %>
+  #   <% end %>
+  #
+  # This would first render "advertiser/_account.erb" with @buyer passed in as the local variable +account+, then render
+  # "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display.
+  #
+  # == Rendering a collection of partials
+  #
+  # The example of partial use describes a familiar pattern where a template needs to iterate over an array and render a sub
+  # template for each of the elements. This pattern has been implemented as a single method that accepts an array and renders
+  # a partial by the same name as the elements contained within. So the three-lined example in "Using partials" can be rewritten
+  # with a single line:
+  #
+  #   <%= render :partial => "ad", :collection => @advertisements %>
+  #
+  # This will render "advertiser/_ad.erb" and pass the local variable +ad+ to the template for display. An iteration counter
+  # will automatically be made available to the template with a name of the form +partial_name_counter+. In the case of the
+  # example above, the template would be fed +ad_counter+.
+  #
+  # NOTE: Due to backwards compatibility concerns, the collection can't be one of hashes. Normally you'd also just keep domain objects,
+  # like Active Records, in there.
+  #
+  # == Rendering shared partials
+  #
+  # Two controllers can share a set of partials and render them like this:
+  #
+  #   <%= render :partial => "advertisement/ad", :locals => { :ad => @advertisement } %>
+  #
+  # This will render the partial "advertisement/_ad.erb" regardless of which controller this is being called from.
+  #
+  # == Rendering partials with layouts
+  #
+  # Partials can have their own layouts applied to them. These layouts are different than the ones that are specified globally
+  # for the entire action, but they work in a similar fashion. Imagine a list with two types of users:
+  #
+  #   <%# app/views/users/index.html.erb &>
+  #   Here's the administrator:
+  #   <%= render :partial => "user", :layout => "administrator", :locals => { :user => administrator } %>
+  #
+  #   Here's the editor:
+  #   <%= render :partial => "user", :layout => "editor", :locals => { :user => editor } %>
+  #
+  #   <%# app/views/users/_user.html.erb &>
+  #   Name: <%= user.name %>
+  #
+  #   <%# app/views/users/_administrator.html.erb &>
+  #   <div id="administrator">
+  #     Budget: $<%= user.budget %>
+  #     <%= yield %>
+  #   </div>
+  #
+  #   <%# app/views/users/_editor.html.erb &>
+  #   <div id="editor">
+  #     Deadline: $<%= user.deadline %>
+  #     <%= yield %>
+  #   </div>
+  #
+  # ...this will return:
+  #
+  #   Here's the administrator:
+  #   <div id="administrator">
+  #     Budget: $<%= user.budget %>
+  #     Name: <%= user.name %>
+  #   </div>
+  #
+  #   Here's the editor:
+  #   <div id="editor">
+  #     Deadline: $<%= user.deadline %>
+  #     Name: <%= user.name %>
+  #   </div>
+  #
+  # You can also apply a layout to a block within any template:
+  #
+  #   <%# app/views/users/_chief.html.erb &>
+  #   <% render(:layout => "administrator", :locals => { :user => chief }) do %>
+  #     Title: <%= chief.title %>
+  #   <% end %>
+  #
+  # ...this will return:
+  #
+  #   <div id="administrator">
+  #     Budget: $<%= user.budget %>
+  #     Title: <%= chief.name %>
+  #   </div>
+  #
+  # As you can see, the <tt>:locals</tt> hash is shared between both the partial and its layout.
+  module Partials
+    private
+      def render_partial(partial_path, object_assigns = nil, local_assigns = {}) #:nodoc:
+        case partial_path
+        when String, Symbol, NilClass
+          # Render the template
+          ActionView::PartialTemplate.new(self, partial_path, object_assigns, local_assigns).render_template
+        when ActionView::Helpers::FormBuilder
+          builder_partial_path = partial_path.class.to_s.demodulize.underscore.sub(/_builder$/, '')
+          render_partial(builder_partial_path, object_assigns, (local_assigns || {}).merge(builder_partial_path.to_sym => partial_path))
+        when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope
+          if partial_path.any?
+            collection = partial_path
+            render_partial_collection(nil, collection, nil, local_assigns)
+          else
+            ""
+          end
+        else
+          render_partial(ActionController::RecordIdentifier.partial_path(partial_path, controller.class.controller_path), partial_path, local_assigns)
+        end
+      end
+
+      def render_partial_collection(partial_path, collection, partial_spacer_template = nil, local_assigns = {}) #:nodoc:
+        return " " if collection.empty?
+
+        local_assigns = local_assigns ? local_assigns.clone : {}
+        spacer = partial_spacer_template ? render(:partial => partial_spacer_template) : ''
+
+        if partial_path.nil?
+          render_partial_collection_with_unknown_partial_path(collection, local_assigns)
+        else
+          render_partial_collection_with_known_partial_path(collection, partial_path, local_assigns)
+        end.join(spacer)
+      end
+
+      def render_partial_collection_with_known_partial_path(collection, partial_path, local_assigns)
+        template = ActionView::PartialTemplate.new(self, partial_path, nil, local_assigns)
+        collection.map do |element|
+          template.render_member(element)
+        end
+      end
+
+      def render_partial_collection_with_unknown_partial_path(collection, local_assigns)
+        templates = Hash.new
+        i = 0
+        collection.map do |element|
+          partial_path = ActionController::RecordIdentifier.partial_path(element, controller.class.controller_path)
+          template = templates[partial_path] ||= ActionView::PartialTemplate.new(self, partial_path, nil, local_assigns)
+          template.counter = i
+          i += 1
+          template.render_member(element)
+        end
+      end
+  end
+end

data/lib/action_view/template.rb

@@ -0,0 +1,125 @@
+module ActionView #:nodoc:
+  class Template #:nodoc:
+
+    attr_accessor :locals
+    attr_reader :handler, :path, :extension, :filename, :path_without_extension, :method
+
+    def initialize(view, path, use_full_path, locals = {})
+      @view = view
+      @finder = @view.finder
+      # Clear the forward slash at the beginning if exists
+      @path = use_full_path ? path.sub(/^\//, '') : path
+      @view.first_render ||= @path
+      @source = nil # Don't read the source until we know that it is required
+      set_extension_and_file_name(use_full_path)
+      
+      @locals = locals || {}
+      @handler = self.class.handler_class_for_extension(@extension).new(@view)
+    end
+
+    def render_template
+      render
+    rescue Exception => e
+      raise e unless filename
+      if TemplateError === e
+        e.sub_template_of(filename)
+        raise e
+      else
+        raise TemplateError.new(self, @view.assigns, e)
+      end
+    end
+    
+    def render
+      prepare!
+      @handler.render(self)
+    end
+
+    def source
+      @source ||= File.read(self.filename)
+    end
+
+    def method_key
+      @filename
+    end
+
+    def base_path_for_exception
+      @finder.find_base_path_for("#{@path_without_extension}.#{@extension}") || @finder.view_paths.first
+    end
+    
+    def prepare!
+      @view.send :evaluate_assigns
+      @view.current_render_extension = @extension
+      
+      if @handler.compilable?
+        @handler.compile_template(self) # compile the given template, if necessary
+        @method = @view.method_names[method_key] # Set the method name for this template and run it
+      end
+    end
+
+    private
+
+    def set_extension_and_file_name(use_full_path)
+      @path_without_extension, @extension = @finder.path_and_extension(@path)
+      if use_full_path
+        if @extension
+          @filename = @finder.pick_template(@path_without_extension, @extension)
+        else
+          @extension = @finder.pick_template_extension(@path).to_s
+          raise_missing_template_exception unless @extension
+          
+          @filename = @finder.pick_template(@path, @extension)
+          @extension = @extension.gsub(/^.+\./, '') # strip off any formats
+        end
+      else
+        @filename = @path
+      end
+
+      raise_missing_template_exception if @filename.blank?
+    end
+    
+    def raise_missing_template_exception
+      full_template_path = @path.include?('.') ? @path : "#{@path}.#{@view.template_format}.erb"
+      display_paths = @finder.view_paths.join(':')
+      template_type = (@path =~ /layouts/i) ? 'layout' : 'template'
+      raise(MissingTemplate, "Missing #{template_type} #{full_template_path} in view path #{display_paths}")
+    end
+
+    # Template Handlers
+    
+    @@template_handlers = HashWithIndifferentAccess.new
+    @@default_template_handlers = nil
+    
+    # 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.to_sym] = klass
+      TemplateFinder.update_extension_cache_for(extension.to_s)
+    end
+
+    def self.template_handler_extensions
+      @@template_handlers.keys.map(&:to_s).sort
+    end
+
+    def self.register_default_template_handler(extension, klass)
+      register_template_handler(extension, klass)
+      @@default_template_handlers = klass
+    end
+
+    def self.handler_class_for_extension(extension)
+      (extension && @@template_handlers[extension.to_sym]) || @@default_template_handlers
+    end
+
+    register_default_template_handler :erb, TemplateHandlers::ERB
+    register_template_handler :builder, TemplateHandlers::Builder
+
+    # TODO: Depreciate old template extensions
+    register_template_handler :rhtml, TemplateHandlers::ERB
+    register_template_handler :rxml, TemplateHandlers::Builder
+    
+  end
+end

data/lib/action_view/template_error.rb

@@ -0,0 +1,110 @@
+module ActionView
+  # The TemplateError exception is raised when the compilation of the template fails. This exception then gathers a
+  # bunch of intimate details and uses it to report a very precise exception message.
+  class TemplateError < ActionViewError #:nodoc:
+    SOURCE_CODE_RADIUS = 3
+
+    attr_reader :original_exception
+
+    def initialize(template, assigns, original_exception)
+      @base_path = template.base_path_for_exception
+      @assigns, @source, @original_exception = assigns.dup, template.source, original_exception
+      @file_path = template.filename
+      @backtrace = compute_backtrace
+    end
+
+    def message
+      ActiveSupport::Deprecation.silence { original_exception.message }
+    end
+
+    def clean_backtrace
+      original_exception.clean_backtrace
+    end
+
+    def sub_template_message
+      if @sub_templates
+        "Trace of template inclusion: " +
+        @sub_templates.collect { |template| strip_base_path(template) }.join(", ")
+      else
+        ""
+      end
+    end
+
+    def source_extract(indentation = 0)
+      return unless num = line_number
+      num = num.to_i
+
+      source_code = IO.readlines(@file_path)
+
+      start_on_line = [ num - SOURCE_CODE_RADIUS - 1, 0 ].max
+      end_on_line   = [ num + SOURCE_CODE_RADIUS - 1, source_code.length].min
+
+      indent = ' ' * indentation
+      line_counter = start_on_line
+      return unless source_code = source_code[start_on_line..end_on_line] 
+      
+      source_code.sum do |line|
+        line_counter += 1
+        "#{indent}#{line_counter}: #{line}"
+      end
+    end
+
+    def sub_template_of(template_path)
+      @sub_templates ||= []
+      @sub_templates << template_path
+    end
+
+    def line_number
+      @line_number ||=
+        if file_name
+          regexp = /#{Regexp.escape File.basename(file_name)}:(\d+)/
+
+          $1 if message =~ regexp or clean_backtrace.find { |line| line =~ regexp }
+        end
+    end
+
+    def file_name
+      stripped = strip_base_path(@file_path)
+      stripped.slice!(0,1) if stripped[0] == ?/
+      stripped
+    end
+
+    def to_s
+      "\n\n#{self.class} (#{message}) #{source_location}:\n" +
+        "#{source_extract}\n    #{clean_backtrace.join("\n    ")}\n\n"
+    end
+
+    # don't do anything nontrivial here. Any raised exception from here becomes fatal 
+    # (and can't be rescued).
+    def backtrace
+      @backtrace
+    end
+
+    private
+      def compute_backtrace
+        [
+          "#{source_location.capitalize}\n\n#{source_extract(4)}\n    " +
+          clean_backtrace.join("\n    ")
+        ]
+      end
+
+      def strip_base_path(path)
+        stripped_path = File.expand_path(path).gsub(@base_path, "")
+        stripped_path.gsub!(/^#{Regexp.escape File.expand_path(RAILS_ROOT)}/, '') if defined?(RAILS_ROOT)
+        stripped_path
+      end
+
+      def source_location
+        if line_number
+          "on line ##{line_number} of "
+        else
+          'in '
+        end + file_name
+      end
+  end
+end
+
+if defined?(Exception::TraceSubstitutions)
+  Exception::TraceSubstitutions << [/:in\s+`_run_(html|xml).*'\s*$/, '']
+  Exception::TraceSubstitutions << [%r{^\s*#{Regexp.escape RAILS_ROOT}/}, ''] if defined?(RAILS_ROOT)
+end