2 require 'action_view/helpers/tag_helper'
6 # The Date Helper primarily creates select/option tags for different kinds of dates and date elements. All of the
7 # select-type methods share a number of common options that are as follows:
9 # * <tt>:prefix</tt> - overwrites the default prefix of "date" used for the select names. So specifying "birthday"
10 # would give birthday[month] instead of date[month] if passed to the select_month method.
11 # * <tt>:include_blank</tt> - set to true if it should be possible to set an empty date.
12 # * <tt>:discard_type</tt> - set to true if you want to discard the type part of the select name. If set to true,
13 # the select_month method would use simply "date" (which can be overwritten using <tt>:prefix</tt>) instead of
16 # Reports the approximate distance in time between two Time or Date objects or integers as seconds.
17 # Set <tt>include_seconds</tt> to true if you want more detailed approximations when distance < 1 min, 29 secs
18 # Distances are reported based on the following table:
20 # 0 <-> 29 secs # => less than a minute
21 # 30 secs <-> 1 min, 29 secs # => 1 minute
22 # 1 min, 30 secs <-> 44 mins, 29 secs # => [2..44] minutes
23 # 44 mins, 30 secs <-> 89 mins, 29 secs # => about 1 hour
24 # 89 mins, 29 secs <-> 23 hrs, 59 mins, 29 secs # => about [2..24] hours
25 # 23 hrs, 59 mins, 29 secs <-> 47 hrs, 59 mins, 29 secs # => 1 day
26 # 47 hrs, 59 mins, 29 secs <-> 29 days, 23 hrs, 59 mins, 29 secs # => [2..29] days
27 # 29 days, 23 hrs, 59 mins, 30 secs <-> 59 days, 23 hrs, 59 mins, 29 secs # => about 1 month
28 # 59 days, 23 hrs, 59 mins, 30 secs <-> 1 yr minus 1 sec # => [2..12] months
29 # 1 yr <-> 2 yrs minus 1 secs # => about 1 year
30 # 2 yrs <-> max time or date # => over [2..X] years
32 # With <tt>include_seconds</tt> = true and the difference < 1 minute 29 seconds:
33 # 0-4 secs # => less than 5 seconds
34 # 5-9 secs # => less than 10 seconds
35 # 10-19 secs # => less than 20 seconds
36 # 20-39 secs # => half a minute
37 # 40-59 secs # => less than a minute
38 # 60-89 secs # => 1 minute
41 # from_time = Time.now
42 # distance_of_time_in_words(from_time, from_time + 50.minutes) # => about 1 hour
43 # distance_of_time_in_words(from_time, 50.minutes.from_now) # => about 1 hour
44 # distance_of_time_in_words(from_time, from_time + 15.seconds) # => less than a minute
45 # distance_of_time_in_words(from_time, from_time + 15.seconds, true) # => less than 20 seconds
46 # distance_of_time_in_words(from_time, 3.years.from_now) # => over 3 years
47 # distance_of_time_in_words(from_time, from_time + 60.hours) # => about 3 days
48 # distance_of_time_in_words(from_time, from_time + 45.seconds, true) # => less than a minute
49 # distance_of_time_in_words(from_time, from_time - 45.seconds, true) # => less than a minute
50 # distance_of_time_in_words(from_time, 76.seconds.from_now) # => 1 minute
51 # distance_of_time_in_words(from_time, from_time + 1.year + 3.days) # => about 1 year
52 # distance_of_time_in_words(from_time, from_time + 4.years + 9.days + 30.minutes + 5.seconds) # => over 4 years
54 # to_time = Time.now + 6.years + 19.days
55 # distance_of_time_in_words(from_time, to_time, true) # => over 6 years
56 # distance_of_time_in_words(to_time, from_time, true) # => over 6 years
57 # distance_of_time_in_words(Time.now, Time.now) # => less than a minute
59 def distance_of_time_in_words(from_time
, to_time
= 0, include_seconds
= false, options
= {})
60 from_time
= from_time
.to_time
if from_time
.respond_to
?(:to_time)
61 to_time
= to_time
.to_time
if to_time
.respond_to
?(:to_time)
62 distance_in_minutes
= (((to_time
- from_time
).abs
)/60).round
63 distance_in_seconds
= ((to_time
- from_time
).abs
).round
65 I18n
.with_options
:locale => options
[:locale], :scope => :'datetime.distance_in_words' do |locale
|
66 case distance_in_minutes
68 return distance_in_minutes
== 0 ?
69 locale
.t(:less_than_x_minutes, :count => 1) :
70 locale
.t(:x_minutes, :count => distance_in_minutes
) unless include_seconds
72 case distance_in_seconds
73 when 0..4 then locale
.t
:less_than_x_seconds, :count => 5
74 when 5..9 then locale
.t
:less_than_x_seconds, :count => 10
75 when 10..19 then locale
.t
:less_than_x_seconds, :count => 20
76 when 20..39 then locale
.t
:half_a_minute
77 when 40..59 then locale
.t
:less_than_x_minutes, :count => 1
78 else locale
.t
:x_minutes, :count => 1
81 when 2..44 then locale
.t
:x_minutes, :count => distance_in_minutes
82 when 45..89 then locale
.t
:about_x_hours, :count => 1
83 when 90..1439 then locale
.t
:about_x_hours, :count => (distance_in_minutes
.to_f
/ 60.0).round
84 when 1440..2879 then locale
.t
:x_days, :count => 1
85 when 2880..43199 then locale
.t
:x_days, :count => (distance_in_minutes
/ 1440).round
86 when 43200..86399 then locale
.t
:about_x_months, :count => 1
87 when 86400..525599 then locale
.t
:x_months, :count => (distance_in_minutes
/ 43200).round
88 when 525600..1051199 then locale
.t
:about_x_years, :count => 1
89 else locale
.t
:over_x_years, :count => (distance_in_minutes
/ 525600).round
94 # Like distance_of_time_in_words, but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>.
97 # time_ago_in_words(3.minutes.from_now) # => 3 minutes
98 # time_ago_in_words(Time.now - 15.hours) # => 15 hours
99 # time_ago_in_words(Time.now) # => less than a minute
101 # from_time = Time.now - 3.days - 14.minutes - 25.seconds # => 3 days
102 def time_ago_in_words(from_time
, include_seconds
= false)
103 distance_of_time_in_words(from_time
, Time
.now
, include_seconds
)
106 alias_method
:distance_of_time_in_words_to_now, :time_ago_in_words
108 # Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based
109 # attribute (identified by +method+) on an object assigned to the template (identified by +object+). You can
110 # the output in the +options+ hash.
113 # * <tt>:use_month_numbers</tt> - Set to true if you want to use month numbers rather than month names (e.g.
114 # "2" instead of "February").
115 # * <tt>:use_short_month</tt> - Set to true if you want to use the abbreviated month name instead of the full
116 # name (e.g. "Feb" instead of "February").
117 # * <tt>:add_month_number</tt> - Set to true if you want to show both, the month's number and name (e.g.
118 # "2 - February" instead of "February").
119 # * <tt>:use_month_names</tt> - Set to an array with 12 month names if you want to customize month names.
120 # Note: You can also use Rails' new i18n functionality for this.
121 # * <tt>:date_separator</tt> - Specifies a string to separate the date fields. Default is "" (i.e. nothing).
122 # * <tt>:start_year</tt> - Set the start year for the year select. Default is <tt>Time.now.year - 5</tt>.
123 # * <tt>:end_year</tt> - Set the end year for the year select. Default is <tt>Time.now.year + 5</tt>.
124 # * <tt>:discard_day</tt> - Set to true if you don't want to show a day select. This includes the day
125 # as a hidden field instead of showing a select field. Also note that this implicitly sets the day to be the
126 # first of the given month in order to not create invalid dates like 31 February.
127 # * <tt>:discard_month</tt> - Set to true if you don't want to show a month select. This includes the month
128 # as a hidden field instead of showing a select field. Also note that this implicitly sets :discard_day to true.
129 # * <tt>:discard_year</tt> - Set to true if you don't want to show a year select. This includes the year
130 # as a hidden field instead of showing a select field.
131 # * <tt>:order</tt> - Set to an array containing <tt>:day</tt>, <tt>:month</tt> and <tt>:year</tt> do
132 # customize the order in which the select fields are shown. If you leave out any of the symbols, the respective
133 # select will not be shown (like when you set <tt>:discard_xxx => true</tt>. Defaults to the order defined in
134 # the respective locale (e.g. [:year, :month, :day] in the en locale that ships with Rails).
135 # * <tt>:include_blank</tt> - Include a blank option in every select field so it's possible to set empty
137 # * <tt>:default</tt> - Set a default date if the affected date isn't set or is nil.
138 # * <tt>:disabled</tt> - Set to true if you want show the select fields as disabled.
139 # * <tt>:prompt</tt> - Set to true (for a generic prompt), a prompt string or a hash of prompt strings
140 # for <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>, <tt>:hour</tt>, <tt>:minute</tt> and <tt>:second</tt>.
141 # Setting this option prepends a select option with a generic prompt (Day, Month, Year, Hour, Minute, Seconds)
142 # or the given prompt string.
144 # If anything is passed in the +html_options+ hash it will be applied to every select tag in the set.
146 # NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.
149 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
150 # date_select("post", "written_on")
152 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
153 # # with the year in the year drop down box starting at 1995.
154 # date_select("post", "written_on", :start_year => 1995)
156 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
157 # # with the year in the year drop down box starting at 1995, numbers used for months instead of words,
158 # # and without a day select box.
159 # date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true,
160 # :discard_day => true, :include_blank => true)
162 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
163 # # with the fields ordered as day, month, year rather than month, day, year.
164 # date_select("post", "written_on", :order => [:day, :month, :year])
166 # # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
167 # # lacking a year field.
168 # date_select("user", "birthday", :order => [:month, :day])
170 # # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
171 # # which is initially set to the date 3 days from the current date
172 # date_select("post", "written_on", :default => 3.days.from_now)
174 # # Generates a date select that when POSTed is stored in the credit_card variable, in the bill_due attribute
175 # # that will have a default day of 20.
176 # date_select("credit_card", "bill_due", :default => { :day => 20 })
178 # # Generates a date select with custom prompts
179 # date_select("post", "written_on", :prompt => { :day => 'Select day', :month => 'Select month', :year => 'Select year' })
181 # The selects are prepared for multi-parameter assignment to an Active Record object.
183 # Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that
184 # all month choices are valid.
185 def date_select(object_name
, method
, options
= {}, html_options
= {})
186 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_date_select_tag(options
, html_options
)
189 # Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a
190 # specified time-based attribute (identified by +method+) on an object assigned to the template (identified by
191 # +object+). You can include the seconds with <tt>:include_seconds</tt>.
193 # This method will also generate 3 input hidden tags, for the actual year, month and day unless the option
194 # <tt>:ignore_date</tt> is set to +true+.
196 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
199 # # Creates a time select tag that, when POSTed, will be stored in the post variable in the sunrise attribute
200 # time_select("post", "sunrise")
202 # # Creates a time select tag that, when POSTed, will be stored in the order variable in the submitted
204 # time_select("order", "submitted")
206 # # Creates a time select tag that, when POSTed, will be stored in the mail variable in the sent_at attribute
207 # time_select("mail", "sent_at")
209 # # Creates a time select tag with a seconds field that, when POSTed, will be stored in the post variables in
210 # # the sunrise attribute.
211 # time_select("post", "start_time", :include_seconds => true)
213 # # Creates a time select tag with a seconds field that, when POSTed, will be stored in the entry variables in
214 # # the submission_time attribute.
215 # time_select("entry", "submission_time", :include_seconds => true)
217 # # You can set the :minute_step to 15 which will give you: 00, 15, 30 and 45.
218 # time_select 'game', 'game_time', {:minute_step => 15}
220 # # Creates a time select tag with a custom prompt. Use :prompt => true for generic prompts.
221 # time_select("post", "written_on", :prompt => {:hour => 'Choose hour', :minute => 'Choose minute', :second => 'Choose seconds'})
222 # time_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
223 # time_select("post", "written_on", :prompt => true) # generic prompts for all
225 # The selects are prepared for multi-parameter assignment to an Active Record object.
227 # Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that
228 # all month choices are valid.
229 def time_select(object_name
, method
, options
= {}, html_options
= {})
230 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_time_select_tag(options
, html_options
)
233 # Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a
234 # specified datetime-based attribute (identified by +method+) on an object assigned to the template (identified
235 # by +object+). Examples:
237 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
240 # # Generates a datetime select that, when POSTed, will be stored in the post variable in the written_on
242 # datetime_select("post", "written_on")
244 # # Generates a datetime select with a year select that starts at 1995 that, when POSTed, will be stored in the
245 # # post variable in the written_on attribute.
246 # datetime_select("post", "written_on", :start_year => 1995)
248 # # Generates a datetime select with a default value of 3 days from the current time that, when POSTed, will
249 # # be stored in the trip variable in the departing attribute.
250 # datetime_select("trip", "departing", :default => 3.days.from_now)
252 # # Generates a datetime select that discards the type that, when POSTed, will be stored in the post variable
253 # # as the written_on attribute.
254 # datetime_select("post", "written_on", :discard_type => true)
256 # # Generates a datetime select with a custom prompt. Use :prompt=>true for generic prompts.
257 # datetime_select("post", "written_on", :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
258 # datetime_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
259 # datetime_select("post", "written_on", :prompt => true) # generic prompts for all
261 # The selects are prepared for multi-parameter assignment to an Active Record object.
262 def datetime_select(object_name
, method
, options
= {}, html_options
= {})
263 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_datetime_select_tag(options
, html_options
)
266 # Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the
267 # +datetime+. It's also possible to explicitly set the order of the tags using the <tt>:order</tt> option with
268 # an array of symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not
269 # supply a Symbol, it will be appended onto the <tt>:order</tt> passed in. You can also add
270 # <tt>:date_separator</tt>, <tt>:datetime_separator</tt> and <tt>:time_separator</tt> keys to the +options+ to
271 # control visual display of the elements.
273 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
276 # my_date_time = Time.now + 4.days
278 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
279 # select_datetime(my_date_time)
281 # # Generates a datetime select that defaults to today (no specified datetime)
284 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
285 # # with the fields ordered year, month, day rather than month, day, year.
286 # select_datetime(my_date_time, :order => [:year, :month, :day])
288 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
289 # # with a '/' between each date field.
290 # select_datetime(my_date_time, :date_separator => '/')
292 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
293 # # with a date fields separated by '/', time fields separated by '' and the date and time fields
294 # # separated by a comma (',').
295 # select_datetime(my_date_time, :date_separator => '/', :time_separator => '', :datetime_separator => ',')
297 # # Generates a datetime select that discards the type of the field and defaults to the datetime in
298 # # my_date_time (four days after today)
299 # select_datetime(my_date_time, :discard_type => true)
301 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
302 # # prefixed with 'payday' rather than 'date'
303 # select_datetime(my_date_time, :prefix => 'payday')
305 # # Generates a datetime select with a custom prompt. Use :prompt=>true for generic prompts.
306 # select_datetime(my_date_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
307 # select_datetime(my_date_time, :prompt => {:hour => true}) # generic prompt for hours
308 # select_datetime(my_date_time, :prompt => true) # generic prompts for all
310 def select_datetime(datetime
= Time
.current
, options
= {}, html_options
= {})
311 DateTimeSelector
.new(datetime
, options
, html_options
).select_datetime
314 # Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+.
315 # It's possible to explicitly set the order of the tags using the <tt>:order</tt> option with an array of
316 # symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not supply a Symbol,
317 # it will be appended onto the <tt>:order</tt> passed in.
319 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
322 # my_date = Time.today + 6.days
324 # # Generates a date select that defaults to the date in my_date (six days after today)
325 # select_date(my_date)
327 # # Generates a date select that defaults to today (no specified date)
330 # # Generates a date select that defaults to the date in my_date (six days after today)
331 # # with the fields ordered year, month, day rather than month, day, year.
332 # select_date(my_date, :order => [:year, :month, :day])
334 # # Generates a date select that discards the type of the field and defaults to the date in
335 # # my_date (six days after today)
336 # select_date(my_date, :discard_type => true)
338 # # Generates a date select that defaults to the date in my_date,
339 # # which has fields separated by '/'
340 # select_date(my_date, :date_separator => '/')
342 # # Generates a date select that defaults to the datetime in my_date (six days after today)
343 # # prefixed with 'payday' rather than 'date'
344 # select_date(my_date, :prefix => 'payday')
346 # # Generates a date select with a custom prompt. Use :prompt=>true for generic prompts.
347 # select_date(my_date, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
348 # select_date(my_date, :prompt => {:hour => true}) # generic prompt for hours
349 # select_date(my_date, :prompt => true) # generic prompts for all
351 def select_date(date
= Date
.current
, options
= {}, html_options
= {})
352 DateTimeSelector
.new(date
, options
, html_options
).select_date
355 # Returns a set of html select-tags (one for hour and minute)
356 # You can set <tt>:time_separator</tt> key to format the output, and
357 # the <tt>:include_seconds</tt> option to include an input for seconds.
359 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
362 # my_time = Time.now + 5.days + 7.hours + 3.minutes + 14.seconds
364 # # Generates a time select that defaults to the time in my_time
365 # select_time(my_time)
367 # # Generates a time select that defaults to the current time (no specified time)
370 # # Generates a time select that defaults to the time in my_time,
371 # # which has fields separated by ':'
372 # select_time(my_time, :time_separator => ':')
374 # # Generates a time select that defaults to the time in my_time,
375 # # that also includes an input for seconds
376 # select_time(my_time, :include_seconds => true)
378 # # Generates a time select that defaults to the time in my_time, that has fields
379 # # separated by ':' and includes an input for seconds
380 # select_time(my_time, :time_separator => ':', :include_seconds => true)
382 # # Generates a time select with a custom prompt. Use :prompt=>true for generic prompts.
383 # select_time(my_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
384 # select_time(my_time, :prompt => {:hour => true}) # generic prompt for hours
385 # select_time(my_time, :prompt => true) # generic prompts for all
387 def select_time(datetime
= Time
.current
, options
= {}, html_options
= {})
388 DateTimeSelector
.new(datetime
, options
, html_options
).select_time
391 # Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
392 # The <tt>second</tt> can also be substituted for a second number.
393 # Override the field name using the <tt>:field_name</tt> option, 'second' by default.
396 # my_time = Time.now + 16.minutes
398 # # Generates a select field for seconds that defaults to the seconds for the time in my_time
399 # select_second(my_time)
401 # # Generates a select field for seconds that defaults to the number given
404 # # Generates a select field for seconds that defaults to the seconds for the time in my_time
405 # # that is named 'interval' rather than 'second'
406 # select_second(my_time, :field_name => 'interval')
408 # # Generates a select field for seconds with a custom prompt. Use :prompt=>true for a
410 # select_minute(14, :prompt => 'Choose seconds')
412 def select_second(datetime
, options
= {}, html_options
= {})
413 DateTimeSelector
.new(datetime
, options
, html_options
).select_second
416 # Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
417 # Also can return a select tag with options by <tt>minute_step</tt> from 0 through 59 with the 00 minute
418 # selected. The <tt>minute</tt> can also be substituted for a minute number.
419 # Override the field name using the <tt>:field_name</tt> option, 'minute' by default.
422 # my_time = Time.now + 6.hours
424 # # Generates a select field for minutes that defaults to the minutes for the time in my_time
425 # select_minute(my_time)
427 # # Generates a select field for minutes that defaults to the number given
430 # # Generates a select field for minutes that defaults to the minutes for the time in my_time
431 # # that is named 'stride' rather than 'second'
432 # select_minute(my_time, :field_name => 'stride')
434 # # Generates a select field for minutes with a custom prompt. Use :prompt=>true for a
436 # select_minute(14, :prompt => 'Choose minutes')
438 def select_minute(datetime
, options
= {}, html_options
= {})
439 DateTimeSelector
.new(datetime
, options
, html_options
).select_minute
442 # Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
443 # The <tt>hour</tt> can also be substituted for a hour number.
444 # Override the field name using the <tt>:field_name</tt> option, 'hour' by default.
447 # my_time = Time.now + 6.hours
449 # # Generates a select field for hours that defaults to the hour for the time in my_time
450 # select_hour(my_time)
452 # # Generates a select field for hours that defaults to the number given
455 # # Generates a select field for hours that defaults to the minutes for the time in my_time
456 # # that is named 'stride' rather than 'second'
457 # select_hour(my_time, :field_name => 'stride')
459 # # Generates a select field for hours with a custom prompt. Use :prompt => true for a
461 # select_hour(13, :prompt =>'Choose hour')
463 def select_hour(datetime
, options
= {}, html_options
= {})
464 DateTimeSelector
.new(datetime
, options
, html_options
).select_hour
467 # Returns a select tag with options for each of the days 1 through 31 with the current day selected.
468 # The <tt>date</tt> can also be substituted for a hour number.
469 # Override the field name using the <tt>:field_name</tt> option, 'day' by default.
472 # my_date = Time.today + 2.days
474 # # Generates a select field for days that defaults to the day for the date in my_date
475 # select_day(my_time)
477 # # Generates a select field for days that defaults to the number given
480 # # Generates a select field for days that defaults to the day for the date in my_date
481 # # that is named 'due' rather than 'day'
482 # select_day(my_time, :field_name => 'due')
484 # # Generates a select field for days with a custom prompt. Use :prompt => true for a
486 # select_day(5, :prompt => 'Choose day')
488 def select_day(date
, options
= {}, html_options
= {})
489 DateTimeSelector
.new(date
, options
, html_options
).select_day
492 # Returns a select tag with options for each of the months January through December with the current month
493 # selected. The month names are presented as keys (what's shown to the user) and the month numbers (1-12) are
494 # used as values (what's submitted to the server). It's also possible to use month numbers for the presentation
495 # instead of names -- set the <tt>:use_month_numbers</tt> key in +options+ to true for this to happen. If you
496 # want both numbers and names, set the <tt>:add_month_numbers</tt> key in +options+ to true. If you would prefer
497 # to show month names as abbreviations, set the <tt>:use_short_month</tt> key in +options+ to true. If you want
498 # to use your own month names, set the <tt>:use_month_names</tt> key in +options+ to an array of 12 month names.
499 # Override the field name using the <tt>:field_name</tt> option, 'month' by default.
502 # # Generates a select field for months that defaults to the current month that
503 # # will use keys like "January", "March".
504 # select_month(Date.today)
506 # # Generates a select field for months that defaults to the current month that
507 # # is named "start" rather than "month"
508 # select_month(Date.today, :field_name => 'start')
510 # # Generates a select field for months that defaults to the current month that
511 # # will use keys like "1", "3".
512 # select_month(Date.today, :use_month_numbers => true)
514 # # Generates a select field for months that defaults to the current month that
515 # # will use keys like "1 - January", "3 - March".
516 # select_month(Date.today, :add_month_numbers => true)
518 # # Generates a select field for months that defaults to the current month that
519 # # will use keys like "Jan", "Mar".
520 # select_month(Date.today, :use_short_month => true)
522 # # Generates a select field for months that defaults to the current month that
523 # # will use keys like "Januar", "Marts."
524 # select_month(Date.today, :use_month_names => %w(Januar Februar Marts ...))
526 # # Generates a select field for months with a custom prompt. Use :prompt => true for a
528 # select_month(14, :prompt => 'Choose month')
530 def select_month(date
, options
= {}, html_options
= {})
531 DateTimeSelector
.new(date
, options
, html_options
).select_month
534 # Returns a select tag with options for each of the five years on each side of the current, which is selected.
535 # The five year radius can be changed using the <tt>:start_year</tt> and <tt>:end_year</tt> keys in the
536 # +options+. Both ascending and descending year lists are supported by making <tt>:start_year</tt> less than or
537 # greater than <tt>:end_year</tt>. The <tt>date</tt> can also be substituted for a year given as a number.
538 # Override the field name using the <tt>:field_name</tt> option, 'year' by default.
541 # # Generates a select field for years that defaults to the current year that
542 # # has ascending year values
543 # select_year(Date.today, :start_year => 1992, :end_year => 2007)
545 # # Generates a select field for years that defaults to the current year that
546 # # is named 'birth' rather than 'year'
547 # select_year(Date.today, :field_name => 'birth')
549 # # Generates a select field for years that defaults to the current year that
550 # # has descending year values
551 # select_year(Date.today, :start_year => 2005, :end_year => 1900)
553 # # Generates a select field for years that defaults to the year 2006 that
554 # # has ascending year values
555 # select_year(2006, :start_year => 2000, :end_year => 2010)
557 # # Generates a select field for years with a custom prompt. Use :prompt => true for a
559 # select_year(14, :prompt => 'Choose year')
561 def select_year(date
, options
= {}, html_options
= {})
562 DateTimeSelector
.new(date
, options
, html_options
).select_year
566 class DateTimeSelector
#:nodoc:
567 extend ActiveSupport
::Memoizable
568 include ActionView
::Helpers::TagHelper
570 DEFAULT_PREFIX
= 'date'.freeze
unless const_defined
?('DEFAULT_PREFIX')
572 :year => 1, :month => 2, :day => 3, :hour => 4, :minute => 5, :second => 6
573 }.freeze
unless const_defined
?('POSITION')
575 def initialize(datetime
, options
= {}, html_options
= {})
576 @options = options
.dup
577 @html_options = html_options
.dup
582 # TODO: Remove tag conditional
583 # Ideally we could just join select_date and select_date for the tag case
584 if @options[:tag] && @options[:ignore_date]
587 order
= date_order
.dup
588 order
-= [:hour, :minute, :second]
590 @options[:discard_year] ||= true unless order
.include?(:year)
591 @options[:discard_month] ||= true unless order
.include?(:month)
592 @options[:discard_day] ||= true if @options[:discard_month] || !order
.include?(:day)
593 @options[:discard_minute] ||= true if @options[:discard_hour]
594 @options[:discard_second] ||= true unless @options[:include_seconds] && !@options[:discard_minute]
596 # If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
597 # valid (otherwise it could be 31 and february wouldn't be a valid date)
598 if @datetime && @options[:discard_day] && !@options[:discard_month]
599 @datetime = @datetime.change(:day => 1)
602 [:day, :month, :year].each
{ |o
| order
.unshift(o
) unless order
.include?(o
) }
603 order
+= [:hour, :minute, :second] unless @options[:discard_hour]
605 build_selects_from_types(order
)
607 "#{select_date}#{@options[:datetime_separator]}#{select_time}"
612 order
= date_order
.dup
614 # TODO: Remove tag conditional
616 @options[:discard_hour] = true
617 @options[:discard_minute] = true
618 @options[:discard_second] = true
620 @options[:discard_year] ||= true unless order
.include?(:year)
621 @options[:discard_month] ||= true unless order
.include?(:month)
622 @options[:discard_day] ||= true if @options[:discard_month] || !order
.include?(:day)
624 # If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
625 # valid (otherwise it could be 31 and february wouldn't be a valid date)
626 if @datetime && @options[:discard_day] && !@options[:discard_month]
627 @datetime = @datetime.change(:day => 1)
631 [:day, :month, :year].each
{ |o
| order
.unshift(o
) unless order
.include?(o
) }
633 build_selects_from_types(order
)
639 # TODO: Remove tag conditional
641 @options[:discard_month] = true
642 @options[:discard_year] = true
643 @options[:discard_day] = true
644 @options[:discard_second] ||= true unless @options[:include_seconds]
646 order
+= [:year, :month, :day] unless @options[:ignore_date]
649 order
+= [:hour, :minute]
650 order
<< :second if @options[:include_seconds]
652 build_selects_from_types(order
)
656 if @options[:use_hidden] || @options[:discard_second]
657 build_hidden(:second, sec
) if @options[:include_seconds]
659 build_options_and_select(:second, sec
)
664 if @options[:use_hidden] || @options[:discard_minute]
665 build_hidden(:minute, min
)
667 build_options_and_select(:minute, min
, :step => @options[:minute_step])
672 if @options[:use_hidden] || @options[:discard_hour]
673 build_hidden(:hour, hour
)
675 build_options_and_select(:hour, hour
, :end => 23)
680 if @options[:use_hidden] || @options[:discard_day]
681 build_hidden(:day, day
)
683 build_options_and_select(:day, day
, :start => 1, :end => 31, :leading_zeros => false)
688 if @options[:use_hidden] || @options[:discard_month]
689 build_hidden(:month, month
)
692 1.upto(12) do |month_number
|
693 options
= { :value => month_number
}
694 options
[:selected] = "selected" if month
== month_number
695 month_options
<< content_tag(:option, month_name(month_number
), options
) + "\n"
697 build_select(:month, month_options
.join
)
702 if !@datetime || @datetime == 0
704 middle_year
= Date
.today
.year
706 val
= middle_year
= year
709 if @options[:use_hidden] || @options[:discard_year]
710 build_hidden(:year, val
)
713 options
[:start] = @options[:start_year] || middle_year
- 5
714 options
[:end] = @options[:end_year] || middle_year
+ 5
715 options
[:step] = options
[:start] < options
[:end] ? 1 : -1
716 options
[:leading_zeros] = false
718 build_options_and_select(:year, val
, options
)
723 %w( sec min hour day month year
).each
do |method
|
724 define_method(method
) do
725 @datetime.kind_of
?(Fixnum
) ? @datetime : @datetime.send(method
) if @datetime
729 # Returns translated month names, but also ensures that a custom month
730 # name array has a leading nil element
732 month_names
= @options[:use_month_names] || translated_month_names
733 month_names
.unshift(nil) if month_names
.size
< 13
738 # Returns translated month names
739 # => [nil, "January", "February", "March",
740 # "April", "May", "June", "July",
741 # "August", "September", "October",
742 # "November", "December"]
744 # If :use_short_month option is set
745 # => [nil, "Jan", "Feb", "Mar", "Apr", "May", "Jun",
746 # "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
747 def translated_month_names
749 key
= @options[:use_short_month] ? :'date.abbr_month_names' : :'date.month_names'
750 I18n
.translate(key
, :locale => @options[:locale])
754 # Lookup month name for number
755 # month_name(1) => "January"
757 # If :use_month_numbers option is passed
760 # If :add_month_numbers option is passed
761 # month_name(1) => "1 - January"
762 def month_name(number
)
763 if @options[:use_month_numbers]
765 elsif @options[:add_month_numbers]
766 "#{number} - #{month_names[number]}"
773 @options[:order] || translated_date_order
777 def translated_date_order
779 I18n
.translate(:'date.order', :locale => @options[:locale]) || []
783 # Build full select tag from date type and options
784 def build_options_and_select(type
, selected
, options
= {})
785 build_select(type
, build_options(selected
, options
))
788 # Build select option html from date value and options
789 # build_options(15, :start => 1, :end => 31)
790 # => "<option value="1">1</option>
791 # <option value=\"2\">2</option>
792 # <option value=\"3\">3</option>..."
793 def build_options(selected
, options
= {})
794 start
= options
.delete(:start) || 0
795 stop
= options
.delete(:end) || 59
796 step
= options
.delete(:step) || 1
797 leading_zeros
= options
.delete(:leading_zeros).nil? ? true : false
800 start
.step(stop
, step
) do |i
|
801 value
= leading_zeros
? sprintf("%02d", i
) : i
802 tag_options
= { :value => value
}
803 tag_options
[:selected] = "selected" if selected
== i
804 select_options
<< content_tag(:option, value
, tag_options
)
806 select_options
.join("\n") + "\n"
809 # Builds select tag from date type and html select options
810 # build_select(:month, "<option value="1">January</option>...")
811 # => "<select id="post_written_on_2i" name="post[written_on(2i)]">
812 # <option value="1">January</option>...
814 def build_select(type
, select_options_as_html
)
816 :id => input_id_from_type(type
),
817 :name => input_name_from_type(type
)
818 }.merge(@html_options)
819 select_options
.merge
!(:disabled => 'disabled') if @options[:disabled]
822 select_html
<< content_tag(:option, '', :value => '') + "\n" if @options[:include_blank]
823 select_html
<< prompt_option_tag(type
, @options[:prompt]) + "\n" if @options[:prompt]
824 select_html
<< select_options_as_html
.to_s
826 content_tag(:select, select_html
, select_options
) + "\n"
829 # Builds a prompt option tag with supplied options or from default options
830 # prompt_option_tag(:month, :prompt => 'Select month')
831 # => "<option value="">Select month</option>"
832 def prompt_option_tag(type
, options
)
833 default_options
= {:year => false, :month => false, :day => false, :hour => false, :minute => false, :second => false}
837 prompt
= default_options
.merge(options
)[type
.to_sym
]
841 prompt
= I18n
.translate(('datetime.prompts.' + type
.to_s
).to_sym
, :locale => @options[:locale])
844 prompt
? content_tag(:option, prompt
, :value => '') : ''
847 # Builds hidden input tag for date part and value
848 # build_hidden(:year, 2008)
849 # => "<input id="post_written_on_1i" name="post[written_on(1i)]" type="hidden" value="2008" />"
850 def build_hidden(type
, value
)
853 :id => input_id_from_type(type
),
854 :name => input_name_from_type(type
),
859 # Returns the name attribute for the input tag
860 # => post[written_on(1i)]
861 def input_name_from_type(type
)
862 prefix
= @options[:prefix] || ActionView
::Helpers::DateTimeSelector::DEFAULT_PREFIX
863 prefix
+= "[#{@options[:index]}]" if @options.has_key
?(:index)
865 field_name
= @options[:field_name] || type
866 if @options[:include_position]
867 field_name
+= "(#{ActionView::Helpers::DateTimeSelector::POSITION[type]}i)"
870 @options[:discard_type] ? prefix
: "#{prefix}[#{field_name}]"
873 # Returns the id attribute for the input tag
874 # => "post_written_on_1i"
875 def input_id_from_type(type
)
876 input_name_from_type(type
).gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '')
879 # Given an ordering of datetime components, create the selection html
880 # and join them with their appropriate seperators
881 def build_selects_from_types(order
)
883 order
.reverse
.each
do |type
|
884 separator
= separator(type
) unless type
== order
.first
# don't add on last field
885 select
.insert(0, separator
.to_s
+ send("select_#{type}").to_s
)
890 # Returns the separator for a given datetime component
894 @options[:date_separator]
896 (@options[:discard_year] && @options[:discard_day]) ? "" : @options[:datetime_separator]
898 @options[:time_separator]
900 @options[:include_seconds] ? @options[:time_separator] : ""
905 class InstanceTag
#:nodoc:
906 def to_date_select_tag(options
= {}, html_options
= {})
907 datetime_selector(options
, html_options
).select_date
910 def to_time_select_tag(options
= {}, html_options
= {})
911 datetime_selector(options
, html_options
).select_time
914 def to_datetime_select_tag(options
= {}, html_options
= {})
915 datetime_selector(options
, html_options
).select_datetime
919 def datetime_selector(options
, html_options
)
920 datetime
= value(object
) || default_datetime(options
)
922 options
= options
.dup
923 options
[:field_name] = @method_name
924 options
[:include_position] = true
925 options
[:prefix] ||= @object_name
926 options
[:index] = @auto_index if @auto_index && !options
.has_key
?(:index)
927 options
[:datetime_separator] ||= ' — '
928 options
[:time_separator] ||= ' : '
930 DateTimeSelector
.new(datetime
, options
.merge(:tag => true), html_options
)
933 def default_datetime(options
)
934 return if options
[:include_blank] || options
[:prompt]
936 case options
[:default]
942 default
= options
[:default].dup
944 # Rename :minute and :second to :min and :sec
945 default
[:min] ||= default
[:minute]
946 default
[:sec] ||= default
[:second]
950 [:year, :month, :day, :hour, :min, :sec].each
do |key
|
951 default
[key
] ||= time
.send(key
)
955 default
[:year], default
[:month], default
[:day],
956 default
[:hour], default
[:min], default
[:sec]
963 def date_select(method
, options
= {}, html_options
= {})
964 @template.date_select(@object_name, method
, objectify_options(options
), html_options
)
967 def time_select(method
, options
= {}, html_options
= {})
968 @template.time_select(@object_name, method
, objectify_options(options
), html_options
)
971 def datetime_select(method
, options
= {}, html_options
= {})
972 @template.datetime_select(@object_name, method
, objectify_options(options
), html_options
)