actionpack 1.12.3 → 1.12.4

data/lib/action_controller/layout.rb

@@ -27,7 +27,7 @@ module ActionController #:nodoc:
     # that the header and footer are only mentioned in one place, like this:
     #
     #   <!-- The header part of this layout -->
-    #   <%= @content_for_layout %>
+    #   <%= yield %>
     #   <!-- The footer part of this layout -->
     #
     # And then you have content pages that look like this:
@@ -47,7 +47,7 @@ module ActionController #:nodoc:
     # references that won't materialize before rendering time:
     #
     #   <h1><%= @page_title %></h1>
-    #   <%= @content_for_layout %>
+    #   <%= yield %>
     #
     # ...and content pages that fulfill these references _at_ rendering time:
     #
@@ -159,10 +159,12 @@ module ActionController #:nodoc:
     #
     # As you can see, you pass the template as the first parameter, the status code as the second ("200" is OK), and the layout
     # as the third.
+    #
+    # 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.
     module ClassMethods
-      # If a layout is specified, all actions rendered through render and render_action will have their result assigned 
-      # to <tt>@content_for_layout</tt>, which can then be used by the layout to insert their contents with
-      # <tt><%= @content_for_layout %></tt>. This layout can itself depend on instance variables assigned during action
+      # 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 = {})
         add_layout_conditions(conditions)

data/lib/action_controller/mime_responds.rb

@@ -92,6 +92,12 @@ module ActionController #:nodoc:
       # 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.
+      # 
+      # 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 bot" unless types.any? ^ block
         block ||= lambda { |responder| types.each { |type| responder.send(type) } }
@@ -160,4 +166,4 @@ module ActionController #:nodoc:
       end
     end
   end
-end
+end

data/lib/action_controller/pagination.rb

@@ -31,7 +31,7 @@ module ActionController
   # instance variable, which is an ordered collection of model objects for the
   # current page (at most 20, sorted by last name and first name), and a 
   # <tt>@person_pages</tt> Paginator instance. The current page is determined
-  # by the <tt>@params['page']</tt> variable.
+  # by the <tt>params[:page]</tt> variable.
   #
   # ==== Pagination for a single action
   #
@@ -47,7 +47,7 @@ module ActionController
   # ==== Custom/"classic" pagination 
   #
   #   def list
-  #     @person_pages = Paginator.new self, Person.count, 10, @params['page']
+  #     @person_pages = Paginator.new self, Person.count, 10, params[:page]
   #     @people = Person.find :all, :order => 'last_name, first_name', 
   #                           :limit  =>  @person_pages.items_per_page,
   #                           :offset =>  @person_pages.current.offset

data/lib/action_controller/request.rb

@@ -1,5 +1,6 @@
 module ActionController
-  # These methods are available in both the production and test Request objects.
+  # Subclassing AbstractRequest makes these methods available to the request objects used in production and testing,
+  # CgiRequest and TestRequest
   class AbstractRequest
     cattr_accessor :relative_url_root
 
@@ -65,6 +66,7 @@ module ActionController
         end
     end
 
+    # Returns the accepted MIME type for the request
     def accepts
       @accepts ||=
         if @env['HTTP_ACCEPT'].to_s.strip.empty?
@@ -202,15 +204,21 @@ module ActionController
       host + port_string
     end
 
-    def path_parameters=(parameters)
+    def path_parameters=(parameters) #:nodoc:
       @path_parameters = parameters
       @symbolized_path_parameters = @parameters = nil
     end
 
-    def symbolized_path_parameters
+    # The same as <tt>path_parameters</tt> with explicitly symbolized keys 
+    def symbolized_path_parameters 
       @symbolized_path_parameters ||= path_parameters.symbolize_keys
     end
 
+    # Returns a hash with the parameters used to form the path of the request 
+    #
+    # Example: 
+    #
+    #   {:action => 'my_action', :controller => 'my_controller'}
     def path_parameters
       @path_parameters ||= {}
     end

