Class: Date

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `::DateAndTime::Calculations`, `::DateAndTime::Zones`
Inherits:	Object
Defined in:	activesupport/lib/active_support/core_ext/date/blank.rb, activesupport/lib/active_support/core_ext/date/acts_like.rb, activesupport/lib/active_support/core_ext/date/calculations.rb, activesupport/lib/active_support/core_ext/date/conversions.rb, activesupport/lib/active_support/core_ext/date/zones.rb, activesupport/lib/active_support/core_ext/object/json.rb

Constant Summary

DATE_FORMATS =
# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 9

{
  short: "%d %b",
  long: "%B %d, %Y",
  db: "%Y-%m-%d",
  inspect: "%Y-%m-%d",
  number: "%Y%m%d",
  long_ordinal: lambda { |date|
    day_format = ActiveSupport::Inflector.ordinalize(date.day)
    date.strftime("%B #{day_format}, %Y") # => "April 25th, 2007"
  },
  rfc822: "%d %b %Y",
  iso8601: lambda { |date| date.iso8601 }
}

`::DateAndTime::Calculations` - Included

DAYS_INTO_WEEK, WEEKEND_DAYS

Class Attribute Summary

.beginning_of_week rw

Returns the week start (e.g. :monday) for the current request, if this has been set (via .beginning_of_week=).
.beginning_of_week=(week_start) rw

Sets .beginning_of_week to a week start (e.g. :monday) for current request/thread.
.beginning_of_week_default rw

Class Method Summary

.current

Returns Time.zone.today when Time.zone or config.time_zone are set, otherwise just returns Date.today.
.find_beginning_of_week!(week_start)

