Module: DateAndTime::Calculations

Included in:
Date, Time
Defined in:
activesupport/lib/active_support/core_ext/date_and_time/calculations.rb

Constant Summary collapse

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

Instance Method Summary collapse

Instance Method Details

#all_monthObject

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


304
305
306
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 304

def all_month
  beginning_of_month..end_of_month
end

#all_quarterObject

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


309
310
311
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 309

def all_quarter
  beginning_of_quarter..end_of_quarter
end

#all_week(start_day = Date.beginning_of_week) ⇒ Object

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.


299
300
301
# 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

#all_yearObject

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


314
315
316
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 314

def all_year
  beginning_of_year..end_of_year
end

#beginning_of_monthObject 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

110
111
112
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 110

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

#beginning_of_quarterObject 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

124
125
126
127
# 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

#beginning_of_week(start_day = Date.beginning_of_week) ⇒ Object 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.


255
256
257
258
# 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

#beginning_of_yearObject 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

154
155
156
# 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

#days_ago(days) ⇒ Object

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


62
63
64
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 62

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

#days_since(days) ⇒ Object

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


67
68
69
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 67

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

#days_to_week_start(start_day = Date.beginning_of_week) ⇒ Object

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.


245
246
247
248
249
# 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

#end_of_monthObject 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.


284
285
286
287
# 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

#end_of_quarterObject 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

139
140
141
142
# 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

#end_of_week(start_day = Date.beginning_of_week) ⇒ Object 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.


271
272
273
# 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

#end_of_yearObject 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.


292
293
294
# 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

#future?Boolean

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

Returns:

  • (Boolean)

47
48
49
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 47

def future?
  self > self.class.current
end

#mondayObject

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


263
264
265
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 263

def monday
  beginning_of_week(:monday)
end

#months_ago(months) ⇒ Object

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


82
83
84
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 82

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

#months_since(months) ⇒ Object

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


87
88
89
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 87

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

#next_dayObject

Returns a new date/time representing the next day.


32
33
34
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 32

def next_day
  advance(days: 1)
end

#next_monthObject

Short-hand for months_since(1).


190
191
192
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 190

def next_month
  months_since(1)
end

#next_quarterObject

Short-hand for months_since(3)


195
196
197
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 195

def next_quarter
  months_since(3)
end

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

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

175
176
177
178
# 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

#next_weekdayObject

Returns a new date/time representing the next weekday.


181
182
183
184
185
186
187
# 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

#next_yearObject

Short-hand for years_since(1).


200
201
202
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 200

def next_year
  years_since(1)
end

#on_weekday?Boolean

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

Returns:

  • (Boolean)

57
58
59
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 57

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

#on_weekend?Boolean

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

Returns:

  • (Boolean)

52
53
54
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 52

def on_weekend?
  WEEKEND_DAYS.include?(wday)
end

#past?Boolean

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

Returns:

  • (Boolean)

42
43
44
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 42

def past?
  self < self.class.current
end

#prev_dayObject

Returns a new date/time representing the previous day.


22
23
24
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 22

def prev_day
  advance(days: -1)
end

#prev_monthObject Also known as: last_month

Short-hand for months_ago(1).


225
226
227
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 225

def prev_month
  months_ago(1)
end

#prev_quarterObject Also known as: last_quarter

Short-hand for months_ago(3).


231
232
233
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 231

def prev_quarter
  months_ago(3)
end

#prev_week(start_day = Date.beginning_of_week, same_time: false) ⇒ Object 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.


208
209
210
211
# 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

#prev_weekdayObject Also known as: last_weekday

Returns a new date/time representing the previous weekday.


215
216
217
218
219
220
221
# 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

#prev_yearObject Also known as: last_year

Short-hand for years_ago(1).


237
238
239
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 237

def prev_year
  years_ago(1)
end

#sundayObject

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


278
279
280
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 278

def sunday
  end_of_week(:monday)
end

#today?Boolean

Returns true if the date/time is today.

Returns:

  • (Boolean)

37
38
39
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 37

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

#tomorrowObject

Returns a new date/time representing tomorrow.


27
28
29
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 27

def tomorrow
  advance(days: 1)
end

#weeks_ago(weeks) ⇒ Object

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


72
73
74
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 72

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

#weeks_since(weeks) ⇒ Object

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


77
78
79
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 77

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

#years_ago(years) ⇒ Object

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


92
93
94
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 92

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

#years_since(years) ⇒ Object

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


97
98
99
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 97

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

#yesterdayObject

Returns a new date/time representing yesterday.


17
18
19
# File 'activesupport/lib/active_support/core_ext/date_and_time/calculations.rb', line 17

def yesterday
  advance(days: -1)
end