Spec-Zone.ru › Ruby on Rails 7.2

класс Date

Родитель:
Объект
Включенные модули:
DateAndTime::Calculations, DateAndTime::Zones

Константы

DATE_FORMATS

Атрибуты

beginning_of_week_default[RW]

Открытые методы класса

beginning_of_week() Показать исходный код
# 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

Возвращает начало недели (например, :monday) для текущего запроса, если это было установлено (через Date.beginning_of_week=). Если Date.beginning_of_week не было установлено для текущего запроса, возвращает начало недели, указанное в config.beginning_of_week. Если config.beginning_of_week не было указано, возвращает :monday.

beginning_of_week=(week_start) Показать исходный код
# 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

Устанавливает Date.beginning_of_week в начало недели (например, :monday) для текущего запроса/потока.

Этот метод принимает любой из следующих символов дня: :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday

current() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 48
def current
  ::Time.zone ? ::Time.zone.today : ::Date.today
end

Возвращает Time.zone.today, когда Time.zone или config.time_zone установлены, в противном случае возвращает просто Date.today.

find_beginning_of_week!(week_start) Показать исходный код
# 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

Возвращает символ дня начала недели (например, :monday), или вызывает исключение ArgumentError для недопустимого символа дня.

tomorrow() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 43
def tomorrow
  ::Date.current.tomorrow
end

Возвращает новый Date, представляющий дату через 1 день после сегодняшней (т.е. дата завтрашнего дня).

yesterday() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 38
def yesterday
  ::Date.current.yesterday
end

Возвращает новый Date, представляющий дату 1 день назад (т.е. дата вчерашнего дня).

END_OF_DOCUMENT_MARKER

Методы экземпляра публичного класса

<=>(other)
Также алиасируется как: compare_without_coercion
Псевдоним для: compare_with_coercion
acts_like_date?() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/acts_like.rb, line 7
def acts_like_date?
  true
end

Использует утиную типизацию как класс, похожий на дату. См. Object#acts_like?.

advance(options) Показать исходный код
# 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

Обеспечивает точные вычисления Date для лет, месяцев и дней. Параметр options принимает хеш с любыми из этих ключей: :years, :months, :weeks, :days.

Приращения применяются в порядке временных единиц от наибольших к наименьшим. Другими словами, дата сначала увеличивается на :years, затем на :months, затем на :weeks, затем на :days. Этот порядок может повлиять на результат в конце месяца. Например, увеличение сначала на месяцы, а затем на дни:

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

В то время как увеличение сначала на дни, а затем на месяцы, приводит к другому результату:

Date.new(2004, 9, 30).advance(days: 1).advance(months: 1)
# => Mon, 01 Nov 2004
ago(seconds) Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 55
def ago(seconds)
  in_time_zone.since(-seconds)
end

Преобразует Date в Time (или DateTime, если необходимо) с часовой частью, установленной в начало дня (0:00), а затем вычитает указанное количество секунд.

at_beginning_of_day()
Псевдоним для: beginning_of_day
at_end_of_day()
Псевдоним для: end_of_day
at_midday()
Псевдоним для: middle_of_day
at_middle_of_day()
Псевдоним для: middle_of_day
at_midnight()
Псевдоним для: beginning_of_day
at_noon()
Псевдоним для: middle_of_day
beginning_of_day() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 67
def beginning_of_day
  in_time_zone
end

Преобразует Date в Time (или DateTime, если необходимо) с часовой частью, установленной в начало дня (0:00)

Также алиасируется как: midnight, at_midnight, at_beginning_of_day
change(options) Показать исходный код
# 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

Возвращает новую Date, где один или несколько элементов были изменены в соответствии с параметром options. Параметр options — это хеш с комбинацией этих ключей: :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)
compare_with_coercion(other) Показать исходный код
# 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

Разрешает сравнивать Date с Time, преобразуя их в DateTime и используя оператор <=> оттуда.

Также алиасируется как: <=>
compare_without_coercion(other)
Псевдоним для: <=>
default_inspect()
Псевдоним для: inspect
end_of_day() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 85
def end_of_day
  in_time_zone.end_of_day
end

Преобразует Date в Time (или DateTime, если необходимо) с часовой частью, установленной в конец дня (23:59:59)

Также алиасируется как: at_end_of_day
in(seconds)
Псевдоним для: since
inspect()
Также алиасируется как: default_inspect
Псевдоним для: readable_inspect
midday()
Псевдоним для: middle_of_day
middle_of_day() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 75
def middle_of_day
  in_time_zone.middle_of_day
end

Преобразует Date в Time (или DateTime, если необходимо) с часовой частью, установленной в полдень (12:00)

Также алиасируется как: midday, noon, at_midday, at_noon, at_middle_of_day
midnight()
Псевдоним для: beginning_of_day
noon()
Псевдоним для: middle_of_day
readable_inspect() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/conversions.rb, line 61
def readable_inspect
  strftime("%a, %d %b %Y")
end

Переопределяет метод inspect по умолчанию на удобочитаемый, например, «Пн, 21 фев 2005 г.»

Также алиасируется как: inspect
since(seconds) Показать исходный код
# File activesupport/lib/active_support/core_ext/date/calculations.rb, line 61
def since(seconds)
  in_time_zone.since(seconds)
end

Преобразует Date в Time (или DateTime, если необходимо) с часовой частью, установленной в начало дня (0:00), а затем добавляет указанное количество секунд.

Также алиасируется как: in
to_formatted_s(format = :default)
Псевдоним для: to_fs
to_fs(format = :default) Показать исходный код
# 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

Преобразовать в строку формата. См. DATE_FORMATS для предопределенных форматов.

Этот метод является псевдонимом для 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"

Добавление собственных форматов дат для to_fs

Вы можете добавить свои собственные форматы в хеш Date::DATE_FORMATS. Используйте имя формата в качестве ключа хеша и строку strftime или экземпляр Proc, принимающий аргумент даты, в качестве значения.

# 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}") }
Также алиасируется как: to_formatted_s
to_time(form = :local) Показать исходный код
# 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

Преобразует экземпляр Date в Time, где время установлено в начало дня. Часовой пояс может быть :local или :utc (по умолчанию :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

ПРИМЕЧАНИЕ: Часовой пояс :local — это часовой пояс Ruby, т.е. ENV['TZ']. Если требуется часовой пояс приложения, используйте in_time_zone.

xmlschema() Показать исходный код
# File activesupport/lib/active_support/core_ext/date/conversions.rb, line 93
def xmlschema
  in_time_zone.xmlschema
end

Возвращает строку, представляющую время в используемом часовом поясе в формате DateTime, определенном XML Schema:

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

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API