actionpack 1.11.2 → 1.12.0

data/lib/action_controller/layout.rb

@@ -1,16 +1,16 @@
 module ActionController #:nodoc:
   module Layout #:nodoc:
-    def self.append_features(base)
-      super
+    def self.included(base)
+      base.extend(ClassMethods)
       base.class_eval do
         alias_method :render_with_no_layout, :render
         alias_method :render, :render_with_a_layout
 
         class << self
           alias_method :inherited_without_layout, :inherited
+          alias_method :inherited, :inherited_with_layout
         end
       end
-      base.extend(ClassMethods)
     end
 
     # Layouts reverse the common pattern of including shared headers and footers in many templates to isolate changes in
@@ -66,9 +66,11 @@ module ActionController #:nodoc:
     # <tt>app/views/layouts/weblog.rhtml</tt> or <tt>app/views/layouts/weblog.rxml</tt> exists then it will be automatically set as
     # the layout for your WeblogController. You can create a layout with the name <tt>application.rhtml</tt> or <tt>application.rxml</tt>
     # and this will be set as the default controller if there is no layout with the same name as the current controller and there is 
-    # no layout explicitly assigned with the +layout+ method. Setting a layout explicitly will always override the automatic behaviour
-    # for the controller where the layout is set. Explicitly setting the layout in a parent class, though, will not override the 
-    # child class's layout assignement if the child class has a layout with the same name. 
+    # no layout explicitly assigned with the +layout+ method. Nested controllers use the same folder structure for automatic layout.
+    # assignment. So an Admin::WeblogController will look for a template named <tt>app/views/layouts/admin/weblog.rhtml</tt>.
+    # Setting a layout explicitly will always override the automatic behaviour for the controller where the layout is set.
+    # Explicitly setting the layout in a parent class, though, will not override the child class's layout assignement if the child
+    # class has a layout with the same name. 
     #
     # == Inheritance for layouts
     #
@@ -168,17 +170,23 @@ module ActionController #:nodoc:
       end
 
       def layout_conditions #:nodoc:
-        read_inheritable_attribute("layout_conditions")
+        @layout_conditions ||= read_inheritable_attribute("layout_conditions")
+      end
+      
+      def default_layout #:nodoc:
+        @default_layout ||= read_inheritable_attribute("layout")
       end
 
       private
-        def inherited(child)
+        def inherited_with_layout(child)
           inherited_without_layout(child)
