Bob's raining patches: fixes date_helper bugs and usability issues. References #3811.

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@5685 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

2 files changed, 224 insertions, 121 deletions

diff --git a/actionpack/lib/action_view/helpers/active_record_helper.rb b/actionpack/lib/action_view/helpers/active_record_helper.rb
index 7a1aeff342..a001ae5e65 100644
--- a/actionpack/lib/action_view/helpers/active_record_helper.rb
+++ b/actionpack/lib/action_view/helpers/active_record_helper.rb
@@ -167,6 +167,8 @@ module ActionView
             to_date_select_tag(options)
           when :datetime, :timestamp
             to_datetime_select_tag(options)
+          when :time
+            to_time_select_tag(options)
           when :boolean
             to_boolean_select_tag(options)
         end
@@ -208,6 +210,15 @@ module ActionView
         end
       end
 
+      alias_method :to_time_select_tag_without_error_wrapping, :to_time_select_tag
+      def to_time_select_tag(options = {})
+        if object.respond_to?("errors") && object.errors.respond_to?("on")
+          error_wrapping(to_time_select_tag_without_error_wrapping(options), object.errors.on(@method_name))
+        else
+          to_time_select_tag_without_error_wrapping(options)
+        end
+      end
+
       def error_wrapping(html_tag, has_error)
         has_error ? Base.field_error_proc.call(html_tag, self) : html_tag
       end
diff --git a/actionpack/lib/action_view/helpers/date_helper.rb b/actionpack/lib/action_view/helpers/date_helper.rb
index 5a86ecc2ab..6123cd9114 100755
--- a/actionpack/lib/action_view/helpers/date_helper.rb
+++ b/actionpack/lib/action_view/helpers/date_helper.rb
@@ -62,7 +62,7 @@ module ActionView
               when 40..59 then 'less than a minute'
               else             '1 minute'
             end
-                                
+
           when 2..44           then "#{distance_in_minutes} minutes"
           when 45..89          then 'about 1 hour'
           when 90..1439        then "about #{(distance_in_minutes.to_f / 60.0).round} hours"
@@ -74,12 +74,12 @@ module ActionView
           else                      "over #{(distance_in_minutes / 525960).round} years"
         end
       end
-      
+
       # Like distance_of_time_in_words, but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>.
       def time_ago_in_words(from_time, include_seconds = false)
         distance_of_time_in_words(from_time, Time.now, include_seconds)
       end
-      
+
       alias_method :distance_of_time_in_words_to_now, :time_ago_in_words
 
       # Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by
@@ -108,6 +108,19 @@ module ActionView
         InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_date_select_tag(options)
       end
 
+      # Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a specified
+      # time-based attribute (identified by +method+) on an object assigned to the template (identified by +object+).
+      # You can include the seconds with <tt>:include_seconds</tt>.
+      # Examples:
+      #
+      #   time_select("post", "sunrise")
+      #   time_select("post", "start_time", :include_seconds => true)
+      #
+      # The selects are prepared for multi-parameter assignment to an Active Record object.
+      def time_select(object_name, method, options = {})
+        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_time_select_tag(options)
+      end
+
       # Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based
       # attribute (identified by +method+) on an object assigned to the template (identified by +object+). Examples:
       #
@@ -119,36 +132,55 @@ module ActionView
         InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_datetime_select_tag(options)
       end
 
+      # Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the +datetime+.
+      # 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. If you do not supply a Symbol, it
+      # will be appened onto the <tt>:order</tt> passed in. You can also add <tt>:date_separator</tt> and <tt>:time_separator</tt>
+      # keys to the +options+ to control visual display of the elements.
+       def select_datetime(datetime = Time.now, options = {})
+        separator = options[:datetime_separator] || ''
+        select_date(datetime, options) + separator + select_time(datetime, options)
+       end
+
       # Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+.
+      # It's 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. If you do not supply a Symbol, it
+      # will be appened onto the <tt>:order</tt> passed in.
       def select_date(date = Date.today, options = {})
-        select_year(date, options) + select_month(date, options) + select_day(date, options)
-      end
+        options[:order] ||= []
+        [:year, :month, :day].each { |o| options[:order].push(o) unless options[:order].include?(o) }
 