Returns week start day symbol (e.g.
.tomorrow

Returns a new Date representing the date 1 day after today (i.e.
.yesterday

Returns a new Date representing the date 1 day ago (i.e.

Instance Attribute Summary

#acts_like_date? ⇒ Boolean readonly

Duck-types as a Date-like class.

`::DateAndTime::Calculations` - Included

#future?	Returns true if the date/time is in the future.
#next_day?	Alias for DateAndTime::Calculations#tomorrow?.
#on_weekday?	Returns true if the date/time does not fall on a Saturday or Sunday.
#on_weekend?	Returns true if the date/time falls on a Saturday or Sunday.
#past?	Returns true if the date/time is in the past.
#prev_day?	Alias for DateAndTime::Calculations#yesterday?.
#today?	Returns true if the date/time is today.
#tomorrow	Returns a new date/time representing tomorrow.
#tomorrow?	Returns true if the date/time is tomorrow.
#yesterday	Returns a new date/time representing yesterday.
#yesterday?	Returns true if the date/time is yesterday.

Instance Method Summary

#+(other)

Alias for #plus_with_duration.
#-(other)

Alias for #minus_with_duration.
#<=>(other)

Alias for #compare_with_coercion.
#advance(options)

Provides precise Date calculations for years, months, and days.
#ago(seconds)

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

Alias for #beginning_of_day.
#at_end_of_day

Alias for #end_of_day.
#at_midday

Alias for #middle_of_day.
#at_middle_of_day

Alias for #middle_of_day.
#at_midnight

Alias for #beginning_of_day.
#at_noon

Alias for #middle_of_day.
#beginning_of_day (also: #midnight, #at_midnight, #at_beginning_of_day)

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

Returns a new Date where one or more of the elements have been changed according to the options parameter.
#compare_with_coercion(other) (also: #<=>)

Allow Date to be compared with ::Time by converting to ::Time and relying on the <=> from there.
#compare_without_coercion
#default_inspect
#end_of_day (also: #at_end_of_day)

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

Alias for #since.
#inspect

Alias for #readable_inspect.
#midday

Alias for #middle_of_day.
#middle_of_day (also: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day)

Converts Date to a ::Time (or ::Time if necessary) with the time portion set to the middle of the day (12:00).
#midnight

Alias for #beginning_of_day.
#minus_without_duration
#noon

Alias for #middle_of_day.
#plus_without_duration
#readable_inspect (also: #inspect)

Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005”.
#since(seconds) (also: #in)

Converts Date to a ::Time (or ::Time if necessary) with the time portion set to the beginning of the day (0:00) and then adds the specified number of seconds.
#to_formatted_s(format = :default)

Alias for #to_fs.
#to_fs(format = :default) (also: #to_formatted_s)

Convert to a formatted string.
#to_time(form = :local)

Converts a Date instance to a ::Time, where the time is set to the beginning of the day.
#xmlschema

Returns a string which represents the time in used time zone as ::Time defined by XML Schema:

`::DateAndTime::Calculations` - Included

#after?	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	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 DateAndTime::Calculations#beginning_of_month.
#at_beginning_of_quarter	Alias for DateAndTime::Calculations#beginning_of_quarter.
#at_beginning_of_week	Alias for DateAndTime::Calculations#beginning_of_week.
#at_beginning_of_year	Alias for DateAndTime::Calculations#beginning_of_year.
#at_end_of_month	Alias for DateAndTime::Calculations#end_of_month.
#at_end_of_quarter	Alias for DateAndTime::Calculations#end_of_quarter.
#at_end_of_week	Alias for DateAndTime::Calculations#end_of_week.
#at_end_of_year	Alias for DateAndTime::Calculations#end_of_year.
#before?	Returns true if the date/time falls before `date_or_time`.
#beginning_of_month	Returns a new date/time at the start of the month.
#beginning_of_quarter	Returns a new date/time at the start of the quarter.
#beginning_of_week	Returns a new date/time representing the start of this week on the given day.
#beginning_of_year	Returns a new date/time at the beginning of the year.
#days_ago	Returns a new date/time the specified number of days ago.
#days_since	Returns a new date/time the specified number of days in the future.
#days_to_week_start	Returns the number of days to the start of the week on the given day.
#end_of_month	Returns a new date/time representing the end of the month.
#end_of_quarter	Returns a new date/time at the end of the quarter.
#end_of_week	Returns a new date/time representing the end of this week on the given day.
#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 DateAndTime::Calculations#prev_quarter.
#last_week	Alias for DateAndTime::Calculations#prev_week.
#last_weekday	Alias for DateAndTime::Calculations#prev_weekday.
#last_year	Short-hand for `years_ago(1)`.
#monday	Returns Monday of this week assuming that week starts on Monday.
#months_ago	Returns a new date/time the specified number of months ago.
#months_since	Returns a new date/time the specified number of months in the future.
#next_occurring	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	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	Returns a new date/time representing the previous occurrence of the specified day of week.
#prev_quarter	Short-hand for `months_ago(3)`.
#prev_week	Returns a new date/time representing the given day in the previous week.
#prev_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	Returns a new date/time the specified number of weeks ago.
#weeks_since	Returns a new date/time the specified number of weeks in the future.
#years_ago	Returns a new date/time the specified number of years ago.
#years_since	Returns a new date/time the specified number of years in the future.

`::DateAndTime::Zones` - Included

#in_time_zone

Returns the simultaneous time in Time.zone if a zone is given or if Time.zone_default is set.

Class Attribute Details

.beginning_of_week (rw)

Returns the week start (e.g. :monday) for the current request, if this has been set (via .beginning_of_week=). If beginning_of_week has not been set for the current request, returns the week start specified in config.beginning_of_week. If no config.beginning_of_week was specified, returns :monday.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 19


def beginning_of_week
  ::ActiveSupport::IsolatedExecutionState[:beginning_of_week] || beginning_of_week_default || :monday
end

.beginning_of_week=(week_start) (rw)

Sets .beginning_of_week to a week start (e.g. :monday) for current request/thread.

This method accepts any of the following day symbols: :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 27


def beginning_of_week=(week_start)
  ::ActiveSupport::IsolatedExecutionState[:beginning_of_week] = find_beginning_of_week!(week_start)
end

.beginning_of_week_default (rw)

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 14


attr_accessor :beginning_of_week_default

Class Method Details

.current

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 48


def current
  ::Time.zone ? ::Time.zone.today : ::Date.today
end

.find_beginning_of_week!(week_start)

Returns week start day symbol (e.g. :monday), or raises an ArgumentError for invalid day symbol.

Raises:

(ArgumentError)

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 32


def find_beginning_of_week!(week_start)
  raise ArgumentError, "Invalid beginning of week: #{week_start}" unless ::Date::DAYS_INTO_WEEK.key?(week_start)
  week_start
end

.tomorrow

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 43


def tomorrow
  ::Date.current.tomorrow
end

.yesterday

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 38


def yesterday
  ::Date.current.yesterday
end

Instance Attribute Details

#acts_like_date? ⇒ `Boolean` (readonly)

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/acts_like.rb', line 7


def acts_like_date?
  true
end

Instance Method Details

#+(other)

Alias for #plus_with_duration.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 98


alias_method :+, :plus_with_duration

#-(other)

Alias for #minus_with_duration.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 108


alias_method :-, :minus_with_duration

#<=>(other)

Alias for #compare_with_coercion.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 160


alias_method :<=>, :compare_with_coercion

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

The increments are applied in order of time units from largest to smallest. In other words, the date is incremented first by :years, then by :months, then by :weeks, then by :days. This order can affect the result around the end of a month. For example, incrementing first by months then by days:

Date.new(2004, 9, 30).advance(months: 1, days: 1)
# => Sun, 31 Oct 2004

Whereas incrementing first by days then by months yields a different result:

Date.new(2004, 9, 30).advance(days: 1).advance(months: 1)
# => Mon, 01 Nov 2004

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 127


def advance(options)
  d = self

  d = d >> options[:years] * 12 if options[:years]
  d = d >> options[:months] if options[:months]
  d = d + options[:weeks] * 7 if options[:weeks]
  d = d + options[:days] if options[:days]

  d
end

#ago(seconds)

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 55


def ago(seconds)
  in_time_zone.since(-seconds)
end

#at_beginning_of_day

Alias for #beginning_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 72


alias :at_beginning_of_day :beginning_of_day

#at_end_of_day

Alias for #end_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 88


alias :at_end_of_day :end_of_day

#at_midday

Alias for #middle_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 80


alias :at_midday :middle_of_day

#at_middle_of_day

Alias for #middle_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 82


alias :at_middle_of_day :middle_of_day

#at_midnight

Alias for #beginning_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 71


alias :at_midnight :beginning_of_day

#at_noon

Alias for #middle_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 81


alias :at_noon :middle_of_day

#beginning_of_day Also known as: #midnight, #at_midnight, #at_beginning_of_day

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 67


def beginning_of_day
  in_time_zone
end

#change(options)

Returns a new Date where one or more of the elements have been changed according to the options parameter. The options parameter is a hash with a combination of these keys: :year, :month, :day.

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)

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 143


def change(options)
  ::Date.new(
    options.fetch(:year, year),
    options.fetch(:month, month),
    options.fetch(:day, day)
  )
end

#compare_with_coercion(other) Also known as: #<=>

Allow Date to be compared with ::Time by converting to ::Time and relying on the <=> from there.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 152


def compare_with_coercion(other)
  if other.is_a?(Time)
    to_datetime <=> other
  else
    compare_without_coercion(other)
  end
end

#compare_without_coercion

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 159


alias_method :compare_without_coercion, :<=>

#default_inspect

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 64


alias_method :default_inspect, :inspect

#end_of_day Also known as: #at_end_of_day

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 85


def end_of_day
  in_time_zone.end_of_day
end

#in(seconds)

Alias for #since.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 64


alias :in :since

#inspect

Alias for #readable_inspect.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 65


alias_method :inspect, :readable_inspect

#midday

Alias for #middle_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 78


alias :midday :middle_of_day

#middle_of_day Also known as: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day

Converts Date to a ::Time (or ::Time if necessary) with the time portion set to the middle of the day (12:00)

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 75


def middle_of_day
  in_time_zone.middle_of_day
end

#midnight

Alias for #beginning_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 70


alias :midnight :beginning_of_day

#minus_without_duration

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 107


alias_method :minus_without_duration, :-

#noon

Alias for #middle_of_day.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 79


alias :noon :middle_of_day

#plus_without_duration

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 97


alias_method :plus_without_duration, :+

#readable_inspect Also known as: #inspect

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 61


def readable_inspect
  strftime("%a, %d %b %Y")
end

#since(seconds) Also known as: #in

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

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/calculations.rb', line 61


def since(seconds)
  in_time_zone.since(seconds)
end

#to_formatted_s(format = :default)

Alias for #to_fs.

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 58


alias_method :to_formatted_s, :to_fs

#to_fs(format = :default) Also known as: #to_formatted_s

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

This method is aliased to #to_formatted_s.

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

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

date.to_fs(:short)         # => "10 Nov"
date.to_fs(:number)        # => "20071110"
date.to_fs(:long)          # => "November 10, 2007"
date.to_fs(:long_ordinal)  # => "November 10th, 2007"
date.to_fs(:rfc822)        # => "10 Nov 2007"
date.to_fs(:iso8601)       # => "2007-11-10"

Adding your own date formats to to_fs

You can add your own formats to the 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/date_formats.rb
Date::DATE_FORMATS[:month_and_year] = '%B %Y'
Date::DATE_FORMATS[:short_ordinal] = ->(date) { date.strftime("%B #{date.day.ordinalize}") }

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 47


def to_fs(format = :default)
  if formatter = DATE_FORMATS[format]
    if formatter.respond_to?(:call)
      formatter.call(self).to_s
    else
      strftime(formatter)
    end
  else
    to_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).

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

date.to_time                   # => 2007-11-10 00:00:00 0800
date.to_time(:local)           # => 2007-11-10 00:00:00 0800

date.to_time(:utc)             # => 2007-11-10 00:00:00 UTC

NOTE: The :local timezone is Ruby’s process timezone, i.e. ENV['TZ']. If the application’s timezone is needed, then use in_time_zone instead.

Raises:

(ArgumentError)

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 81


def to_time(form = :local)
  raise ArgumentError, "Expected :local or :utc, got #{form.inspect}." unless [:local, :utc].include?(form)
  ::Time.public_send(form, year, month, day)
end

#xmlschema

Returns a string which represents the time in used time zone as ::Time defined by XML Schema:

date = Date.new(2015, 05, 23)  # => Sat, 23 May 2015
date.xmlschema                 # => "2015-05-23T00:00:00+04:00"

[ GitHub ]

# File 'activesupport/lib/active_support/core_ext/date/conversions.rb', line 93


def xmlschema
  in_time_zone.xmlschema
end

Class: Date

Constant Summary

::DateAndTime::Calculations - Included

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

::DateAndTime::Calculations - Included

Instance Method Summary

::DateAndTime::Calculations - Included

::DateAndTime::Zones - Included

Class Attribute Details

.beginning_of_week (rw)

.beginning_of_week=(week_start) (rw)

.beginning_of_week_default (rw)

Class Method Details

.current

.find_beginning_of_week!(week_start)

.tomorrow

.yesterday

Instance Attribute Details

#acts_like_date? ⇒ Boolean (readonly)

Instance Method Details

#+(other)

#-(other)

#<=>(other)

#advance(options)

#ago(seconds)

#at_beginning_of_day

#at_end_of_day

#at_midday

#at_middle_of_day

#at_midnight

#at_noon

#beginning_of_day Also known as: #midnight, #at_midnight, #at_beginning_of_day

#change(options)

#compare_with_coercion(other) Also known as: #<=>

#compare_without_coercion

#default_inspect

#end_of_day Also known as: #at_end_of_day

#in(seconds)

#inspect

#midday

#middle_of_day Also known as: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day

#midnight

#minus_without_duration

#noon

#plus_without_duration

#readable_inspect Also known as: #inspect

#since(seconds) Also known as: #in

#to_formatted_s(format = :default)

#to_fs(format = :default) Also known as: #to_formatted_s

Adding your own date formats to to_fs

#to_time(form = :local)

#xmlschema

`::DateAndTime::Calculations` - Included

`::DateAndTime::Calculations` - Included

`::DateAndTime::Calculations` - Included

`::DateAndTime::Zones` - Included

#acts_like_date? ⇒ `Boolean` (readonly)