Date
Methods
- #
- A
- B
- C
- D
- E
- F
- I
- M
- N
- R
- S
- T
- X
- Y
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() Link
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: show | on GitHub
def beginning_of_week ::ActiveSupport::IsolatedExecutionState[:beginning_of_week] || beginning_of_week_default || :monday end
beginning_of_week=(week_start) Link
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: show | on GitHub
def beginning_of_week=(week_start) ::ActiveSupport::IsolatedExecutionState[:beginning_of_week] = find_beginning_of_week!(week_start) end
current() Link
Returns Time.zone.today when Time.zone or config.time_zone are set, otherwise just returns Date.today.
Source: show | on GitHub
def current ::Time.zone ? ::Time.zone.today : ::Date.today end
find_beginning_of_week!(week_start) Link
Returns week start day symbol (e.g. :monday), or raises an ArgumentError for invalid day symbol.
Source: show | on GitHub
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() Link
Returns a new Date representing the date 1 day after today (i.e. tomorrow’s date).
Source: show | on GitHub
def tomorrow ::Date.current.tomorrow end
yesterday() Link
Returns a new Date representing the date 1 day ago (i.e. yesterday’s date).
Source: show | on GitHub
def yesterday ::Date.current.yesterday end
Instance Public methods
acts_like_date?() Link
advance(options) Link
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)
Whereas incrementing first by days then by months yields a different result:
Date.new(2004, 9, 30).advance(days: 1).advance(months: 1)
Source: show | on GitHub
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) Link
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: show | on GitHub
def ago(seconds) in_time_zone.since(-seconds) end
at_beginning_of_day() Link
at_end_of_day() Link
at_middle_of_day() Link
beginning_of_day() Link
Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
change(options) Link
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, 12).change(year: 2005, month: 1)
Source: show | on GitHub
def change(options) ::Date.new( options.fetch(:year, year), options.fetch(:month, month), options.fetch(:day, day) ) end
compare_with_coercion(other) Link
Allow Date to be compared with Time by converting to DateTime and relying on the <=> from there.
Also aliased as: <=>
Source: show | on GitHub
def compare_with_coercion(other) if other.is_a?(Time) to_datetime <=> other else compare_without_coercion(other) end end
default_inspect() Link
end_of_day() Link
Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)
Source: show | on GitHub
def end_of_day in_time_zone.end_of_day end
middle_of_day() Link
Converts Date to a Time (or DateTime if necessary) with the time portion set to the middle of the day (12:00)
Source: show | on GitHub
def middle_of_day in_time_zone.middle_of_day end
readable_inspect() Link
Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005”
Source: show | on GitHub
def readable_inspect strftime("%a, %d %b %Y") end
since(seconds) Link
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: show | on GitHub
def since(seconds) in_time_zone.since(seconds) end
to_formatted_s(format = :default) Link
to_fs(format = :default) Link
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) date.to_fs(:db) date.to_formatted_s(:db) date.to_fs(:short) date.to_fs(:number) date.to_fs(:long) date.to_fs(:long_ordinal) date.to_fs(:rfc822) date.to_fs(:rfc2822) date.to_fs(:iso8601)
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.
Date::DATE_FORMATS[:month_and_year] = '%B %Y' Date::DATE_FORMATS[:short_ordinal] = ->(date) { date.strftime("%B #{date.day.ordinalize}") }
Source: show | on GitHub
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) Link
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) date.to_time date.to_time(:local) date.to_time(: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: show | on GitHub
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