require "date" module ActionView module Helpers # The Date Helper primarily creates select/option tags for different kinds of dates and date elements. All of the select-type methods # share a number of common options that are as follows: # # * :prefix - overwrites the default prefix of "date" used for the select names. So specifying "birthday" would give # birthday[month] instead of date[month] if passed to the select_month method. # * :include_blank - set to true if it should be possible to set an empty date. # * :discard_type - set to true if you want to discard the type part of the select name. If set to true, the select_month # method would use simply "date" (which can be overwritten using :prefix) instead of "date[month]". module DateHelper DEFAULT_PREFIX = "date" unless const_defined?("DEFAULT_PREFIX") # Reports the approximate distance in time between to Time objects. For example, if the distance is 47 minutes, it'll return # "about 1 hour". See the source for the complete wording list. def distance_of_time_in_words(from_time, to_time) distance_in_minutes = ((to_time - from_time) / 60).round case distance_in_minutes when 0 then "less than a minute" when 1 then "1 minute" when 2..45 then "#{distance_in_minutes} minutes" when 46..90 then "about 1 hour" when 90..1440 then "about #{(distance_in_minutes.to_f / 60.0).round} hours" when 1441..2880 then "1 day" else "#{(distance_in_minutes / 1440).round} days" end end # Like distance_of_time_in_words, but where to_time is fixed to Time.now. def distance_of_time_in_words_to_now(from_time) distance_of_time_in_words(from_time, Time.now) end # 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 discard options. The discard options are :discard_month and :discard_day. Set to true, they'll drop the respective # select. Discarding the month select will also automatically discard the day select. # # NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed. Additionally, you can get the # month select before the year by setting :month_before_year to true in the options. This is especially useful for credit card forms. # Examples: # # date_select("post", "written_on") # date_select("post", "written_on", :start_year => 1995) # date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true, # :discard_day => true, :include_blank => true) # # The selects are prepared for multi-parameter assignment to an Active Record object. def date_select(object, method, options = {}) InstanceTag.new(object, method, self).to_date_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: # # datetime_select("post", "written_on") # datetime_select("post", "written_on", :start_year => 1995) # # The selects are prepared for multi-parameter assignment to an Active Record object. def datetime_select(object, method, options = {}) InstanceTag.new(object, method, self).to_datetime_select_tag(options) end # Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+. def select_date(date = Date.today, options = {}) 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+. 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) end # Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected. # The minute can also be substituted for a minute number. def select_minute(datetime, options = {}) minute_options = [] 0.upto(59) do |minute| minute_options << ((datetime.kind_of?(Fixnum) ? datetime : datetime.min) == minute ? "\n" : "\n" ) end select_html("minute", minute_options, options[:prefix], options[:include_blank], options[:discard_type]) end # Returns a select tag with options for each of the hours 0 through 23 with the current hour selected. # The hour can also be substituted for a hour number. def select_hour(datetime, options = {}) hour_options = [] 0.upto(23) do |hour| hour_options << ((datetime.kind_of?(Fixnum) ? datetime : datetime.hour) == hour ? "\n" : "\n" ) end select_html("hour", hour_options, options[:prefix], options[:include_blank], options[:discard_type]) end # Returns a select tag with options for each of the days 1 through 31 with the current day selected. # The date can also be substituted for a hour number. def select_day(date, options = {}) day_options = [] 1.upto(31) do |day| day_options << ((date.kind_of?(Fixnum) ? date : date.day) == day ? "\n" : "\n" ) end select_html("day", day_options, options[:prefix], options[:include_blank], options[:discard_type]) 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 :use_month_numbers key in +options+ to true for this to happen. If you want both numbers and names, # set the :add_month_numbers key in +options+ to true. 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" def select_month(date, options = {}) month_options = [] 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] else Date::MONTHNAMES[month_number] end month_options << ((date.kind_of?(Fixnum) ? date : date.month) == month_number ? %(\n) : %(\n) ) end select_html("month", month_options, options[:prefix], options[:include_blank], options[:discard_type]) 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 # can be changed using the :start_year and :end_year keys in the +options+. The date can also be substituted # for a year given as a number. Example: # # select_year(Date.today, :start_year => 1992, :end_year => 2007) def select_year(date, options = {}) year_options = [] y = date.kind_of?(Fixnum) ? (y = (date == 0) ? Date.today.year : date) : date.year default_start_year, default_end_year = y-5, y+5 (options[:start_year] || default_start_year).upto(options[:end_year] || default_end_year) do |year| year_options << ((date.kind_of?(Fixnum) ? date : date.year) == year ? "\n" : "\n" ) end select_html("year", year_options, options[:prefix], options[:include_blank], options[:discard_type]) end private def select_html(type, options, prefix = nil, include_blank = false, discard_type = false) select_html = %(\n" return select_html end def leading_zero_on_single_digits(number) number > 9 ? number : "0#{number}" end end class InstanceTag #:nodoc: include DateHelper def to_date_select_tag(options = {}) defaults = { :discard_type => true } options = defaults.merge(options) options_with_prefix = Proc.new { |position| options.update({ :prefix => "#{@object_name}[#{@method_name}(#{position}i)]" }) } date = options[:include_blank] ? (value || 0) : (value || Date.today) date_select = "" if options[:month_before_year] date_select << select_month(date, options_with_prefix.call(2)) unless options[:discard_month] date_select << select_year(date, options_with_prefix.call(1)) else date_select << select_year(date, options_with_prefix.call(1)) date_select << select_month(date, options_with_prefix.call(2)) unless options[:discard_month] end date_select << select_day(date, options_with_prefix.call(3)) unless options[:discard_day] || options[:discard_month] return date_select end def to_datetime_select_tag(options = {}) defaults = { :discard_type => true } options = defaults.merge(options) options_with_prefix = Proc.new { |position| options.update({ :prefix => "#{@object_name}[#{@method_name}(#{position}i)]" }) } datetime = options[:include_blank] ? (value || 0) : (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 << " — " + 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] return datetime_select end end end end