edge badge
Methods
#
A
B
C
D
E
F
I
M
N
R
S
T
X
Y
Included Modules
Constants
DATE_FORMATS = { :short => '%e %b', :long => '%B %e, %Y', :db => '%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 => '%e %b %Y', :iso8601 => lambda { |date| date.iso8601 } }
 
Attributes
[RW] beginning_of_week_default
Instance Public methods
<=>(other)
Also aliased as: compare_without_coercion
acts_like_date?()

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

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

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 53
def ago(seconds)
  in_time_zone.since(-seconds)
end
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()

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 65
def beginning_of_day
  in_time_zone
end
beginning_of_week()

Returns the week start (e.g. :monday) for the current request, if this has been set (via #beginning_of_week=). If Date.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.

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 17
def beginning_of_week
  Thread.current[:beginning_of_week] || beginning_of_week_default || :monday
end
beginning_of_week=(week_start)

Sets Date.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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 25
def beginning_of_week=(week_start)
  Thread.current[:beginning_of_week] = find_beginning_of_week!(week_start)
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)
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 125
def change(options)
  ::Date.new(
    options.fetch(:year, year),
    options.fetch(:month, month),
    options.fetch(:day, day)
  )
end
compare_with_coercion(other)

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

Also aliased as: <=>
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 134
def compare_with_coercion(other)
  if other.is_a?(Time)
    self.to_datetime <=> other
  else
    compare_without_coercion(other)
  end
end
compare_without_coercion(other)
Alias for: <=>
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 46
def current
  ::Time.zone ? ::Time.zone.today : ::Date.today
end
default_inspect()
Alias for: inspect
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)

Also aliased as: at_end_of_day
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 83
def end_of_day
  in_time_zone.end_of_day
end
find_beginning_of_week!(week_start)

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 30
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
in(seconds)
Alias for: since
inspect()
Also aliased as: default_inspect
Alias for: readable_inspect
midday()
Alias for: middle_of_day
middle_of_day()

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 73
def middle_of_day
  in_time_zone.middle_of_day
end
midnight()
Alias for: beginning_of_day
noon()
Alias for: middle_of_day
readable_inspect()

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

Also aliased as: inspect
# File activesupport/lib/active_support/core_ext/date/conversions.rb, line 66
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

Also aliased as: in
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 59
def since(seconds)
  in_time_zone.since(seconds)
end
to_default_s(format = :default)
Alias for: to_s
to_formatted_s(format = :default)

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

This method is aliased to to_s.

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"
date.to_formatted_s(:iso8601)       # => "2007-11-10"

Adding your own date 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/date_formats.rb
Date::DATE_FORMATS[:month_and_year] = '%B %Y'
Date::DATE_FORMATS[:short_ordinal] = ->(date) { date.strftime("%B #{date.day.ordinalize}") }
Also aliased as: to_s
# File activesupport/lib/active_support/core_ext/date/conversions.rb, line 51
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_s(format = :default)
Also aliased as: to_default_s
Alias for: to_formatted_s
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                   # => 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
# File activesupport/lib/active_support/core_ext/date/conversions.rb, line 81
def to_time(form = :local)
  ::Time.send(form, year, month, day)
end
tomorrow()

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

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 41
def tomorrow
  ::Date.current.tomorrow
end
xmlschema()
# File activesupport/lib/active_support/core_ext/date/conversions.rb, line 85
def xmlschema
  in_time_zone.xmlschema
end
yesterday()

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

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