Module: DateAndTime::Calculations

Included in:
Date, Time
Defined in:
lib/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_month ⇒ Object

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



297
298
299
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 297

def all_month
  beginning_of_month..end_of_month
end

#all_quarter ⇒ Object

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



302
303
304
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 302

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.



292
293
294
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 292

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

#all_year ⇒ Object

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



307
308
309
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 307

def all_year
  beginning_of_year..end_of_year
end

#beginning_of_month ⇒ Object 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



103
104
105
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 103

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

#beginning_of_quarter ⇒ Object 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



117
118
119
120
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 117

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.



248
249
250
251
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 248

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 ⇒ Object 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



147
148
149
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 147

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.



55
56
57
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 55

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.



60
61
62
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 60

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.



238
239
240
241
242
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 238

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_month ⇒ Object 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.



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

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

#end_of_quarter ⇒ Object 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



132
133
134
135
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 132

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.



264
265
266
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 264

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 ⇒ Object 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.



285
286
287
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 285

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) 


45
46
47
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 45

def future?
  self > self.class.current
end

#monday ⇒ Object

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



256
257
258
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 256

def monday
  beginning_of_week(:monday)
end

#months_ago(months) ⇒ Object

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



75
76
77
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 75

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.



80
81
82
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 80

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

#next_day ⇒ Object

Returns a new date/time representing the next day.



30
31
32
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 30

def next_day
  advance(days: 1)
end

#next_month ⇒ Object

Short-hand for months_since(1).



183
184
185
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 183

def next_month
  months_since(1)
end

#next_quarter ⇒ Object

Short-hand for months_since(3)



188
189
190
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 188

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



168
169
170
171
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 168

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 ⇒ Object

Returns a new date/time representing the next weekday.



174
175
176
177
178
179
180
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 174

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

#next_year ⇒ Object

Short-hand for years_since(1).



193
194
195
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 193

def next_year
  years_since(1)
end

#on_weekend? ⇒ Boolean

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

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 50

def on_weekend?
  WEEKEND_DAYS.include?(wday)
end

#past? ⇒ Boolean

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

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 40

def past?
  self < self.class.current
end

#prev_day ⇒ Object

Returns a new date/time representing the previous day.



20
21
22
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 20

def prev_day
  advance(days: -1)
end

#prev_month ⇒ Object Also known as: last_month

Short-hand for months_ago(1).



218
219
220
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 218

def prev_month
  months_ago(1)
end

#prev_quarter ⇒ Object Also known as: last_quarter

Short-hand for months_ago(3).



224
225
226
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 224

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.



201
202
203
204
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 201

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 ⇒ Object Also known as: last_weekday

Returns a new date/time representing the previous weekday.



208
209
210
211
212
213
214
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 208

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

#prev_year ⇒ Object Also known as: last_year

Short-hand for years_ago(1).



230
231
232
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 230

def prev_year
  years_ago(1)
end

#sunday ⇒ Object

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



271
272
273
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 271

def sunday
  end_of_week(:monday)
end

#today? ⇒ Boolean

Returns true if the date/time is today.

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 35

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

#tomorrow ⇒ Object

Returns a new date/time representing tomorrow.



25
26
27
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 25

def tomorrow
  advance(days: 1)
end

#weeks_ago(weeks) ⇒ Object

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



65
66
67
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 65

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.



70
71
72
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 70

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

#years_ago(years) ⇒ Object

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



85
86
87
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 85

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.



90
91
92
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 90

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

#yesterday ⇒ Object

Returns a new date/time representing yesterday.



15
16
17
 
# File 'lib/core_ext/date_and_time/calculations.rb', line 15

def yesterday
  advance(days: -1)
end