edge badge
Methods
A
B
D
E
F
L
M
N
O
P
S
T
W
Y
Constants
DAYS_INTO_WEEK = { monday: 0, tuesday: 1, wednesday: 2, thursday: 3, friday: 4, saturday: 5, sunday: 6 }
 
WEEKEND_DAYS = [ 6, 0 ]
 
Instance Public methods
all_day()

Returns a Range representing the whole day of the current date/time.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 307
def all_day
  beginning_of_day..end_of_day
end
all_month()

Returns a Range representing the whole month of the current date/time.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 318
def all_month
  beginning_of_month..end_of_month
end
all_quarter()

Returns a Range representing the whole quarter of the current date/time.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 323
def all_quarter
  beginning_of_quarter..end_of_quarter
end
all_week(start_day = Date.beginning_of_week)

Returns a Range representing the whole week of the current date/time. Week starts on start_day, default is Date.beginning_of_week or config.beginning_of_week when set.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 313
def all_week(start_day = Date.beginning_of_week)
  beginning_of_week(start_day)..end_of_week(start_day)
end
all_year()

Returns a Range representing the whole year of the current date/time.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 328
def all_year
  beginning_of_year..end_of_year
end
at_beginning_of_month()
Alias for: beginning_of_month
at_beginning_of_quarter()
at_beginning_of_week(start_day = Date.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(start_day = Date.beginning_of_week)
Alias for: end_of_week
at_end_of_year()
Alias for: end_of_year
beginning_of_month()

Returns a new date/time at the start of the month.

today = Date.today # => Thu, 18 Jun 2015
today.beginning_of_month # => Mon, 01 Jun 2015

DateTime objects will have a time set to 0:00.

now = DateTime.current # => Thu, 18 Jun 2015 15:23:13 +0000
now.beginning_of_month # => Mon, 01 Jun 2015 00:00:00 +0000
Also aliased as: at_beginning_of_month
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 111
def beginning_of_month
  first_hour(change(day: 1))
end
beginning_of_quarter()

Returns a new date/time at the start of the quarter.

today = Date.today # => Fri, 10 Jul 2015
today.beginning_of_quarter # => Wed, 01 Jul 2015

DateTime objects will have a time set to 0:00.

now = DateTime.current # => Fri, 10 Jul 2015 18:41:29 +0000
now.beginning_of_quarter # => Wed, 01 Jul 2015 00:00:00 +0000
Also aliased as: at_beginning_of_quarter
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 125
def beginning_of_quarter
  first_quarter_month = [10, 7, 4, 1].detect { |m| m <= month }
  beginning_of_month.change(month: first_quarter_month)
end
beginning_of_week(start_day = Date.beginning_of_week)

Returns a new date/time representing the start of this week on the given day. Week is assumed to start on start_day, default is Date.beginning_of_week or config.beginning_of_week when set. DateTime objects have their time set to 0:00.

Also aliased as: at_beginning_of_week
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 264
def beginning_of_week(start_day = Date.beginning_of_week)
  result = days_ago(days_to_week_start(start_day))
  acts_like?(:time) ? result.midnight : result
end
beginning_of_year()

Returns a new date/time at the beginning of the year.

today = Date.today # => Fri, 10 Jul 2015
today.beginning_of_year # => Thu, 01 Jan 2015

DateTime objects will have a time set to 0:00.

now = DateTime.current # => Fri, 10 Jul 2015 18:41:29 +0000
now.beginning_of_year # => Thu, 01 Jan 2015 00:00:00 +0000
Also aliased as: at_beginning_of_year
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 155
def beginning_of_year
  change(month: 1).beginning_of_month
end
days_ago(days)

Returns a new date/time the specified number of days ago.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 63
def days_ago(days)
  advance(days: -days)
end
days_since(days)

Returns a new date/time the specified number of days in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 68
def days_since(days)
  advance(days: days)
end
days_to_week_start(start_day = Date.beginning_of_week)

Returns the number of days to the start of the week on the given day. Week is assumed to start on start_day, default is Date.beginning_of_week or config.beginning_of_week when set.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 254
def days_to_week_start(start_day = Date.beginning_of_week)
  start_day_number = DAYS_INTO_WEEK[start_day]
  current_day_number = wday != 0 ? wday - 1 : 6
  (current_day_number - start_day_number) % 7
end
end_of_month()

Returns a new date/time representing the end of the month. DateTime objects will have a time set to 23:59:59.

Also aliased as: at_end_of_month
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 293
def end_of_month
  last_day = ::Time.days_in_month(month, year)
  last_hour(days_since(last_day - day))
end
end_of_quarter()

Returns a new date/time at the end of the quarter.

today = Date.today # => Fri, 10 Jul 2015
today.end_of_quarter # => Wed, 30 Sep 2015

DateTime objects will have a time set to 23:59:59.

now = DateTime.current # => Fri, 10 Jul 2015 18:41:29 +0000
now.end_of_quarter # => Wed, 30 Sep 2015 23:59:59 +0000
Also aliased as: at_end_of_quarter
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 140
def end_of_quarter
  last_quarter_month = [3, 6, 9, 12].detect { |m| m >= month }
  beginning_of_month.change(month: last_quarter_month).end_of_month
end
end_of_week(start_day = Date.beginning_of_week)

Returns a new date/time representing the end of this week on the given day. Week is assumed to start on start_day, default is Date.beginning_of_week or config.beginning_of_week when set. DateTime objects have their time set to 23:59:59.

Also aliased as: at_end_of_week
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 280
def end_of_week(start_day = Date.beginning_of_week)
  last_hour(days_since(6 - days_to_week_start(start_day)))
end
end_of_year()

Returns a new date/time representing the end of the year. DateTime objects will have a time set to 23:59:59.

Also aliased as: at_end_of_year
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 301
def end_of_year
  change(month: 12).end_of_month
end
future?()

Returns true if the date/time is in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 48
def future?
  self > self.class.current
end
last_month()

Short-hand for #months_ago(1).

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 231
def last_month
  months_ago(1)
end
last_quarter()
Alias for: prev_quarter
last_week(start_day = Date.beginning_of_week, same_time: false)
Alias for: prev_week
last_weekday()
Alias for: prev_weekday
last_year()

Short-hand for #years_ago(1).

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 247
def last_year
  years_ago(1)
end
monday()

Returns Monday of this week assuming that week starts on Monday. DateTime objects have their time set to 0:00.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 272
def monday
  beginning_of_week(:monday)
end
months_ago(months)

Returns a new date/time the specified number of months ago.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 83
def months_ago(months)
  advance(months: -months)
end
months_since(months)

Returns a new date/time the specified number of months in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 88
def months_since(months)
  advance(months: months)
end
next_day(days = 1)

Returns a new date/time the specified number of days in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 33
def next_day(days = 1)
  advance(days: days)
end
next_month(months = 1)

Returns a new date/time the specified number of months in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 191
def next_month(months = 1)
  advance(months: months)
end
next_occurring(day_of_week)

Returns specific next occurring day of week

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 333
def next_occurring(day_of_week)
  current_day_number = wday != 0 ? wday - 1 : 6
  from_now = DAYS_INTO_WEEK.fetch(day_of_week) - current_day_number
  from_now += 7 unless from_now > 0
  since(from_now.days)
end
next_quarter()

Short-hand for #months_since(3)

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 196
def next_quarter
  months_since(3)
end
next_week(given_day_in_next_week = Date.beginning_of_week, same_time: false)

Returns a new date/time representing the given day in the next week.

today = Date.today # => Thu, 07 May 2015
today.next_week    # => Mon, 11 May 2015

The given_day_in_next_week defaults to the beginning of the week which is determined by Date.beginning_of_week or config.beginning_of_week when set.

today = Date.today       # => Thu, 07 May 2015
today.next_week(:friday) # => Fri, 15 May 2015

DateTime objects have their time set to 0:00 unless same_time is true.

now = DateTime.current # => Thu, 07 May 2015 13:31:16 +0000
now.next_week      # => Mon, 11 May 2015 00:00:00 +0000
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 176
def next_week(given_day_in_next_week = Date.beginning_of_week, same_time: false)
  result = first_hour(weeks_since(1).beginning_of_week.days_since(days_span(given_day_in_next_week)))
  same_time ? copy_time_to(result) : result
end
next_weekday()

Returns a new date/time representing the next weekday.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 182
def next_weekday
  if next_day.on_weekend?
    next_week(:monday, same_time: true)
  else
    next_day
  end
end
next_year(years = 1)

Returns a new date/time the specified number of years in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 201
def next_year(years = 1)
  advance(years: years)
end
on_weekday?()

Returns true if the date/time does not fall on a Saturday or Sunday.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 58
def on_weekday?
  !WEEKEND_DAYS.include?(wday)
end
on_weekend?()

Returns true if the date/time falls on a Saturday or Sunday.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 53
def on_weekend?
  WEEKEND_DAYS.include?(wday)
end
past?()

Returns true if the date/time is in the past.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 43
def past?
  self < self.class.current
end
prev_day(days = 1)

Returns a new date/time the specified number of days ago.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 23
def prev_day(days = 1)
  advance(days: -days)
end
prev_month(months = 1)

Returns a new date/time the specified number of months ago.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 226
def prev_month(months = 1)
  advance(months: -months)
end
prev_occurring(day_of_week)

Returns specific previous occurring day of week

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 341
def prev_occurring(day_of_week)
  current_day_number = wday != 0 ? wday - 1 : 6
  ago = current_day_number - DAYS_INTO_WEEK.fetch(day_of_week)
  ago += 7 unless ago > 0
  ago(ago.days)
end
prev_quarter()

Short-hand for #months_ago(3).

Also aliased as: last_quarter
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 236
def prev_quarter
  months_ago(3)
end
prev_week(start_day = Date.beginning_of_week, same_time: false)

Returns a new date/time representing the given day in the previous week. Week is assumed to start on start_day, default is Date.beginning_of_week or config.beginning_of_week when set. DateTime objects have their time set to 0:00 unless same_time is true.

Also aliased as: last_week
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 209
def prev_week(start_day = Date.beginning_of_week, same_time: false)
  result = first_hour(weeks_ago(1).beginning_of_week.days_since(days_span(start_day)))
  same_time ? copy_time_to(result) : result
end
prev_weekday()

Returns a new date/time representing the previous weekday.

Also aliased as: last_weekday
# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 216
def prev_weekday
  if prev_day.on_weekend?
    copy_time_to(beginning_of_week(:friday))
  else
    prev_day
  end
end
prev_year(years = 1)

Returns a new date/time the specified number of years ago.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 242
def prev_year(years = 1)
  advance(years: -years)
end
sunday()

Returns Sunday of this week assuming that week starts on Monday. DateTime objects have their time set to 23:59:59.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 287
def sunday
  end_of_week(:monday)
end
today?()

Returns true if the date/time is today.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 38
def today?
  to_date == ::Date.current
end
tomorrow()

Returns a new date/time representing tomorrow.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 28
def tomorrow
  advance(days: 1)
end
weeks_ago(weeks)

Returns a new date/time the specified number of weeks ago.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 73
def weeks_ago(weeks)
  advance(weeks: -weeks)
end
weeks_since(weeks)

Returns a new date/time the specified number of weeks in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 78
def weeks_since(weeks)
  advance(weeks: weeks)
end
years_ago(years)

Returns a new date/time the specified number of years ago.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 93
def years_ago(years)
  advance(years: -years)
end
years_since(years)

Returns a new date/time the specified number of years in the future.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 98
def years_since(years)
  advance(years: years)
end
yesterday()

Returns a new date/time representing yesterday.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 18
def yesterday
  advance(days: -1)
end