Module: DateAndTime::Calculations
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Defined in: | activesupport/lib/active_support/core_ext/date_and_time/calculations.rb |
Constant Summary
-
DAYS_INTO_WEEK =
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 8{ sunday: 0, monday: 1, tuesday: 2, wednesday: 3, thursday: 4, friday: 5, saturday: 6 }
-
WEEKEND_DAYS =
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 17[ 6, 0 ]
Instance Attribute Summary
-
#future? ⇒ Boolean
readonly
Returns true if the date/time is in the future.
-
#next_day?
readonly
Alias for #tomorrow?.
-
#on_weekday? ⇒ Boolean
readonly
Returns true if the date/time does not fall on a Saturday or Sunday.
-
#on_weekend? ⇒ Boolean
readonly
Returns true if the date/time falls on a Saturday or Sunday.
-
#past? ⇒ Boolean
readonly
Returns true if the date/time is in the past.
-
#prev_day?
readonly
Alias for #yesterday?.
-
#today? ⇒ Boolean
readonly
Returns true if the date/time is today.
-
#tomorrow
readonly
Returns a new date/time representing tomorrow.
-
#tomorrow? ⇒ Boolean
(also: #next_day?)
readonly
Returns true if the date/time is tomorrow.
-
#yesterday
readonly
Returns a new date/time representing yesterday.
-
#yesterday? ⇒ Boolean
(also: #prev_day?)
readonly
Returns true if the date/time is yesterday.
Instance Method Summary
-
#after?(date_or_time) ⇒ Boolean
Returns true if the date/time falls after
date_or_time
. -
#all_day
Returns a
::Range
representing the whole day of the current date/time. -
#all_month
Returns a
::Range
representing the whole month of the current date/time. -
#all_quarter
Returns a
::Range
representing the whole quarter of the current date/time. -
#all_week(start_day = Date.beginning_of_week)
Returns a
::Range
representing the whole week of the current date/time. -
#all_year
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.
-
#before?(date_or_time) ⇒ Boolean
Returns true if the date/time falls before
date_or_time
. -
#beginning_of_month
(also: #at_beginning_of_month)
Returns a new date/time at the start of the month.
-
#beginning_of_quarter
(also: #at_beginning_of_quarter)
Returns a new date/time at the start of the quarter.
-
#beginning_of_week(start_day = Date.beginning_of_week)
(also: #at_beginning_of_week)
Returns a new date/time representing the start of this week on the given day.
-
#beginning_of_year
(also: #at_beginning_of_year)
Returns a new date/time at the beginning of the year.
-
#days_ago(days)
Returns a new date/time the specified number of days ago.
-
#days_since(days)
Returns a new date/time the specified number of days in the future.
-
#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.
-
#end_of_month
(also: #at_end_of_month)
Returns a new date/time representing the end of the month.
-
#end_of_quarter
(also: #at_end_of_quarter)
Returns a new date/time at the end of the quarter.
-
#end_of_week(start_day = Date.beginning_of_week)
(also: #at_end_of_week)
Returns a new date/time representing the end of this week on the given day.
-
#end_of_year
(also: #at_end_of_year)
Returns a new date/time representing the end of the year.
-
#last_month
Short-hand for
months_ago(1)
. -
#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)
. -
#monday
Returns Monday of this week assuming that week starts on Monday.
-
#months_ago(months)
Returns a new date/time the specified number of months ago.
-
#months_since(months)
Returns a new date/time the specified number of months in the future.
-
#next_occurring(day_of_week)
Returns a new date/time representing the next occurrence of the specified day of week.
-
#next_quarter
Short-hand for
months_since(3)
. -
#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.
-
#next_weekday
Returns a new date/time representing the next weekday.
-
#prev_occurring(day_of_week)
Returns a new date/time representing the previous occurrence of the specified day of week.
-
#prev_quarter
(also: #last_quarter)
Short-hand for
months_ago(3)
. -
#prev_week(start_day = Date.beginning_of_week, same_time: false)
(also: #last_week)
Returns a new date/time representing the given day in the previous week.
-
#prev_weekday
(also: #last_weekday)
Returns a new date/time representing the previous weekday.
-
#quarter
Returns the quarter for a date/time.
-
#sunday
Returns Sunday of this week assuming that week starts on Monday.
-
#weeks_ago(weeks)
Returns a new date/time the specified number of weeks ago.
-
#weeks_since(weeks)
Returns a new date/time the specified number of weeks in the future.
-
#years_ago(years)
Returns a new date/time the specified number of years ago.
-
#years_since(years)
Returns a new date/time the specified number of years in the future.
Instance Attribute Details
#future? ⇒ Boolean
(readonly)
Returns true if the date/time is in the future.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 52
def future? self > self.class.current end
#next_day? (readonly)
Alias for #tomorrow?.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 38
alias :next_day? :tomorrow?
#on_weekday? ⇒ Boolean
(readonly)
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 62
def on_weekday? !WEEKEND_DAYS.include?(wday) end
#on_weekend? ⇒ Boolean
(readonly)
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 57
def on_weekend? WEEKEND_DAYS.include?(wday) end
#past? ⇒ Boolean
(readonly)
Returns true if the date/time is in the past.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 47
def past? self < self.class.current end
#prev_day? (readonly)
Alias for #yesterday?.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 44
alias :prev_day? :yesterday?
#today? ⇒ Boolean
(readonly)
Returns true if the date/time is today.
#tomorrow (readonly)
Returns a new date/time representing tomorrow.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 25
def tomorrow advance(days: 1) end
#tomorrow? ⇒ Boolean
(readonly)
Also known as: #next_day?
Returns true if the date/time is tomorrow.
#yesterday (readonly)
Returns a new date/time representing yesterday.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 20
def yesterday advance(days: -1) end
#yesterday? ⇒ Boolean
(readonly)
Also known as: #prev_day?
Returns true if the date/time is yesterday.
Instance Method Details
#after?(date_or_time) ⇒ Boolean
Returns true if the date/time falls after date_or_time
.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 72
def after?(date_or_time) self > date_or_time end
#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 310
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 321
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 326
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 316
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 331
def all_year beginning_of_year..end_of_year end
#at_beginning_of_month
Alias for #beginning_of_month.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 128
alias :at_beginning_of_month :beginning_of_month
#at_beginning_of_quarter
Alias for #beginning_of_quarter.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 143
alias :at_beginning_of_quarter :beginning_of_quarter
#at_beginning_of_week(start_day = Date.beginning_of_week)
Alias for #beginning_of_week.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 271
alias :at_beginning_of_week :beginning_of_week
#at_beginning_of_year
Alias for #beginning_of_year.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 182
alias :at_beginning_of_year :beginning_of_year
#at_end_of_month
Alias for #end_of_month.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 300
alias :at_end_of_month :end_of_month
#at_end_of_quarter
Alias for #end_of_quarter.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 158
alias :at_end_of_quarter :end_of_quarter
#at_end_of_week(start_day = Date.beginning_of_week)
Alias for #end_of_week.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 286
alias :at_end_of_week :end_of_week
#at_end_of_year
Alias for #end_of_year.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 307
alias :at_end_of_year :end_of_year
#before?(date_or_time) ⇒ Boolean
Returns true if the date/time falls before date_or_time
.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 67
def before?(date_or_time) self < date_or_time end
#beginning_of_month Also known as: #at_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
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 125
def beginning_of_month first_hour(change(day: 1)) end
#beginning_of_quarter Also known as: #at_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
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 139
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) Also known as: #at_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.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 267
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 Also known as: #at_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
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 179
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 77
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 82
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 258
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 Also known as: #at_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.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 296
def end_of_month last_day = ::Time.days_in_month(month, year) last_hour(days_since(last_day - day)) end
#end_of_quarter Also known as: #at_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
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 154
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) Also known as: #at_end_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.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 283
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 Also known as: #at_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.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 304
def end_of_year change(month: 12).end_of_month end
#last_month
Short-hand for months_ago(1)
.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 240
def last_month months_ago(1) end
#last_quarter
Alias for #prev_quarter.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 248
alias_method :last_quarter, :prev_quarter
#last_week(start_day = Date.beginning_of_week, same_time: false)
Alias for #prev_week.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 227
alias_method :last_week, :prev_week
#last_weekday
Alias for #prev_weekday.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 237
alias_method :last_weekday, :prev_weekday
#last_year
Short-hand for years_ago(1)
.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 251
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 275
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 97
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 102
def months_since(months) advance(months: months) end
#next_occurring(day_of_week)
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 340
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
Short-hand for months_since(3)
.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 215
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 200
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 206
def next_weekday if next_day.on_weekend? next_week(:monday, same_time: true) else next_day end end
#prev_occurring(day_of_week)
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 351
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 Also known as: #last_quarter
Short-hand for months_ago(3)
.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 245
def prev_quarter months_ago(3) end
#prev_week(start_day = Date.beginning_of_week, same_time: false) Also known as: #last_week
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.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 223
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 Also known as: #last_weekday
Returns a new date/time representing the previous weekday.
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 230
def prev_weekday if prev_day.on_weekend? copy_time_to(beginning_of_week(:friday)) else prev_day end end
#quarter
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 166
def quarter (month / 3.0).ceil 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 290
def sunday end_of_week(:monday) 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 87
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 92
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 107
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 112
def years_since(years) advance(years: years) end