actionpack 3.1.12 → 3.2.0.rc1

data/lib/action_view/path_set.rb

@@ -1,11 +1,55 @@
 module ActionView #:nodoc:
   # = Action View PathSet
-  class PathSet < Array #:nodoc:
-    %w(initialize << concat insert push unshift).each do |method|
+  class PathSet #:nodoc:
+    include Enumerable
+
+    attr_reader :paths
+
+    def initialize(paths = [])
+      @paths = typecast paths
+    end
+
+    def initialize_copy(other)
+      @paths = other.paths.dup
+      self
+    end
+
+    def [](i)
+      paths[i]
+    end
+
+    def to_ary
+      paths.dup
+    end
+
+    def include?(item)
+      paths.include? item
+    end
+
+    def pop
+      paths.pop
+    end
+
+    def size
+      paths.size
+    end
+
+    def each(&block)
+      paths.each(&block)
+    end
+
+    def compact
+      PathSet.new paths.compact
+    end
+
+    def +(array)
+      PathSet.new(paths + array)
+    end
+
+    %w(<< concat push insert unshift).each do |method|
       class_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{method}(*args)
-          super
-          typecast!
+          paths.#{method}(*typecast(args))
         end
       METHOD
     end
@@ -17,7 +61,7 @@ module ActionView #:nodoc:
     def find_all(path, prefixes = [], *args)
       prefixes = [prefixes] if String === prefixes
       prefixes.each do |prefix|
-        each do |resolver|
+        paths.each do |resolver|
           templates = resolver.find_all(path, prefix, *args)
           return templates unless templates.empty?
         end
@@ -25,17 +69,20 @@ module ActionView #:nodoc:
       []
     end
 
-    def exists?(*args)
-      find_all(*args).any?
+    def exists?(path, prefixes, *args)
+      find_all(path, prefixes, *args).any?
     end
 
-  protected
+    private
 
-    def typecast!
-      each_with_index do |path, i|
-        path = path.to_s if path.is_a?(Pathname)
-        next unless path.is_a?(String)
-        self[i] = OptimizedFileSystemResolver.new(path)
+    def typecast(paths)
+      paths.map do |path|
+        case path
+        when Pathname, String
+          OptimizedFileSystemResolver.new path.to_s
+        else
+          path
+        end
       end
     end
   end

data/lib/action_view/renderer/abstract_renderer.rb

@@ -11,15 +11,22 @@ module ActionView
       raise NotImplementedError
     end
 
-    # Checks if the given path contains a format and if so, change
-    # the lookup context to take this new format into account.
-    def wrap_formats(value)
-      return yield unless value.is_a?(String)
-
-      if value.sub!(formats_regexp, "")
-        update_details(:formats => [$1.to_sym]){ yield }
-      else
-        yield
+    protected
+    
+    def extract_details(options)
+      details = {}
+      @lookup_context.registered_details.each do |key|
+        next unless value = options[key]
+        details[key] = Array.wrap(value)
+      end
+      details
+    end
+    
+    def extract_format(value, details)
+      if value.is_a?(String) && value.sub!(formats_regexp, "")
+        ActiveSupport::Deprecation.warn "Passing the format in the template name is deprecated. " \
+          "Please pass render with :formats => [:#{$1}] instead.", caller
+        details[:formats] ||= [$1.to_sym]
       end
     end
 
