DateAndTime::Calculations (original) (raw)

Methods

A

• after?,
• all_day,
• all_month,
• all_quarter,
• all_week,
• all_year,
• 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

B

• before?,
• beginning_of_month,
• beginning_of_quarter,
• beginning_of_week,
• beginning_of_year

D

• days_ago,
• days_since,
• days_to_week_start

E

• end_of_month,
• end_of_quarter,
• end_of_week,
• end_of_year

F

• future?

L

• last_month,
• last_quarter,
• last_week,
• last_weekday,
• last_year

M

• monday,
• months_ago,
• months_since

N

• next_day?,
• next_occurring,
• next_quarter,
• next_week,
• next_weekday

O

• on_weekday?,
• on_weekend?

P

• past?,
• prev_day?,
• prev_occurring,
• prev_quarter,
• prev_week,
• prev_weekday

Q

• quarter

S

• sunday

T

• today?,
• tomorrow,
• tomorrow?

W

• weeks_ago,
• weeks_since

Y

• years_ago,
• years_since,
• yesterday,
• yesterday?

Constants

Instance Public methods

after?(date_or_time)Link

Returns true if the date/time falls after date_or_time.

Source: show | on GitHub

def after?(date_or_time) self > date_or_time end

all_day()Link

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

Source: show | on GitHub

def all_day beginning_of_day..end_of_day end

all_month()Link

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

Source: show | on GitHub

def all_month beginning_of_month..end_of_month end

all_quarter()Link

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

Source: show | on GitHub

def all_quarter beginning_of_quarter..end_of_quarter end

all_week(start_day = Date.beginning_of_week)Link

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: show | on GitHub

def all_week(start_day = Date.beginning_of_week) beginning_of_week(start_day)..end_of_week(start_day) end

all_year()Link

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

Source: show | on GitHub

def all_year beginning_of_year..end_of_year end

at_beginning_of_month()Link

at_beginning_of_quarter()Link

at_beginning_of_week(start_day = Date.beginning_of_week)Link

at_beginning_of_year()Link

at_end_of_month()Link

at_end_of_quarter()Link

at_end_of_week(start_day = Date.beginning_of_week)Link

at_end_of_year()Link

before?(date_or_time)Link

Returns true if the date/time falls before date_or_time.

Source: show | on GitHub

def before?(date_or_time) self < date_or_time end

beginning_of_month()Link

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

Source: show | on GitHub

def beginning_of_month first_hour(change(day: 1)) end

beginning_of_quarter()Link

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

Source: show | on GitHub

def beginning_of_quarter first_quarter_month = month - (2 + month) % 3 beginning_of_month.change(month: first_quarter_month) end

beginning_of_week(start_day = Date.beginning_of_week)Link

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.

Source: show | on GitHub

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

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

Source: show | on GitHub

def beginning_of_year change(month: 1).beginning_of_month end

days_ago(days)Link

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

Source: show | on GitHub

def days_ago(days) advance(days: -days) end

days_since(days)Link

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

Source: show | on GitHub

def days_since(days) advance(days: days) end

days_to_week_start(start_day = Date.beginning_of_week)Link

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: show | on GitHub

def days_to_week_start(start_day = Date.beginning_of_week) start_day_number = DAYS_INTO_WEEK.fetch(start_day) (wday - start_day_number) % 7 end

end_of_month()Link

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

Source: show | on GitHub

def end_of_month last_day = ::Time.days_in_month(month, year) last_hour(days_since(last_day - day)) end

end_of_quarter()Link

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

Source: show | on GitHub

def end_of_quarter last_quarter_month = month + (12 - month) % 3 beginning_of_month.change(month: last_quarter_month).end_of_month end

end_of_week(start_day = Date.beginning_of_week)Link

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.

Source: show | on GitHub

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

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

Source: show | on GitHub

def end_of_year change(month: 12).end_of_month end

future?()Link

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

Source: show | on GitHub

def future? self > self.class.current end

last_month()Link

Short-hand for months_ago(1).

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

last_year()Link

Short-hand for years_ago(1).

monday()Link

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

Source: show | on GitHub

def monday beginning_of_week(:monday) end

months_ago(months)Link

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

Source: show | on GitHub

def months_ago(months) advance(months: -months) end

months_since(months)Link

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

Source: show | on GitHub

def months_since(months) advance(months: months) end

next_occurring(day_of_week)Link

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

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

Source: show | on GitHub

def next_occurring(day_of_week) from_now = DAYS_INTO_WEEK.fetch(day_of_week) - wday from_now += 7 unless from_now > 0 advance(days: from_now) end

next_quarter()Link

Short-hand for months_since(3).

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

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: show | on GitHub

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

Returns a new date/time representing the next weekday.

Source: show | on GitHub

def next_weekday if next_day.on_weekend? next_week(:monday, same_time: true) else next_day end end

on_weekday?()Link

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

Source: show | on GitHub

def on_weekday? !WEEKEND_DAYS.include?(wday) end

on_weekend?()Link

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

Source: show | on GitHub

def on_weekend? WEEKEND_DAYS.include?(wday) end

past?()Link

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

prev_occurring(day_of_week)Link

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: show | on GitHub

def prev_occurring(day_of_week) ago = wday - DAYS_INTO_WEEK.fetch(day_of_week) ago += 7 unless ago > 0 advance(days: -ago) end

prev_quarter()Link

Short-hand for months_ago(3).

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

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.

Source: show | on GitHub

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

Returns a new date/time representing the previous weekday.

Source: show | on GitHub

def prev_weekday if prev_day.on_weekend? copy_time_to(beginning_of_week(:friday)) else prev_day end end

quarter()Link

Returns the quarter for a date/time.

Date.new(2010, 1, 31).quarter  # => 1
Date.new(2010, 4, 12).quarter  # => 2
Date.new(2010, 9, 15).quarter  # => 3
Date.new(2010, 12, 25).quarter # => 4

sunday()Link

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

today?()Link

Returns true if the date/time is today.

Source: show | on GitHub

def today? to_date == ::Date.current end

tomorrow()Link

Returns a new date/time representing tomorrow.

tomorrow?()Link

Returns true if the date/time is tomorrow.

Source: show | on GitHub

def tomorrow? to_date == ::Date.current.tomorrow end

weeks_ago(weeks)Link

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

Source: show | on GitHub

def weeks_ago(weeks) advance(weeks: -weeks) end

weeks_since(weeks)Link

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

Source: show | on GitHub

def weeks_since(weeks) advance(weeks: weeks) end

years_ago(years)Link

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

Source: show | on GitHub

def years_ago(years) advance(years: -years) end

years_since(years)Link

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

Source: show | on GitHub

def years_since(years) advance(years: years) end

yesterday()Link

Returns a new date/time representing yesterday.

yesterday?()Link

Returns true if the date/time is yesterday.

Source: show | on GitHub

def yesterday? to_date == ::Date.current.yesterday end