Class: Date

current()

Returns Time.zone.today when Time.zone or config.time_zone are set, otherwise just returns Date.today.

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 38
def current
  ::Time.zone ? ::Time.zone.today : ::Date.today
end

tomorrow()

Returns a new Date representing the date 1 day after today (i.e. tomorrow’s date).

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 33
def tomorrow
  ::Date.current.tomorrow
end

yesterday()

Returns a new Date representing the date 1 day ago (i.e. yesterday’s date).

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 28
def yesterday
  ::Date.current.yesterday
end

>>(n)

Backported from 1.9. The one in 1.8 leads to incorrect next_month and friends for dates where the calendar reform is involved. It additionally prevents an infinite loop fixed in r27013.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 14
def >>(n)
  y, m = (year * 12 + (mon - 1) + n).divmod(12)
  m,   = (m + 1)                    .divmod(1)
  d = mday
  until jd2 = self.class.valid_civil?(y, m, d, start)
    d -= 1
    raise ArgumentError, 'invalid date' unless d > 0
  end
  self + (jd2 - jd)
end

acts_like_date?()

Duck-types as a Date-like class. See Object#acts_like?.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/acts_like.rb, line 5
def acts_like_date?
  true
end

advance(options)

Provides precise Date calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 106
def advance(options)
  options = options.dup
  d = self
  d = d >> options.delete(:years) * 12 if options[:years]
  d = d >> options.delete(:months)     if options[:months]
  d = d +  options.delete(:weeks) * 7  if options[:weeks]
  d = d +  options.delete(:days)       if options[:days]
  d
end

ago(seconds)

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then subtracts the specified number of seconds.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 60
def ago(seconds)
  to_time_in_current_zone.since(-seconds)
end

beginning_of_day()

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)

This method is also aliased as midnight at_midnight at_beginning_of_day

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 72
def beginning_of_day
  to_time_in_current_zone
end

beginning_of_month()

Returns a new ; DateTime objects will have time set to 0:00DateTime representing the start of the month (1st of the month; DateTime objects will have time set to 0:00)

This method is also aliased as at_beginning_of_month

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 196
def beginning_of_month
  self.acts_like?(:time) ? change(:day => 1,:hour => 0, :min => 0, :sec => 0) : change(:day => 1)
end

beginning_of_quarter()

Returns a new Date/DateTime representing the start of the quarter (1st of january, april, july, october; DateTime objects will have time set to 0:00)

This method is also aliased as at_beginning_of_quarter

[ show source ]

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

beginning_of_week()

Returns a new Date/DateTime representing the “start” of this week (i.e, Monday; DateTime objects will have time set to 0:00).

This method is also aliased as monday at_beginning_of_week

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 171
def beginning_of_week
  days_to_monday = self.wday!=0 ? self.wday-1 : 6
  result = self - days_to_monday
  self.acts_like?(:time) ? result.midnight : result
end

beginning_of_year()

Returns a new Date/DateTime representing the start of the year (1st of january; DateTime objects will have time set to 0:00)

This method is also aliased as at_beginning_of_year

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 221
def beginning_of_year
  self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0) : change(:month => 1, :day => 1)
end

change(options)

Returns a new Date where one or more of the elements have been changed according to the options parameter.

Examples:

Date.new(2007, 5, 12).change(:day => 1)                  # => Date.new(2007, 5, 1)
Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 122
def change(options)
  ::Date.new(
    options[:year]  || self.year,
    options[:month] || self.month,
    options[:day]   || self.day
  )
end

end_of_day()

Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 80
def end_of_day
  to_time_in_current_zone.end_of_day
end

end_of_month()

Returns a new Date/DateTime representing the end of the month (last day of the month; DateTime objects will have time set to 0:00)

This method is also aliased as at_end_of_month

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 202
def end_of_month
  last_day = ::Time.days_in_month( self.month, self.year )
  self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day)
end

end_of_quarter()

Returns a new Date/DateTime representing the end of the quarter (last day of march, june, september, december; DateTime objects will have time set to 23:59:59)

This method is also aliased as at_end_of_quarter

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 215
def end_of_quarter
  beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
end

end_of_week()

Returns a new Date/DateTime representing the end of this week (Sunday, DateTime objects will have time set to 23:59:59).

This method is also aliased as sunday at_end_of_week

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 180
def end_of_week
  days_to_sunday = self.wday!=0 ? 7-self.wday : 0
  result = self + days_to_sunday.days
  self.acts_like?(:time) ? result.end_of_day : result
end

end_of_year()

Returns a new Time representing the end of the year (31st of december; DateTime objects will have time set to 23:59:59)

This method is also aliased as at_end_of_year

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 227
def end_of_year
  self.acts_like?(:time) ? change(:month => 12,:day => 31,:hour => 23, :min => 59, :sec => 59) : change(:month => 12, :day => 31)
