actionpack 1.9.1 → 1.10.1

data/lib/action_view/helpers/active_record_helper.rb

@@ -17,8 +17,8 @@ module ActionView
       # (title is a VARCHAR column and holds "Hello World"):
       #   input("post", "title") =>
       #     <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
-      def input(record_name, method)
-        InstanceTag.new(record_name, method, self).to_tag
+      def input(record_name, method, options = {})
+        InstanceTag.new(record_name, method, self).to_tag(options)
       end
 
       # Returns an entire form with input tags and everything for a specified Active Record object. Example
@@ -71,7 +71,7 @@ module ActionView
         yield contents if block_given?
         contents << submit_tag(submit_value)
 
-        content_tag('form', contents, :action => action, :method => 'post')
+        content_tag('form', contents, :action => action, :method => 'post', :enctype => options[:multipart] ? 'multipart/form-data': nil)
       end
 
       # Returns a string containing the error message attached to the +method+ on the +object+, if one exists.
@@ -96,6 +96,10 @@ module ActionView
       # * <tt>header_tag</tt> - Used for the header of the error div (default: h2)
       # * <tt>id</tt> - The id of the error div (default: errorExplanation)
       # * <tt>class</tt> - The class of the error div (default: errorExplanation)
+      #
+      # NOTE: This is a pre-packaged presentation of the errors with embedded strings and a certain HTML structure. If what
+      # you need is significantly different from the default presentation, it makes plenty of sense to access the object.errors
+      # instance yourself and set it up. View the source of this method to see how easy it is.
       def error_messages_for(object_name, options = {})
         options = options.symbolize_keys
         object = instance_variable_get("@#{object_name}")

data/lib/action_view/helpers/asset_tag_helper.rb

@@ -18,13 +18,13 @@ module ActionView
       #     <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.curenthost.com/controller/feed" />
       #   auto_discovery_link_tag(:rss, {:action => "feed"}, {:title => "My RSS"}) # =>
       #     <link rel="alternate" type="application/rss+xml" title="My RSS" href="http://www.curenthost.com/controller/feed" />
-      def auto_discovery_link_tag(type = :rss, options = {}, tag_options = {})
+      def auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {})
         tag(
           "link", 
-          "rel" => tag_options[:rel] || "alternate",
-          "type" => tag_options[:type] || "application/#{type}+xml",
+          "rel"   => tag_options[:rel] || "alternate",
+          "type"  => tag_options[:type] || "application/#{type}+xml",
           "title" => tag_options[:title] || type.to_s.upcase,
-          "href" => url_for(options.merge(:only_path => false))
+          "href"  => url_options.is_a?(Hash) ? url_for(url_options.merge(:only_path => false)) : url_options
         )
       end
 
@@ -46,12 +46,21 @@ module ActionView
       #
       #   javascript_include_tag :defaults # =>
       #     <script type="text/javascript" src="/javascripts/prototype.js"></script>
-      #     <script type="text/javascript" src="/javascripts/effects.js"></script>
-      #     <script type="text/javascript" src="/javascripts/controls.js"></script>
-      #     <script type="text/javascript" src="/javascripts/dragdrop.js"></script>      
+      #     <script type="text/javascript" src="/javascripts/scriptaculous.js"></script>
+      #     <script type="text/javascript" src="/javascripts/application.js"></script> *see beloe
+      #   
+      # If there's an <tt>application.js</tt> file in your <tt>public/javascripts</tt> directory,
+      # <tt>javascript_include_tag :defaults</tt> will automatically include it. This file
+      # facilitates the inclusion of small snippets of JavaScript code, along the lines of
+      # <tt>controllers/application.rb</tt> and <tt>helpers/application_helper.rb</tt>.
       def javascript_include_tag(*sources)
         options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