-          child.layout(child.controller_name) unless layout_list.grep(/^#{child.controller_name}\.r(?:x|ht)ml$/).empty?
+          child.send :include, Reloadable
+          layout_match = child.name.underscore.sub(/_controller$/, '').sub(/^controllers\//, '')
+          child.layout(layout_match) unless layout_list.grep(%r{layouts/#{layout_match}\.[a-z][0-9a-z]*$}).empty?
         end
 
         def layout_list
-          Dir.glob("#{template_root}/layouts/*.r{x,ht}ml").map { |layout| File.basename(layout) }
+          Dir.glob("#{template_root}/layouts/**/*")
         end
 
         def add_layout_conditions(conditions)
@@ -188,6 +196,12 @@ module ActionController #:nodoc:
         def normalize_conditions(conditions)
           conditions.inject({}) {|hash, (key, value)| hash.merge(key => [value].flatten.map {|action| action.to_s})}
         end
+        
+        def layout_directory_exists_cache
+          @@layout_directory_exists_cache ||= Hash.new do |h, dirname|
+            h[dirname] = File.directory? dirname
+          end
+        end
     end
 
     # Returns the name of the active layout. If the layout was specified as a method reference (through a symbol), this method
@@ -195,18 +209,27 @@ module ActionController #:nodoc:
     # object). If the layout was defined without a directory, layouts is assumed. So <tt>layout "weblog/standard"</tt> will return
     # weblog/standard, but <tt>layout "standard"</tt> will return layouts/standard.
     def active_layout(passed_layout = nil)
-      layout = passed_layout || self.class.read_inheritable_attribute("layout")
+      layout = passed_layout || self.class.default_layout
 
       active_layout = case layout
+        when String then layout
         when Symbol then send(layout)
         when Proc   then layout.call(self)
-        when String then layout
       end
-
-      active_layout.include?("/") ? active_layout : "layouts/#{active_layout}" if active_layout
+      
+      # Explicitly passed layout names with slashes are looked up relative to the template root,
+      # but auto-discovered layouts derived from a nested controller will contain a slash, though be relative
+      # to the 'layouts' directory so we have to check the file system to infer which case the layout name came from.
+      if active_layout
+        if active_layout.include?('/') && ! layout_directory?(active_layout)
+          active_layout
+        else
+          "layouts/#{active_layout}"
+        end
+      end
     end
 
-    def render_with_a_layout(options = nil, deprecated_status = nil, deprecated_layout = nil) #:nodoc:
+    def render_with_a_layout(options = nil, deprecated_status = nil, deprecated_layout = nil, &block) #:nodoc:
       template_with_options = options.is_a?(Hash)
 
       if apply_layout?(template_with_options, options) && (layout = pick_layout(template_with_options, options, deprecated_layout))
@@ -214,10 +237,10 @@ module ActionController #:nodoc:
         logger.info("Rendering #{options} within #{layout}") if logger
 
         if template_with_options
-          content_for_layout = render_with_no_layout(options)
+          content_for_layout = render_with_no_layout(options, &block)
           deprecated_status = options[:status] || deprecated_status
         else
-          content_for_layout = render_with_no_layout(options, deprecated_status)
+          content_for_layout = render_with_no_layout(options, deprecated_status, &block)
         end
 
         erase_render_results
@@ -225,17 +248,21 @@ module ActionController #:nodoc:
         @template.instance_variable_set("@content_for_layout", content_for_layout)
         render_text(@template.render_file(layout, true), deprecated_status)
       else
-        render_with_no_layout(options, deprecated_status)
+        render_with_no_layout(options, deprecated_status, &block)
       end
     end
 
     private
+    
       def apply_layout?(template_with_options, options)
-        if template_with_options
-          (options.has_key?(:layout) && options[:layout]!=false) || options.values_at(:text, :file, :inline, :partial, :nothing).compact.empty?
-        else
-          true
-        end
+        return false if options == :update
+        template_with_options ?  candidate_for_layout?(options) : !template_exempt_from_layout?
+      end
+
+      def candidate_for_layout?(options)
+        (options.has_key?(:layout) && options[:layout] != false) || 
+        options.values_at(:text, :xml, :file, :inline, :partial, :nothing).compact.empty? &&
+        !template_exempt_from_layout?(default_template_name(options[:action] || options[:template]))
       end
 
       def pick_layout(template_with_options, options, deprecated_layout)
@@ -269,5 +296,13 @@ module ActionController #:nodoc:
           true
         end
       end
+      
+      # Does a layout directory for this class exist?
+      # we cache this info in a class level hash
+      def layout_directory?(layout_name)
+        template_path = File.join(self.class.view_root, 'layouts', layout_name)
+        dirname = File.dirname(template_path)
+        self.class.send(:layout_directory_exists_cache)[dirname]
+      end
   end
 end

data/lib/action_controller/mime_responds.rb

@@ -0,0 +1,163 @@
+module ActionController #:nodoc:
+  module MimeResponds #:nodoc:
+    def self.included(base)
+      base.send(:include, ActionController::MimeResponds::InstanceMethods)
+    end
+
+    module InstanceMethods
+      # Without web-service support, an action which collects the data for displaying a list of people
+      # might look something like this:
+      #
+      #   def list
+      #     @people = Person.find(:all)
+      #   end
+      # 
+      # Here's the same action, with web-service support baked in:
+      # 
+      #   def list
+      #     @people = Person.find(:all)
+      # 
+      #     respond_to do |wants|
+      #       wants.html
+      #       wants.xml { render :xml => @people.to_xml }
+      #     end
+      #   end
+      # 
+      # What that says is, "if the client wants HTML in response to this action, just respond as we 
+      # would have before, but if the client wants XML, return them the list of people in XML format." 
+      # (Rails determines the desired response format from the HTTP Accept header submitted by the client.)
+      # 
+      # Supposing you have an action that adds a new person, optionally creating their company 
+      # (by name) if it does not already exist, without web-services, it might look like this:
+      # 
+      #   def add
+      #     @company = Company.find_or_create_by_name(params[:company][:name])
+      #     @person  = @company.people.create(params[:person])
+      # 
+      #     redirect_to(person_list_url)
+      #   end
+      # 
+      # Here's the same action, with web-service support baked in:
+      # 
+      #   def add
+      #     company  = params[:person].delete(:company)
+      #     @company = Company.find_or_create_by_name(company[:name])
+      #     @person  = @company.people.create(params[:person])
+      # 
+      #     respond_to do |wants|
+      #       wants.html { redirect_to(person_list_url) }
+      #       wants.js
+      #       wants.xml  { render :xml => @person.to_xml(:include => @company) }
+      #     end
+      #   end
+      # 
+      # If the client wants HTML, we just redirect them back to the person list. If they want Javascript 
+      # (wants.js), then it is an RJS request and we render the RJS template associated with this action. 
+      # Lastly, if the client wants XML, we render the created person as XML, but with a twist: we also 
+      # include the person’s company in the rendered XML, so you get something like this:
+      # 
+      #   <person>
+      #     <id>...</id>
+      #     ...
+      #     <company>
+      #       <id>...</id>
+      #       <name>...</name>
+      #       ...
+      #     </company>
+      #   </person>
+      # 
+      # Note, however, the extra bit at the top of that action:
+      # 
+      #   company  = params[:person].delete(:company)
+      #   @company = Company.find_or_create_by_name(company[:name])
+      # 
+      # This is because the incoming XML document (if a web-service request is in process) can only contain a 
+      # single root-node. So, we have to rearrange things so that the request looks like this (url-encoded):
+      # 
+      #   person[name]=...&person[company][name]=...&...
+      # 
+      # And, like this (xml-encoded):
+      # 
+      #   <person>
+      #     <name>...</name>
+      #     <company>
+      #       <name>...</name>
+      #     </company>
+      #   </person>
+      # 
+      # In other words, we make the request so that it operates on a single entity—a person. Then, in the action, 
+      # we extract the company data from the request, find or create the company, and then create the new person 
+      # with the remaining data.
+      # 
+      # Note that you can define your own XML parameter parser which would allow you to describe multiple entities 
+      # in a single request (i.e., by wrapping them all in a single root note), but if you just go with the flow 
+      # and accept Rails' defaults, life will be much easier.
+      def respond_to(*types, &block)
+        raise ArgumentError, "respond_to takes either types or a block, never bot" unless types.any? ^ block
+        block ||= lambda { |responder| types.each { |type| responder.send(type) } }
+        responder = Responder.new(block.binding)
+        block.call(responder)
+        responder.respond
+      end
+    end
+    
+    class Responder #:nodoc:
+      DEFAULT_BLOCKS = {
+        :html    => 'Proc.new { render }',
+        :js      => 'Proc.new { render :action => "#{action_name}.rjs" }',
+        :xml     => 'Proc.new { render :action => "#{action_name}.rxml" }'
+      }
+      
+      def initialize(block_binding)
+        @block_binding = block_binding
+        @mime_type_priority = eval("request.accepts", block_binding)
+        @order     = []
+        @responses = {}
+      end
+
+      def custom(mime_type, &block)
+        mime_type = mime_type.is_a?(Mime::Type) ? mime_type : Mime::Type.lookup(mime_type.to_s)
+        
+        @order << mime_type
+        
+        if block_given?
+          @responses[mime_type] = block
+        else
+          @responses[mime_type] = eval(DEFAULT_BLOCKS[mime_type.to_sym], @block_binding)
+        end
+      end
+      
+      for mime_type in %w( all html js xml rss atom yaml )
+        eval <<-EOT
+          def #{mime_type}(&block)
+            custom(Mime::#{mime_type.upcase}, &block)
+          end
+        EOT
+      end
+
+      def any(*args, &block)
+        args.each { |type| send(type, &block) }
+      end
+      
+      def respond
+        for priority in @mime_type_priority
+          if priority == Mime::ALL
+            @responses[@order.first].call
+            return
+          else
+            if priority === @order
+              @responses[priority].call
+              return # mime type match found, be happy and return
+            end
+          end
+        end
+        
+        if @order.include?(Mime::ALL)
+          @responses[Mime::ALL].call
+        else
+          eval 'render(:nothing => true, :status => "406 Not Acceptable")', @block_binding
+        end
+      end
+    end
+  end
+end

data/lib/action_controller/mime_type.rb

@@ -0,0 +1,142 @@
+module Mime
+  class Type #:nodoc:
+    # A simple helper class used in parsing the accept header
+    class AcceptItem #:nodoc:
+      attr_accessor :order, :name, :q
+
+      def initialize(order, name, q=nil)
+        @order = order
+        @name = name.strip
+        q ||= 0.0 if @name == "*/*" # default "*/*" to end of list
+        @q = ((q || 1.0).to_f * 100).to_i
+      end
+
+      def to_s
+        @name
+      end
+
+      def <=>(item)
+        result = item.q <=> q
+        result = order <=> item.order if result == 0
+        result
+      end
+
+      def ==(item)
+        name == (item.respond_to?(:name) ? item.name : item)
+      end
+    end
+
+    class << self
+      def lookup(string)
+        LOOKUP[string]
+      end
+
+      def parse(accept_header)
+        # keep track of creation order to keep the subsequent sort stable
+        index = 0
+        list = accept_header.split(/,/).
+          map! { |i| AcceptItem.new(index += 1, *i.split(/;\s*q=/)) }.sort!
+
+        # Take care of the broken text/xml entry by renaming or deleting it
+  
+        text_xml = list.index("text/xml")
+        app_xml = list.index("application/xml")
+
+        if text_xml && app_xml
+          # set the q value to the max of the two
+          list[app_xml].q = [list[text_xml].q, list[app_xml].q].max
+
+          # make sure app_xml is ahead of text_xml in the list
+          if app_xml > text_xml
+            list[app_xml], list[text_xml] = list[text_xml], list[app_xml]
+            app_xml, text_xml = text_xml, app_xml
+          end
+
+          # delete text_xml from the list
+          list.delete_at(text_xml)
+  
+        elsif text_xml
+          list[text_xml].name = "application/xml"
+        end
+
+        # Look for more specific xml-based types and sort them ahead of app/xml
+
+        if app_xml
+          idx = app_xml
+          app_xml_type = list[app_xml]
+
+          while(idx < list.length)
+            type = list[idx]
+            break if type.q < app_xml_type.q
+            if type.name =~ /\+xml$/
+              list[app_xml], list[idx] = list[idx], list[app_xml]
+              app_xml = idx
+            end
+            idx += 1
+          end
+        end
+
+        list.map! { |i| Mime::Type.lookup(i.name) }.uniq!
+        list
+      end
+    end
+    
+    def initialize(string, symbol = nil, synonyms = [])
+      @symbol, @synonyms = symbol, synonyms
+      @string = string
+    end
+    
+    def to_s
+      @string
+    end
+    
+    def to_str
+      to_s
+    end
+    
+    def to_sym
+      @symbol || @string.to_sym
+    end
+
+    def ===(list)
+      if list.is_a?(Array)
+        (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
+      else
+        super
+      end
+    end
+    
+    def ==(mime_type)
+      (@synonyms + [ self ]).any? { |synonym| synonym.to_s == mime_type.to_s } if mime_type
+    end
+  end
+
+  ALL   = Type.new "*/*", :all
+  HTML  = Type.new "text/html", :html, %w( application/xhtml+xml )
+  JS    = Type.new "text/javascript", :js, %w( application/javascript application/x-javascript )
+  XML   = Type.new "application/xml", :xml, %w( text/xml application/x-xml )
+  RSS   = Type.new "application/rss+xml", :rss
+  ATOM  = Type.new "application/atom+xml", :atom
+  YAML  = Type.new "application/x-yaml", :yaml, %w( text/yaml )
+
+  LOOKUP = Hash.new { |h, k| h[k] = Type.new(k) }
+
+  LOOKUP["*/*"]                      = ALL
+
+  LOOKUP["text/html"]                = HTML
+  LOOKUP["application/xhtml+xml"]    = HTML
+
+  LOOKUP["application/xml"]          = XML
+  LOOKUP["text/xml"]                 = XML
+  LOOKUP["application/x-xml"]        = XML
+
+  LOOKUP["text/javascript"]          = JS
+  LOOKUP["application/javascript"]   = JS
+  LOOKUP["application/x-javascript"] = JS
+
+  LOOKUP["text/yaml"]                = YAML
+  LOOKUP["application/x-yaml"]       = YAML
+
+  LOOKUP["application/rss+xml"]      = RSS
+  LOOKUP["application/atom+xml"]     = ATOM
+end