@@ -27,8 +34,6 @@ module ActionView
       @@formats_regexp ||= /\.(#{Mime::SET.symbols.join('|')})$/
     end
 
-    protected
-
     def instrument(name, options={})
       ActiveSupport::Notifications.instrument("render_#{name}.action_view", options){ yield }
     end

data/lib/action_view/renderer/partial_renderer.rb

@@ -27,7 +27,7 @@ module ActionView
   #
   # == The :as and :object options
   #
-  # By default <tt>ActionView::Partials::PartialRenderer</tt> doesn't have any local variables.
+  # By default <tt>ActionView::PartialRenderer</tt> doesn't have any local variables.
   # The <tt>:object</tt> option can be used to pass an object to the partial. For instance:
   #
   #   <%= render :partial => "account", :object => @buyer %>
@@ -82,16 +82,18 @@ module ActionView
   #
   # This will render the partial "advertisement/_ad.html.erb" regardless of which controller this is being called from.
   #
-  # == Rendering objects with the RecordIdentifier
+  # == Rendering objects that respond to `to_partial_path`
   #
-  # Instead of explicitly naming the location of a partial, you can also let the RecordIdentifier do the work if
-  # you're following its conventions for RecordIdentifier#partial_path. Examples:
+  # Instead of explicitly naming the location of a partial, you can also let PartialRenderer do the work
+  # and pick the proper path by checking `to_proper_path` method. If the object passed to render is a collection,
+  # all objects must return the same path.
   #
-  #  # @account is an Account instance, so it uses the RecordIdentifier to replace
+  #  # @account.to_partial_path returns 'accounts/account', so it can be used to replace:
   #  # <%= render :partial => "accounts/account", :locals => { :account => @account} %>
   #  <%= render :partial => @account %>
   #
-  #  # @posts is an array of Post instances, so it uses the RecordIdentifier to replace
+  #  # @posts is an array of Post instances, so every post record returns 'posts/post' on `to_partial_path`,
+  #  # that's why we can replace:
   #  # <%= render :partial => "posts/post", :collection => @posts %>
   #  <%= render :partial => @posts %>
   #
@@ -106,13 +108,14 @@ module ActionView
   #  # Instead of <%= render :partial => "account", :locals => { :account => @buyer } %>
   #  <%= render "account", :account => @buyer %>
   #
-  #  # @account is an Account instance, so it uses the RecordIdentifier to replace
-  #  # <%= render :partial => "accounts/account", :locals => { :account => @account } %>
-  #  <%= render(@account) %>
+  #  # @account.to_partial_path returns 'accounts/account', so it can be used to replace:
+  #  # <%= render :partial => "accounts/account", :locals => { :account => @account} %>
+  #  <%= render @account %>
   #
-  #  # @posts is an array of Post instances, so it uses the RecordIdentifier to replace
+  #  # @posts is an array of Post instances, so every post record returns 'posts/post' on `to_partial_path`,
+  #  # that's why we can replace:
   #  # <%= render :partial => "posts/post", :collection => @posts %>
-  #  <%= render(@posts) %>
+  #  <%= render @posts %>
   #
   # == Rendering partials with layouts
   #
@@ -205,28 +208,26 @@ module ActionView
   #       Deadline: <%= user.deadline %>
   #     <%- end -%>
   #   <% end %>
-  class PartialRenderer < AbstractRenderer #:nodoc:
-    PARTIAL_NAMES = Hash.new {|h,k| h[k] = {} }
+  class PartialRenderer < AbstractRenderer
+    PARTIAL_NAMES = Hash.new { |h,k| h[k] = {} }
 
     def initialize(*)
       super
-      @partial_names = PARTIAL_NAMES[@lookup_context.prefixes.first]
+      @context_prefix = @lookup_context.prefixes.first
+      @partial_names = PARTIAL_NAMES[@context_prefix]
     end
 
     def render(context, options, block)
       setup(context, options, block)
+      identifier = (@template = find_partial) ? @template.identifier : @path
 
-      wrap_formats(@path) do
-        identifier = ((@template = find_partial) ? @template.identifier : @path)
-
-        if @collection
-          instrument(:collection, :identifier => identifier || "collection", :count => @collection.size) do
-            render_collection
-          end
-        else
-          instrument(:partial, :identifier => identifier) do
-            render_partial
-          end
+      if @collection
+        instrument(:collection, :identifier => identifier || "collection", :count => @collection.size) do
+          render_collection
+        end
+      else
+        instrument(:partial, :identifier => identifier) do
+          render_partial
         end
       end
     end
@@ -270,6 +271,7 @@ module ActionView
       @options = options
       @locals  = options[:locals] || {}
       @block   = block
+      @details = extract_details(options)
 
       if String === partial
         @object     = options[:object]
@@ -292,6 +294,13 @@ module ActionView
         paths.map! { |path| retrieve_variable(path).unshift(path) }
       end
 
+      if String === partial && @variable.to_s !~ /^[a-z_][a-zA-Z_0-9]*$/
+        raise ArgumentError.new("The partial name (#{partial}) is not a valid Ruby identifier; " +
+                                "make sure your partial name starts with a letter or underscore, " +
+                                "and is followed by any combinations of letters, numbers, or underscores.")
+      end
+
+      extract_format(@path, @details)
       self
     end
 
@@ -319,7 +328,7 @@ module ActionView
 
     def find_template(path=@path, locals=@locals.keys)
       prefixes = path.include?(?/) ? [] : @lookup_context.prefixes
-      @lookup_context.find_template(path, prefixes, true, locals)
+      @lookup_context.find_template(path, prefixes, true, locals, @details)
     end
 
     def collection_with_template
@@ -355,27 +364,37 @@ module ActionView
     end
 
     def partial_path(object = @object)
-      @partial_names[object.class.name] ||= begin
-        object = object.to_model if object.respond_to?(:to_model)
-        object.class.model_name.partial_path.dup.tap do |partial|
-          path = @lookup_context.prefixes.first
-          merge_path_into_partial(path, partial)
+      object = object.to_model if object.respond_to?(:to_model)
+
+      path = if object.respond_to?(:to_partial_path)
+        object.to_partial_path
+      else
+        klass = object.class
+        if klass.respond_to?(:model_name)
+          ActiveSupport::Deprecation.warn "ActiveModel-compatible objects whose classes return a #model_name that responds to #partial_path are deprecated. Please respond to #to_partial_path directly instead."
+          klass.model_name.partial_path
+        else
+          raise ArgumentError.new("'#{object.inspect}' is not an ActiveModel-compatible object that returns a valid partial path.")
         end
       end
+
+      @partial_names[path] ||= merge_prefix_into_object_path(@context_prefix, path.dup)
     end
 
-    def merge_path_into_partial(path, partial)
-      if path.include?(?/) && partial.include?(?/)
-        overlap = []
-        path_array = File.dirname(path).split('/')
-        partial_array = partial.split('/')[0..-3] # skip model dir & partial
+    def merge_prefix_into_object_path(prefix, object_path)
+      if prefix.include?(?/) && object_path.include?(?/)
+        prefixes = []
+        prefix_array = File.dirname(prefix).split('/')
+        object_path_array = object_path.split('/')[0..-3] # skip model dir & partial
 
-        path_array.each_with_index do |dir, index|
-          overlap << dir if dir == partial_array[index]
+        prefix_array.each_with_index do |dir, index|
+          break if dir == object_path_array[index]
+          prefixes << dir
         end
 
-        partial.gsub!(/^#{overlap.join('/')}\//,'')
-        partial.insert(0, "#{File.dirname(path)}/")
+        (prefixes << object_path).join("/")
+      else
+        object_path
       end
     end
 

data/lib/action_view/renderer/template_renderer.rb

@@ -4,13 +4,12 @@ require 'active_support/core_ext/array/wrap'
 module ActionView
   class TemplateRenderer < AbstractRenderer #:nodoc:
     def render(context, options)
-      @view = context
-
-      wrap_formats(options[:template] || options[:file]) do
-        template = determine_template(options)
-        freeze_formats(template.formats, true)
-        render_template(template, options[:layout], options[:locals])
-      end
+      @view    = context
+      @details = extract_details(options)
+      extract_format(options[:file] || options[:template], @details)
+      template = determine_template(options)
+      freeze_formats(template.formats, true)
+      render_template(template, options[:layout], options[:locals])
     end
 
     # Determine the template to be rendered using the given options.
@@ -20,13 +19,13 @@ module ActionView
       if options.key?(:text)
         Template::Text.new(options[:text], formats.try(:first))
       elsif options.key?(:file)
-        with_fallbacks { find_template(options[:file], nil, false, keys) }
+        with_fallbacks { find_template(options[:file], nil, false, keys, @details) }
       elsif options.key?(:inline)
         handler = Template.handler_for_extension(options[:type] || "erb")
         Template.new(options[:inline], "inline template", handler, :locals => keys)
       elsif options.key?(:template)
         options[:template].respond_to?(:render) ?
-          options[:template] : find_template(options[:template], options[:prefixes], false, keys)
+          options[:template] : find_template(options[:template], options[:prefixes], false, keys, @details)
       end
     end
 
@@ -59,15 +58,28 @@ module ActionView
     # context object. If no layout is found, it checks if at least a layout with
     # the given name exists across all details before raising the error.
     def find_layout(layout, keys)
-      begin
-        with_layout_format do
-          layout =~ /^\// ?
-            with_fallbacks { find_template(layout, nil, false, keys) } : find_template(layout, nil, false, keys)
-        end
-      rescue ActionView::MissingTemplate
-        update_details(:formats => nil) do
-          raise unless template_exists?(layout)
+      with_layout_format { resolve_layout(layout, keys) }
+    end
+
+    def resolve_layout(layout, keys)
+      case layout
+      when String
+        begin
+          if layout =~ /^\//
+            with_fallbacks { find_template(layout, nil, false, keys, @details) }
+          else
+            find_template(layout, nil, false, keys, @details)
+          end
+        rescue ActionView::MissingTemplate
+          all_details = @details.merge(:formats => @lookup_context.default_formats)
+          raise unless template_exists?(layout, nil, false, keys, all_details)
         end
+      when Proc
+        resolve_layout(layout.call, keys)
+      when FalseClass
+        nil
+      else
+        layout
       end
     end
   end

data/lib/action_view/template.rb

@@ -91,7 +91,6 @@ module ActionView
 
     eager_autoload do
       autoload :Error
-      autoload :Handler
       autoload :Handlers
       autoload :Text
     end

data/lib/action_view/template/error.rb

@@ -57,6 +57,7 @@ module ActionView
       attr_reader :original_exception, :backtrace
 
       def initialize(template, assigns, original_exception)
+        super(original_exception.message)
         @template, @assigns, @original_exception = template, assigns.dup, original_exception
         @sub_templates = nil
         @backtrace = original_exception.backtrace
@@ -66,10 +67,6 @@ module ActionView
         @template.identifier
       end
 
-      def message
-        original_exception.message
-      end
-
       def sub_template_message
         if @sub_templates
           "Trace of template inclusion: " +
@@ -92,10 +89,14 @@ module ActionView
         line_counter = start_on_line
         return unless source_code = source_code[start_on_line..end_on_line]
 
-        source_code.sum do |line|
+        extract = source_code.sum do |line|
           line_counter += 1
           "#{indent}#{line_counter}: #{line}\n"
         end
+
+        extract.encode! if extract.respond_to?(:encode!)
+
+        extract
       end
 
       def sub_template_of(template_path)

data/lib/action_view/template/handlers.rb

@@ -41,12 +41,6 @@ module ActionView #:nodoc:
         @@default_template_handlers = klass
       end
 
-      def handler_class_for_extension(extension)
-        ActiveSupport::Deprecation.warn "handler_class_for_extension is deprecated. " <<
-          "Please use handler_for_extension instead", caller
-        handler_for_extension(extension)
-      end
-
       def handler_for_extension(extension)
         registered_template_handler(extension) || @@default_template_handlers
       end

data/lib/action_view/template/handlers/builder.rb

@@ -6,12 +6,21 @@ module ActionView
       self.default_format = Mime::XML
 
       def call(template)
-        require 'builder'
+        require_engine
         "xml = ::Builder::XmlMarkup.new(:indent => 2);" +
           "self.output_buffer = xml.target!;" +
           template.source +
           ";xml.target!;"
       end
+
+      protected
+
+      def require_engine
+        @required ||= begin
+          require "builder"
+          true
+        end
+      end
     end
   end
 end