-      # 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)
+        select_date = ''
+        options[:order].each do |o|
+          select_date << self.send("select_#{o}", date, options)
+        end
+        select_date
       end
 
       # Returns a set of html select-tags (one for hour and minute)
+      # You can set <tt>:add_separator</tt> key to format the output.
       def select_time(datetime = Time.now, options = {})
-        h = select_hour(datetime, options) + select_minute(datetime, options) + (options[:include_seconds] ? select_second(datetime, options) : '')
+        separator = options[:time_separator] || ''
+        select_hour(datetime, options) + separator + select_minute(datetime, options) + (options[:include_seconds] ? separator + select_second(datetime, options) : '')
       end
 
       # Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
       # The <tt>second</tt> can also be substituted for a second number.
       # Override the field name using the <tt>:field_name</tt> option, 'second' by default.
       def select_second(datetime, options = {})
-        second_options = []
-
-        0.upto(59) do |second|
-          second_options << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.sec) == second) ?
-            %(<option value="#{leading_zero_on_single_digits(second)}" selected="selected">#{leading_zero_on_single_digits(second)}</option>\n) :
-            %(<option value="#{leading_zero_on_single_digits(second)}">#{leading_zero_on_single_digits(second)}</option>\n)
-          )
+        val = datetime ? (datetime.kind_of?(Fixnum) ? datetime : datetime.sec) : ''
+        if options[:use_hidden]
+          options[:include_seconds] ? hidden_html(options[:field_name] || 'second', val, options) : ''
+        else
+          second_options = []
+          0.upto(59) do |second|
+            second_options << ((val == second) ?
+              %(<option value="#{leading_zero_on_single_digits(second)}" selected="selected">#{leading_zero_on_single_digits(second)}</option>\n) :
+              %(<option value="#{leading_zero_on_single_digits(second)}">#{leading_zero_on_single_digits(second)}</option>\n)
+            )
+          end
+          select_html(options[:field_name] || 'second', second_options, options)
         end
-
-        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.
@@ -156,84 +188,100 @@ module ActionView
       # The <tt>minute</tt> can also be substituted for a minute number.
       # Override the field name using the <tt>:field_name</tt> option, 'minute' by default.
       def select_minute(datetime, options = {})
-        minute_options = []
-
-        0.step(59, options[:minute_step] || 1) do |minute|
-          minute_options << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.min) == minute) ?
-            %(<option value="#{leading_zero_on_single_digits(minute)}" selected="selected">#{leading_zero_on_single_digits(minute)}</option>\n) :
-            %(<option value="#{leading_zero_on_single_digits(minute)}">#{leading_zero_on_single_digits(minute)}</option>\n)
-          )
-        end
-
-        select_html(options[:field_name] || 'minute', minute_options, options[:prefix], options[:include_blank], options[:discard_type], options[:disabled])
+        val = datetime ? (datetime.kind_of?(Fixnum) ? datetime : datetime.min) : ''
+        if options[:use_hidden]
+          hidden_html(options[:field_name] || 'minute', val, options)
+        else
+          minute_options = []
+          0.step(59, options[:minute_step] || 1) do |minute|
+            minute_options << ((val == minute) ?
+              %(<option value="#{leading_zero_on_single_digits(minute)}" selected="selected">#{leading_zero_on_single_digits(minute)}</option>\n) :
+              %(<option value="#{leading_zero_on_single_digits(minute)}">#{leading_zero_on_single_digits(minute)}</option>\n)
+            )
+          end
+          select_html(options[:field_name] || 'minute', minute_options, options)
+         end
       end
 
       # Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
       # The <tt>hour</tt> can also be substituted for a hour number.
       # Override the field name using the <tt>:field_name</tt> option, 'hour' by default.
       def select_hour(datetime, options = {})
-        hour_options = []
-
-        0.upto(23) do |hour|
-          hour_options << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.hour) == hour) ?
-            %(<option value="#{leading_zero_on_single_digits(hour)}" selected="selected">#{leading_zero_on_single_digits(hour)}</option>\n) :
-            %(<option value="#{leading_zero_on_single_digits(hour)}">#{leading_zero_on_single_digits(hour)}</option>\n)
-          )
+        val = datetime ? (datetime.kind_of?(Fixnum) ? datetime : datetime.hour) : ''
+        if options[:use_hidden]
+          hidden_html(options[:field_name] || 'hour', val, options)
+        else
+          hour_options = []
+          0.upto(23) do |hour|
+            hour_options << ((val == hour) ?
+              %(<option value="#{leading_zero_on_single_digits(hour)}" selected="selected">#{leading_zero_on_single_digits(hour)}</option>\n) :
+              %(<option value="#{leading_zero_on_single_digits(hour)}">#{leading_zero_on_single_digits(hour)}</option>\n)
+            )
+          end
+          select_html(options[:field_name] || 'hour', hour_options, options)
         end
-
-        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.
       # The <tt>date</tt> can also be substituted for a hour number.
       # Override the field name using the <tt>:field_name</tt> option, 'day' by default.
       def select_day(date, options = {})
-        day_options = []
-
-        1.upto(31) do |day|
-          day_options << ((date && (date.kind_of?(Fixnum) ? date : date.day) == day) ?
-            %(<option value="#{day}" selected="selected">#{day}</option>\n) :
-            %(<option value="#{day}">#{day}</option>\n)
-          )
+        val = date ? (date.kind_of?(Fixnum) ? date : date.day) : ''
+        if options[:use_hidden]
+          hidden_html(options[:field_name] || 'day', val, options)
+        else
+          day_options = []
+          1.upto(31) do |day|
+            day_options << ((val == day) ?
+              %(<option value="#{day}" selected="selected">#{day}</option>\n) :
+              %(<option value="#{day}">#{day}</option>\n)
+            )
+          end
+          select_html(options[:field_name] || 'day', day_options, options)
         end
-
-        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.
       # The month names are presented as keys (what's shown to the user) and the month numbers (1-12) are used as values
       # (what's submitted to the server). It's also possible to use month numbers for the presentation instead of names --
       # set the <tt>:use_month_numbers</tt> key in +options+ to true for this to happen. If you want both numbers and names,
-      # set the <tt>:add_month_numbers</tt> key in +options+ to true. Examples:
+      # set the <tt>:add_month_numbers</tt> key in +options+ to true. If you would prefer to show month names as abbreviations,
+      # set the <tt>:use_short_month</tt> key in +options+ to true. If you want to use your own month names, set the
+      # <tt>:use_month_names</tt> key in +options+ to an array of 12 month names.
+      #
+      # Examples:
       #
       #   select_month(Date.today)                             # Will use keys like "January", "March"
       #   select_month(Date.today, :use_month_numbers => true) # Will use keys like "1", "3"
       #   select_month(Date.today, :add_month_numbers => true) # Will use keys like "1 - January", "3 - March"
+      #   select_month(Date.today, :use_short_month => true)   # Will use keys like "Jan", "Mar"
+      #   select_month(Date.today, :use_month_names => %w(Januar Februar Marts ...))   # Will use keys like "Januar", "Marts"
       #
       # 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 + ' - ' + month_names[month_number]
-          else
-            month_names[month_number]
-          end
+        val = date ? (date.kind_of?(Fixnum) ? date : date.month) : ''
+        if options[:use_hidden]
+          hidden_html(options[:field_name] || 'month', val, options)
+        else
+          month_options = []
+          month_names = options[:use_month_names] || (options[:use_short_month] ? Date::ABBR_MONTHNAMES : Date::MONTHNAMES)
+          month_names.unshift(nil) if month_names.size < 13
+          1.upto(12) do |month_number|
+            month_name = if options[:use_month_numbers]
+              month_number
+            elsif options[:add_month_numbers]
+              month_number.to_s + ' - ' + month_names[month_number]
+            else
+              month_names[month_number]
+            end
 
-          month_options << ((date && (date.kind_of?(Fixnum) ? date : date.month) == month_number) ?
-            %(<option value="#{month_number}" selected="selected">#{month_name}</option>\n) :
-            %(<option value="#{month_number}">#{month_name}</option>\n)
-          )
+            month_options << ((val == month_number) ?
+              %(<option value="#{month_number}" selected="selected">#{month_name}</option>\n) :
+              %(<option value="#{month_number}">#{month_name}</option>\n)
+            )
+          end
+          select_html(options[:field_name] || 'month', month_options, options)
         end
-
-        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
@@ -243,37 +291,51 @@ module ActionView
       #
       #   select_year(Date.today, :start_year => 1992, :end_year => 2007)  # ascending year values
       #   select_year(Date.today, :start_year => 2005, :end_year => 1900)  # descending year values
+      #   select_year(2006, :start_year => 2000, :end_year => 2010)
       #
       # Override the field name using the <tt>:field_name</tt> option, 'year' by default.
       def select_year(date, options = {})
-        year_options = []
-        y = date ? (date.kind_of?(Fixnum) ? (y = (date == 0) ? Date.today.year : date) : date.year) : Date.today.year
-
-        start_year, end_year = (options[:start_year] || y-5), (options[:end_year] || y+5)
-        step_val = start_year < end_year ? 1 : -1
-
-        start_year.step(end_year, step_val) do |year|
-          year_options << ((date && (date.kind_of?(Fixnum) ? date : date.year) == year) ?
-            %(<option value="#{year}" selected="selected">#{year}</option>\n) :
-            %(<option value="#{year}">#{year}</option>\n)
-          )
+        val = date ? (date.kind_of?(Fixnum) ? date : date.year) : ''
+        if options[:use_hidden]
+          hidden_html(options[:field_name] || 'year', val, options)
+        else
+          year_options = []
+          y = date ? (date.kind_of?(Fixnum) ? (y = (date == 0) ? Date.today.year : date) : date.year) : Date.today.year
+
+          start_year, end_year = (options[:start_year] || y-5), (options[:end_year] || y+5)
+          step_val = start_year < end_year ? 1 : -1
+          start_year.step(end_year, step_val) do |year|
+            year_options << ((val == year) ?
+              %(<option value="#{year}" selected="selected">#{year}</option>\n) :
+              %(<option value="#{year}">#{year}</option>\n)
+            )
+          end
+          select_html(options[:field_name] || 'year', year_options, options)
         end
-
-        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, disabled = false)
-          select_html  = %(<select name="#{prefix || DEFAULT_PREFIX})
-          select_html << "[#{type}]" unless discard_type
-          select_html << %(")
-          select_html << %( disabled="disabled") if disabled
+
+        def select_html(type, html_options, options)
+          name_and_id_from_options(options, type)
+          select_html  = %(<select id="#{options[:id]}" name="#{options[:name]}")
+          select_html << %( disabled="disabled") if options[:disabled]
           select_html << %(>\n)
-          select_html << %(<option value=""></option>\n) if include_blank
-          select_html << options.to_s
+          select_html << %(<option value=""></option>\n) if options[:include_blank]
+          select_html << html_options.to_s
           select_html << "</select>\n"
         end
 
+        def hidden_html(type, value, options)
+          name_and_id_from_options(options, type)
+          hidden_html = %(<input type="hidden" id="#{options[:id]}" name="#{options[:name]}" value="#{value}" />\n)
+        end
+
+        def name_and_id_from_options(options, type)
+          options[:name] = (options[:prefix] || DEFAULT_PREFIX) + (options[:discard_type] ? '' : "[#{type}]")
+          options[:id] = options[:name].gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '')
+        end
+
         def leading_zero_on_single_digits(number)
           number > 9 ? number : "0#{number}"
         end
@@ -283,45 +345,71 @@ module ActionView
       include DateHelper
 
       def to_date_select_tag(options = {})
-        defaults = { :discard_type => true }
-        options  = defaults.merge(options)
-        options_with_prefix = Proc.new { |position| options.merge(:prefix => "#{@object_name}[#{@method_name}(#{position}i)]") }
-        value = value(object)
-        date     = options[:include_blank] ? (value || 0) : (value || Date.today)
+        date_or_time_select options.merge(:discard_hour => true)
+      end
 
-        date_select = ''
-        options[:order]   = [:month, :year, :day] if options[:month_before_year] # For backwards compatibility
-        options[:order] ||= [:year, :month, :day]
+      def to_time_select_tag(options = {})
+        date_or_time_select options.merge(:discard_year => true, :discard_month => true)
+      end
 
-        position = {:year => 1, :month => 2, :day => 3}
+      def to_datetime_select_tag(options = {})
+        date_or_time_select options
+      end
 
-        discard = {}
-        discard[:year]  = true if options[:discard_year]
-        discard[:month] = true if options[:discard_month]
-        discard[:day]   = true if options[:discard_day] or options[:discard_month]
+      private
+        def date_or_time_select(options)
+          defaults = { :discard_type => true }
+          options  = defaults.merge(options)
+          datetime = value(object)
+          datetime ||= Time.now if options[:include_blank]
+
+          position = { :year => 1, :month => 2, :day => 3, :hour => 4, :minute => 5, :second => 6 }
+
+          order = (options[:order] ||= [:year, :month, :day])
+
+          # Discard explicit and implicit by not being included in the :order
+          discard = {}
+          discard[:year]   = true if options[:discard_year] or !order.include?(:year)
+          discard[:month]  = true if options[:discard_month] or !order.include?(:month)
+          discard[:day]    = true if options[:discard_day] or discard[:month] or !order.include?(:day)
+          discard[:hour]   = true if options[:discard_hour]
+          discard[:minute] = true if options[:discard_minute] or discard[:hour]
+          discard[:second] = true unless options[:include_seconds] && !discard[:minute]
+
+          # Maintain valid dates by including hidden fields for discarded elements
+          [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
+          # Ensure proper ordering of :hour, :minute and :second
+          [:hour, :minute, :second].each { |o| order.delete(o); order.push(o) }
+
+          date_or_time_select = ''
+          order.reverse.each do |param|
+            # Send hidden fields for discarded elements once output has started
+            # This ensures AR can reconstruct valid dates using ParseDate
+            next if discard[param] && date_or_time_select.empty?
+
+            date_or_time_select.insert(0, self.send("select_#{param}", datetime, options_with_prefix(position[param], options.merge(:use_hidden => discard[param]))))
+            date_or_time_select.insert(0,
+              case param
+                when :hour then (discard[:year] && discard[:day] ? "" : " &mdash; ")
+                when :minute then " : "
+                when :second then options[:include_seconds] ? " : " : ""
+                else ""
+              end)
 
-        options[:order].each do |param|
-          date_select << self.send("select_#{param}", date, options_with_prefix.call(position[param])) unless discard[param]
-        end
+          end
 
-        date_select
-      end
+          date_or_time_select
+        end
 
-      def to_datetime_select_tag(options = {})
-        defaults = { :discard_type => true }
-        options  = defaults.merge(options)
-        options_with_prefix = Proc.new { |position| options.merge(:prefix => "#{@object_name}[#{@method_name}(#{position}i)]") }
-        value = value(object)
-        datetime = options[:include_blank] ? (value || nil) : (value || Time.now)
-
-        datetime_select  = select_year(datetime, options_with_prefix.call(1))
-        datetime_select << select_month(datetime, options_with_prefix.call(2)) unless options[:discard_month]
-        datetime_select << select_day(datetime, options_with_prefix.call(3)) unless options[:discard_day] || options[:discard_month]
-        datetime_select << ' &mdash; ' + select_hour(datetime, options_with_prefix.call(4)) unless options[:discard_hour]
-        datetime_select << ' : ' + select_minute(datetime, options_with_prefix.call(5)) unless options[:discard_minute] || options[:discard_hour]
-
-        datetime_select
-      end
+        def options_with_prefix(position, options)
+          prefix = "#{@object_name}"
+          if options[:index]
+            prefix << "[#{options[:index]}]"
+          elsif @auto_index
+            prefix << "[#{@auto_index}]"
+          end
+          options.merge(:prefix => "#{prefix}[#{@method_name}(#{position}i)]")
+        end
     end
 
     class FormBuilder
@@ -329,6 +417,10 @@ module ActionView
         @template.date_select(@object_name, method, options.merge(:object => @object))
       end
 
+      def time_select(method, options = {})
+        @template.time_select(@object_name, method, options.merge(:object => @object))
+      end
+
       def datetime_select(method, options = {})
         @template.datetime_select(@object_name, method, options.merge(:object => @object))
       end