Enables the use of time calculations within Date itself

Namespace
Methods
A
B
C
E
F
I
M
N
P
S
T
Y
Instance Public methods
advance(options)

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 94
def advance(options)
  options = options.dup
  d = self
  d = d >> options.delete(:years) * 12 if options[:years]
  d = d >> options.delete(:months)     if options[:months]
  d = d +  options.delete(:weeks) * 7  if options[:weeks]
  d = d +  options.delete(:days)       if options[:days]
  d
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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 52
def ago(seconds)
  to_time.since(-seconds)
end
at_beginning_of_day()
at_beginning_of_month()
at_beginning_of_quarter()
at_beginning_of_week()
at_beginning_of_year()
at_end_of_month()
at_end_of_quarter()
at_end_of_week()
at_end_of_year()
at_midnight()
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)

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 64
def beginning_of_day
  to_time
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)

Also aliased as: at_beginning_of_month
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 193
def beginning_of_month
  self.acts_like?(:time) ? change(:day => 1,:hour => 0, :min => 0, :sec => 0) : change(:day => 1)
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)

Also aliased as: at_beginning_of_quarter
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 206
def beginning_of_quarter
  beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
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)

Also aliased as: monday, at_beginning_of_week
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 169
def beginning_of_week
  days_to_monday = self.wday!=0 ? self.wday-1 : 6
  result = self - days_to_monday
  self.acts_like?(:time) ? result.midnight : result
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)

Also aliased as: at_beginning_of_year
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 218
def beginning_of_year
  self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0) : change(:month => 1, :day => 1)
end
change(options)

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

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)
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 110
def change(options)
  ::Date.new(
    options[:year]  || self.year,
    options[:month] || self.month,
    options[:day]   || self.day
  )
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)

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 72
def end_of_day
  to_time.end_of_day
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)

Also aliased as: at_end_of_month
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 199
def end_of_month
  last_day = ::Time.days_in_month( self.month, self.year )
  self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day)
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)

Also aliased as: at_end_of_quarter
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 212
def end_of_quarter
  beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
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)

Also aliased as: at_end_of_week
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 178
def end_of_week
  days_to_sunday = self.wday!=0 ? 7-self.wday : 0
  result = self + days_to_sunday.days
  self.acts_like?(:time) ? result.end_of_day : result
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)

Also aliased as: at_end_of_year
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 224
def end_of_year
  self.acts_like?(:time) ? change(:month => 12,:day => 31,:hour => 23, :min => 59, :sec => 59) : change(:month => 12, :day => 31)
end
future?()

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 46
def future?
  self > ::Date.current
end
in(seconds)
midnight()
monday()
months_ago(months)

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

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

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

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

Short-hand for #months_since(1)

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 164
def next_month
  months_since(1)
end
next_week(day = :monday)

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

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

Short-hand for #years_since(1)

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 149
def next_year
  years_since(1)
end
past?()

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 36
def past?
  self < ::Date.current
end
prev_month()

Short-hand for #months_ago(1)

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 159
def prev_month
  months_ago(1)
end
prev_year()

Short-hand for #years_ago(1)

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 144
def prev_year
  years_ago(1)
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

Also aliased as: in
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 58
def since(seconds)
  to_time.since(seconds)
end
today?()

Tells whether the Date object's date is today

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

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 235
def tomorrow
  self + 1
end
years_ago(years)

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

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

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

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

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 230
def yesterday
  self - 1
end