eactionpack 2.1.2

data/lib/action_controller/layout.rb

@@ -0,0 +1,309 @@
+module ActionController #:nodoc:
+  module Layout #:nodoc:
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        # NOTE: Can't use alias_method_chain here because +render_without_layout+ is already
+        # defined as a publicly exposed method
+        alias_method :render_with_no_layout, :render
+        alias_method :render, :render_with_a_layout
+
+        class << self
+          alias_method_chain :inherited, :layout
+        end
+      end
+    end
+
+    # Layouts reverse the common pattern of including shared headers and footers in many templates to isolate changes in
+    # repeated setups. The inclusion pattern has pages that look like this:
+    #
+    #   <%= render "shared/header" %>
+    #   Hello World
+    #   <%= render "shared/footer" %>
+    #
+    # This approach is a decent way of keeping common structures isolated from the changing content, but it's verbose
+    # and if you ever want to change the structure of these two includes, you'll have to change all the templates.
+    #
+    # With layouts, you can flip it around and have the common structure know where to insert changing content. This means
+    # that the header and footer are only mentioned in one place, like this:
+    #
+    #   // The header part of this layout
+    #   <%= yield %>
+    #   // The footer part of this layout
+    #
+    # And then you have content pages that look like this:
+    #
+    #    hello world
+    #
+    # At rendering time, the content page is computed and then inserted in the layout, like this:
+    #
+    #   // The header part of this layout
+    #   hello world
+    #   // The footer part of this layout
+    #
+    # NOTE: The old notation for rendering the view from a layout was to expose the magic <tt>@content_for_layout</tt> instance
+    # variable. The preferred notation now is to use <tt>yield</tt>, as documented above.
+    #
+    # == Accessing shared variables
+    #
+    # Layouts have access to variables specified in the content pages and vice versa. This allows you to have layouts with
+    # references that won't materialize before rendering time:
+    #
+    #   <h1><%= @page_title %></h1>
+    #   <%= yield %>
+    #
+    # ...and content pages that fulfill these references _at_ rendering time:
+    #
+    #    <% @page_title = "Welcome" %>
+    #    Off-world colonies offers you a chance to start a new life
+    #
+    # The result after rendering is:
+    #
+    #   <h1>Welcome</h1>
+    #   Off-world colonies offers you a chance to start a new life
+    #
+    # == Automatic layout assignment
+    #
+    # If there is a template in <tt>app/views/layouts/</tt> with the same name as the current controller then it will be automatically
+    # set as that controller's layout unless explicitly told otherwise. Say you have a WeblogController, for example. If a template named
+    # <tt>app/views/layouts/weblog.erb</tt> or <tt>app/views/layouts/weblog.builder</tt> exists then it will be automatically set as
+    # the layout for your WeblogController. You can create a layout with the name <tt>application.erb</tt> or <tt>application.builder</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. 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.erb</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 assignment if the child
+    # class has a layout with the same name.
+    #
+    # == Inheritance for layouts
+    #
+    # Layouts are shared downwards in the inheritance hierarchy, but not upwards. Examples:
+    #
+    #   class BankController < ActionController::Base
+    #     layout "bank_standard"
+    #
+    #   class InformationController < BankController
+    #
+    #   class VaultController < BankController
+    #     layout :access_level_layout
+    #
+    #   class EmployeeController < BankController
+    #     layout nil
+    #
+    # The InformationController uses "bank_standard" inherited from the BankController, the VaultController overwrites
+    # and picks the layout dynamically, and the EmployeeController doesn't want to use a layout at all.
+    #
+    # == Types of layouts
+    #
+    # Layouts are basically just regular templates, but the name of this template needs not be specified statically. Sometimes
+    # you want to alternate layouts depending on runtime information, such as whether someone is logged in or not. This can
+    # be done either by specifying a method reference as a symbol or using an inline method (as a proc).
+    #
+    # The method reference is the preferred approach to variable layouts and is used like this:
+    #
+    #   class WeblogController < ActionController::Base
+    #     layout :writers_and_readers
+    #
+    #     def index
+    #       # fetching posts
+    #     end
+    #
+    #     private
+    #       def writers_and_readers
+    #         logged_in? ? "writer_layout" : "reader_layout"
+    #       end
+    #
+    # Now when a new request for the index action is processed, the layout will vary depending on whether the person accessing
+    # is logged in or not.
+    #
+    # If you want to use an inline method, such as a proc, do something like this:
+    #
+    #   class WeblogController < ActionController::Base
+    #     layout proc{ |controller| controller.logged_in? ? "writer_layout" : "reader_layout" }
+    #
+    # Of course, the most common way of specifying a layout is still just as a plain template name:
+    #
+    #   class WeblogController < ActionController::Base
+    #     layout "weblog_standard"
+    #
+    # If no directory is specified for the template name, the template will by default be looked for in <tt>app/views/layouts/</tt>.
+    # Otherwise, it will be looked up relative to the template root.
+    #
+    # == Conditional layouts
+    #
+    # If you have a layout that by default is applied to all the actions of a controller, you still have the option of rendering
+    # a given action or set of actions without a layout, or restricting a layout to only a single action or a set of actions. The
+    # <tt>:only</tt> and <tt>:except</tt> options can be passed to the layout call. For example:
+    #
+    #   class WeblogController < ActionController::Base
+    #     layout "weblog_standard", :except => :rss
+    #
+    #     # ...
+    #
+    #   end
+    #
+    # This will assign "weblog_standard" as the WeblogController's layout  except for the +rss+ action, which will not wrap a layout
+    # around the rendered view.
+    #
+    # Both the <tt>:only</tt> and <tt>:except</tt> condition can accept an arbitrary number of method references, so
+    # #<tt>:except => [ :rss, :text_only ]</tt> is valid, as is <tt>:except => :rss</tt>.
+    #
+    # == Using a different layout in the action render call
+    #
+    # If most of your actions use the same layout, it makes perfect sense to define a controller-wide layout as described above.
+    # Sometimes you'll have exceptions where one action wants to use a different layout than the rest of the controller.
+    # You can do this by passing a <tt>:layout</tt> option to the <tt>render</tt> call. For example:
+    #
+    #   class WeblogController < ActionController::Base
+    #     layout "weblog_standard"
+    #
+    #     def help
+    #       render :action => "help", :layout => "help"
+    #     end
+    #   end
+    #
+    # This will render the help action with the "help" layout instead of the controller-wide "weblog_standard" layout.
+    module ClassMethods
+      # If a layout is specified, all rendered actions will have their result rendered
+      # when the layout <tt>yield</tt>s. This layout can itself depend on instance variables assigned during action
+      # performance and have access to them as any normal template would.
+      def layout(template_name, conditions = {}, auto = false)
+        add_layout_conditions(conditions)
+        write_inheritable_attribute "layout", template_name
+        write_inheritable_attribute "auto_layout", auto
+      end
+
+      def layout_conditions #:nodoc:
+        @layout_conditions ||= read_inheritable_attribute("layout_conditions")
+      end
+
+      def default_layout(format) #:nodoc:
+        layout = read_inheritable_attribute("layout")
+        return layout unless read_inheritable_attribute("auto_layout")
+        @default_layout ||= {}
+        @default_layout[format] ||= default_layout_with_format(format, layout)
+        @default_layout[format]
+      end
+
+      def layout_list #:nodoc:
+        Array(view_paths).sum([]) { |path| Dir["#{path}/layouts/**/*"] }
+      end
+
+      private
+        def inherited_with_layout(child)
+          inherited_without_layout(child)
+          unless child.name.blank?
+            layout_match = child.name.underscore.sub(/_controller$/, '').sub(/^controllers\//, '')
+            child.layout(layout_match, {}, true) unless child.layout_list.grep(%r{layouts/#{layout_match}(\.[a-z][0-9a-z]*)+$}).empty?
+          end
+        end
+
+        def add_layout_conditions(conditions)
+          write_inheritable_hash "layout_conditions", normalize_conditions(conditions)
+        end
+
+        def normalize_conditions(conditions)
+          conditions.inject({}) {|hash, (key, value)| hash.merge(key => [value].flatten.map {|action| action.to_s})}
+        end
+
+        def default_layout_with_format(format, layout)
+          list = layout_list
+          if list.grep(%r{layouts/#{layout}\.#{format}(\.[a-z][0-9a-z]*)+$}).empty?
+            (!list.grep(%r{layouts/#{layout}\.([a-z][0-9a-z]*)+$}).empty? && format == :html) ? layout : nil
+          else
+            layout
+          end
+        end
+    end
+
+    # Returns the name of the active layout. If the layout was specified as a method reference (through a symbol), this method
+    # is called and the return value is used. Likewise if the layout was specified as an inline method (through a proc or method
+    # 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.default_layout(response.template.template_format)
+      active_layout = case layout
+        when String then layout
+        when Symbol then send!(layout)
+        when Proc   then layout.call(self)
+      end
+
+      # 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
+
+    protected
+      def render_with_a_layout(options = nil, extra_options = {}, &block) #:nodoc:
+        template_with_options = options.is_a?(Hash)
+
+        if (layout = pick_layout(template_with_options, options)) && apply_layout?(template_with_options, options)
+          options = options.merge :layout => false if template_with_options
+          logger.info("Rendering template within #{layout}") if logger
+
+          content_for_layout = render_with_no_layout(options, extra_options, &block)
+          erase_render_results
+          add_variables_to_assigns
+          @template.instance_variable_set("@content_for_layout", content_for_layout)
+          response.layout = layout
+          status = template_with_options ? options[:status] : nil
+          render_for_text(@template.render_file(layout, true), status)
+        else
+          render_with_no_layout(options, extra_options, &block)
+        end
+      end
+
+
+    private
+      def apply_layout?(template_with_options, options)
+        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, :json, :js, :file, :inline, :partial, :nothing).compact.empty? &&
+          !template_exempt_from_layout?(options[:template] || default_template_name(options[:action]))
+      end
+
+      def pick_layout(template_with_options, options)
+        if template_with_options
+          case layout = options[:layout]
+            when FalseClass
+              nil
+            when NilClass, TrueClass
+              active_layout if action_has_layout?
+            else
+              active_layout(layout)
+          end
+        else
+          active_layout if action_has_layout?
+        end
+      end
+
+      def action_has_layout?
+        if conditions = self.class.layout_conditions
+          case
+            when only = conditions[:only]
+              only.include?(action_name)
+            when except = conditions[:except]
+              !except.include?(action_name)
+            else
+              true
+          end
+        else
+          true
+        end
+      end
+
+      def layout_directory?(layout_name)
+        @template.finder.find_template_extension_from_handler(File.join('layouts', layout_name))
+      end
+  end
+end

data/lib/action_controller/mime_responds.rb

@@ -0,0 +1,173 @@
+module ActionController #:nodoc:
+  module MimeResponds #:nodoc:
+    def self.included(base)
+      base.module_eval do
+        include ActionController::MimeResponds::InstanceMethods
+      end
+    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 index
+      #     @people = Person.find(:all)
+      #   end
+      #
+      # Here's the same action, with web-service support baked in:
+      #
+      #   def index
+      #     @people = Person.find(:all)
+      #
+      #     respond_to do |format|
+      #       format.html
+      #       format.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 create
+      #     @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 create
+      #     company  = params[:person].delete(:company)
+      #     @company = Company.find_or_create_by_name(company[:name])
+      #     @person  = @company.people.create(params[:person])
+      #
+      #     respond_to do |format|
+      #       format.html { redirect_to(person_list_url) }
+      #       format.js
+      #       format.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
+      # (format.js), then it is an JS request and we render the js.erb 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's 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 node), but if you just go with the flow
+      # and accept Rails' defaults, life will be much easier.
+      #
+      # If you need to use a MIME type which isn't supported by default, you can register your own handlers in
+      # environment.rb as follows.
+      #
+      #   Mime::Type.register "image/jpg", :jpg
+      def respond_to(*types, &block)
+        raise ArgumentError, "respond_to takes either types or a block, never both" unless types.any? ^ block
+        block ||= lambda { |responder| types.each { |type| responder.send(type) } }
+        responder = Responder.new(self)
+        block.call(responder)
+        responder.respond
+      end
+    end
+
+    class Responder #:nodoc:
+      def initialize(controller)
+        @controller = controller
+        @request    = controller.request
+        @response   = controller.response
+        
+        @mime_type_priority = Array(Mime::Type.lookup_by_extension(@request.parameters[:format]) || @request.accepts)
+
+        @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
+        @responses[mime_type] ||= Proc.new do
+          @response.template.template_format = mime_type.to_sym
+          @response.content_type = mime_type.to_s
+          block_given? ? block.call : @controller.send(:render, :action => @controller.action_name)
+        end
+      end
+
+      def any(*args, &block)
+        if args.any?
+          args.each { |type| send(type, &block) }
+        else
+          custom(@mime_type_priority.first, &block)
+        end
+      end
+
+      def method_missing(symbol, &block)
+        mime_constant = symbol.to_s.upcase
+
+        if Mime::SET.include?(Mime.const_get(mime_constant))
+          custom(Mime.const_get(mime_constant), &block)
+        else
+          super
+        end
+      end
+
+      def respond
+        for priority in @mime_type_priority
+          if priority == Mime::ALL
+            @responses[@order.first].call
+            return
+          else
+            if @responses[priority]
+              @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
+          @controller.send :head, :not_acceptable
+        end
+      end
+    end
+  end
+end