Date | RailsDoc(β)

Methods

<=>
acts_like_date?
advance
ago
at_beginning_of_day
at_end_of_day
at_midday
at_middle_of_day
at_midnight
at_noon
beginning_of_day
beginning_of_week
beginning_of_week=
change
compare_with_coercion
compare_without_coercion
current
default_inspect
end_of_day
find_beginning_of_week!
in
inspect
midday
middle_of_day
midnight
noon
readable_inspect
since
to_formatted_s
to_fs
to_time
tomorrow
xmlschema
yesterday

Included Modules

Constants

DATE_FORMATS

{ 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", rfc2822: "%d %b %Y", iso8601: lambda { |date| date.iso8601 } }

Attributes

[RW]

beginning_of_week_default

Class Public methods

beginning_of_week()

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

📝 Source code

# 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

🔎 See on GitHub

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

📝 Source code

# 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

🔎 See on GitHub

current()

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

📝 Source code

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

🔎 See on GitHub

find_beginning_of_week!(week_start)

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

📝 Source code

# 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

🔎 See on GitHub

tomorrow()

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

📝 Source code

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

🔎 See on GitHub

yesterday()

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

📝 Source code

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

🔎 See on GitHub

Instance Public methods

<=>(other)

Also aliased as: compare_without_coercion

Alias for: compare_with_coercion

acts_like_date?()

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

# 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

🔎 See on GitHub

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.

📝 Source code

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

🔎 See on GitHub

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)

Also aliased as: midnight, at_midnight, at_beginning_of_day

📝 Source code

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

🔎 See on GitHub

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)

📝 Source code

# 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

🔎 See on GitHub

compare_with_coercion(other)

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

Also aliased as: <=>

📝 Source code

# 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

🔎 See on GitHub

compare_without_coercion(other)

Alias for: <=>

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

📝 Source code

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

🔎 See on GitHub

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)

Also aliased as: midday, noon, at_midday, at_noon, at_middle_of_day

📝 Source code

# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 75
  def middle_of_day
    in_time_zone.middle_of_day
  end

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

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

📝 Source code

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

🔎 See on GitHub

to_formatted_s(format = :default)

Alias for: to_fs

to_fs(format = :default)

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(:rfc2822)       # => "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::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_formatted_s

📝 Source code

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

🔎 See on GitHub

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.

📝 Source code

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

🔎 See on GitHub

xmlschema()

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

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

📝 Source code

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

🔎 See on GitHub

Date < Object

Methods

Included Modules

Constants

Attributes

Class Public methods

beginning_of_week()

beginning_of_week=(week_start)

current()

find_beginning_of_week!(week_start)

tomorrow()

yesterday()

Instance Public methods

<=>(other)

acts_like_date?()

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

change(options)

compare_with_coercion(other)

compare_without_coercion(other)

default_inspect()

end_of_day()

in(seconds)

inspect()

midday()

middle_of_day()

midnight()

noon()

readable_inspect()

since(seconds)

to_formatted_s(format = :default)

to_fs(format = :default)

Adding your own date formats to to_fs

to_time(form = :local)

xmlschema()

Adding your own date formats to `to_fs`