data/lib/action_controller/routing.rb

@@ -218,7 +218,11 @@ module ActionController
           expr = "::#{controller.split('/').collect {|c| c.camelize}.join('::')}Controller"
           g.result :controller, expr, true
         end
-
+        
+        def file_kinds(kind)
+          ((@file_kinds ||= []) << kind).uniq! || @file_kinds
+        end
+        
         def traverse_to_controller(segments, start_at = 0)
           mod = ::Object
           length = segments.length
@@ -228,6 +232,7 @@ module ActionController
             return nil unless /\A[A-Za-z][A-Za-z\d_]*\Z/ =~ (segment = segments[index])
             index += 1
             
+            file_kinds :app
             mod_name = segment.camelize
             controller_name = "#{mod_name}Controller"
             path_suffix = File.join(segments[start_at..(index - 1)])
@@ -268,7 +273,7 @@ module ActionController
             $LOAD_PATH.select do |base|
               base = File.expand_path(base)
               extended_root = File.expand_path(RAILS_ROOT)
-              base[0, extended_root.length] == extended_root || base =~ %r{rails-[\d.]+/builtin}
+              base.match(/\A#{Regexp.escape(extended_root)}\/*#{file_kinds(:lib) * '|'}/) || base =~ %r{rails-[\d.]+/builtin}
             end
           else
             $LOAD_PATH

data/lib/action_controller/streaming.rb

@@ -14,7 +14,7 @@ module ActionController #:nodoc:
       # it feasible to send even large files.
       #
       # Be careful to sanitize the path parameter if it coming from a web
-      # page.  send_file(@params['path']) allows a malicious user to
+      # page.  send_file(params[:path]) allows a malicious user to
       # download any file on your server.
       #
       # Options:
@@ -28,6 +28,7 @@ module ActionController #:nodoc:
       #   or to read the entire file before sending (false). Defaults to true.
       # * <tt>:buffer_size</tt> - specifies size (in bytes) of the buffer used to stream the file.
       #   Defaults to 4096.
+      # * <tt>:status</tt> - specifies the status code to send with the response. Defaults to '200 OK'.
       #
       # The default Content-Type and Content-Disposition headers are
       # set to download arbitrary binary files in as many browsers as
@@ -37,9 +38,12 @@ module ActionController #:nodoc:
       # Simple download:
       #   send_file '/path/to.zip'
       #
-      # Show a JPEG in browser:
+      # Show a JPEG in the browser:
       #   send_file '/path/to.jpeg', :type => 'image/jpeg', :disposition => 'inline'
       #
+      # Show a 404 page in the browser:
+      #   send_file '/path/to/404.html, :type => 'text/html; charset=utf-8', :status => 404
+      #
       # Read about the other Content-* HTTP headers if you'd like to
       # provide the user with more information (such as Content-Description).
       # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
@@ -61,7 +65,7 @@ module ActionController #:nodoc:
         @performed_render = false
 
         if options[:stream]
-          render :text => Proc.new { |response, output|
+          render :status => options[:status], :text => Proc.new { |response, output|
             logger.info "Streaming file #{path}" unless logger.nil?
             len = options[:buffer_size] || 4096
             File.open(path, 'rb') do |file|
@@ -81,7 +85,7 @@ module ActionController #:nodoc:
           }
         else
           logger.info "Sending file #{path}" unless logger.nil?
-          File.open(path, 'rb') { |file| render :text => file.read }
+          File.open(path, 'rb') { |file| render :status => options[:status], :text => file.read }
         end
       end
 
@@ -93,6 +97,7 @@ module ActionController #:nodoc:
       # * <tt>:type</tt> - specifies an HTTP content type.
       #   Defaults to 'application/octet-stream'.
       # * <tt>:disposition</tt> - specifies whether the file will be shown inline or downloaded.  
+      # * <tt>:status</tt> - specifies the status code to send with the response. Defaults to '200 OK'.
       #   Valid values are 'inline' and 'attachment' (default).
       #
       # Generic data download:
@@ -109,7 +114,7 @@ module ActionController #:nodoc:
         logger.info "Sending data #{options[:filename]}" unless logger.nil?
         send_file_headers! options.merge(:length => data.size)
         @performed_render = false
-        render :text => data
+        render :status => options[:status], :text => data
       end
 
     private
@@ -139,4 +144,4 @@ module ActionController #:nodoc:
         @headers['Cache-Control'] = 'private' if @headers['Cache-Control'] == 'no-cache'
       end
   end
-end
+end

data/lib/action_controller/templates/scaffolds/layout.rhtml

@@ -63,7 +63,7 @@
 
 <p style="color: green"><%= flash[:notice] %></p>
 
-<%= @content_for_layout %>
+<%= yield %>
 
 </body>
 </html>

data/lib/action_controller/verification.rb

@@ -37,7 +37,7 @@ module ActionController #:nodoc:
       # is a hash consisting of the following key/value pairs:
       #
       # * <tt>:params</tt>: a single key or an array of keys that must
-      #   be in the @params hash in order for the action(s) to be safely
+      #   be in the <tt>params</tt> hash in order for the action(s) to be safely
       #   called.
       # * <tt>:session</tt>: a single key or an array of keys that must
       #   be in the @session in order for the action(s) to be safely called.

data/lib/action_pack/version.rb

@@ -2,7 +2,7 @@ module ActionPack #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 12
-    TINY  = 3
+    TINY  = 4
     
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/action_view/base.rb

@@ -11,7 +11,7 @@ module ActionView #:nodoc:
   # 
   # = ERb
   # 
-  # You trigger ERb by using embeddings such as <% %> and <%= %>. The difference is whether you want output or not. Consider the 
+  # You trigger ERb by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> tag set is used when you want output. Consider the 
   # following loop for names:
   #
   #   <b>Names of all the people</b>
@@ -19,12 +19,14 @@ module ActionView #:nodoc:
   #     Name: <%= person.name %><br/>
   #   <% end %>
   #
-  # The loop is setup in regular embedding tags (<% %>) and the name is written using the output embedding tag (<%= %>). Note that this
+  # The loop is setup in regular embedding tags <% %> and the name is written using the output embedding tag <%= %>. Note that this
   # is not just a usage suggestion. Regular output functions like print or puts won't work with ERb templates. So this would be wrong:
   #
   #   Hi, Mr. <% puts "Frodo" %>
   #
-  # (If you absolutely must write from within a function, you can use the TextHelper#concat)
+  # If you absolutely must write from within a function, you can use the TextHelper#concat
+  #
+  # <%- and -%> suppress leading and trailing whitespace, including the trailing newline, and can be used interchangeably with <% and %>.
   #
   # == Using sub templates
   #
@@ -425,7 +427,8 @@ module ActionView #:nodoc:
 
         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)
+            @@compile_time[render_symbol] < File.mtime(file_name) || (File.symlink?(file_name) ? 
+              @@compile_time[render_symbol] < File.lstat(file_name).mtime : false)
           end
         else
           true

data/lib/action_view/helpers/capture_helper.rb

@@ -1,6 +1,6 @@
 module ActionView
   module Helpers
-    # Capture lets you extract parts of code into instance variables which
+    # Capture lets you extract parts of code which
     # can be used in other points of the template or even layout file.
     #
     # == Capturing a block into an instance variable
@@ -8,12 +8,11 @@ module ActionView
     #   <% @script = capture do %>
     #     [some html...]
     #   <% end %>
-    #  
     #
     # == Add javascript to header using content_for
     #
-    # content_for("name") is a wrapper for capture which will store the 
-    # fragment in a instance variable similar to @content_for_layout.
+    # content_for("name") is a wrapper for capture which will 
+    # make the fragment available by name to a yielding layout or template.
     #
     # layout.rhtml:
     #
@@ -21,11 +20,11 @@ module ActionView
     #   <head>
     #	    <title>layout with js</title>
     #	    <script type="text/javascript">
-    #	    <%= @content_for_script %>
-    #   	</script>
+    #	      <%= yield :script %>
+    #     </script>
     #   </head>
     #   <body>
-    #     <%= @content_for_layout %>
+    #     <%= yield %>
     #   </body>
     #   </html>
     #
@@ -69,13 +68,9 @@ module ActionView
         end
       end
       
-      # Content_for will store the given block
-      # in an instance variable for later use in another template
-      # or in the layout. 
-      # 
-      # The name of the instance variable is content_for_<name> 
-      # to stay consistent with @content_for_layout which is used 
-      # by ActionView's layouts
+      # Calling content_for stores the block of markup for later use.
+      # Subsequently, you can make calls to it by name with <tt>yield</tt>
+      # in another template or in the layout. 
       # 
       # Example:
       # 
@@ -83,10 +78,17 @@ module ActionView
       #     alert('hello world')
       #   <% end %>
       #
-      # You can use @content_for_header anywhere in your templates.
+      # You can use yield :header anywhere in your templates.
+      #
+      #   <%= yield :header %>
       #
       # NOTE: Beware that content_for is ignored in caches. So you shouldn't use it
-      # for elements that are going to be fragment cached. 
+      # for elements that are going to be fragment cached.
+      #
+      # The deprecated way of accessing a content_for block was to use a instance variable
+      # named @@content_for_#{name_of_the_content_block}@. So <tt><%= content_for('footer') %></tt>
+      # would be avaiable as <tt><%= @content_for_footer %></tt>. The preferred notation now is
+      # <tt><%= yield :footer %></tt>.
       def content_for(name, &block)
         eval "@content_for_#{name} = (@content_for_#{name} || '') + capture(&block)"
       end

data/lib/action_view/helpers/java_script_macros_helper.rb

@@ -27,6 +27,7 @@ module ActionView
       # <tt>:url</tt>::       Specifies the url where the updated value should
       #                       be sent after the user presses "ok".
       # 
+      #
       # Addtional +options+ are:
       # <tt>:rows</tt>::              Number of rows (more than 1 will use a TEXTAREA)
       # <tt>:cols</tt>::              Number of characters the text input should span (works for both INPUT and TEXTAREA)
@@ -122,10 +123,10 @@ module ActionView
       # <tt>:on_show</tt>::   Like on_hide, only now the expression is called
       #                       then the div is shown.
       # <tt>:after_update_element</tt>::   A Javascript expression that is called when the
-      #                       user has selected one of the proposed values. 
-      #                       The expression should take two variables: element and value.
-      #                       Element is a DOM element for the field, value
-      #                       is the value selected by the user.
+      #                                    user has selected one of the proposed values. 
+      #                                    The expression should take two variables: element and value.
+      #                                    Element is a DOM element for the field, value
+      #                                    is the value selected by the user.
       # <tt>:select</tt>::    Pick the class of the element from which the value for 
       #                       insertion should be extracted. If this is not specified,
       #                       the entire element is used.

data/lib/action_view/helpers/prototype_helper.rb

@@ -143,7 +143,7 @@ module ActionView
       # background instead of the regular reloading POST arrangement. Even 
       # though it's using JavaScript to serialize the form elements, the form
       # submission will work just like a regular submission as viewed by the
-      # receiving side (all elements available in @params). The options for 
+      # receiving side (all elements available in <tt>params</tt>). The options for 
       # specifying the target with :url and defining callbacks is the same as
       # link_to_remote.
       #
@@ -171,9 +171,10 @@ module ActionView
       end
 
       # Works like form_remote_tag, but uses form_for semantics.
-      def remote_form_for(object_name, object, options = {}, &proc)
+      def remote_form_for(object_name, *args, &proc)
+        options = args.last.is_a?(Hash) ? args.pop : {}
         concat(form_remote_tag(options), proc.binding)
-        fields_for(object_name, object, options, &proc)
+        fields_for(object_name, *(args << options), &proc)
         concat('</form>', proc.binding)
       end
       alias_method :form_remote_for, :remote_form_for

data/lib/action_view/helpers/text_helper.rb

@@ -77,7 +77,7 @@ module ActionView
       end
 
       begin
-        require_library_or_gem "redcloth"
+        require_library_or_gem "redcloth" unless Object.const_defined?(:RedCloth)
 
         # Returns the text with all the Textile codes turned into HTML-tags.
         # <i>This method is only available if RedCloth can be required</i>.
@@ -104,7 +104,7 @@ module ActionView
       end
 
       begin
-        require_library_or_gem "bluecloth"
+        require_library_or_gem "bluecloth" unless Object.const_defined?(:BlueCloth)
 
         # Returns the text with all the Markdown codes turned into HTML-tags.
         # <i>This method is only available if BlueCloth can be required</i>.
@@ -116,7 +116,7 @@ module ActionView
       end
       
       # Returns +text+ transformed into HTML using very simple formatting rules
-      # Surrounds paragraphs with <tt>&lt;p&gt;</tt> tags, and converts line breaks into <tt>&lt;br /&gt;</tt>
+      # Surrounds paragraphs with <tt><p></tt> tags, and converts line breaks into <tt><br/></tt>
       # Two consecutive newlines(<tt>\n\n</tt>) are considered as a paragraph, one newline (<tt>\n</tt>) is
       # considered a linebreak, three or more consecutive newlines are turned into two newlines 
       def simple_format(text)
@@ -129,7 +129,7 @@ module ActionView
       end
 
       # Turns all urls and email addresses into clickable links. The +link+ parameter can limit what should be linked.
-      # Options are :all (default), :email_addresses, and :urls.
+      # Options are <tt>:all</tt> (default), <tt>:email_addresses</tt>, and <tt>:urls</tt>.
       #
       # Example:
       #   auto_link("Go to http://www.rubyonrails.com and say hello to david@loudthinking.com") =>
@@ -235,28 +235,28 @@ module ActionView
       # array every time it is called. This can be used to alternate classes
       # for table rows:
       #
-      # <%- for item in @items do -%>
-      #   <tr class="<%= cycle("even", "odd") %>">
-      #     ... use item ...
-      #   </tr>
-      # <%- end -%>
+      #   <%- for item in @items do -%>
+      #     <tr class="<%= cycle("even", "odd") %>">
+      #       ... use item ...
+      #     </tr>
+      #   <%- end -%>
       #
       # You can use named cycles to prevent clashes in nested loops.  You'll
       # have to reset the inner cycle, manually:
       #
-      # <%- for item in @items do -%>
-      #   <tr class="<%= cycle("even", "odd", :name => "row_class")
-      #     <td>
-      #       <%- for value in item.values do -%>
-      #         <span style="color:'<%= cycle("red", "green", "blue"
-      #                                       :name => "colors") %>'">
-      #           item
-      #         </span>
-      #       <%- end -%>
-      #       <%- reset_cycle("colors") -%>
-      #     </td>
-      #   </tr>
-      # <%- end -%>
+      #   <%- for item in @items do -%>
+      #     <tr class="<%= cycle("even", "odd", :name => "row_class")
+      #       <td>
+      #         <%- for value in item.values do -%>
+      #           <span style="color:'<%= cycle("red", "green", "blue"
+      #                                         :name => "colors") %>'">
+      #             item
+      #           </span>
+      #         <%- end -%>
+      #         <%- reset_cycle("colors") -%>
+      #       </td>
+      #    </tr>
+      #  <%- end -%>
       def cycle(first_value, *values)
         if (values.last.instance_of? Hash)
           params = values.pop