DateAndTime::Calculations

all_day()

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

📝 Source code

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 308
    def all_day
      beginning_of_day..end_of_day
    end

🔎 See on GitHub

all_month()

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

📝 Source code

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

🔎 See on GitHub

all_quarter()

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

📝 Source code

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

🔎 See on GitHub

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.

📝 Source code

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

🔎 See on GitHub

all_year()

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

📝 Source code

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

🔎 See on GitHub

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

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

days_ago(days)

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

📝 Source code

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

🔎 See on GitHub

days_since(days)

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

📝 Source code

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

🔎 See on GitHub

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.

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

future?()

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

📝 Source code

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

🔎 See on GitHub

last_month()

Short-hand for months_ago(1).

📝 Source code

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

🔎 See on GitHub

last_quarter()

Alias for: prev_quarter

last_week(start_day = Date.beginning_of_week, same_time: false)

today = Date.today               # => Thu, 14 Dec 2017
today.next_occurring(:monday)    # => Mon, 18 Dec 2017
today.next_occurring(:thursday)  # => Thu, 21 Dec 2017

📝 Source code

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 338
    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
      advance(days: from_now)
    end

🔎 See on GitHub

next_quarter()

Short-hand for months_since(3)

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

next_weekday()

Returns a new date/time representing the next weekday.

📝 Source code

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

🔎 See on GitHub

next_year(years = 1)

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

📝 Source code

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

🔎 See on GitHub

on_weekday?()

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

📝 Source code

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

🔎 See on GitHub

on_weekend?()

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

📝 Source code

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

🔎 See on GitHub

past?()

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

📝 Source code

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

🔎 See on GitHub

prev_day(days = 1)

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

📝 Source code

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

🔎 See on GitHub

prev_month(months = 1)

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

📝 Source code

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

🔎 See on GitHub

prev_occurring(day_of_week)

Returns a new date/time representing the previous occurrence of the specified day of week.

today = Date.today               # => Thu, 14 Dec 2017
today.prev_occurring(:monday)    # => Mon, 11 Dec 2017
today.prev_occurring(:thursday)  # => Thu, 07 Dec 2017

📝 Source code

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 350
    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
      advance(days: -ago)
    end

🔎 See on GitHub

prev_quarter()

Short-hand for months_ago(3).

Also aliased as: last_quarter

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

prev_weekday()

Returns a new date/time representing the previous weekday.

Also aliased as: last_weekday

📝 Source code

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

🔎 See on GitHub

prev_year(years = 1)

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

📝 Source code

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

🔎 See on GitHub

sunday()

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

📝 Source code

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

🔎 See on GitHub

today?()

Returns true if the date/time is today.

📝 Source code

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

🔎 See on GitHub

tomorrow()

Returns a new date/time representing tomorrow.

📝 Source code

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

🔎 See on GitHub

weeks_ago(weeks)

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

📝 Source code

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

🔎 See on GitHub

weeks_since(weeks)

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

📝 Source code

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

🔎 See on GitHub

years_ago(years)

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

📝 Source code

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

🔎 See on GitHub

years_since(years)

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

📝 Source code

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

🔎 See on GitHub

yesterday()

Returns a new date/time representing yesterday.

📝 Source code

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

🔎 See on GitHub

DAYS_INTO_WEEK	=	{ monday: 0, tuesday: 1, wednesday: 2, thursday: 3, friday: 4, saturday: 5, sunday: 6 }
WEEKEND_DAYS	=	[ 6, 0 ]

DateAndTime::Calculations

Methods

Constants

Instance Public methods

all_day()

all_month()

all_quarter()

all_week(start_day = Date.beginning_of_week)

all_year()

at_beginning_of_month()

at_beginning_of_quarter()

at_beginning_of_week(start_day = Date.beginning_of_week)

at_beginning_of_year()

at_end_of_month()

at_end_of_quarter()

at_end_of_week(start_day = Date.beginning_of_week)

at_end_of_year()

beginning_of_month()

beginning_of_quarter()

beginning_of_week(start_day = Date.beginning_of_week)

beginning_of_year()

days_ago(days)

days_since(days)

days_to_week_start(start_day = Date.beginning_of_week)

end_of_month()

end_of_quarter()

end_of_week(start_day = Date.beginning_of_week)

end_of_year()

future?()

last_month()

last_quarter()

last_week(start_day = Date.beginning_of_week, same_time: false)

last_weekday()

last_year()

monday()

months_ago(months)

months_since(months)

next_day(days = 1)

next_month(months = 1)

next_occurring(day_of_week)

next_quarter()

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

next_weekday()

next_year(years = 1)

on_weekday?()

on_weekend?()

past?()

prev_day(days = 1)

prev_month(months = 1)

prev_occurring(day_of_week)

prev_quarter()

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

prev_weekday()

prev_year(years = 1)

sunday()

today?()

tomorrow()

weeks_ago(weeks)

weeks_since(weeks)

years_ago(years)

years_since(years)

yesterday()