-        sources = ['prototype', 'effects', 'controls', 'dragdrop'] if sources.first == :defaults
+        if sources.first == :defaults
+          sources = ['prototype', 'scriptaculous']
+          if defined?(RAILS_ROOT) and File.exists?("#{RAILS_ROOT}/public/javascripts/application.js")
+            sources << 'application' 
+          end
+        end
         sources.collect { |source|
           source = javascript_path(source)        
           content_tag("script", "", { "type" => "text/javascript", "src" => source }.merge(options))
@@ -94,7 +103,7 @@ module ActionView
         compute_public_path(source, 'images', 'png')
       end
 
-      # Returns an image tag converting the +options+ instead html options on the tag, but with these special cases:
+      # Returns an image tag converting the +options+ into html options on the tag, but with these special cases:
       #
       # * <tt>:alt</tt>  - If no alt text is given, the file name part of the +src+ is used (capitalized and without the extension)
       # * <tt>:size</tt> - Supplied as "XxY", so "30x45" becomes width="30" and height="45"
@@ -119,10 +128,11 @@ module ActionView
       
       private
         def compute_public_path(source, dir, ext)
-          source = "/#{dir}/#{source}" unless source.include?("/")
+          source = "/#{dir}/#{source}" unless source.first == "/" || source.include?(":")
           source = "#{source}.#{ext}" unless source.include?(".")
-          source = "#{@request.relative_url_root}#{source}" unless %r{^[-a-z]+://} =~ source
-          ActionController::Base.asset_host + source
+          source = "#{@controller.request.relative_url_root}#{source}" unless %r{^[-a-z]+://} =~ source
+          source = ActionController::Base.asset_host + source unless source.include?(":")
+          source
         end
     end
   end

data/lib/action_view/helpers/capture_helper.rb

@@ -81,17 +81,9 @@ module ActionView
       #
       # NOTE: Beware that content_for is ignored in caches. So you shouldn't use it
       # for elements that are going to be fragment cached. 
-      def content_for(name, &block)                      
-        base = controller.instance_variable_get(instance_var_name(name)) || ""
-        data = capture(&block)
-        controller.instance_variable_set(instance_var_name(name), base + data)
-        data
+      def content_for(name, &block)
+        eval "@content_for_#{name} = (@content_for_#{name} || '') + capture(&block)"
       end
-      
-      private      
-        def instance_var_name(name) #:nodoc#
-          "@content_for_#{name}"
-        end
     end
   end
 end

data/lib/action_view/helpers/date_helper.rb

@@ -13,7 +13,7 @@ module ActionView
     module DateHelper
       DEFAULT_PREFIX = 'date' unless const_defined?('DEFAULT_PREFIX')
 
-      # Reports the approximate distance in time between to Time objects or integers. 
+      # Reports the approximate distance in time between two Time objects or integers. 
       # For example, if the distance is 47 minutes, it'll return
       # "about 1 hour". See the source for the complete wording list.
       #
@@ -56,12 +56,14 @@ module ActionView
 
       # Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by
       # +method+) on an object assigned to the template (identified by +object+). It's possible to tailor the selects through the +options+ hash,
-      # which both accepts all the keys that each of the individual select builders does (like :use_month_numbers for select_month) and a range of
+      # which accepts all the keys that each of the individual select builders do (like :use_month_numbers for select_month) as well as a range of
       # discard options. The discard options are <tt>:discard_year</tt>, <tt>:discard_month</tt> and <tt>:discard_day</tt>. Set to true, they'll
       # drop the respective select. Discarding the month select will also automatically discard the day select. It's also possible to explicitly
       # set the order of the tags using the <tt>:order</tt> option with an array of symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in
       # the desired order. Symbols may be omitted and the respective select is not included.
       #
+      # Passing :disabled => true as part of the +options+ will make elements inaccessible for change.
+      #
       # NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.
       #
       # Examples:
@@ -94,7 +96,7 @@ module ActionView
         select_year(date, options) + select_month(date, options) + select_day(date, options)
       end
 
-      # Returns a set of html select-tags (one for year, month, day, hour, and minute) preselected the +datetime+.
+      # Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the +datetime+.
       def select_datetime(datetime = Time.now, options = {})
         select_year(datetime, options) + select_month(datetime, options) + select_day(datetime, options) +
         select_hour(datetime, options) + select_minute(datetime, options)
@@ -118,7 +120,7 @@ module ActionView
           )
         end
 
-        select_html(options[:field_name] || 'second', second_options, options[:prefix], options[:include_blank], options[:discard_type])
+        select_html(options[:field_name] || 'second', second_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled])
       end
 
       # Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
@@ -135,7 +137,7 @@ module ActionView
           )
         end
 
