W3cubDocs

module DateAndTime::Calculations

Constants

DAYS_INTO_WEEK

Public Instance Methods

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 223
def all_month
  beginning_of_month..end_of_month
end

all_quarter() Show source

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 228
def all_quarter
  beginning_of_quarter..end_of_quarter
end

all_week(start_day = Date.beginning_of_week) Show source

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.

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

all_year() Show source

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 233
def all_year
  beginning_of_year..end_of_year
end

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

Returns a new date/time at the start of the month. DateTime objects will have a time set to 0:00.

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

Also aliased as: at_beginning_of_month

beginning_of_quarter() Show source

Returns a new date/time at the start of the quarter. Example: 1st January, 1st July, 1st October. DateTime objects will have a time set to 0:00.

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

Also aliased as: at_beginning_of_quarter

beginning_of_week(start_day = Date.beginning_of_week) Show source

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 174
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

Also aliased as: at_beginning_of_week

beginning_of_year() Show source

Return a new date/time at the beginning of the year. Example: 1st January. DateTime objects will have a time set to 0:00.

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

Also aliased as: at_beginning_of_year

days_ago(days) Show source

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

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

days_since(days) Show source

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 44
def days_since(days)
  advance(:days => days)
end

days_to_week_start(start_day = Date.beginning_of_week) Show source

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 164
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() Show source

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 203
def end_of_month
  last_day = ::Time.days_in_month(month, year)
  last_hour(days_since(last_day - day))
end

Also aliased as: at_end_of_month

end_of_quarter() Show source

Returns a new date/time at the end of the quarter. Example: 31st March, 30th June, 30th September. DateTime objects will have a time set to 23:59:59.

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

Also aliased as: at_end_of_quarter

end_of_week(start_day = Date.beginning_of_week) Show source

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 190
def end_of_week(start_day = Date.beginning_of_week)
  last_hour(days_since(6 - days_to_week_start(start_day)))
end

Also aliased as: at_end_of_week

end_of_year() Show source

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 211
def end_of_year
  change(:month => 12).end_of_month
end

Also aliased as: at_end_of_year

future?() Show source

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

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

last_month()

Alias for: prev_month

last_quarter()

Alias for: prev_quarter

last_week(start_day = Date.beginning_of_week)

Alias for: prev_week

last_year()

Alias for: prev_year

monday() Show source

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 182
def monday
  beginning_of_week(:monday)
end

months_ago(months) Show source

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

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 59
def months_ago(months)
  advance(:months => -months)
end

months_since(months) Show source

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 64
def months_since(months)
  advance(:months => months)
end

next_month() Show source

Short-hand for #months_since(1).

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 120
def next_month
  months_since(1)
end

next_quarter() Show source

Short-hand for #months_since(3)

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

next_week(given_day_in_next_week = Date.beginning_of_week) Show source

Returns a new date/time representing the given day in the next week. 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. DateTime objects have their time set to 0:00.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 115
def next_week(given_day_in_next_week = Date.beginning_of_week)
  first_hour(weeks_since(1).beginning_of_week.days_since(days_span(given_day_in_next_week)))
end

next_year() Show source

Short-hand for #years_since(1).

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 130
def next_year
  years_since(1)
end

past?() Show source

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

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

prev_month() Show source

Short-hand for #months_ago(1).

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

Also aliased as: last_month

prev_quarter() Show source

Short-hand for #months_ago(3).

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

Also aliased as: last_quarter

prev_week(start_day = Date.beginning_of_week) Show source

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.

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 138
def prev_week(start_day = Date.beginning_of_week)
  first_hour(weeks_ago(1).beginning_of_week.days_since(days_span(start_day)))
end

Also aliased as: last_week

prev_year() Show source

Short-hand for #years_ago(1).

# File activesupport/lib/active_support/core_ext/date_and_time/calculations.rb, line 156
def prev_year
  years_ago(1)
end

Also aliased as: last_year

sunday() Show source

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 197
def sunday
  end_of_week(:monday)
end

today?() Show source

Returns true if the date/time is today.

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

tomorrow() Show source

Returns a new date/time representing tomorrow.

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

weeks_ago(weeks) Show source

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

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

weeks_since(weeks) Show source

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 54
def weeks_since(weeks)
  advance(:weeks => weeks)
end

years_ago(years) Show source

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

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

years_since(years) Show source

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 74
def years_since(years)
  advance(:years => years)
end

yesterday() Show source

Returns a new date/time representing yesterday.

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