Module: ActiveSupport::CoreExtensions::Date::Calculations

advance(options)

Provides precise Date calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days.

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 94
 94:         def advance(options)
 95:           options = options.dup
 96:           d = self
 97:           d = d >> options.delete(:years) * 12 if options[:years]
 98:           d = d >> options.delete(:months)     if options[:months]
 99:           d = d +  options.delete(:weeks) * 7  if options[:weeks]
100:           d = d +  options.delete(:days)       if options[:days]
101:           d
102:         end

ago(seconds)

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then subtracts the specified number of seconds

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 52
52:         def ago(seconds)
53:           to_time.since(-seconds)
54:         end

at_beginning_of_day()

Alias for beginning_of_day

at_beginning_of_month()

Alias for beginning_of_month

at_beginning_of_quarter()

Alias for beginning_of_quarter

at_beginning_of_week()

Alias for beginning_of_week

at_beginning_of_year()

Alias for beginning_of_year

at_end_of_month()

Alias for end_of_month

at_end_of_quarter()

Alias for end_of_quarter

at_end_of_week()

Alias for end_of_week

at_end_of_year()

Alias for end_of_year

at_midnight()

Alias for beginning_of_day

beginning_of_day()

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 64
64:         def beginning_of_day
65:           to_time
66:         end

beginning_of_month()

Returns a new ; DateTime objects will have time set to 0:00DateTime representing the start of the month (1st of the month; DateTime objects will have time set to 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 183
183:         def beginning_of_month
184:           self.acts_like?(:time) ? change(:day => 1,:hour => 0, :min => 0, :sec => 0) : change(:day => 1)
185:         end

beginning_of_quarter()

Returns a new Date/DateTime representing the start of the quarter (1st of january, april, july, october; DateTime objects will have time set to 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 196
196:         def beginning_of_quarter
197:           beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
198:         end

beginning_of_week()

Returns a new Date/DateTime representing the "start" of this week (i.e, Monday; DateTime objects will have time set to 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 159
159:         def beginning_of_week
160:           days_to_monday = self.wday!=0 ? self.wday-1 : 6
161:           result = self - days_to_monday
162:           self.acts_like?(:time) ? result.midnight : result
163:         end

beginning_of_year()

Returns a new Date/DateTime representing the start of the year (1st of january; DateTime objects will have time set to 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 208
208:         def beginning_of_year
209:           self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0) : change(:month => 1, :day => 1)
210:         end

change(options)

Returns a new Date where one or more of the elements have been changed according to the options parameter.

Examples:

  Date.new(2007, 5, 12).change(:day => 1)                  # => Date.new(2007, 5, 1)
  Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 110
110:         def change(options)
111:           ::Date.new(
112:             options[:year]  || self.year,
113:             options[:month] || self.month,
114:             options[:day]   || self.day
115:           )
116:         end

end_of_day()

Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 72
72:         def end_of_day
73:           to_time.end_of_day
74:         end

end_of_month()

Returns a new Date/DateTime representing the end of the month (last day of the month; DateTime objects will have time set to 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 189
189:         def end_of_month
190:           last_day = ::Time.days_in_month( self.month, self.year )
191:           self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day)
192:         end

end_of_quarter()

Returns a new Date/DateTime representing the end of the quarter (last day of march, june, september, december; DateTime objects will have time set to 23:59:59)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 202
202:         def end_of_quarter
203:           beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
204:         end

end_of_week()

Returns a new Date/DateTime representing the end of this week (Sunday, DateTime objects will have time set to 23:59:59)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 168
168:         def end_of_week
169:           days_to_sunday = self.wday!=0 ? 7-self.wday : 0
170:           result = self + days_to_sunday.days
171:           self.acts_like?(:time) ? result.end_of_day : result
172:         end

end_of_year()

Returns a new Time representing the end of the year (31st of december; DateTime objects will have time set to 23:59:59)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 214
214:         def end_of_year
215:           self.acts_like?(:time) ? change(:month => 12,:day => 31,:hour => 23, :min => 59, :sec => 59) : change(:month => 12, :day => 31)
216:         end

future?()

Tells whether the Date object‘s date lies in the future

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 46
46:         def future?
47:           self > ::Date.current
48:         end

in(seconds)

Alias for since

last_month()

Short-hand for months_ago(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 149
149:         def last_month
150:           months_ago(1)
151:         end

last_year()

Short-hand for years_ago(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 139
139:         def last_year
140:           years_ago(1)
141:         end

midnight()

Alias for beginning_of_day

monday()

Alias for beginning_of_week

months_ago(months)

Returns a new Date/DateTime representing the time a number of specified months ago

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 119
119:         def months_ago(months)
120:           advance(:months => -months)
121:         end

months_since(months)

Returns a new Date/DateTime representing the time a number of specified months in the future

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 124
124:         def months_since(months)
125:           advance(:months => months)
126:         end

next_month()

Short-hand for months_since(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 154
154:         def next_month
155:           months_since(1)
156:         end

next_week(day = :monday)

Returns a new Date/DateTime representing the start of the given day in next week (default is Monday).

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 176
176:         def next_week(day = :monday)
177:           days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6}
178:           result = (self + 7).beginning_of_week + days_into_week[day]
179:           self.acts_like?(:time) ? result.change(:hour => 0) : result
180:         end

next_year()

Short-hand for years_since(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 144
144:         def next_year
145:           years_since(1)
146:         end

past?()

Tells whether the Date object‘s date lies in the past

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 36
36:         def past?
37:           self < ::Date.current
38:         end

since(seconds)

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then adds the specified number of seconds

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 58
58:         def since(seconds)
59:           to_time.since(seconds)
60:         end

today?()

Tells whether the Date object‘s date is today

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 41
41:         def today?
42:           self.to_date == ::Date.current # we need the to_date because of DateTime
43:         end

tomorrow()

Convenience method which returns a new Date/DateTime representing the time 1 day since the instance time

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 225
225:         def tomorrow
226:           self + 1
227:         end

years_ago(years)

Returns a new Date/DateTime representing the time a number of specified years ago

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 129
129:         def years_ago(years)
130:           advance(:years => -years)
131:         end

years_since(years)

Returns a new Date/DateTime representing the time a number of specified years in the future

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 134
134:         def years_since(years)
135:           advance(:years => years)
136:         end

yesterday()

Convenience method which returns a new Date/DateTime representing the time 1 day ago

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 220
220:         def yesterday
221:           self - 1
222:         end

Methods

Classes and Modules

Public Instance methods