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 <-> 1 yr, 3 months # => about 1 year
30
# 1 yr, 3 months <-> 1 yr, 9 months # => over 1 year
31
# 1 yr, 9 months <-> 2 yr minus 1 sec # => almost 2 years
32
# 2 yrs <-> max time or date # => (same rules as 1 yr)
34
# With <tt>include_seconds</tt> = true and the difference < 1 minute 29 seconds:
35
# 0-4 secs # => less than 5 seconds
36
# 5-9 secs # => less than 10 seconds
37
# 10-19 secs # => less than 20 seconds
38
# 20-39 secs # => half a minute
39
# 40-59 secs # => less than a minute
40
# 60-89 secs # => 1 minute
43
# from_time = Time.now
44
# distance_of_time_in_words(from_time, from_time + 50.minutes) # => about 1 hour
45
# distance_of_time_in_words(from_time, 50.minutes.from_now) # => about 1 hour
46
# distance_of_time_in_words(from_time, from_time + 15.seconds) # => less than a minute
47
# distance_of_time_in_words(from_time, from_time + 15.seconds, true) # => less than 20 seconds
48
# distance_of_time_in_words(from_time, 3.years.from_now) # => about 3 years
49
# distance_of_time_in_words(from_time, from_time + 60.hours) # => about 3 days
50
# distance_of_time_in_words(from_time, from_time + 45.seconds, true) # => less than a minute
51
# distance_of_time_in_words(from_time, from_time - 45.seconds, true) # => less than a minute
52
# distance_of_time_in_words(from_time, 76.seconds.from_now) # => 1 minute
53
# distance_of_time_in_words(from_time, from_time + 1.year + 3.days) # => about 1 year
54
# distance_of_time_in_words(from_time, from_time + 3.years + 6.months) # => over 3 years
55
# distance_of_time_in_words(from_time, from_time + 4.years + 9.days + 30.minutes + 5.seconds) # => about 4 years
57
# to_time = Time.now + 6.years + 19.days
58
# distance_of_time_in_words(from_time, to_time, true) # => about 6 years
59
# distance_of_time_in_words(to_time, from_time, true) # => about 6 years
60
# distance_of_time_in_words(Time.now, Time.now) # => less than a minute
62
def distance_of_time_in_words(from_time, to_time = 0, include_seconds = false, options = {})
63
from_time = from_time.to_time if from_time.respond_to?(:to_time)
64
to_time = to_time.to_time if to_time.respond_to?(:to_time)
65
distance_in_minutes = (((to_time - from_time).abs)/60).round
66
distance_in_seconds = ((to_time - from_time).abs).round
68
I18n.with_options :locale => options[:locale], :scope => :'datetime.distance_in_words' do |locale|
69
case distance_in_minutes
71
return distance_in_minutes == 0 ?
72
locale.t(:less_than_x_minutes, :count => 1) :
73
locale.t(:x_minutes, :count => distance_in_minutes) unless include_seconds
75
case distance_in_seconds
76
when 0..4 then locale.t :less_than_x_seconds, :count => 5
77
when 5..9 then locale.t :less_than_x_seconds, :count => 10
78
when 10..19 then locale.t :less_than_x_seconds, :count => 20
79
when 20..39 then locale.t :half_a_minute
80
when 40..59 then locale.t :less_than_x_minutes, :count => 1
81
else locale.t :x_minutes, :count => 1
84
when 2..44 then locale.t :x_minutes, :count => distance_in_minutes
85
when 45..89 then locale.t :about_x_hours, :count => 1
86
when 90..1439 then locale.t :about_x_hours, :count => (distance_in_minutes.to_f / 60.0).round
87
when 1440..2529 then locale.t :x_days, :count => 1
88
when 2530..43199 then locale.t :x_days, :count => (distance_in_minutes.to_f / 1440.0).round
89
when 43200..86399 then locale.t :about_x_months, :count => 1
90
when 86400..525599 then locale.t :x_months, :count => (distance_in_minutes.to_f / 43200.0).round
92
distance_in_years = distance_in_minutes / 525600
93
minute_offset_for_leap_year = (distance_in_years / 4) * 1440
94
remainder = ((distance_in_minutes - minute_offset_for_leap_year) % 525600)
96
locale.t(:about_x_years, :count => distance_in_years)
97
elsif remainder < 394200
98
locale.t(:over_x_years, :count => distance_in_years)
100
locale.t(:almost_x_years, :count => distance_in_years + 1)
106
# Like distance_of_time_in_words, but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>.
109
# time_ago_in_words(3.minutes.from_now) # => 3 minutes
110
# time_ago_in_words(Time.now - 15.hours) # => 15 hours
111
# time_ago_in_words(Time.now) # => less than a minute
113
# from_time = Time.now - 3.days - 14.minutes - 25.seconds # => 3 days
114
def time_ago_in_words(from_time, include_seconds = false)
115
distance_of_time_in_words(from_time, Time.now, include_seconds)
118
alias_method :distance_of_time_in_words_to_now, :time_ago_in_words
120
# Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based
121
# attribute (identified by +method+) on an object assigned to the template (identified by +object+). You can
122
# the output in the +options+ hash.
125
# * <tt>:use_month_numbers</tt> - Set to true if you want to use month numbers rather than month names (e.g.
126
# "2" instead of "February").
127
# * <tt>:use_short_month</tt> - Set to true if you want to use the abbreviated month name instead of the full
128
# name (e.g. "Feb" instead of "February").
129
# * <tt>:add_month_number</tt> - Set to true if you want to show both, the month's number and name (e.g.
130
# "2 - February" instead of "February").
131
# * <tt>:use_month_names</tt> - Set to an array with 12 month names if you want to customize month names.
132
# Note: You can also use Rails' new i18n functionality for this.
133
# * <tt>:date_separator</tt> - Specifies a string to separate the date fields. Default is "" (i.e. nothing).
134
# * <tt>:start_year</tt> - Set the start year for the year select. Default is <tt>Time.now.year - 5</tt>.
135
# * <tt>:end_year</tt> - Set the end year for the year select. Default is <tt>Time.now.year + 5</tt>.
136
# * <tt>:discard_day</tt> - Set to true if you don't want to show a day select. This includes the day
137
# as a hidden field instead of showing a select field. Also note that this implicitly sets the day to be the
138
# first of the given month in order to not create invalid dates like 31 February.
139
# * <tt>:discard_month</tt> - Set to true if you don't want to show a month select. This includes the month
140
# as a hidden field instead of showing a select field. Also note that this implicitly sets :discard_day to true.
141
# * <tt>:discard_year</tt> - Set to true if you don't want to show a year select. This includes the year
142
# as a hidden field instead of showing a select field.
143
# * <tt>:order</tt> - Set to an array containing <tt>:day</tt>, <tt>:month</tt> and <tt>:year</tt> do
144
# customize the order in which the select fields are shown. If you leave out any of the symbols, the respective
145
# select will not be shown (like when you set <tt>:discard_xxx => true</tt>. Defaults to the order defined in
146
# the respective locale (e.g. [:year, :month, :day] in the en locale that ships with Rails).
147
# * <tt>:include_blank</tt> - Include a blank option in every select field so it's possible to set empty
149
# * <tt>:default</tt> - Set a default date if the affected date isn't set or is nil.
150
# * <tt>:disabled</tt> - Set to true if you want show the select fields as disabled.
151
# * <tt>:prompt</tt> - Set to true (for a generic prompt), a prompt string or a hash of prompt strings
152
# for <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>, <tt>:hour</tt>, <tt>:minute</tt> and <tt>:second</tt>.
153
# Setting this option prepends a select option with a generic prompt (Day, Month, Year, Hour, Minute, Seconds)
154
# or the given prompt string.
156
# If anything is passed in the +html_options+ hash it will be applied to every select tag in the set.
158
# NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.
161
# # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
162
# date_select("post", "written_on")
164
# # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
165
# # with the year in the year drop down box starting at 1995.
166
# date_select("post", "written_on", :start_year => 1995)
168
# # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
169
# # with the year in the year drop down box starting at 1995, numbers used for months instead of words,
170
# # and without a day select box.
171
# date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true,
172
# :discard_day => true, :include_blank => true)
174
# # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
175
# # with the fields ordered as day, month, year rather than month, day, year.
176
# date_select("post", "written_on", :order => [:day, :month, :year])
178
# # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
179
# # lacking a year field.
180
# date_select("user", "birthday", :order => [:month, :day])
182
# # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
183
# # which is initially set to the date 3 days from the current date
184
# date_select("post", "written_on", :default => 3.days.from_now)
186
# # Generates a date select that when POSTed is stored in the credit_card variable, in the bill_due attribute
187
# # that will have a default day of 20.
188
# date_select("credit_card", "bill_due", :default => { :day => 20 })
190
# # Generates a date select with custom prompts
191
# date_select("post", "written_on", :prompt => { :day => 'Select day', :month => 'Select month', :year => 'Select year' })
193
# The selects are prepared for multi-parameter assignment to an Active Record object.
195
# 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
196
# all month choices are valid.
197
def date_select(object_name, method, options = {}, html_options = {})
198
InstanceTag.new(object_name, method, self, options.delete(:object)).to_date_select_tag(options, html_options)
201
# Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a
202
# specified time-based attribute (identified by +method+) on an object assigned to the template (identified by
203
# +object+). You can include the seconds with <tt>:include_seconds</tt>.
205
# This method will also generate 3 input hidden tags, for the actual year, month and day unless the option
206
# <tt>:ignore_date</tt> is set to +true+.
208
# If anything is passed in the html_options hash it will be applied to every select tag in the set.
211
# # Creates a time select tag that, when POSTed, will be stored in the post variable in the sunrise attribute
212
# time_select("post", "sunrise")
214
# # Creates a time select tag that, when POSTed, will be stored in the order variable in the submitted
216
# time_select("order", "submitted")
218
# # Creates a time select tag that, when POSTed, will be stored in the mail variable in the sent_at attribute
219
# time_select("mail", "sent_at")
221
# # Creates a time select tag with a seconds field that, when POSTed, will be stored in the post variables in
222
# # the sunrise attribute.
223
# time_select("post", "start_time", :include_seconds => true)
225
# # Creates a time select tag with a seconds field that, when POSTed, will be stored in the entry variables in
226
# # the submission_time attribute.
227
# time_select("entry", "submission_time", :include_seconds => true)
229
# # You can set the :minute_step to 15 which will give you: 00, 15, 30 and 45.
230
# time_select 'game', 'game_time', {:minute_step => 15}
232
# # Creates a time select tag with a custom prompt. Use :prompt => true for generic prompts.
233
# time_select("post", "written_on", :prompt => {:hour => 'Choose hour', :minute => 'Choose minute', :second => 'Choose seconds'})
234
# time_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
235
# time_select("post", "written_on", :prompt => true) # generic prompts for all
237
# The selects are prepared for multi-parameter assignment to an Active Record object.
239
# 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
240
# all month choices are valid.
241
def time_select(object_name, method, options = {}, html_options = {})
242
InstanceTag.new(object_name, method, self, options.delete(:object)).to_time_select_tag(options, html_options)
245
# Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a
246
# specified datetime-based attribute (identified by +method+) on an object assigned to the template (identified
247
# by +object+). Examples:
249
# If anything is passed in the html_options hash it will be applied to every select tag in the set.
252
# # Generates a datetime select that, when POSTed, will be stored in the post variable in the written_on
254
# datetime_select("post", "written_on")
256
# # Generates a datetime select with a year select that starts at 1995 that, when POSTed, will be stored in the
257
# # post variable in the written_on attribute.
258
# datetime_select("post", "written_on", :start_year => 1995)
260
# # Generates a datetime select with a default value of 3 days from the current time that, when POSTed, will
261
# # be stored in the trip variable in the departing attribute.
262
# datetime_select("trip", "departing", :default => 3.days.from_now)
264
# # Generates a datetime select that discards the type that, when POSTed, will be stored in the post variable
265
# # as the written_on attribute.
266
# datetime_select("post", "written_on", :discard_type => true)
268
# # Generates a datetime select with a custom prompt. Use :prompt=>true for generic prompts.
269
# datetime_select("post", "written_on", :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
270
# datetime_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
271
# datetime_select("post", "written_on", :prompt => true) # generic prompts for all
273
# The selects are prepared for multi-parameter assignment to an Active Record object.
274
def datetime_select(object_name, method, options = {}, html_options = {})
275
InstanceTag.new(object_name, method, self, options.delete(:object)).to_datetime_select_tag(options, html_options)
278
# Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the
279
# +datetime+. It's also possible to explicitly set the order of the tags using the <tt>:order</tt> option with
280
# an array of symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not
281
# supply a Symbol, it will be appended onto the <tt>:order</tt> passed in. You can also add
282
# <tt>:date_separator</tt>, <tt>:datetime_separator</tt> and <tt>:time_separator</tt> keys to the +options+ to
283
# control visual display of the elements.
285
# If anything is passed in the html_options hash it will be applied to every select tag in the set.
288
# my_date_time = Time.now + 4.days
290
# # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
291
# select_datetime(my_date_time)
293
# # Generates a datetime select that defaults to today (no specified datetime)
296
# # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
297
# # with the fields ordered year, month, day rather than month, day, year.
298
# select_datetime(my_date_time, :order => [:year, :month, :day])
300
# # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
301
# # with a '/' between each date field.
302
# select_datetime(my_date_time, :date_separator => '/')
304
# # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
305
# # with a date fields separated by '/', time fields separated by '' and the date and time fields
306
# # separated by a comma (',').
307
# select_datetime(my_date_time, :date_separator => '/', :time_separator => '', :datetime_separator => ',')
309
# # Generates a datetime select that discards the type of the field and defaults to the datetime in
310
# # my_date_time (four days after today)
311
# select_datetime(my_date_time, :discard_type => true)
313
# # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
314
# # prefixed with 'payday' rather than 'date'
315
# select_datetime(my_date_time, :prefix => 'payday')
317
# # Generates a datetime select with a custom prompt. Use :prompt=>true for generic prompts.
318
# select_datetime(my_date_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
319
# select_datetime(my_date_time, :prompt => {:hour => true}) # generic prompt for hours
320
# select_datetime(my_date_time, :prompt => true) # generic prompts for all
322
def select_datetime(datetime = Time.current, options = {}, html_options = {})
323
DateTimeSelector.new(datetime, options, html_options).select_datetime
326
# Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+.
327
# It's possible to explicitly set the order of the tags using the <tt>:order</tt> option with an array of
328
# symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not supply a Symbol,
329
# it will be appended onto the <tt>:order</tt> passed in.
331
# If anything is passed in the html_options hash it will be applied to every select tag in the set.
334
# my_date = Time.today + 6.days
336
# # Generates a date select that defaults to the date in my_date (six days after today)
337
# select_date(my_date)
339
# # Generates a date select that defaults to today (no specified date)
342
# # Generates a date select that defaults to the date in my_date (six days after today)
343
# # with the fields ordered year, month, day rather than month, day, year.
344
# select_date(my_date, :order => [:year, :month, :day])
346
# # Generates a date select that discards the type of the field and defaults to the date in
347
# # my_date (six days after today)
348
# select_date(my_date, :discard_type => true)
350
# # Generates a date select that defaults to the date in my_date,
351
# # which has fields separated by '/'
352
# select_date(my_date, :date_separator => '/')
354
# # Generates a date select that defaults to the datetime in my_date (six days after today)
355
# # prefixed with 'payday' rather than 'date'
356
# select_date(my_date, :prefix => 'payday')
358
# # Generates a date select with a custom prompt. Use :prompt=>true for generic prompts.
359
# select_date(my_date, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
360
# select_date(my_date, :prompt => {:hour => true}) # generic prompt for hours
361
# select_date(my_date, :prompt => true) # generic prompts for all
363
def select_date(date = Date.current, options = {}, html_options = {})
364
DateTimeSelector.new(date, options, html_options).select_date
367
# Returns a set of html select-tags (one for hour and minute)
368
# You can set <tt>:time_separator</tt> key to format the output, and
369
# the <tt>:include_seconds</tt> option to include an input for seconds.
371
# If anything is passed in the html_options hash it will be applied to every select tag in the set.
374
# my_time = Time.now + 5.days + 7.hours + 3.minutes + 14.seconds
376
# # Generates a time select that defaults to the time in my_time
377
# select_time(my_time)
379
# # Generates a time select that defaults to the current time (no specified time)
382
# # Generates a time select that defaults to the time in my_time,
383
# # which has fields separated by ':'
384
# select_time(my_time, :time_separator => ':')
386
# # Generates a time select that defaults to the time in my_time,
387
# # that also includes an input for seconds
388
# select_time(my_time, :include_seconds => true)
390
# # Generates a time select that defaults to the time in my_time, that has fields
391
# # separated by ':' and includes an input for seconds
392
# select_time(my_time, :time_separator => ':', :include_seconds => true)
394
# # Generates a time select with a custom prompt. Use :prompt=>true for generic prompts.
395
# select_time(my_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
396
# select_time(my_time, :prompt => {:hour => true}) # generic prompt for hours
397
# select_time(my_time, :prompt => true) # generic prompts for all
399
def select_time(datetime = Time.current, options = {}, html_options = {})
400
DateTimeSelector.new(datetime, options, html_options).select_time
403
# Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
404
# The <tt>second</tt> can also be substituted for a second number.
405
# Override the field name using the <tt>:field_name</tt> option, 'second' by default.
408
# my_time = Time.now + 16.minutes
410
# # Generates a select field for seconds that defaults to the seconds for the time in my_time
411
# select_second(my_time)
413
# # Generates a select field for seconds that defaults to the number given
416
# # Generates a select field for seconds that defaults to the seconds for the time in my_time
417
# # that is named 'interval' rather than 'second'
418
# select_second(my_time, :field_name => 'interval')
420
# # Generates a select field for seconds with a custom prompt. Use :prompt=>true for a
422
# select_minute(14, :prompt => 'Choose seconds')
424
def select_second(datetime, options = {}, html_options = {})
425
DateTimeSelector.new(datetime, options, html_options).select_second
428
# Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
429
# Also can return a select tag with options by <tt>minute_step</tt> from 0 through 59 with the 00 minute
430
# selected. The <tt>minute</tt> can also be substituted for a minute number.
431
# Override the field name using the <tt>:field_name</tt> option, 'minute' by default.
434
# my_time = Time.now + 6.hours
436
# # Generates a select field for minutes that defaults to the minutes for the time in my_time
437
# select_minute(my_time)
439
# # Generates a select field for minutes that defaults to the number given
442
# # Generates a select field for minutes that defaults to the minutes for the time in my_time
443
# # that is named 'stride' rather than 'second'
444
# select_minute(my_time, :field_name => 'stride')
446
# # Generates a select field for minutes with a custom prompt. Use :prompt=>true for a
448
# select_minute(14, :prompt => 'Choose minutes')
450
def select_minute(datetime, options = {}, html_options = {})
451
DateTimeSelector.new(datetime, options, html_options).select_minute
454
# Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
455
# The <tt>hour</tt> can also be substituted for a hour number.
456
# Override the field name using the <tt>:field_name</tt> option, 'hour' by default.
459
# my_time = Time.now + 6.hours
461
# # Generates a select field for hours that defaults to the hour for the time in my_time
462
# select_hour(my_time)
464
# # Generates a select field for hours that defaults to the number given
467
# # Generates a select field for hours that defaults to the minutes for the time in my_time
468
# # that is named 'stride' rather than 'second'
469
# select_hour(my_time, :field_name => 'stride')
471
# # Generates a select field for hours with a custom prompt. Use :prompt => true for a
473
# select_hour(13, :prompt =>'Choose hour')
475
def select_hour(datetime, options = {}, html_options = {})
476
DateTimeSelector.new(datetime, options, html_options).select_hour
479
# Returns a select tag with options for each of the days 1 through 31 with the current day selected.
480
# The <tt>date</tt> can also be substituted for a hour number.
481
# Override the field name using the <tt>:field_name</tt> option, 'day' by default.
484
# my_date = Time.today + 2.days
486
# # Generates a select field for days that defaults to the day for the date in my_date
487
# select_day(my_time)
489
# # Generates a select field for days that defaults to the number given
492
# # Generates a select field for days that defaults to the day for the date in my_date
493
# # that is named 'due' rather than 'day'
494
# select_day(my_time, :field_name => 'due')
496
# # Generates a select field for days with a custom prompt. Use :prompt => true for a
498
# select_day(5, :prompt => 'Choose day')
500
def select_day(date, options = {}, html_options = {})
501
DateTimeSelector.new(date, options, html_options).select_day
504
# Returns a select tag with options for each of the months January through December with the current month
505
# selected. The month names are presented as keys (what's shown to the user) and the month numbers (1-12) are
506
# used as values (what's submitted to the server). It's also possible to use month numbers for the presentation
507
# instead of names -- set the <tt>:use_month_numbers</tt> key in +options+ to true for this to happen. If you
508
# want both numbers and names, set the <tt>:add_month_numbers</tt> key in +options+ to true. If you would prefer
509
# to show month names as abbreviations, set the <tt>:use_short_month</tt> key in +options+ to true. If you want
510
# to use your own month names, set the <tt>:use_month_names</tt> key in +options+ to an array of 12 month names.
511
# Override the field name using the <tt>:field_name</tt> option, 'month' by default.
514
# # Generates a select field for months that defaults to the current month that
515
# # will use keys like "January", "March".
516
# select_month(Date.today)
518
# # Generates a select field for months that defaults to the current month that
519
# # is named "start" rather than "month"
520
# select_month(Date.today, :field_name => 'start')
522
# # Generates a select field for months that defaults to the current month that
523
# # will use keys like "1", "3".
524
# select_month(Date.today, :use_month_numbers => true)
526
# # Generates a select field for months that defaults to the current month that
527
# # will use keys like "1 - January", "3 - March".
528
# select_month(Date.today, :add_month_numbers => true)
530
# # Generates a select field for months that defaults to the current month that
531
# # will use keys like "Jan", "Mar".
532
# select_month(Date.today, :use_short_month => true)
534
# # Generates a select field for months that defaults to the current month that
535
# # will use keys like "Januar", "Marts."
536
# select_month(Date.today, :use_month_names => %w(Januar Februar Marts ...))
538
# # Generates a select field for months with a custom prompt. Use :prompt => true for a
540
# select_month(14, :prompt => 'Choose month')
542
def select_month(date, options = {}, html_options = {})
543
DateTimeSelector.new(date, options, html_options).select_month
546
# Returns a select tag with options for each of the five years on each side of the current, which is selected.
547
# The five year radius can be changed using the <tt>:start_year</tt> and <tt>:end_year</tt> keys in the
548
# +options+. Both ascending and descending year lists are supported by making <tt>:start_year</tt> less than or
549
# greater than <tt>:end_year</tt>. The <tt>date</tt> can also be substituted for a year given as a number.
550
# Override the field name using the <tt>:field_name</tt> option, 'year' by default.
553
# # Generates a select field for years that defaults to the current year that
554
# # has ascending year values
555
# select_year(Date.today, :start_year => 1992, :end_year => 2007)
557
# # Generates a select field for years that defaults to the current year that
558
# # is named 'birth' rather than 'year'
559
# select_year(Date.today, :field_name => 'birth')
561
# # Generates a select field for years that defaults to the current year that
562
# # has descending year values
563
# select_year(Date.today, :start_year => 2005, :end_year => 1900)
565
# # Generates a select field for years that defaults to the year 2006 that
566
# # has ascending year values
567
# select_year(2006, :start_year => 2000, :end_year => 2010)
569
# # Generates a select field for years with a custom prompt. Use :prompt => true for a
571
# select_year(14, :prompt => 'Choose year')
573
def select_year(date, options = {}, html_options = {})
574
DateTimeSelector.new(date, options, html_options).select_year
578
class DateTimeSelector #:nodoc:
579
extend ActiveSupport::Memoizable
580
include ActionView::Helpers::TagHelper
582
DEFAULT_PREFIX = 'date'.freeze unless const_defined?('DEFAULT_PREFIX')
584
:year => 1, :month => 2, :day => 3, :hour => 4, :minute => 5, :second => 6
585
}.freeze unless const_defined?('POSITION')
587
def initialize(datetime, options = {}, html_options = {})
588
@options = options.dup
589
@html_options = html_options.dup
594
# TODO: Remove tag conditional
595
# Ideally we could just join select_date and select_date for the tag case
596
if @options[:tag] && @options[:ignore_date]
599
order = date_order.dup
600
order -= [:hour, :minute, :second]
602
@options[:discard_year] ||= true unless order.include?(:year)
603
@options[:discard_month] ||= true unless order.include?(:month)
604
@options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day)
605
@options[:discard_minute] ||= true if @options[:discard_hour]
606
@options[:discard_second] ||= true unless @options[:include_seconds] && !@options[:discard_minute]
608
# If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
609
# valid (otherwise it could be 31 and february wouldn't be a valid date)
610
if @datetime && @options[:discard_day] && !@options[:discard_month]
611
@datetime = @datetime.change(:day => 1)
614
[:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
615
order += [:hour, :minute, :second] unless @options[:discard_hour]
617
build_selects_from_types(order)
619
"#{select_date}#{@options[:datetime_separator]}#{select_time}"
624
order = date_order.dup
626
# TODO: Remove tag conditional
628
@options[:discard_hour] = true
629
@options[:discard_minute] = true
630
@options[:discard_second] = true
632
@options[:discard_year] ||= true unless order.include?(:year)
633
@options[:discard_month] ||= true unless order.include?(:month)
634
@options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day)
636
# If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
637
# valid (otherwise it could be 31 and february wouldn't be a valid date)
638
if @datetime && @options[:discard_day] && !@options[:discard_month]
639
@datetime = @datetime.change(:day => 1)
643
[:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
645
build_selects_from_types(order)
651
# TODO: Remove tag conditional
653
@options[:discard_month] = true
654
@options[:discard_year] = true
655
@options[:discard_day] = true
656
@options[:discard_second] ||= true unless @options[:include_seconds]
658
order += [:year, :month, :day] unless @options[:ignore_date]
661
order += [:hour, :minute]
662
order << :second if @options[:include_seconds]
664
build_selects_from_types(order)
668
if @options[:use_hidden] || @options[:discard_second]
669
build_hidden(:second, sec) if @options[:include_seconds]
671
build_options_and_select(:second, sec)
676
if @options[:use_hidden] || @options[:discard_minute]
677
build_hidden(:minute, min)
679
build_options_and_select(:minute, min, :step => @options[:minute_step])
684
if @options[:use_hidden] || @options[:discard_hour]
685
build_hidden(:hour, hour)
687
build_options_and_select(:hour, hour, :end => 23)
692
if @options[:use_hidden] || @options[:discard_day]
693
build_hidden(:day, day)
695
build_options_and_select(:day, day, :start => 1, :end => 31, :leading_zeros => false)
700
if @options[:use_hidden] || @options[:discard_month]
701
build_hidden(:month, month)
704
1.upto(12) do |month_number|
705
options = { :value => month_number }
706
options[:selected] = "selected" if month == month_number
707
month_options << content_tag(:option, month_name(month_number), options) + "\n"
709
build_select(:month, month_options.join)
714
if !@datetime || @datetime == 0
716
middle_year = Date.today.year
718
val = middle_year = year
721
if @options[:use_hidden] || @options[:discard_year]
722
build_hidden(:year, val)
725
options[:start] = @options[:start_year] || middle_year - 5
726
options[:end] = @options[:end_year] || middle_year + 5
727
options[:step] = options[:start] < options[:end] ? 1 : -1
728
options[:leading_zeros] = false
730
build_options_and_select(:year, val, options)
735
%w( sec min hour day month year ).each do |method|
736
define_method(method) do
737
@datetime.kind_of?(Fixnum) ? @datetime : @datetime.send(method) if @datetime
741
# Returns translated month names, but also ensures that a custom month
742
# name array has a leading nil element
744
month_names = @options[:use_month_names] || translated_month_names
745
month_names.unshift(nil) if month_names.size < 13
750
# Returns translated month names
751
# => [nil, "January", "February", "March",
752
# "April", "May", "June", "July",
753
# "August", "September", "October",
754
# "November", "December"]
756
# If :use_short_month option is set
757
# => [nil, "Jan", "Feb", "Mar", "Apr", "May", "Jun",
758
# "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
759
def translated_month_names
761
key = @options[:use_short_month] ? :'date.abbr_month_names' : :'date.month_names'
762
I18n.translate(key, :locale => @options[:locale])
766
# Lookup month name for number
767
# month_name(1) => "January"
769
# If :use_month_numbers option is passed
772
# If :add_month_numbers option is passed
773
# month_name(1) => "1 - January"
774
def month_name(number)
775
if @options[:use_month_numbers]
777
elsif @options[:add_month_numbers]
778
"#{number} - #{month_names[number]}"
785
@options[:order] || translated_date_order
789
def translated_date_order
791
I18n.translate(:'date.order', :locale => @options[:locale]) || []
795
# Build full select tag from date type and options
796
def build_options_and_select(type, selected, options = {})
797
build_select(type, build_options(selected, options))
800
# Build select option html from date value and options
801
# build_options(15, :start => 1, :end => 31)
802
# => "<option value="1">1</option>
803
# <option value=\"2\">2</option>
804
# <option value=\"3\">3</option>..."
805
def build_options(selected, options = {})
806
start = options.delete(:start) || 0
807
stop = options.delete(:end) || 59
808
step = options.delete(:step) || 1
809
leading_zeros = options.delete(:leading_zeros).nil? ? true : false
812
start.step(stop, step) do |i|
813
value = leading_zeros ? sprintf("%02d", i) : i
814
tag_options = { :value => value }
815
tag_options[:selected] = "selected" if selected == i
816
select_options << content_tag(:option, value, tag_options)
818
select_options.join("\n") + "\n"
821
# Builds select tag from date type and html select options
822
# build_select(:month, "<option value="1">January</option>...")
823
# => "<select id="post_written_on_2i" name="post[written_on(2i)]">
824
# <option value="1">January</option>...
826
def build_select(type, select_options_as_html)
828
:id => input_id_from_type(type),
829
:name => input_name_from_type(type)
830
}.merge(@html_options)
831
select_options.merge!(:disabled => 'disabled') if @options[:disabled]
834
select_html << content_tag(:option, '', :value => '') + "\n" if @options[:include_blank]
835
select_html << prompt_option_tag(type, @options[:prompt]) + "\n" if @options[:prompt]
836
select_html << select_options_as_html.to_s
838
content_tag(:select, select_html, select_options) + "\n"
841
# Builds a prompt option tag with supplied options or from default options
842
# prompt_option_tag(:month, :prompt => 'Select month')
843
# => "<option value="">Select month</option>"
844
def prompt_option_tag(type, options)
845
default_options = {:year => false, :month => false, :day => false, :hour => false, :minute => false, :second => false}
849
prompt = default_options.merge(options)[type.to_sym]
853
prompt = I18n.translate(('datetime.prompts.' + type.to_s).to_sym, :locale => @options[:locale])
856
prompt ? content_tag(:option, prompt, :value => '') : ''
859
# Builds hidden input tag for date part and value
860
# build_hidden(:year, 2008)
861
# => "<input id="post_written_on_1i" name="post[written_on(1i)]" type="hidden" value="2008" />"
862
def build_hidden(type, value)
865
:id => input_id_from_type(type),
866
:name => input_name_from_type(type),
871
# Returns the name attribute for the input tag
872
# => post[written_on(1i)]
873
def input_name_from_type(type)
874
prefix = @options[:prefix] || ActionView::Helpers::DateTimeSelector::DEFAULT_PREFIX
875
prefix += "[#{@options[:index]}]" if @options.has_key?(:index)
877
field_name = @options[:field_name] || type
878
if @options[:include_position]
879
field_name += "(#{ActionView::Helpers::DateTimeSelector::POSITION[type]}i)"
882
@options[:discard_type] ? prefix : "#{prefix}[#{field_name}]"
885
# Returns the id attribute for the input tag
886
# => "post_written_on_1i"
887
def input_id_from_type(type)
888
input_name_from_type(type).gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '')
891
# Given an ordering of datetime components, create the selection HTML
892
# and join them with their appropriate separators.
893
def build_selects_from_types(order)
895
order.reverse.each do |type|
896
separator = separator(type) unless type == order.first # don't add on last field
897
select.insert(0, separator.to_s + send("select_#{type}").to_s)
902
# Returns the separator for a given datetime component
906
@options[:date_separator]
908
(@options[:discard_year] && @options[:discard_day]) ? "" : @options[:datetime_separator]
910
@options[:time_separator]
912
@options[:include_seconds] ? @options[:time_separator] : ""
917
class InstanceTag #:nodoc:
918
def to_date_select_tag(options = {}, html_options = {})
919
datetime_selector(options, html_options).select_date.html_safe!
922
def to_time_select_tag(options = {}, html_options = {})
923
datetime_selector(options, html_options).select_time.html_safe!
926
def to_datetime_select_tag(options = {}, html_options = {})
927
datetime_selector(options, html_options).select_datetime.html_safe!
931
def datetime_selector(options, html_options)
932
datetime = value(object) || default_datetime(options)
934
options = options.dup
935
options[:field_name] = @method_name
936
options[:include_position] = true
937
options[:prefix] ||= @object_name
938
options[:index] = @auto_index if defined?(@auto_index) && @auto_index && !options.has_key?(:index)
939
options[:datetime_separator] ||= ' — '
940
options[:time_separator] ||= ' : '
942
DateTimeSelector.new(datetime, options.merge(:tag => true), html_options)
945
def default_datetime(options)
946
return if options[:include_blank] || options[:prompt]
948
case options[:default]
954
default = options[:default].dup
956
# Rename :minute and :second to :min and :sec
957
default[:min] ||= default[:minute]
958
default[:sec] ||= default[:second]
962
[:year, :month, :day, :hour, :min, :sec].each do |key|
963
default[key] ||= time.send(key)
967
default[:year], default[:month], default[:day],
968
default[:hour], default[:min], default[:sec]
975
def date_select(method, options = {}, html_options = {})
976
@template.date_select(@object_name, method, objectify_options(options), html_options)
979
def time_select(method, options = {}, html_options = {})
980
@template.time_select(@object_name, method, objectify_options(options), html_options)
983
def datetime_select(method, options = {}, html_options = {})
984
@template.datetime_select(@object_name, method, objectify_options(options), html_options)
added
removed
vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb
