Module: ActionView::Helpers::DateHelper
- Included in:
- InstanceTag
- Defined in:
- lib/action_view/helpers/date_helper.rb
Overview
The Date Helper primarily creates select/option tags for different kinds of dates and date elements. All of the select-type methods share a number of common options that are as follows:
-
:prefix
- overwrites the default prefix of “date” used for the select names. So specifying “birthday” would give birthday instead of date if passed to the select_month method. -
:include_blank
- set to true if it should be possible to set an empty date. -
:discard_type
- set to true if you want to discard the type part of the select name. If set to true, the select_month method would use simply “date” (which can be overwritten using:prefix
) instead of “date”.
Constant Summary collapse
- DEFAULT_PREFIX =
'date'
Instance Method Summary collapse
-
#date_select(object, method, options = {}) ⇒ Object
Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by
method
) on an object assigned to the template (identified byobject
). -
#datetime_select(object, method, options = {}) ⇒ Object
Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based attribute (identified by
method
) on an object assigned to the template (identified byobject
). -
#distance_of_time_in_words(from_time, to_time = 0, include_seconds = false) ⇒ Object
Reports the approximate distance in time between to Time objects or integers.
-
#select_date(date = Date.today, options = {}) ⇒ Object
Returns a set of html select-tags (one for year, month, and day) pre-selected with the
date
. -
#select_datetime(datetime = Time.now, options = {}) ⇒ Object
Returns a set of html select-tags (one for year, month, day, hour, and minute) preselected the
datetime
. -
#select_day(date, options = {}) ⇒ Object
Returns a select tag with options for each of the days 1 through 31 with the current day selected.
-
#select_hour(datetime, options = {}) ⇒ Object
Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
-
#select_minute(datetime, options = {}) ⇒ Object
Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
-
#select_month(date, options = {}) ⇒ Object
Returns a select tag with options for each of the months January through December with the current month selected.
-
#select_second(datetime, options = {}) ⇒ Object
Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
-
#select_time(datetime = Time.now, options = {}) ⇒ Object
Returns a set of html select-tags (one for hour and minute).
-
#select_year(date, options = {}) ⇒ Object
Returns a select tag with options for each of the five years on each side of the current, which is selected.
-
#time_ago_in_words(from_time, include_seconds = false) ⇒ Object
(also: #distance_of_time_in_words_to_now)
Like distance_of_time_in_words, but where
to_time
is fixed toTime.now
.
Instance Method Details
#date_select(object, method, options = {}) ⇒ Object
Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by method
) on an object assigned to the template (identified by object
). It’s possible to tailor the selects through the options
hash, which both accepts all the keys that each of the individual select builders does (like :use_month_numbers for select_month) and a range of discard options. The discard options are :discard_year
, :discard_month
and :discard_day
. Set to true, they’ll drop the respective select. Discarding the month select will also automatically discard the day select. It’s also possible to explicitly set the order of the tags using the :order
option with an array of symbols :year
, :month
and :day
in the desired order. Symbols may be omitted and the respective select is not included.
NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.
Examples:
date_select("post", "written_on")
date_select("post", "written_on", :start_year => 1995)
date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true,
:discard_day => true, :include_blank => true)
date_select("post", "written_on", :order => [:day, :month, :year])
date_select("user", "birthday", :order => [:month, :day])
The selects are prepared for multi-parameter assignment to an Active Record object.
77 78 79 |
# File 'lib/action_view/helpers/date_helper.rb', line 77 def date_select(object, method, = {}) InstanceTag.new(object, method, self).to_date_select_tag() end |
#datetime_select(object, method, options = {}) ⇒ Object
Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based attribute (identified by method
) on an object assigned to the template (identified by object
). Examples:
datetime_select("post", "written_on")
datetime_select("post", "written_on", :start_year => 1995)
The selects are prepared for multi-parameter assignment to an Active Record object.
88 89 90 |
# File 'lib/action_view/helpers/date_helper.rb', line 88 def datetime_select(object, method, = {}) InstanceTag.new(object, method, self).to_datetime_select_tag() end |
#distance_of_time_in_words(from_time, to_time = 0, include_seconds = false) ⇒ Object
Reports the approximate distance in time between to Time objects or integers. For example, if the distance is 47 minutes, it’ll return “about 1 hour”. See the source for the complete wording list.
Integers are interpreted as seconds. So, distance_of_time_in_words(50)
returns “less than a minute”.
Set include_seconds
to true if you want more detailed approximations if distance < 1 minute
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/action_view/helpers/date_helper.rb', line 24 def distance_of_time_in_words(from_time, to_time = 0, include_seconds = false) from_time = from_time.to_time if from_time.respond_to?(:to_time) to_time = to_time.to_time if to_time.respond_to?(:to_time) distance_in_minutes = (((to_time - from_time).abs)/60).round distance_in_seconds = ((to_time - from_time).abs).round case distance_in_minutes when 0..1 return (distance_in_minutes==0) ? 'less than a minute' : '1 minute' unless include_seconds case distance_in_seconds when 0..5 then 'less than 5 seconds' when 6..10 then 'less than 10 seconds' when 11..20 then 'less than 20 seconds' when 21..40 then 'half a minute' when 41..59 then 'less than a minute' else '1 minute' end when 2..45 then "#{distance_in_minutes} minutes" when 46..90 then 'about 1 hour' when 90..1440 then "about #{(distance_in_minutes.to_f / 60.0).round} hours" when 1441..2880 then '1 day' else "#{(distance_in_minutes / 1440).round} days" end end |
#select_date(date = Date.today, options = {}) ⇒ Object
Returns a set of html select-tags (one for year, month, and day) pre-selected with the date
.
93 94 95 |
# File 'lib/action_view/helpers/date_helper.rb', line 93 def select_date(date = Date.today, = {}) select_year(date, ) + select_month(date, ) + select_day(date, ) end |
#select_datetime(datetime = Time.now, options = {}) ⇒ Object
Returns a set of html select-tags (one for year, month, day, hour, and minute) preselected the datetime
.
98 99 100 101 |
# File 'lib/action_view/helpers/date_helper.rb', line 98 def select_datetime(datetime = Time.now, = {}) select_year(datetime, ) + select_month(datetime, ) + select_day(datetime, ) + select_hour(datetime, ) + select_minute(datetime, ) end |
#select_day(date, options = {}) ⇒ Object
Returns a select tag with options for each of the days 1 through 31 with the current day selected. The date
can also be substituted for a hour number. Override the field name using the :field_name
option, ‘day’ by default.
160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/action_view/helpers/date_helper.rb', line 160 def select_day(date, = {}) = [] 1.upto(31) do |day| << ((date && (date.kind_of?(Fixnum) ? date : date.day) == day) ? %(<option value="#{day}" selected="selected">#{day}</option>\n) : %(<option value="#{day}">#{day}</option>\n) ) end select_html([:field_name] || 'day', , [:prefix], [:include_blank], [:discard_type]) end |
#select_hour(datetime, options = {}) ⇒ Object
Returns a select tag with options for each of the hours 0 through 23 with the current hour selected. The hour
can also be substituted for a hour number. Override the field name using the :field_name
option, ‘hour’ by default.
144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/action_view/helpers/date_helper.rb', line 144 def select_hour(datetime, = {}) = [] 0.upto(23) do |hour| << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.hour) == hour) ? %(<option value="#{leading_zero_on_single_digits(hour)}" selected="selected">#{leading_zero_on_single_digits(hour)}</option>\n) : %(<option value="#{leading_zero_on_single_digits(hour)}">#{leading_zero_on_single_digits(hour)}</option>\n) ) end select_html([:field_name] || 'hour', , [:prefix], [:include_blank], [:discard_type]) end |
#select_minute(datetime, options = {}) ⇒ Object
Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected. Also can return a select tag with options by minute_step
from 0 through 59 with the 00 minute selected The minute
can also be substituted for a minute number. Override the field name using the :field_name
option, ‘minute’ by default.
128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/action_view/helpers/date_helper.rb', line 128 def select_minute(datetime, = {}) = [] 0.step(59, [:minute_step] || 1) do |minute| << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.min) == minute) ? %(<option value="#{leading_zero_on_single_digits(minute)}" selected="selected">#{leading_zero_on_single_digits(minute)}</option>\n) : %(<option value="#{leading_zero_on_single_digits(minute)}">#{leading_zero_on_single_digits(minute)}</option>\n) ) end select_html([:field_name] || 'minute', , [:prefix], [:include_blank], [:discard_type]) end |
#select_month(date, options = {}) ⇒ Object
Returns a select tag with options for each of the months January through December with the current month selected. The month names are presented as keys (what’s shown to the user) and the month numbers (1-12) are used as values (what’s submitted to the server). It’s also possible to use month numbers for the presentation instead of names – set the :use_month_numbers
key in options
to true for this to happen. If you want both numbers and names, set the :add_month_numbers
key in options
to true. Examples:
select_month(Date.today) # Will use keys like "January", "March"
select_month(Date.today, :use_month_numbers => true) # Will use keys like "1", "3"
select_month(Date.today, :add_month_numbers => true) # Will use keys like "1 - January", "3 - March"
Override the field name using the :field_name
option, ‘month’ by default.
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/action_view/helpers/date_helper.rb', line 184 def select_month(date, = {}) = [] 1.upto(12) do |month_number| month_name = if [:use_month_numbers] month_number elsif [:add_month_numbers] month_number.to_s + ' - ' + Date::MONTHNAMES[month_number] else Date::MONTHNAMES[month_number] end << ((date && (date.kind_of?(Fixnum) ? date : date.month) == month_number) ? %(<option value="#{month_number}" selected="selected">#{month_name}</option>\n) : %(<option value="#{month_number}">#{month_name}</option>\n) ) end select_html([:field_name] || 'month', , [:prefix], [:include_blank], [:discard_type]) end |
#select_second(datetime, options = {}) ⇒ Object
Returns a select tag with options for each of the seconds 0 through 59 with the current second selected. The second
can also be substituted for a second number. Override the field name using the :field_name
option, ‘second’ by default.
111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/action_view/helpers/date_helper.rb', line 111 def select_second(datetime, = {}) = [] 0.upto(59) do |second| << ((datetime && (datetime.kind_of?(Fixnum) ? datetime : datetime.sec) == second) ? %(<option value="#{leading_zero_on_single_digits(second)}" selected="selected">#{leading_zero_on_single_digits(second)}</option>\n) : %(<option value="#{leading_zero_on_single_digits(second)}">#{leading_zero_on_single_digits(second)}</option>\n) ) end select_html([:field_name] || 'second', , [:prefix], [:include_blank], [:discard_type]) end |
#select_time(datetime = Time.now, options = {}) ⇒ Object
Returns a set of html select-tags (one for hour and minute)
104 105 106 |
# File 'lib/action_view/helpers/date_helper.rb', line 104 def select_time(datetime = Time.now, = {}) h = select_hour(datetime, ) + select_minute(datetime, ) + ([:include_seconds] ? select_second(datetime, ) : '') end |
#select_year(date, options = {}) ⇒ Object
Returns a select tag with options for each of the five years on each side of the current, which is selected. The five year radius can be changed using the :start_year
and :end_year
keys in the options
. Both ascending and descending year lists are supported by making :start_year
less than or greater than :end_year
. The date
can also be substituted for a year given as a number. Example:
select_year(Date.today, :start_year => 1992, :end_year => 2007) # ascending year values
select_year(Date.today, :start_year => 2005, :end_year => 1900) # descending year values
Override the field name using the :field_name
option, ‘year’ by default.
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/action_view/helpers/date_helper.rb', line 214 def select_year(date, = {}) = [] y = date ? (date.kind_of?(Fixnum) ? (y = (date == 0) ? Date.today.year : date) : date.year) : Date.today.year start_year, end_year = ([:start_year] || y-5), ([:end_year] || y+5) step_val = start_year < end_year ? 1 : -1 start_year.step(end_year, step_val) do |year| << ((date && (date.kind_of?(Fixnum) ? date : date.year) == year) ? %(<option value="#{year}" selected="selected">#{year}</option>\n) : %(<option value="#{year}">#{year}</option>\n) ) end select_html([:field_name] || 'year', , [:prefix], [:include_blank], [:discard_type]) end |
#time_ago_in_words(from_time, include_seconds = false) ⇒ Object Also known as: distance_of_time_in_words_to_now
Like distance_of_time_in_words, but where to_time
is fixed to Time.now
.
51 52 53 |
# File 'lib/action_view/helpers/date_helper.rb', line 51 def time_ago_in_words(from_time, include_seconds = false) distance_of_time_in_words(from_time, Time.now, include_seconds) end |