-        select_html(options[:field_name] || 'minute', minute_options, options[:prefix], options[:include_blank], options[:discard_type])
+        select_html(options[:field_name] || 'minute', minute_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled])
       end
 
       # Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
@@ -151,7 +153,7 @@ module ActionView
           )
         end
 
-        select_html(options[:field_name] || 'hour', hour_options, options[:prefix], options[:include_blank], options[:discard_type])
+        select_html(options[:field_name] || 'hour', hour_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled])
       end
 
       # Returns a select tag with options for each of the days 1 through 31 with the current day selected.
@@ -167,7 +169,7 @@ module ActionView
           )
         end
 
-        select_html(options[:field_name] || 'day', day_options, options[:prefix], options[:include_blank], options[:discard_type])
+        select_html(options[:field_name] || 'day', day_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled])
       end
 
       # Returns a select tag with options for each of the months January through December with the current month selected.
@@ -181,16 +183,20 @@ module ActionView
       #   select_month(Date.today, :add_month_numbers => true) # Will use keys like "1 - January", "3 - March"
       #
       # Override the field name using the <tt>:field_name</tt> option, 'month' by default.
+      #
+      # If you would prefer to show month names as abbreviations, set the
+      # <tt>:use_short_month</tt> key in +options+ to true.
       def select_month(date, options = {})
         month_options = []
+        month_names = options[:use_short_month] ? Date::ABBR_MONTHNAMES : Date::MONTHNAMES
 
         1.upto(12) do |month_number|
           month_name = if options[:use_month_numbers]
             month_number
           elsif options[:add_month_numbers]
-            month_number.to_s + ' - ' + Date::MONTHNAMES[month_number]
+            month_number.to_s + ' - ' + month_names[month_number]
           else
-            Date::MONTHNAMES[month_number]
+            month_names[month_number]
           end
 
           month_options << ((date && (date.kind_of?(Fixnum) ? date : date.month) == month_number) ?
@@ -199,7 +205,7 @@ module ActionView
           )
         end
 
-        select_html(options[:field_name] || 'month', month_options, options[:prefix], options[:include_blank], options[:discard_type])
+        select_html(options[:field_name] || 'month', month_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled])
       end
 
       # Returns a select tag with options for each of the five years on each side of the current, which is selected. The five year radius
@@ -225,14 +231,16 @@ module ActionView
           )
         end
 
-        select_html(options[:field_name] || 'year', year_options, options[:prefix], options[:include_blank], options[:discard_type])
+        select_html(options[:field_name] || 'year', year_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled])
       end
 
       private
