Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 1040 lines (956 sloc) 52.762 kB
d0e067f @josevalim Add missing require.
josevalim authored
1 require 'date'
cd937e6 @NZKoz Make date_helper use tag and content_tag. Move to assert_dom_equal i…
NZKoz authored
2 require 'action_view/helpers/tag_helper'
944d314 @spastorino Add Date#rfc3339 and Date#iso8601 to AS
spastorino authored
3 require 'active_support/core_ext/date/conversions'
e472f76 @spastorino Adds disable option to date_helpers generated hidden fields when html…
spastorino authored
4 require 'active_support/core_ext/hash/slice'
d0e067f @josevalim Add missing require.
josevalim authored
5 require 'active_support/core_ext/object/with_options'
db045db @dhh Initial
dhh authored
6
7 module ActionView
8 module Helpers
5a0bc2c @rizwanreza Adds title and description where needed.
rizwanreza authored
9 # = Action View Date Helpers
10 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
11 # The Date Helper primarily creates select/option tags for different kinds of dates and date elements. All of the
12 # select-type methods share a number of common options that are as follows:
db045db @dhh Initial
dhh authored
13 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
14 # * <tt>:prefix</tt> - overwrites the default prefix of "date" used for the select names. So specifying "birthday"
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
15 # would give birthday[month] instead of date[month] if passed to the <tt>select_month</tt> method.
db045db @dhh Initial
dhh authored
16 # * <tt>:include_blank</tt> - set to true if it should be possible to set an empty date.
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
17 # * <tt>:discard_type</tt> - set to true if you want to discard the type part of the select name. If set to true,
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
18 # the <tt>select_month</tt> method would use simply "date" (which can be overwritten using <tt>:prefix</tt>) instead
19 # of "date[month]".
db045db @dhh Initial
dhh authored
20 module DateHelper
17f7eaa @dhh Improved resolution of DateHelper#distance_of_time_in_words for bette…
dhh authored
21 # Reports the approximate distance in time between two Time or Date objects or integers as seconds.
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
22 # Set <tt>include_seconds</tt> to true if you want more detailed approximations when distance < 1 min, 29 secs.
a02c607 @dhh Docfix (closes #11263) [Irfy]
dhh authored
23 # Distances are reported based on the following table:
959707b @jeremy r1335@iwill: jeremy | 2005-06-17 11:41:50 -0700
jeremy authored
24 #
a02c607 @dhh Docfix (closes #11263) [Irfy]
dhh authored
25 # 0 <-> 29 secs # => less than a minute
26 # 30 secs <-> 1 min, 29 secs # => 1 minute
27 # 1 min, 30 secs <-> 44 mins, 29 secs # => [2..44] minutes
28 # 44 mins, 30 secs <-> 89 mins, 29 secs # => about 1 hour
93def19 @mrduncan Fixing distance_of_time_in_words range near 2 days
mrduncan authored
29 # 89 mins, 30 secs <-> 23 hrs, 59 mins, 29 secs # => about [2..24] hours
30 # 23 hrs, 59 mins, 30 secs <-> 41 hrs, 59 mins, 29 secs # => 1 day
805126b @mrduncan Aligning comments
mrduncan authored
31 # 41 hrs, 59 mins, 30 secs <-> 29 days, 23 hrs, 59 mins, 29 secs # => [2..29] days
a02c607 @dhh Docfix (closes #11263) [Irfy]
dhh authored
32 # 29 days, 23 hrs, 59 mins, 30 secs <-> 59 days, 23 hrs, 59 mins, 29 secs # => about 1 month
33 # 59 days, 23 hrs, 59 mins, 30 secs <-> 1 yr minus 1 sec # => [2..12] months
c9318e9 @jtrupiano Introduce :almost keyword for distance_of_time_in_words. Make 1.75 da…
jtrupiano authored
34 # 1 yr <-> 1 yr, 3 months # => about 1 year
35 # 1 yr, 3 months <-> 1 yr, 9 months # => over 1 year
36 # 1 yr, 9 months <-> 2 yr minus 1 sec # => almost 2 years
37 # 2 yrs <-> max time or date # => (same rules as 1 yr)
959707b @jeremy r1335@iwill: jeremy | 2005-06-17 11:41:50 -0700
jeremy authored
38 #
a02c607 @dhh Docfix (closes #11263) [Irfy]
dhh authored
39 # With <tt>include_seconds</tt> = true and the difference < 1 minute 29 seconds:
40 # 0-4 secs # => less than 5 seconds
41 # 5-9 secs # => less than 10 seconds
42 # 10-19 secs # => less than 20 seconds
43 # 20-39 secs # => half a minute
44 # 40-59 secs # => less than a minute
45 # 60-89 secs # => 1 minute
17f7eaa @dhh Improved resolution of DateHelper#distance_of_time_in_words for bette…
dhh authored
46 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
47 # ==== Examples
17f7eaa @dhh Improved resolution of DateHelper#distance_of_time_in_words for bette…
dhh authored
48 # from_time = Time.now
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
49 # distance_of_time_in_words(from_time, from_time + 50.minutes) # => about 1 hour
50 # distance_of_time_in_words(from_time, 50.minutes.from_now) # => about 1 hour
51 # distance_of_time_in_words(from_time, from_time + 15.seconds) # => less than a minute
52 # distance_of_time_in_words(from_time, from_time + 15.seconds, true) # => less than 20 seconds
8ef1cd9 Enhancing distance_of_time_in_words to prefix year output with over a…
Jay Pignata authored
53 # distance_of_time_in_words(from_time, 3.years.from_now) # => about 3 years
6ddd4a3 @mrduncan Days are never approximated using 'about'
mrduncan authored
54 # distance_of_time_in_words(from_time, from_time + 60.hours) # => 3 days
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
55 # distance_of_time_in_words(from_time, from_time + 45.seconds, true) # => less than a minute
56 # distance_of_time_in_words(from_time, from_time - 45.seconds, true) # => less than a minute
57 # distance_of_time_in_words(from_time, 76.seconds.from_now) # => 1 minute
931be6e @jeremy 1 years -> 1 year
jeremy authored
58 # distance_of_time_in_words(from_time, from_time + 1.year + 3.days) # => about 1 year
8ef1cd9 Enhancing distance_of_time_in_words to prefix year output with over a…
Jay Pignata authored
59 # distance_of_time_in_words(from_time, from_time + 3.years + 6.months) # => over 3 years
60 # distance_of_time_in_words(from_time, from_time + 4.years + 9.days + 30.minutes + 5.seconds) # => about 4 years
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
61 #
62 # to_time = Time.now + 6.years + 19.days
c9318e9 @jtrupiano Introduce :almost keyword for distance_of_time_in_words. Make 1.75 da…
jtrupiano authored
63 # distance_of_time_in_words(from_time, to_time, true) # => about 6 years
64 # distance_of_time_in_words(to_time, from_time, true) # => about 6 years
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
65 # distance_of_time_in_words(Time.now, Time.now) # => less than a minute
17f7eaa @dhh Improved resolution of DateHelper#distance_of_time_in_words for bette…
dhh authored
66 #
45d41f0 @svenfuchs integrating I18n into Rails
svenfuchs authored
67 def distance_of_time_in_words(from_time, to_time = 0, include_seconds = false, options = {})
959707b @jeremy r1335@iwill: jeremy | 2005-06-17 11:41:50 -0700
jeremy authored
68 from_time = from_time.to_time if from_time.respond_to?(:to_time)
69 to_time = to_time.to_time if to_time.respond_to?(:to_time)
70 distance_in_minutes = (((to_time - from_time).abs)/60).round
71 distance_in_seconds = ((to_time - from_time).abs).round
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
72
c178a87 @svenfuchs remove call to self.locale from helpers
svenfuchs authored
73 I18n.with_options :locale => options[:locale], :scope => :'datetime.distance_in_words' do |locale|
45d41f0 @svenfuchs integrating I18n into Rails
svenfuchs authored
74 case distance_in_minutes
75 when 0..1
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
76 return distance_in_minutes == 0 ?
45d41f0 @svenfuchs integrating I18n into Rails
svenfuchs authored
77 locale.t(:less_than_x_minutes, :count => 1) :
78 locale.t(:x_minutes, :count => distance_in_minutes) unless include_seconds
79
80 case distance_in_seconds
81 when 0..4 then locale.t :less_than_x_seconds, :count => 5
82 when 5..9 then locale.t :less_than_x_seconds, :count => 10
83 when 10..19 then locale.t :less_than_x_seconds, :count => 20
84 when 20..39 then locale.t :half_a_minute
85 when 40..59 then locale.t :less_than_x_minutes, :count => 1
86 else locale.t :x_minutes, :count => 1
87 end
88
89 when 2..44 then locale.t :x_minutes, :count => distance_in_minutes
90 when 45..89 then locale.t :about_x_hours, :count => 1
91 when 90..1439 then locale.t :about_x_hours, :count => (distance_in_minutes.to_f / 60.0).round
93def19 @mrduncan Fixing distance_of_time_in_words range near 2 days
mrduncan authored
92 when 1440..2519 then locale.t :x_days, :count => 1
93 when 2520..43199 then locale.t :x_days, :count => (distance_in_minutes.to_f / 1440.0).round
45d41f0 @svenfuchs integrating I18n into Rails
svenfuchs authored
94 when 43200..86399 then locale.t :about_x_months, :count => 1
c9318e9 @jtrupiano Introduce :almost keyword for distance_of_time_in_words. Make 1.75 da…
jtrupiano authored
95 when 86400..525599 then locale.t :x_months, :count => (distance_in_minutes.to_f / 43200.0).round
8ef1cd9 Enhancing distance_of_time_in_words to prefix year output with over a…
Jay Pignata authored
96 else
ae7d0d8 @asanghi Take leap years into account more seriously when calculating year dis…
asanghi authored
97 fyear = from_time.year
98 fyear += 1 if from_time.month >= 3
99 tyear = to_time.year
100 tyear -= 1 if to_time.month < 3
101 leap_years = (fyear > tyear) ? 0 : (fyear..tyear).count{|x| Date.leap?(x)}
102 minute_offset_for_leap_year = leap_years * 1440
103 # Discount the leap year days when calculating year distance.
65a9563 @asanghi strip space
asanghi authored
104 # e.g. if there are 20 leap year days between 2 dates having the same day
ae7d0d8 @asanghi Take leap years into account more seriously when calculating year dis…
asanghi authored
105 # and month then the based on 365 days calculation
65a9563 @asanghi strip space
asanghi authored
106 # the distance in years will come out to over 80 years when in written
ae7d0d8 @asanghi Take leap years into account more seriously when calculating year dis…
asanghi authored
107 # english it would read better as about 80 years.
108 minutes_with_offset = distance_in_minutes - minute_offset_for_leap_year
109 remainder = (minutes_with_offset % 525600)
110 distance_in_years = (minutes_with_offset / 525600)
c9318e9 @jtrupiano Introduce :almost keyword for distance_of_time_in_words. Make 1.75 da…
jtrupiano authored
111 if remainder < 131400
112 locale.t(:about_x_years, :count => distance_in_years)
113 elsif remainder < 394200
114 locale.t(:over_x_years, :count => distance_in_years)
115 else
116 locale.t(:almost_x_years, :count => distance_in_years + 1)
117 end
45d41f0 @svenfuchs integrating I18n into Rails
svenfuchs authored
118 end
db045db @dhh Initial
dhh authored
119 end
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
120 end
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
121
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
122 # Like <tt>distance_of_time_in_words</tt>, but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
123 #
124 # ==== Examples
125 # time_ago_in_words(3.minutes.from_now) # => 3 minutes
8ac365f @mrduncan Making example result match actual result
mrduncan authored
126 # time_ago_in_words(Time.now - 15.hours) # => about 15 hours
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
127 # time_ago_in_words(Time.now) # => less than a minute
128 #
3ca6d0e @mrduncan Including actual usage in example
mrduncan authored
129 # from_time = Time.now - 3.days - 14.minutes - 25.seconds
130 # time_ago_in_words(from_time) # => 3 days
131 #
ea3016f @dhh Renamed DateHelper#distance_of_time_in_words_to_now to DateHelper#tim…
dhh authored
132 def time_ago_in_words(from_time, include_seconds = false)
520dae2 @dhh Added include_seconds option as the third parameter to distance_of_ti…
dhh authored
133 distance_of_time_in_words(from_time, Time.now, include_seconds)
db045db @dhh Initial
dhh authored
134 end
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
135
ea3016f @dhh Renamed DateHelper#distance_of_time_in_words_to_now to DateHelper#tim…
dhh authored
136 alias_method :distance_of_time_in_words_to_now, :time_ago_in_words
db045db @dhh Initial
dhh authored
137
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
138 # Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based
5b92dcb Merge docrails
lifo authored
139 # attribute (identified by +method+) on an object assigned to the template (identified by +object+).
140 #
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
141 #
142 # ==== Options
143 # * <tt>:use_month_numbers</tt> - Set to true if you want to use month numbers rather than month names (e.g.
c3f53f4 @lifo Merge docrails
lifo authored
144 # "2" instead of "February").
e033b5d @lifo Merge docrails
lifo authored
145 # * <tt>:use_short_month</tt> - Set to true if you want to use abbreviated month names instead of full
146 # month names (e.g. "Feb" instead of "February").
147 # * <tt>:add_month_numbers</tt> - Set to true if you want to use both month numbers and month names (e.g.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
148 # "2 - February" instead of "February").
149 # * <tt>:use_month_names</tt> - Set to an array with 12 month names if you want to customize month names.
e033b5d @lifo Merge docrails
lifo authored
150 # Note: You can also use Rails' i18n functionality for this.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
151 # * <tt>:date_separator</tt> - Specifies a string to separate the date fields. Default is "" (i.e. nothing).
152 # * <tt>:start_year</tt> - Set the start year for the year select. Default is <tt>Time.now.year - 5</tt>.
153 # * <tt>:end_year</tt> - Set the end year for the year select. Default is <tt>Time.now.year + 5</tt>.
154 # * <tt>:discard_day</tt> - Set to true if you don't want to show a day select. This includes the day
155 # as a hidden field instead of showing a select field. Also note that this implicitly sets the day to be the
156 # first of the given month in order to not create invalid dates like 31 February.
157 # * <tt>:discard_month</tt> - Set to true if you don't want to show a month select. This includes the month
158 # as a hidden field instead of showing a select field. Also note that this implicitly sets :discard_day to true.
159 # * <tt>:discard_year</tt> - Set to true if you don't want to show a year select. This includes the year
160 # as a hidden field instead of showing a select field.
e033b5d @lifo Merge docrails
lifo authored
161 # * <tt>:order</tt> - Set to an array containing <tt>:day</tt>, <tt>:month</tt> and <tt>:year</tt> to
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
162 # customize the order in which the select fields are shown. If you leave out any of the symbols, the respective
163 # select will not be shown (like when you set <tt>:discard_xxx => true</tt>. Defaults to the order defined in
1211896 @svenfuchs use :en as a default locale (in favor of :en-US)
svenfuchs authored
164 # the respective locale (e.g. [:year, :month, :day] in the en locale that ships with Rails).
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
165 # * <tt>:include_blank</tt> - Include a blank option in every select field so it's possible to set empty
166 # dates.
167 # * <tt>:default</tt> - Set a default date if the affected date isn't set or is nil.
168 # * <tt>:disabled</tt> - Set to true if you want show the select fields as disabled.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
169 # * <tt>:prompt</tt> - Set to true (for a generic prompt), a prompt string or a hash of prompt strings
170 # for <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>, <tt>:hour</tt>, <tt>:minute</tt> and <tt>:second</tt>.
171 # Setting this option prepends a select option with a generic prompt (Day, Month, Year, Hour, Minute, Seconds)
172 # or the given prompt string.
b62243a @dhh Added :disabled option to all data selects that'll make the elements …
dhh authored
173 #
64092de @fxn Improve documentation coverage and markup
fxn authored
174 # If anything is passed in the +html_options+ hash it will be applied to every select tag in the set.
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
175 #
9b5ece8 @dhh Added :order option for date_select that allows control over the orde…
dhh authored
176 # NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.
db045db @dhh Initial
dhh authored
177 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
178 # ==== Examples
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
179 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute.
db045db @dhh Initial
dhh authored
180 # date_select("post", "written_on")
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
181 #
182 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
183 # # with the year in the year drop down box starting at 1995.
db045db @dhh Initial
dhh authored
184 # date_select("post", "written_on", :start_year => 1995)
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
185 #
186 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
187 # # with the year in the year drop down box starting at 1995, numbers used for months instead of words,
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
188 # # and without a day select box.
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
189 # date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true,
db045db @dhh Initial
dhh authored
190 # :discard_day => true, :include_blank => true)
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
191 #
192 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
193 # # with the fields ordered as day, month, year rather than month, day, year.
9b5ece8 @dhh Added :order option for date_select that allows control over the orde…
dhh authored
194 # date_select("post", "written_on", :order => [:day, :month, :year])
db045db @dhh Initial
dhh authored
195 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
196 # # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
197 # # lacking a year field.
198 # date_select("user", "birthday", :order => [:month, :day])
199 #
9b84bd3 @latentflip Fixed typos in documentation for the date_select helper in actionpack…
latentflip authored
200 # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
201 # # which is initially set to the date 3 days from the current date
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
202 # date_select("post", "written_on", :default => 3.days.from_now)
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
203 #
204 # # Generates a date select that when POSTed is stored in the credit_card variable, in the bill_due attribute
205 # # that will have a default day of 20.
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
206 # date_select("credit_card", "bill_due", :default => { :day => 20 })
207 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
208 # # Generates a date select with custom prompts.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
209 # date_select("post", "written_on", :prompt => { :day => 'Select day', :month => 'Select month', :year => 'Select year' })
210 #
db045db @dhh Initial
dhh authored
211 # The selects are prepared for multi-parameter assignment to an Active Record object.
0cf79f0 @dhh Fixed that DateHelper#date_select should set the day to the 1st when …
dhh authored
212 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
213 # 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
214 # all month choices are valid.
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
215 def date_select(object_name, method, options = {}, html_options = {})
7098143 @NZKoz Remove unused local_binding option to InstanceTag's Constructor
NZKoz authored
216 InstanceTag.new(object_name, method, self, options.delete(:object)).to_date_select_tag(options, html_options)
db045db @dhh Initial
dhh authored
217 end
218
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
219 # Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a
220 # specified time-based attribute (identified by +method+) on an object assigned to the template (identified by
610e4d9 @asanghi add more documentation; remove unused assignment
asanghi authored
221 # +object+). You can include the seconds with <tt>:include_seconds</tt>. You can get hours in the AM/PM format
222 # with <tt>:ampm</tt> option.
570f5aa @miloops Allow date helpers to ignore date hidden field tags. [#503 state:reso…
miloops authored
223 #
224 # This method will also generate 3 input hidden tags, for the actual year, month and day unless the option
a59a67d @asanghi Explain the implication of using :ignore_date on time_select
asanghi authored
225 # <tt>:ignore_date</tt> is set to +true+. If you set the <tt>:ignore_date</tt> to +true+, you must have a
226 # +date_select+ on the same method within the form otherwise an exception will be raised.
570f5aa @miloops Allow date helpers to ignore date hidden field tags. [#503 state:reso…
miloops authored
227 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
228 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
229 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
230 # ==== Examples
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
231 # # Creates a time select tag that, when POSTed, will be stored in the post variable in the sunrise attribute.
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
232 # time_select("post", "sunrise")
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
233 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
234 # # Creates a time select tag with a seconds field that, when POSTed, will be stored in the post variables in
235 # # the sunrise attribute.
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
236 # time_select("post", "start_time", :include_seconds => true)
237 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
238 # # You can set the <tt>:minute_step</tt> to 15 which will give you: 00, 15, 30 and 45.
4e7d332 Document :minute_step option for time_select. Closes #8814 [brupm]
Marcel Molina authored
239 # time_select 'game', 'game_time', {:minute_step => 15}
240 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
241 # # Creates a time select tag with a custom prompt. Use <tt>:prompt => true</tt> for generic prompts.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
242 # time_select("post", "written_on", :prompt => {:hour => 'Choose hour', :minute => 'Choose minute', :second => 'Choose seconds'})
243 # time_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
244 # time_select("post", "written_on", :prompt => true) # generic prompts for all
245 #
610e4d9 @asanghi add more documentation; remove unused assignment
asanghi authored
246 # # You can set :ampm option to true which will show the hours as: 12 PM, 01 AM .. 11 PM.
247 # time_select 'game', 'game_time', {:ampm => true}
248 #
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
249 # The selects are prepared for multi-parameter assignment to an Active Record object.
0cf79f0 @dhh Fixed that DateHelper#date_select should set the day to the 1st when …
dhh authored
250 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
251 # 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
252 # all month choices are valid.
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
253 def time_select(object_name, method, options = {}, html_options = {})
7098143 @NZKoz Remove unused local_binding option to InstanceTag's Constructor
NZKoz authored
254 InstanceTag.new(object_name, method, self, options.delete(:object)).to_time_select_tag(options, html_options)
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
255 end
256
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
257 # Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a
258 # specified datetime-based attribute (identified by +method+) on an object assigned to the template (identified
5b92dcb Merge docrails
lifo authored
259 # by +object+).
db045db @dhh Initial
dhh authored
260 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
261 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
262 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
263 # ==== Examples
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
264 # # Generates a datetime select that, when POSTed, will be stored in the post variable in the written_on
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
265 # # attribute.
db045db @dhh Initial
dhh authored
266 # datetime_select("post", "written_on")
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
267 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
268 # # Generates a datetime select with a year select that starts at 1995 that, when POSTed, will be stored in the
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
269 # # post variable in the written_on attribute.
db045db @dhh Initial
dhh authored
270 # datetime_select("post", "written_on", :start_year => 1995)
271 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
272 # # Generates a datetime select with a default value of 3 days from the current time that, when POSTed, will
273 # # be stored in the trip variable in the departing attribute.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
274 # datetime_select("trip", "departing", :default => 3.days.from_now)
275 #
610e4d9 @asanghi add more documentation; remove unused assignment
asanghi authored
276 # # Generate a datetime select with hours in the AM/PM format
277 # datetime_select("post", "written_on", :ampm => true)
278 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
279 # # Generates a datetime select that discards the type that, when POSTed, will be stored in the post variable
280 # # as the written_on attribute.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
281 # datetime_select("post", "written_on", :discard_type => true)
282 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
283 # # Generates a datetime select with a custom prompt. Use <tt>:prompt => true</tt> for generic prompts.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
284 # datetime_select("post", "written_on", :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
285 # datetime_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
286 # datetime_select("post", "written_on", :prompt => true) # generic prompts for all
287 #
db045db @dhh Initial
dhh authored
288 # The selects are prepared for multi-parameter assignment to an Active Record object.
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
289 def datetime_select(object_name, method, options = {}, html_options = {})
7098143 @NZKoz Remove unused local_binding option to InstanceTag's Constructor
NZKoz authored
290 InstanceTag.new(object_name, method, self, options.delete(:object)).to_datetime_select_tag(options, html_options)
db045db @dhh Initial
dhh authored
291 end
292
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
293 # Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the
294 # +datetime+. It's also possible to explicitly set the order of the tags using the <tt>:order</tt> option with
295 # an array of symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not
296 # supply a Symbol, it will be appended onto the <tt>:order</tt> passed in. You can also add
297 # <tt>:date_separator</tt>, <tt>:datetime_separator</tt> and <tt>:time_separator</tt> keys to the +options+ to
298 # control visual display of the elements.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
299 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
300 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
301 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
302 # ==== Examples
303 # my_date_time = Time.now + 4.days
304 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
305 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today).
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
306 # select_datetime(my_date_time)
307 #
308 # # Generates a datetime select that defaults to today (no specified datetime)
309 # select_datetime()
310 #
311 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
2af36bb @dhh Fix typos (closes #10378)
dhh authored
312 # # with the fields ordered year, month, day rather than month, day, year.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
313 # select_datetime(my_date_time, :order => [:year, :month, :day])
314 #
315 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
316 # # with a '/' between each date field.
317 # select_datetime(my_date_time, :date_separator => '/')
318 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
319 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
320 # # with a date fields separated by '/', time fields separated by '' and the date and time fields
321 # # separated by a comma (',').
322 # select_datetime(my_date_time, :date_separator => '/', :time_separator => '', :datetime_separator => ',')
323 #
324 # # Generates a datetime select that discards the type of the field and defaults to the datetime in
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
325 # # my_date_time (four days after today)
326 # select_datetime(my_date_time, :discard_type => true)
327 #
610e4d9 @asanghi add more documentation; remove unused assignment
asanghi authored
328 # # Generate a datetime field with hours in the AM/PM format
329 # select_datetime(my_date_time, :ampm => true)
330 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
331 # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
332 # # prefixed with 'payday' rather than 'date'
333 # select_datetime(my_date_time, :prefix => 'payday')
334 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
335 # # Generates a datetime select with a custom prompt. Use <tt>:prompt => true</tt> for generic prompts.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
336 # select_datetime(my_date_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
337 # select_datetime(my_date_time, :prompt => {:hour => true}) # generic prompt for hours
338 # select_datetime(my_date_time, :prompt => true) # generic prompts for all
339 #
f757f58 @gbuesing select_datetime and select_time default to Time.zone.now when config.…
gbuesing authored
340 def select_datetime(datetime = Time.current, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
341 DateTimeSelector.new(datetime, options, html_options).select_datetime
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
342 end
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
343
db045db @dhh Initial
dhh authored
344 # Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+.
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
345 # It's possible to explicitly set the order of the tags using the <tt>:order</tt> option with an array of
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
346 # symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not supply a Symbol,
347 # it will be appended onto the <tt>:order</tt> passed in.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
348 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
349 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
350 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
351 # ==== Examples
352 # my_date = Time.today + 6.days
353 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
354 # # Generates a date select that defaults to the date in my_date (six days afteri today).
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
355 # select_date(my_date)
356 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
357 # # Generates a date select that defaults to today (no specified date).
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
358 # select_date()
359 #
360 # # Generates a date select that defaults to the date in my_date (six days after today)
2af36bb @dhh Fix typos (closes #10378)
dhh authored
361 # # with the fields ordered year, month, day rather than month, day, year.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
362 # select_date(my_date, :order => [:year, :month, :day])
363 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
364 # # Generates a date select that discards the type of the field and defaults to the date in
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
365 # # my_date (six days after today).
0432d15 @lifo Merge with docrails.
lifo authored
366 # select_date(my_date, :discard_type => true)
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
367 #
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
368 # # Generates a date select that defaults to the date in my_date,
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
369 # # which has fields separated by '/'.
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
370 # select_date(my_date, :date_separator => '/')
371 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
372 # # Generates a date select that defaults to the datetime in my_date (six days after today)
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
373 # # prefixed with 'payday' rather than 'date'.
0432d15 @lifo Merge with docrails.
lifo authored
374 # select_date(my_date, :prefix => 'payday')
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
375 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
376 # # Generates a date select with a custom prompt. Use <tt>:prompt => true</tt> for generic prompts.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
377 # select_date(my_date, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
378 # select_date(my_date, :prompt => {:hour => true}) # generic prompt for hours
379 # select_date(my_date, :prompt => true) # generic prompts for all
380 #
6672808 @gbuesing Adding Date.current, which returns Time.zone.today if config.time_zon…
gbuesing authored
381 def select_date(date = Date.current, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
382 DateTimeSelector.new(date, options, html_options).select_date
db045db @dhh Initial
dhh authored
383 end
384
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
385 # Returns a set of html select-tags (one for hour and minute).
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
386 # You can set <tt>:time_separator</tt> key to format the output, and
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
387 # the <tt>:include_seconds</tt> option to include an input for seconds.
388 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
389 # If anything is passed in the html_options hash it will be applied to every select tag in the set.
390 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
391 # ==== Examples
392 # my_time = Time.now + 5.days + 7.hours + 3.minutes + 14.seconds
393 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
394 # # Generates a time select that defaults to the time in my_time.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
395 # select_time(my_time)
396 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
397 # # Generates a time select that defaults to the current time (no specified time).
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
398 # select_time()
399 #
400 # # Generates a time select that defaults to the time in my_time,
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
401 # # which has fields separated by ':'.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
402 # select_time(my_time, :time_separator => ':')
403 #
404 # # Generates a time select that defaults to the time in my_time,
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
405 # # that also includes an input for seconds.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
406 # select_time(my_time, :include_seconds => true)
407 #
408 # # Generates a time select that defaults to the time in my_time, that has fields
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
409 # # separated by ':' and includes an input for seconds.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
410 # select_time(my_time, :time_separator => ':', :include_seconds => true)
411 #
610e4d9 @asanghi add more documentation; remove unused assignment
asanghi authored
412 # # Generate a time select field with hours in the AM/PM format
413 # select_time(my_time, :ampm => true)
414 #
d491130 @fxn Merge branch 'master' of git://github.com/lifo/docrails
fxn authored
415 # # Generates a time select with a custom prompt. Use <tt>:prompt</tt> to true for generic prompts.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
416 # select_time(my_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
417 # select_time(my_time, :prompt => {:hour => true}) # generic prompt for hours
418 # select_time(my_time, :prompt => true) # generic prompts for all
419 #
f757f58 @gbuesing select_datetime and select_time default to Time.zone.now when config.…
gbuesing authored
420 def select_time(datetime = Time.current, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
421 DateTimeSelector.new(datetime, options, html_options).select_time
ce58e5c @dhh Added DateHelper#select_time and DateHelper#select_second #373 [Scott…
dhh authored
422 end
423
424 # Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
425 # The <tt>second</tt> can also be substituted for a second number.
c6ab8f5 @dhh Added :field_name option to DateHelper#select_(year|month|day) to dev…
dhh authored
426 # Override the field name using the <tt>:field_name</tt> option, 'second' by default.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
427 #
428 # ==== Examples
429 # my_time = Time.now + 16.minutes
430 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
431 # # Generates a select field for seconds that defaults to the seconds for the time in my_time.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
432 # select_second(my_time)
433 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
434 # # Generates a select field for seconds that defaults to the number given.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
435 # select_second(33)
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
436 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
437 # # Generates a select field for seconds that defaults to the seconds for the time in my_time
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
438 # # that is named 'interval' rather than 'second'.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
439 # select_second(my_time, :field_name => 'interval')
440 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
441 # # Generates a select field for seconds with a custom prompt. Use <tt>:prompt => true</tt> for a
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
442 # # generic prompt.
443 # select_minute(14, :prompt => 'Choose seconds')
444 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
445 def select_second(datetime, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
446 DateTimeSelector.new(datetime, options, html_options).select_second
ce58e5c @dhh Added DateHelper#select_time and DateHelper#select_second #373 [Scott…
dhh authored
447 end
448
db045db @dhh Initial
dhh authored
449 # Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
450 # Also can return a select tag with options by <tt>minute_step</tt> from 0 through 59 with the 00 minute
451 # selected. The <tt>minute</tt> can also be substituted for a minute number.
c6ab8f5 @dhh Added :field_name option to DateHelper#select_(year|month|day) to dev…
dhh authored
452 # Override the field name using the <tt>:field_name</tt> option, 'minute' by default.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
453 #
454 # ==== Examples
455 # my_time = Time.now + 6.hours
456 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
457 # # Generates a select field for minutes that defaults to the minutes for the time in my_tiime.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
458 # select_minute(my_time)
459 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
460 # # Generates a select field for minutes that defaults to the number given.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
461 # select_minute(14)
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
462 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
463 # # Generates a select field for minutes that defaults to the minutes for the time in my_time
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
464 # # that is named 'stride' rather than 'second'.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
465 # select_minute(my_time, :field_name => 'stride')
466 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
467 # # Generates a select field for minutes with a custom prompt. Use <tt>:prompt => true</tt> for a
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
468 # # generic prompt.
469 # select_minute(14, :prompt => 'Choose minutes')
470 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
471 def select_minute(datetime, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
472 DateTimeSelector.new(datetime, options, html_options).select_minute
db045db @dhh Initial
dhh authored
473 end
474
475 # Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
476 # The <tt>hour</tt> can also be substituted for a hour number.
c6ab8f5 @dhh Added :field_name option to DateHelper#select_(year|month|day) to dev…
dhh authored
477 # Override the field name using the <tt>:field_name</tt> option, 'hour' by default.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
478 #
479 # ==== Examples
480 # my_time = Time.now + 6.hours
481 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
482 # # Generates a select field for hours that defaults to the hour for the time in my_time.
a03e2b3 @lifo Merge with docrails. Also add a rake task to generate guides in your …
lifo authored
483 # select_hour(my_time)
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
484 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
485 # # Generates a select field for hours that defaults to the number given.
a03e2b3 @lifo Merge with docrails. Also add a rake task to generate guides in your …
lifo authored
486 # select_hour(13)
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
487 #
a03e2b3 @lifo Merge with docrails. Also add a rake task to generate guides in your …
lifo authored
488 # # Generates a select field for hours that defaults to the minutes for the time in my_time
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
489 # # that is named 'stride' rather than 'second'.
a03e2b3 @lifo Merge with docrails. Also add a rake task to generate guides in your …
lifo authored
490 # select_hour(my_time, :field_name => 'stride')
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
491 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
492 # # Generates a select field for hours with a custom prompt. Use <tt>:prompt => true</tt> for a
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
493 # # generic prompt.
f274394 @mrduncan Fixing more spacing inconsistencies
mrduncan authored
494 # select_hour(13, :prompt => 'Choose hour')
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
495 #
a869382 @asanghi Allow AM/PM in datetime selectors
asanghi authored
496 # # Generate a select field for hours in the AM/PM format
497 # select_hour(my_time, :ampm => true)
498 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
499 def select_hour(datetime, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
500 DateTimeSelector.new(datetime, options, html_options).select_hour
db045db @dhh Initial
dhh authored
501 end
502
503 # Returns a select tag with options for each of the days 1 through 31 with the current day selected.
504 # The <tt>date</tt> can also be substituted for a hour number.
c6ab8f5 @dhh Added :field_name option to DateHelper#select_(year|month|day) to dev…
dhh authored
505 # Override the field name using the <tt>:field_name</tt> option, 'day' by default.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
506 #
507 # ==== Examples
508 # my_date = Time.today + 2.days
509 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
510 # # Generates a select field for days that defaults to the day for the date in my_date.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
511 # select_day(my_time)
512 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
513 # # Generates a select field for days that defaults to the number given.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
514 # select_day(5)
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
515 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
516 # # Generates a select field for days that defaults to the day for the date in my_date
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
517 # # that is named 'due' rather than 'day'.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
518 # select_day(my_time, :field_name => 'due')
519 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
520 # # Generates a select field for days with a custom prompt. Use <tt>:prompt => true</tt> for a
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
521 # # generic prompt.
522 # select_day(5, :prompt => 'Choose day')
523 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
524 def select_day(date, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
525 DateTimeSelector.new(date, options, html_options).select_day
db045db @dhh Initial
dhh authored
526 end
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
527
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
528 # Returns a select tag with options for each of the months January through December with the current month
529 # selected. The month names are presented as keys (what's shown to the user) and the month numbers (1-12) are
530 # used as values (what's submitted to the server). It's also possible to use month numbers for the presentation
531 # instead of names -- set the <tt>:use_month_numbers</tt> key in +options+ to true for this to happen. If you
532 # want both numbers and names, set the <tt>:add_month_numbers</tt> key in +options+ to true. If you would prefer
533 # to show month names as abbreviations, set the <tt>:use_short_month</tt> key in +options+ to true. If you want
534 # to use your own month names, set the <tt>:use_month_names</tt> key in +options+ to an array of 12 month names.
535 # Override the field name using the <tt>:field_name</tt> option, 'month' by default.
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
536 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
537 # ==== Examples
538 # # Generates a select field for months that defaults to the current month that
539 # # will use keys like "January", "March".
540 # select_month(Date.today)
db045db @dhh Initial
dhh authored
541 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
542 # # Generates a select field for months that defaults to the current month that
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
543 # # is named "start" rather than "month".
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
544 # select_month(Date.today, :field_name => 'start')
545 #
546 # # Generates a select field for months that defaults to the current month that
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
547 # # will use keys like "1", "3".
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
548 # select_month(Date.today, :use_month_numbers => true)
549 #
550 # # Generates a select field for months that defaults to the current month that
551 # # will use keys like "1 - January", "3 - March".
552 # select_month(Date.today, :add_month_numbers => true)
553 #
554 # # Generates a select field for months that defaults to the current month that
555 # # will use keys like "Jan", "Mar".
556 # select_month(Date.today, :use_short_month => true)
557 #
558 # # Generates a select field for months that defaults to the current month that
559 # # will use keys like "Januar", "Marts."
560 # select_month(Date.today, :use_month_names => %w(Januar Februar Marts ...))
c6ab8f5 @dhh Added :field_name option to DateHelper#select_(year|month|day) to dev…
dhh authored
561 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
562 # # Generates a select field for months with a custom prompt. Use <tt>:prompt => true</tt> for a
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
563 # # generic prompt.
564 # select_month(14, :prompt => 'Choose month')
565 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
566 def select_month(date, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
567 DateTimeSelector.new(date, options, html_options).select_month
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
568 end
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
569
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
570 # Returns a select tag with options for each of the five years on each side of the current, which is selected.
571 # The five year radius can be changed using the <tt>:start_year</tt> and <tt>:end_year</tt> keys in the
572 # +options+. Both ascending and descending year lists are supported by making <tt>:start_year</tt> less than or
573 # greater than <tt>:end_year</tt>. The <tt>date</tt> can also be substituted for a year given as a number.
574 # Override the field name using the <tt>:field_name</tt> option, 'year' by default.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
575 #
576 # ==== Examples
577 # # Generates a select field for years that defaults to the current year that
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
578 # # has ascending year values.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
579 # select_year(Date.today, :start_year => 1992, :end_year => 2007)
580 #
581 # # Generates a select field for years that defaults to the current year that
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
582 # # is named 'birth' rather than 'year'.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
583 # select_year(Date.today, :field_name => 'birth')
584 #
585 # # Generates a select field for years that defaults to the current year that
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
586 # # has descending year values.
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
587 # select_year(Date.today, :start_year => 2005, :end_year => 1900)
db045db @dhh Initial
dhh authored
588 #
b00e6a9 @dhh Massive documentation update for all helpers (closes #8223, #8177, #8…
dhh authored
589 # # Generates a select field for years that defaults to the year 2006 that
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
590 # # has ascending year values.
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
591 # select_year(2006, :start_year => 2000, :end_year => 2010)
c6ab8f5 @dhh Added :field_name option to DateHelper#select_(year|month|day) to dev…
dhh authored
592 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
593 # # Generates a select field for years with a custom prompt. Use <tt>:prompt => true</tt> for a
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
594 # # generic prompt.
595 # select_year(14, :prompt => 'Choose year')
596 #
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
597 def select_year(date, options = {}, html_options = {})
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
598 DateTimeSelector.new(date, options, html_options).select_year
599 end
33cc366 @joshk Allow for the format of time_tag in AP to be changed via an option ar…
joshk authored
600
95a5bd8 @s-andringa Added time_tag helper to AP for HTML5 time tag [#5919 state:resolved]
s-andringa authored
601 # Returns an html time tag for the given date or time.
602 #
603 # ==== Examples
604 # time_tag Date.today # =>
605 # <time datetime="2010-11-04">November 04, 2010</time>
606 # time_tag Time.now # =>
607 # <time datetime="2010-11-04T17:55:45+01:00">November 04, 2010 17:55</time>
608 # time_tag Date.yesterday, 'Yesterday' # =>
609 # <time datetime="2010-11-03">Yesterday</time>
610 # time_tag Date.today, :pubdate => true # =>
611 # <time datetime="2010-11-04" pubdate="pubdate">November 04, 2010</time>
612 #
613 def time_tag(date_or_time, *args)
614 options = args.extract_options!
33cc366 @joshk Allow for the format of time_tag in AP to be changed via an option ar…
joshk authored
615 format = options.delete(:format) || :long
616 content = args.first || I18n.l(date_or_time, :format => format)
95a5bd8 @s-andringa Added time_tag helper to AP for HTML5 time tag [#5919 state:resolved]
s-andringa authored
617 datetime = date_or_time.acts_like?(:time) ? date_or_time.xmlschema : date_or_time.rfc3339
33cc366 @joshk Allow for the format of time_tag in AP to be changed via an option ar…
joshk authored
618
619 content_tag(:time, content, options.reverse_merge(:datetime => datetime))
95a5bd8 @s-andringa Added time_tag helper to AP for HTML5 time tag [#5919 state:resolved]
s-andringa authored
620 end
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
621 end
622
623 class DateTimeSelector #:nodoc:
624 extend ActiveSupport::Memoizable
625 include ActionView::Helpers::TagHelper
626
dad71c6 @joshk removed 'unless const_defined?' code smell
joshk authored
627 DEFAULT_PREFIX = 'date'.freeze
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
628 POSITION = {
629 :year => 1, :month => 2, :day => 3, :hour => 4, :minute => 5, :second => 6
dad71c6 @joshk removed 'unless const_defined?' code smell
joshk authored
630 }.freeze
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
631
a869382 @asanghi Allow AM/PM in datetime selectors
asanghi authored
632 AMPM_TRANSLATION = Hash[
633 [[0, "12 AM"], [1, "01 AM"], [2, "02 AM"], [3, "03 AM"],
634 [4, "04 AM"], [5, "05 AM"], [6, "06 AM"], [7, "07 AM"],
635 [8, "08 AM"], [9, "09 AM"], [10, "10 AM"], [11, "11 AM"],
636 [12, "12 PM"], [13, "01 PM"], [14, "02 PM"], [15, "03 PM"],
637 [16, "04 PM"], [17, "05 PM"], [18, "06 PM"], [19, "07 PM"],
638 [20, "08 PM"], [21, "09 PM"], [22, "10 PM"], [23, "11 PM"]]
639 ].freeze
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
640
641 def initialize(datetime, options = {}, html_options = {})
642 @options = options.dup
643 @html_options = html_options.dup
644 @datetime = datetime
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
645 @options[:datetime_separator] ||= ' &mdash; '
646 @options[:time_separator] ||= ' : '
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
647 end
648
649 def select_datetime
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
650 order = date_order.dup
651 order -= [:hour, :minute, :second]
652 @options[:discard_year] ||= true unless order.include?(:year)
653 @options[:discard_month] ||= true unless order.include?(:month)
654 @options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day)
655 @options[:discard_minute] ||= true if @options[:discard_hour]
656 @options[:discard_second] ||= true unless @options[:include_seconds] && !@options[:discard_minute]
657
658 # If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
87e9e3f @rtlechow Action Pack typos.
rtlechow authored
659 # valid (otherwise it could be 31 and February wouldn't be a valid date)
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
660 if @datetime && @options[:discard_day] && !@options[:discard_month]
661 @datetime = @datetime.change(:day => 1)
662 end
663
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
664 if @options[:tag] && @options[:ignore_date]
665 select_time
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
666 else
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
667 [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
668 order += [:hour, :minute, :second] unless @options[:discard_hour]
669
670 build_selects_from_types(order)
671 end
672 end
673
674 def select_date
675 order = date_order.dup
676
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
677 @options[:discard_hour] = true
678 @options[:discard_minute] = true
679 @options[:discard_second] = true
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
680
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
681 @options[:discard_year] ||= true unless order.include?(:year)
682 @options[:discard_month] ||= true unless order.include?(:month)
683 @options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day)
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
684
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
685 # If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
87e9e3f @rtlechow Action Pack typos.
rtlechow authored
686 # valid (otherwise it could be 31 and February wouldn't be a valid date)
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
687 if @datetime && @options[:discard_day] && !@options[:discard_month]
688 @datetime = @datetime.change(:day => 1)
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
689 end
690
691 [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
692
693 build_selects_from_types(order)
694 end
695
696 def select_time
697 order = []
698
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
699 @options[:discard_month] = true
700 @options[:discard_year] = true
701 @options[:discard_day] = true
702 @options[:discard_second] ||= true unless @options[:include_seconds]
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
703
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
704 order += [:year, :month, :day] unless @options[:ignore_date]
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
705
706 order += [:hour, :minute]
707 order << :second if @options[:include_seconds]
708
709 build_selects_from_types(order)
710 end
711
712 def select_second
713 if @options[:use_hidden] || @options[:discard_second]
714 build_hidden(:second, sec) if @options[:include_seconds]
715 else
716 build_options_and_select(:second, sec)
717 end
718 end
719
720 def select_minute
721 if @options[:use_hidden] || @options[:discard_minute]
722 build_hidden(:minute, min)
723 else
724 build_options_and_select(:minute, min, :step => @options[:minute_step])
725 end
726 end
727
728 def select_hour
729 if @options[:use_hidden] || @options[:discard_hour]
730 build_hidden(:hour, hour)
731 else
8bce6e7 @asanghi DRY this baby up
asanghi authored
732 build_options_and_select(:hour, hour, :end => 23, :ampm => @options[:ampm])
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
733 end
734 end
735
736 def select_day
737 if @options[:use_hidden] || @options[:discard_day]
738 build_hidden(:day, day)
739 else
740 build_options_and_select(:day, day, :start => 1, :end => 31, :leading_zeros => false)
741 end
742 end
743
744 def select_month
745 if @options[:use_hidden] || @options[:discard_month]
746 build_hidden(:month, month)
747 else
748 month_options = []
749 1.upto(12) do |month_number|
750 options = { :value => month_number }
751 options[:selected] = "selected" if month == month_number
752 month_options << content_tag(:option, month_name(month_number), options) + "\n"
753 end
754 build_select(:month, month_options.join)
755 end
756 end
757
758 def select_year
759 if !@datetime || @datetime == 0
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
760 val = ''
5dd10d6 @NZKoz Remove nested ternary operators from select_year in favour of conditi…
NZKoz authored
761 middle_year = Date.today.year
762 else
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
763 val = middle_year = year
5dd10d6 @NZKoz Remove nested ternary operators from select_year in favour of conditi…
NZKoz authored
764 end
765
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
766 if @options[:use_hidden] || @options[:discard_year]
767 build_hidden(:year, val)
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
768 else
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
769 options = {}
770 options[:start] = @options[:start_year] || middle_year - 5
771 options[:end] = @options[:end_year] || middle_year + 5
772 options[:step] = options[:start] < options[:end] ? 1 : -1
773 options[:leading_zeros] = false
774
775 build_options_and_select(:year, val, options)
db045db @dhh Initial
dhh authored
776 end
777 end
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
778
db045db @dhh Initial
dhh authored
779 private
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
780 %w( sec min hour day month year ).each do |method|
781 define_method(method) do
782 @datetime.kind_of?(Fixnum) ? @datetime : @datetime.send(method) if @datetime
783 end
784 end
785
786 # Returns translated month names, but also ensures that a custom month
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
787 # name array has a leading nil element.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
788 def month_names
789 month_names = @options[:use_month_names] || translated_month_names
790 month_names.unshift(nil) if month_names.size < 13
791 month_names
792 end
793 memoize :month_names
794
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
795 # Returns translated month names.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
796 # => [nil, "January", "February", "March",
797 # "April", "May", "June", "July",
798 # "August", "September", "October",
799 # "November", "December"]
800 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
801 # If <tt>:use_short_month</tt> option is set
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
802 # => [nil, "Jan", "Feb", "Mar", "Apr", "May", "Jun",
803 # "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
804 def translated_month_names
0aefbe5 @carlosantoniodasilva Removing some unuseful begin/end and refactor prompt_option_tag a bit
carlosantoniodasilva authored
805 key = @options[:use_short_month] ? :'date.abbr_month_names' : :'date.month_names'
806 I18n.translate(key, :locale => @options[:locale])
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
807 end
808
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
809 # Lookup month name for number.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
810 # month_name(1) => "January"
811 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
812 # If <tt>:use_month_numbers</tt> option is passed
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
813 # month_name(1) => 1
814 #
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
815 # If <tt>:add_month_numbers</tt> option is passed
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
816 # month_name(1) => "1 - January"
817 def month_name(number)
818 if @options[:use_month_numbers]
819 number
820 elsif @options[:add_month_numbers]
821 "#{number} - #{month_names[number]}"
822 else
823 month_names[number]
824 end
825 end
826
827 def date_order
828 @options[:order] || translated_date_order
829 end
830 memoize :date_order
831
832 def translated_date_order
0aefbe5 @carlosantoniodasilva Removing some unuseful begin/end and refactor prompt_option_tag a bit
carlosantoniodasilva authored
833 I18n.translate(:'date.order', :locale => @options[:locale]) || []
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
834 end
835
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
836 # Build full select tag from date type and options.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
837 def build_options_and_select(type, selected, options = {})
838 build_select(type, build_options(selected, options))
839 end
840
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
841 # Build select option html from date value and options.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
842 # build_options(15, :start => 1, :end => 31)
843 # => "<option value="1">1</option>
844 # <option value=\"2\">2</option>
845 # <option value=\"3\">3</option>..."
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
846 #
847 # If <tt>:step</tt> options is passed
848 # build_options(15, :start => 1, :end => 31, :step => 2)
849 # => "<option value="1">1</option>
850 # <option value=\"3\">3</option>
851 # <option value=\"5\">5</option>..."
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
852 def build_options(selected, options = {})
853 start = options.delete(:start) || 0
854 stop = options.delete(:end) || 59
855 step = options.delete(:step) || 1
8bce6e7 @asanghi DRY this baby up
asanghi authored
856 options.reverse_merge!({:leading_zeros => true, :ampm => false})
1f499e6 @neerajdotname fixing the ternary operation where the logic is very confusing.
neerajdotname authored
857 leading_zeros = options.delete(:leading_zeros)
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
858
859 select_options = []
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
860 start.step(stop, step) do |i|
861 value = leading_zeros ? sprintf("%02d", i) : i
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
862 tag_options = { :value => value }
863 tag_options[:selected] = "selected" if selected == i
8bce6e7 @asanghi DRY this baby up
asanghi authored
864 text = options[:ampm] ? AMPM_TRANSLATION[i] : value
865 select_options << content_tag(:option, text, tag_options)
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
866 end
f86421f @nono content_tag should escape its input
nono authored
867 (select_options.join("\n") + "\n").html_safe
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
868 end
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
869
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
870 # Builds select tag from date type and html select options.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
871 # build_select(:month, "<option value="1">January</option>...")
872 # => "<select id="post_written_on_2i" name="post[written_on(2i)]">
873 # <option value="1">January</option>...
874 # </select>"
875 def build_select(type, select_options_as_html)
876 select_options = {
877 :id => input_id_from_type(type),
878 :name => input_name_from_type(type)
879 }.merge(@html_options)
880 select_options.merge!(:disabled => 'disabled') if @options[:disabled]
881
cd937e6 @NZKoz Make date_helper use tag and content_tag. Move to assert_dom_equal i…
NZKoz authored
882 select_html = "\n"
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
883 select_html << content_tag(:option, '', :value => '') + "\n" if @options[:include_blank]
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
884 select_html << prompt_option_tag(type, @options[:prompt]) + "\n" if @options[:prompt]
f86421f @nono content_tag should escape its input
nono authored
885 select_html << select_options_as_html
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
886
f86421f @nono content_tag should escape its input
nono authored
887 (content_tag(:select, select_html.html_safe, select_options) + "\n").html_safe
db045db @dhh Initial
dhh authored
888 end
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
889
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
890 # Builds a prompt option tag with supplied options or from default options.
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
891 # prompt_option_tag(:month, :prompt => 'Select month')
892 # => "<option value="">Select month</option>"
893 def prompt_option_tag(type, options)
0aefbe5 @carlosantoniodasilva Removing some unuseful begin/end and refactor prompt_option_tag a bit
carlosantoniodasilva authored
894 prompt = case options
895 when Hash
896 default_options = {:year => false, :month => false, :day => false, :hour => false, :minute => false, :second => false}
897 default_options.merge!(options)[type.to_sym]
898 when String
899 options
900 else
901 I18n.translate(:"datetime.prompts.#{type}", :locale => @options[:locale])
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
902 end
903
70456ae @samoli Use I18n for date/time select helpers prompt text [#561 state:resolved]
samoli authored
904 prompt ? content_tag(:option, prompt, :value => '') : ''
389534c @samoli Added prompt options to date helpers [#561 state:resolved]
samoli authored
905 end
906
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
907 # Builds hidden input tag for date part and value.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
908 # build_hidden(:year, 2008)
909 # => "<input id="post_written_on_1i" name="post[written_on(1i)]" type="hidden" value="2008" />"
910 def build_hidden(type, value)
188d521 @dhh Fixed that much of DateHelper wouldn't return html_safe? strings [DHH]
dhh authored
911 (tag(:input, {
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
912 :type => "hidden",
913 :id => input_id_from_type(type),
914 :name => input_name_from_type(type),
915 :value => value
e472f76 @spastorino Adds disable option to date_helpers generated hidden fields when html…
spastorino authored
916 }.merge(@html_options.slice(:disabled))) + "\n").html_safe
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
917 end
918
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
919 # Returns the name attribute for the input tag.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
920 # => post[written_on(1i)]
921 def input_name_from_type(type)
922 prefix = @options[:prefix] || ActionView::Helpers::DateTimeSelector::DEFAULT_PREFIX
7260852 Fix date_select within fields_for with an index [#1666 state:resolved…
Josh authored
923 prefix += "[#{@options[:index]}]" if @options.has_key?(:index)
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
924
925 field_name = @options[:field_name] || type
926 if @options[:include_position]
927 field_name += "(#{ActionView::Helpers::DateTimeSelector::POSITION[type]}i)"
928 end
929
930 @options[:discard_type] ? prefix : "#{prefix}[#{field_name}]"
931 end
932
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
933 # Returns the id attribute for the input tag.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
934 # => "post_written_on_1i"
935 def input_id_from_type(type)
936 input_name_from_type(type).gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '')
937 end
938
18eb80c @lifo Merge docrails
lifo authored
939 # Given an ordering of datetime components, create the selection HTML
940 # and join them with their appropriate separators.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
941 def build_selects_from_types(order)
942 select = ''
943 order.reverse.each do |type|
944 separator = separator(type) unless type == order.first # don't add on last field
945 select.insert(0, separator.to_s + send("select_#{type}").to_s)
946 end
4cbb9db For performance reasons, you can no longer call html_safe! on Strings…
Yehuda Katz authored
947 select.html_safe
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
948 end
949
71d6b08 @smartinez87 Fix styiling issues on DateHelper docs
smartinez87 authored
950 # Returns the separator for a given datetime component.
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
951 def separator(type)
952 case type
920660b @asanghi patching to ensure separator is printed with order [#5816 state:resol…
asanghi authored
953 when :year
954 @options[:discard_year] ? "" : @options[:date_separator]
5522578 Fixed date_select date_separator when discard_month and/or discard_da…
Thibaud Guillaume-Gentil authored
955 when :month
956 @options[:discard_month] ? "" : @options[:date_separator]
957 when :day
958 @options[:discard_day] ? "" : @options[:date_separator]
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
959 when :hour
960 (@options[:discard_year] && @options[:discard_day]) ? "" : @options[:datetime_separator]
961 when :minute
f76eaa4 @spastorino add time_separator for minutes only if minutes aren't hidden
spastorino authored
962 @options[:discard_minute] ? "" : @options[:time_separator]
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
963 when :second
964 @options[:include_seconds] ? @options[:time_separator] : ""
965 end
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
966 end
db045db @dhh Initial
dhh authored
967 end
968
969 class InstanceTag #:nodoc:
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
970 def to_date_select_tag(options = {}, html_options = {})
4cbb9db For performance reasons, you can no longer call html_safe! on Strings…
Yehuda Katz authored
971 datetime_selector(options, html_options).select_date.html_safe
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
972 end
db045db @dhh Initial
dhh authored
973
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
974 def to_time_select_tag(options = {}, html_options = {})
4cbb9db For performance reasons, you can no longer call html_safe! on Strings…
Yehuda Katz authored
975 datetime_selector(options, html_options).select_time.html_safe
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
976 end
9b5ece8 @dhh Added :order option for date_select that allows control over the orde…
dhh authored
977
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
978 def to_datetime_select_tag(options = {}, html_options = {})
4cbb9db For performance reasons, you can no longer call html_safe! on Strings…
Yehuda Katz authored
979 datetime_selector(options, html_options).select_datetime.html_safe
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
980 end
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
981
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
982 private
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
983 def datetime_selector(options, html_options)
984 datetime = value(object) || default_datetime(options)
74d7664 @miloops Avoid uninitialized variable warning.
miloops authored
985 @auto_index ||= nil
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
986
987 options = options.dup
988 options[:field_name] = @method_name
989 options[:include_position] = true
990 options[:prefix] ||= @object_name
7260852 Fix date_select within fields_for with an index [#1666 state:resolved…
Josh authored
991 options[:index] = @auto_index if @auto_index && !options.has_key?(:index)
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
992
68c96fa @neerajdotname Fix form builder and form helpers inconsistencies [#4432 state:resolved]
neerajdotname authored
993 DateTimeSelector.new(datetime, options, html_options)
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
994 end
dfac1ce @dhh Fixed that form helpers would treat string and symbol keys differentl…
dhh authored
995
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
996 def default_datetime(options)
f04346d @samoli Stops date select helpers from defaulting the selected date to today …
samoli authored
997 return if options[:include_blank] || options[:prompt]
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
998
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
999 case options[:default]
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
1000 when nil
c2c7790 @gbuesing datetime_select defaults to Time.zone.now when config.time_zone is set
gbuesing authored
1001 Time.current
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
1002 when Date, Time
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
1003 options[:default]
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
1004 else
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
1005 default = options[:default].dup
1006
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
1007 # Rename :minute and :second to :min and :sec
1008 default[:min] ||= default[:minute]
1009 default[:sec] ||= default[:second]
1010
bfbf03e @gbuesing ActionView::InstanceTag#default_time_from_options with hash args uses…
gbuesing authored
1011 time = Time.current
ff9f6fc @clemens Refactor DateHelper and improve test coverage [#665 state:resolved]
clemens authored
1012
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
1013 [:year, :month, :day, :hour, :min, :sec].each do |key|
bfbf03e @gbuesing ActionView::InstanceTag#default_time_from_options with hash args uses…
gbuesing authored
1014 default[key] ||= time.send(key)
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
1015 end
1016
105093f @clemens Refactor DateHelper to use DateTimeSelector presenter pattern
clemens authored
1017 Time.utc_time(
1018 default[:year], default[:month], default[:day],
1019 default[:hour], default[:min], default[:sec]
1020 )
1021 end
d6d94c7 @jeremy date_select and datetime_select take a :default option. Closes #7052.
jeremy authored
1022 end
db045db @dhh Initial
dhh authored
1023 end
947cec2 @dhh Added FormHelper#form_for and FormHelper#fields_for that makes it eas…
dhh authored
1024
1025 class FormBuilder
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
1026 def date_select(method, options = {}, html_options = {})
7260852 Fix date_select within fields_for with an index [#1666 state:resolved…
Josh authored
1027 @template.date_select(@object_name, method, objectify_options(options), html_options)
947cec2 @dhh Added FormHelper#form_for and FormHelper#fields_for that makes it eas…
dhh authored
1028 end
1029
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
1030 def time_select(method, options = {}, html_options = {})
7260852 Fix date_select within fields_for with an index [#1666 state:resolved…
Josh authored
1031 @template.time_select(@object_name, method, objectify_options(options), html_options)
07423be @jeremy Bob's raining patches: fixes date_helper bugs and usability issues. R…
jeremy authored
1032 end
1033
4673c47 @NZKoz Allow html_options to be passed to all the date helpers. Closes #600…
NZKoz authored
1034 def datetime_select(method, options = {}, html_options = {})
7260852 Fix date_select within fields_for with an index [#1666 state:resolved…
Josh authored
1035 @template.datetime_select(@object_name, method, objectify_options(options), html_options)
947cec2 @dhh Added FormHelper#form_for and FormHelper#fields_for that makes it eas…
dhh authored
1036 end
1037 end
db045db @dhh Initial
dhh authored
1038 end
202d5c0 @dhh Added support for descending year values in DateHelper#select_year, l…
dhh authored
1039 end
Something went wrong with that request. Please try again.