module DateAndTime::Calculations

Constants

DAYS_INTO_WEEK
WEEKEND_DAYS

Public Instance Methods

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 304
def all_month
  beginning_of_month..end_of_month
end

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

all_quarter() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 309
def all_quarter
  beginning_of_quarter..end_of_quarter
end

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

all_week(start_day = Date.beginning_of_week) Show source

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

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

all_year() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 314
def all_year
  beginning_of_year..end_of_year
end

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

at_beginning_of_month()

Alias for: beginning_of_month

at_beginning_of_quarter()

Alias for: 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() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 110
def beginning_of_month
  first_hour(change(:day => 1))
end

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

beginning_of_quarter() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 124
def beginning_of_quarter
  first_quarter_month = [10, 7, 4, 1].detect { |m| m <= month }
  beginning_of_month.change(:month => first_quarter_month)
end

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

beginning_of_week(start_day = Date.beginning_of_week) Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 255
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

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

beginning_of_year() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 154
def beginning_of_year
  change(:month => 1).beginning_of_month
end

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

days_ago(days) Show source

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

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

days_since(days) Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 67
def days_since(days)
  advance(:days => days)
end

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

days_to_week_start(start_day = Date.beginning_of_week) Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 245
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

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.

end_of_month() Show source

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

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

end_of_quarter() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 139
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

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

end_of_week(start_day = Date.beginning_of_week) Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 271
def end_of_week(start_day = Date.beginning_of_week)
  last_hour(days_since(6 - days_to_week_start(start_day)))
end

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

end_of_year() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 292
def end_of_year
  change(:month => 12).end_of_month
end

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

future?() Show source

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

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

last_month()

Alias for: prev_month

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()

Alias for: prev_year

monday() Show source

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

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

months_ago(months) Show source

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

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

months_since(months) Show source

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

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

next_day() Show source

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

Returns a new date/time representing the next day.

next_month() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 190
def next_month
  months_since(1)
end

Short-hand for #months_since(1).

next_quarter() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 195
def next_quarter
  months_since(3)
end

Short-hand for #months_since(3)

next_week(given_day_in_next_week = Date.beginning_of_week, same_time: false) Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 175
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

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

next_weekday() Show source

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

Returns a new date/time representing the next weekday.

next_year() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 200
def next_year
  years_since(1)
end

Short-hand for #years_since(1).

on_weekday?() Show source

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

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

on_weekend?() Show source

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

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

past?() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 42
def past?
  self < self.class.current
end

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

prev_day() Show source

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

Returns a new date/time representing the previous day.

prev_month() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 225
def prev_month
  months_ago(1)
end

Short-hand for #months_ago(1).

Also aliased as: last_month

prev_quarter() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 231
def prev_quarter
  months_ago(3)
end

Short-hand for #months_ago(3).

Also aliased as: last_quarter

prev_week(start_day = Date.beginning_of_week, same_time: false) Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 208
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

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

prev_weekday() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 215
def prev_weekday
  if prev_day.on_weekend?
    copy_time_to(beginning_of_week(:friday))
  else
    prev_day
  end
end

Returns a new date/time representing the previous weekday.

Also aliased as: last_weekday

prev_year() Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 237
def prev_year
  years_ago(1)
end

Short-hand for #years_ago(1).

Also aliased as: last_year

sunday() Show source

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

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

today?() Show source

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

Returns true if the date/time is today.

tomorrow() Show source

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

Returns a new date/time representing tomorrow.

weeks_ago(weeks) Show source

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

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

weeks_since(weeks) Show source

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 77
def weeks_since(weeks)
  advance(:weeks => weeks)
end

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

years_ago(years) Show source

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

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

years_since(years) Show source

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

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

yesterday() Show source

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

Returns a new date/time representing yesterday.