-        def select_html(type, options, prefix = nil, include_blank = false, discard_type = false)
+        def select_html(type, options, prefix = nil, include_blank = false, discard_type = false, disabled = false)
           select_html  = %(<select name="#{prefix || DEFAULT_PREFIX})
           select_html << "[#{type}]" unless discard_type
-          select_html << %(">\n)
+          select_html << %(")
+          select_html << %( disabled="disabled") if disabled
+          select_html << %(>\n)
           select_html << %(<option value=""></option>\n) if include_blank
           select_html << options.to_s
           select_html << "</select>\n"

data/lib/action_view/helpers/form_helper.rb

@@ -35,7 +35,7 @@ module ActionView
     #       size="20" maxsize="20" value="<%= @person.password %>" />
     #
     #     Single?:
-    #     <input type="checkbox" id="person_single" name="person[single] value="1" />
+    #     <input type="checkbox" id="person_single" name="person[single]" value="1" />
     #
     #     Description:
     #     <textarea cols="20" rows="40" id="person_description" name="person[description]">
@@ -76,17 +76,17 @@ module ActionView
         InstanceTag.new(object, method, self).to_input_field_tag("text", options)
       end
 
-      # Works just like text_field, but returns a input tag of the "password" type instead.
+      # Works just like text_field, but returns an input tag of the "password" type instead.
       def password_field(object, method, options = {})
         InstanceTag.new(object, method, self).to_input_field_tag("password", options)
       end
 
-      # Works just like text_field, but returns a input tag of the "hidden" type instead.
+      # Works just like text_field, but returns an input tag of the "hidden" type instead.
       def hidden_field(object, method, options = {})
         InstanceTag.new(object, method, self).to_input_field_tag("hidden", options)
       end
 
-      # Works just like text_field, but returns a input tag of the "file" type instead, which won't have any default value.
+      # Works just like text_field, but returns an input tag of the "file" type instead, which won't have a default value.
       def file_field(object, method, options = {})
         InstanceTag.new(object, method, self).to_input_field_tag("file", options)
       end
@@ -113,12 +113,12 @@ module ActionView
       #
       # Example (call, result). Imagine that @post.validated? returns 1:
       #   check_box("post", "validated")
-      #     <input type="checkbox" id="post_validate" name="post[validated] value="1" checked="checked" />
+      #     <input type="checkbox" id="post_validate" name="post[validated]" value="1" checked="checked" />
       #     <input name="post[validated]" type="hidden" value="0" />
       #
       # Example (call, result). Imagine that @puppy.gooddog returns no:
       #   check_box("puppy", "gooddog", {}, "yes", "no")
-      #     <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog] value="yes" />
+      #     <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />
       #     <input name="puppy[gooddog]" type="hidden" value="no" />
       def check_box(object, method, options = {}, checked_value = "1", unchecked_value = "0")
         InstanceTag.new(object, method, self).to_check_box_tag(options, checked_value, unchecked_value)
@@ -131,8 +131,8 @@ module ActionView
       # Example (call, result). Imagine that @post.category returns "rails":
       #   radio_button("post", "category", "rails")
       #   radio_button("post", "category", "java")
-      #     <input type="radio" id="post_category" name="post[category] value="rails" checked="checked" />
-      #     <input type="radio" id="post_category" name="post[category] value="java" />
+      #     <input type="radio" id="post_category" name="post[category]" value="rails" checked="checked" />
+      #     <input type="radio" id="post_category" name="post[category]" value="java" />
       #
       def radio_button(object, method, tag_value, options = {})
         InstanceTag.new(object, method, self).to_radio_button_tag(tag_value, options)
@@ -174,7 +174,7 @@ module ActionView
         options = DEFAULT_RADIO_OPTIONS.merge(options.stringify_keys)
         options["type"]     = "radio"
         options["value"]    = tag_value
-        options["checked"]  = "checked" if value == tag_value
+        options["checked"]  = "checked" if value.to_s == tag_value.to_s
         pretty_tag_value    = tag_value.to_s.gsub(/\s/, "_").gsub(/\W/, "").downcase
         options["id"]       = @auto_index ?             
           "#{@object_name}_#{@auto_index}_#{@method_name}_#{pretty_tag_value}" :
@@ -234,7 +234,11 @@ module ActionView
         tag_text << " selected" if value
         tag_text << ">True</option></select>"
       end
-
+      
+      def to_content_tag(tag_name, options = {})
+        content_tag(tag_name, value, options)
+      end
+      
       def object
         @template_object.instance_variable_get "@#{@object_name}"
       end

data/lib/action_view/helpers/form_options_helper.rb

@@ -109,7 +109,7 @@ module ActionView
         container = container.to_a if Hash === container
 
         options_for_select = container.inject([]) do |options, element|
-          if element.respond_to?(:first) && element.respond_to?(:last)
+          if element.is_a?(Array) || element.is_a?(Range)
             is_selected = ( (selected.respond_to?(:include?) ? selected.include?(element.last) : element.last == selected) )
             is_selected = ( (selected.respond_to?(:include?) && !selected.is_a?(String) ? selected.include?(element.last) : element.last == selected) )
             if is_selected
@@ -127,11 +127,11 @@ module ActionView
         options_for_select.join("\n")
       end
 
-      # Returns a string of option tags that has been compiled by iterating over the +collection+ and assigning the
+      # Returns a string of option tags that have been compiled by iterating over the +collection+ and assigning the
       # the result of a call to the +value_method+ as the option value and the +text_method+ as the option text.
       # If +selected_value+ is specified, the element returning a match on +value_method+ will get the selected option tag.
       #
-      # Example (call, result). Imagine a loop iterating over each +person+ in <tt>@project.people</tt> to generate a input tag:
+      # Example (call, result). Imagine a loop iterating over each +person+ in <tt>@project.people</tt> to generate an input tag:
       #   options_from_collection_for_select(@project.people, "id", "name")
       #     <option value="#{person.id}">#{person.name}</option>
       #
@@ -143,7 +143,7 @@ module ActionView
         )
       end
 
-      # Returns a string of option tags, like options_from_collection_for_select, but surrounds them by <optgroup> tags.
+      # Returns a string of option tags, like options_from_collection_for_select, but surrounds them with <optgroup> tags.
       #
       # An array of group objects are passed. Each group should return an array of options when calling group_method
       # Each group should should return its name when calling group_label_method.

data/lib/action_view/helpers/form_tag_helper.rb

@@ -6,7 +6,7 @@ module ActionView
     # Provides a number of methods for creating form tags that doesn't rely on conventions with an object assigned to the template like
     # FormHelper does. With the FormTagHelper, you provide the names and values yourself.
     #
-    # NOTE: The html options disabled, readonly, and multiple can all be treated as booleans. So specifying <tt>disabled => :true</tt>
+    # NOTE: The html options disabled, readonly, and multiple can all be treated as booleans. So specifying <tt>:disabled => true</tt>
     # will give <tt>disabled="disabled"</tt>.
     module FormTagHelper
       # Starts a form tag that points the action to an url configured with <tt>url_for_options</tt> just like
@@ -14,6 +14,7 @@ module ActionView
       #
       # Options:
       # * <tt>:multipart</tt> - If set to true, the enctype is set to "multipart/form-data".
+      # * <tt>:method</tt> - The method to use when submitting the form, usually either "get" or "post".
       def form_tag(url_for_options = {}, options = {}, *parameters_for_url)
         html_options = { "method" => "post" }.merge(options.stringify_keys)
 
@@ -33,26 +34,68 @@ module ActionView
         "</form>"
       end
 
+      # Creates a dropdown selection box, or if the <tt>:multiple</tt> option is set to true, a multiple
+      # choice selection box.
+      #
+      # Helpers::FormOptions can be used to create common select boxes such as countries, time zones, or
+      # associated records.
+      #
+      # <tt>option_tags</tt> is a string containing the option tags for the select box:
+      #   # Outputs <select id="people" name="people"><option>David</option></select>
+      #   select_tag "people", "<option>David</option>"
+      #
+      # Options:
+      # * <tt>:multiple</tt> - If set to true the selection will allow multiple choices.
       def select_tag(name, option_tags = nil, options = {})
-        content_tag("select", option_tags, { "name" => name, "id" => name }.update(convert_options(options)))
+        content_tag("select", option_tags, { "name" => name, "id" => name }.update(options.stringify_keys))
       end
 
+      # Creates a standard text field.
+      #
+      # Options:
+      # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input.
+      # * <tt>:size</tt> - The number of visible characters that will fit in the input.
+      # * <tt>:maxlength</tt> - The maximum number of characters that the browser will allow the user to enter.
+      # 
+      # A hash of standard HTML options for the tag.
       def text_field_tag(name, value = nil, options = {})
-        tag("input", { "type" => "text", "name" => name, "id" => name, "value" => value }.update(convert_options(options)))
+        tag("input", { "type" => "text", "name" => name, "id" => name, "value" => value }.update(options.stringify_keys))
       end
 
+      # Creates a hidden field.
+      #
+      # Takes the same options as text_field_tag
       def hidden_field_tag(name, value = nil, options = {})
         text_field_tag(name, value, options.stringify_keys.update("type" => "hidden"))
       end
 
+      # Creates a file upload field.
+      #
+      # If you are using file uploads then you will also need to set the multipart option for the form:
+      #   <%= form_tag { :action => "post" }, { :multipart => true } %>
+      #     <label for="file">File to Upload</label> <%= file_field_tag "file" %>
+      #     <%= submit_tag %>
+      #   <%= end_form_tag %>
+      #
+      # The specified URL will then be passed a File object containing the selected file, or if the field 
+      # was left blank, a StringIO object.
       def file_field_tag(name, options = {})
-        text_field_tag(name, nil, convert_options(options).update("type" => "file"))
+        text_field_tag(name, nil, options.update("type" => "file"))
       end
 
+      # Creates a password field.
+      #
+      # Takes the same options as text_field_tag
       def password_field_tag(name = "password", value = nil, options = {})
-        text_field_tag(name, value, convert_options(options).update("type" => "password"))
+        text_field_tag(name, value, options.update("type" => "password"))
       end
 
+      # Creates a text input area.
+      #
+      # Options:
+      # * <tt>:size</tt> - A string specifying the dimensions of the textarea.
+      #     # Outputs <textarea name="body" id="body" cols="25" rows="10"></textarea>
+      #     <%= text_area_tag "body", nil, :size => 25x10 %>
       def text_area_tag(name, content = nil, options = {})
         options = options.stringify_keys
         if options["size"]
@@ -60,43 +103,34 @@ module ActionView
           options.delete("size")
         end
 
-        content_tag("textarea", content, { "name" => name, "id" => name }.update(convert_options(options)))
+        content_tag("textarea", content, { "name" => name, "id" => name }.update(options.stringify_keys))
       end
 
+      # Creates a check box.
       def check_box_tag(name, value = "1", checked = false, options = {})
-        html_options = { "type" => "checkbox", "name" => name, "id" => name, "value" => value }.update(convert_options(options))
+        html_options = { "type" => "checkbox", "name" => name, "id" => name, "value" => value }.update(options.stringify_keys)
         html_options["checked"] = "checked" if checked
         tag("input", html_options)
       end
 
+      # Creates a radio button.
       def radio_button_tag(name, value, checked = false, options = {})
-        html_options = { "type" => "radio", "name" => name, "id" => name, "value" => value }.update(convert_options(options))
+        html_options = { "type" => "radio", "name" => name, "id" => name, "value" => value }.update(options.stringify_keys)
         html_options["checked"] = "checked" if checked
         tag("input", html_options)
       end
 
+      # Creates a submit button with the text <tt>value</tt> as the caption.
       def submit_tag(value = "Save changes", options = {})
-        tag("input", { "type" => "submit", "name" => "commit", "value" => value }.update(convert_options(options)))
+        tag("input", { "type" => "submit", "name" => "commit", "value" => value }.update(options.stringify_keys))
       end
       
+      # Displays an image which when clicked will submit the form.
+      #
+      # <tt>source</tt> is passed to AssetTagHelper#image_path
       def image_submit_tag(source, options = {})
-        tag("input", { "type" => "image", "src" => image_path(source) }.update(convert_options(options)))
+        tag("input", { "type" => "image", "src" => image_path(source) }.update(options.stringify_keys))
       end
-      
-      private
-        def convert_options(options)
-          options = options.stringify_keys
-          %w( disabled readonly multiple ).each { |a| boolean_attribute(options, a) }
-          options
-        end
-        
-        def boolean_attribute(options, attribute)
-          if options[attribute]
-            options[attribute] = attribute
-          else
-            options.delete attribute
-          end
-        end
     end
   end
 end