end

future?()

Returns true if the Date object’s date lies in the future.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 54
def future?
  self > ::Date.current
end

months_ago(months)

Returns a new Date/DateTime representing the time a number of specified months ago.

[ show source ]

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

months_since(months)

Returns a new Date/DateTime representing the time a number of specified months in the future.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 136
def months_since(months)
  advance(:months => months)
end

next_month()

Shorthand for months_since(1)

[ show source ]

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

next_week(day = :monday)

Returns a new Date/DateTime representing the start of the given day in next week (default is Monday).

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 189
def next_week(day = :monday)
  days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6}
  result = (self + 7).beginning_of_week + days_into_week[day]
  self.acts_like?(:time) ? result.change(:hour => 0) : result
end

next_year()

Shorthand for years_since(1)

[ show source ]

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

past?()

Returns true if the Date object’s date lies in the past. Otherwise returns false.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 44
def past?
  self < ::Date.current
end

prev_month()

Shorthand for months_ago(1)

[ show source ]

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

prev_year()

Shorthand for years_ago(1)

[ show source ]

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

readable_inspect()

Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005”

This method is also aliased as inspect

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/conversions.rb, line 59
def readable_inspect
  strftime("%a, %d %b %Y")
end

since(seconds)

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then adds the specified number of seconds

This method is also aliased as in

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 66
def since(seconds)
  to_time_in_current_zone.since(seconds)
end

to_date()

A method to keep Time, Date and DateTime instances interchangeable on conversions. In this case, it simply returns self.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/conversions.rb, line 67
def to_date
  self
end

to_datetime()

Converts a Date instance to a DateTime, where the time is set to the beginning of the day and UTC offset is set to 0.

Examples

date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007

date.to_datetime               # => Sat, 10 Nov 2007 00:00:00 0000

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/conversions.rb, line 92
def to_datetime
  ::DateTime.civil(year, month, day, 0, 0, 0, 0)
end

to_formatted_s(format = :default)

Convert to a formatted string. See DATE_FORMATS for predefined formats.

This method is aliased to to_s.

Examples

date = Date.new(2007, 11, 10)       # => Sat, 10 Nov 2007

date.to_formatted_s(:db)            # => "2007-11-10"
date.to_s(:db)                      # => "2007-11-10"

date.to_formatted_s(:short)         # => "10 Nov"
date.to_formatted_s(:long)          # => "November 10, 2007"
date.to_formatted_s(:long_ordinal)  # => "November 10th, 2007"
date.to_formatted_s(:rfc822)        # => "10 Nov 2007"

Adding your own time formats to to_formatted_s

You can add your own formats to the Date::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a date argument as the value.

# config/initializers/time_formats.rb
Date::DATE_FORMATS[:month_and_year] = "%B %Y"
Date::DATE_FORMATS[:short_ordinal] = lambda { |date| date.strftime("%B #{date.day.ordinalize}") }

This method is also aliased as to_s

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/conversions.rb, line 44
def to_formatted_s(format = :default)
  if formatter = DATE_FORMATS[format]
    if formatter.respond_to?(:call)
      formatter.call(self).to_s
    else
      strftime(formatter)
    end
  else
    to_default_s
  end
end

to_time(form = :local)

Converts a Date instance to a Time, where the time is set to the beginning of the day. The timezone can be either :local or :utc (default :local).

Examples

date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007

date.to_time                   # => Sat Nov 10 00:00:00 0800 2007
date.to_time(:local)           # => Sat Nov 10 00:00:00 0800 2007

date.to_time(:utc)             # => Sat Nov 10 00:00:00 UTC 2007

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/conversions.rb, line 81
def to_time(form = :local)
  ::Time.send("#{form}_time", year, month, day)
end

to_time_in_current_zone()

Converts Date to a TimeWithZone in the current zone if Time.zone or Time.zone_default is set, otherwise converts Date to a Time via Date#to_time

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/zones.rb, line 7
def to_time_in_current_zone
  if ::Time.zone
    ::Time.zone.local(year, month, day)
  else
    to_time
  end
end

today?()

Returns true if the Date object’s date is today.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 49
def today?
  self.to_date == ::Date.current # we need the to_date because of DateTime
end

tomorrow()

Convenience method which returns a new Date/DateTime representing the time 1 day since the instance time

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 238
def tomorrow
  self + 1
end

xmlschema()

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/conversions.rb, line 96
def xmlschema
  to_time_in_current_zone.xmlschema
end

years_ago(years)

Returns a new Date/DateTime representing the time a number of specified years ago.

[ show source ]

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

years_since(years)

Returns a new Date/DateTime representing the time a number of specified years in the future.

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 146
def years_since(years)
  advance(:years => years)
end

yesterday()

Convenience method which returns a new Date/DateTime representing the time 1 day ago

[ show source ]

  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 233
def yesterday
  self - 1
end