Spec-Zone.ru › Ruby on Rails 8.1

class DateTime

Родительский класс:
Object
Подключённые модули:
DateAndTime::Compatibility

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

civil_from_format (utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 71
def self.civil_from_format(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0)
  if utc_or_local.to_sym == :local
    offset = ::Time.local(year, month, day).utc_offset.to_r / 86400
  else
    offset = 0
  end
  civil(year, month, day, hour, min, sec, offset)
end

Возвращает DateTime с местным смещением для указанного года, если формат местный; в противном случае смещение равно нулю.

DateTime.civil_from_format :local, 2012
# => Sun, 01 Jan 2012 00:00:00 +0300
DateTime.civil_from_format :local, 2012, 12, 17
# => Mon, 17 Dec 2012 00:00:00 +0000
current () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 10
def current
  ::Time.zone ? ::Time.zone.now.to_datetime : ::Time.now.to_datetime
end

Возвращает Time.zone.now.to_datetime, если заданы Time.zone или config.time_zone; в противном случае возвращает Time.now.to_datetime.

Открытые методы экземпляра

<=> (other) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 208
def <=>(other)
  if other.respond_to? :to_datetime
    super other.to_datetime rescue nil
  else
    super
  end
end

Добавляет поведение к DateTime#<=>, позволяя сравнивать экземпляры Time и ActiveSupport::TimeWithZone с экземпляром DateTime.

Вызывает метод суперкласса
acts_like_date? () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/acts_like.rb, line 8
def acts_like_date?
  true
end

Соответствует интерфейсу класса, подобного Date. См. Object#acts_like?.

acts_like_time? () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/acts_like.rb, line 13
def acts_like_time?
  true
end

Соответствует интерфейсу класса, подобного Time. См. Object#acts_like?.

advance (options) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 82
def advance(options)
  unless options[:weeks].nil?
    options[:weeks], partial_weeks = options[:weeks].divmod(1)
    options[:days] = options.fetch(:days, 0) + 7 * partial_weeks
  end

  unless options[:days].nil?
    options[:days], partial_days = options[:days].divmod(1)
    options[:hours] = options.fetch(:hours, 0) + 24 * partial_days
  end

  d = to_date.advance(options)
  datetime_advanced_by_date = change(year: d.year, month: d.month, day: d.day)
  seconds_to_advance = \
    options.fetch(:seconds, 0) +
    options.fetch(:minutes, 0) * 60 +
    options.fetch(:hours, 0) * 3600

  if seconds_to_advance.zero?
    datetime_advanced_by_date
  else
    datetime_advanced_by_date.since(seconds_to_advance)
  end
end

Использует Date для точных вычислений Time для лет, месяцев и дней. Параметр options принимает хеш с любыми из следующих ключей: :years, :months, :weeks, :days, :hours, :minutes, :seconds.

Как и в случае с Date#advance, приращения применяются по порядку единиц времени от большей к меньшей. Этот порядок может повлиять на результат в конце месяца.

ago (seconds) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 109
def ago(seconds)
  since(-seconds)
end

Возвращает новый DateTime, представляющий время на указанное количество секунд раньше. Не используйте этот метод вместе с x.months, вместо него используйте months_ago!

at_beginning_of_day ()
Псевдоним для: beginning_of_day
at_beginning_of_hour ()
Псевдоним для: beginning_of_hour
at_beginning_of_minute ()
Псевдоним для: beginning_of_minute
at_end_of_day ()
Псевдоним для: end_of_day
at_end_of_hour ()
Псевдоним для: end_of_hour
at_end_of_minute ()
Псевдоним для: end_of_minute
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_time/calculations.rb, line 122
def beginning_of_day
  change(hour: 0)
end

Возвращает новый DateTime, представляющий начало дня (0:00).

Также имеет псевдонимы: midnight, at_midnight, at_beginning_of_day
beginning_of_hour () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 146
def beginning_of_hour
  change(min: 0)
end

Возвращает новый DateTime, представляющий начало часа (hh:00:00).

Также имеет псевдоним: at_beginning_of_hour
beginning_of_minute () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 158
def beginning_of_minute
  change(sec: 0)
end

Возвращает новый DateTime, представляющий начало минуты (hh:mm:00).

Также имеет псевдоним: at_beginning_of_minute
change (options) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 51
def change(options)
  if new_nsec = options[:nsec]
    raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
    new_fraction = Rational(new_nsec, 1000000000)
  else
    new_usec = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))
    new_fraction = Rational(new_usec, 1000000)
  end

  raise ArgumentError, "argument out of range" if new_fraction >= 1

  ::DateTime.civil(
    options.fetch(:year, year),
    options.fetch(:month, month),
    options.fetch(:day, day),
    options.fetch(:hour, hour),
    options.fetch(:min, options[:hour] ? 0 : min),
    options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec) + new_fraction,
    options.fetch(:offset, offset),
    options.fetch(:start, start)
  )
end

Возвращает новый DateTime, в котором один или несколько элементов изменены в соответствии с параметром options. Параметры времени (:hour, :min, :sec) сбрасываются каскадно: если передан только час, минуты и секунды устанавливаются в 0. Если переданы час и минуты, секунды устанавливаются в 0. Параметр options принимает хеш с любыми из следующих ключей: :year, :month, :day, :hour, :min, :sec, :offset, :start.

DateTime.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => DateTime.new(2012, 8, 1, 22, 35, 0)
DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => DateTime.new(1981, 8, 1, 22, 35, 0)
DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => DateTime.new(1981, 8, 29, 0, 0, 0)
default_inspect ()
Псевдоним для: inspect
end_of_day () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 140
def end_of_day
  change(hour: 23, min: 59, sec: 59, usec: Rational(999999999, 1000))
end

Возвращает новый DateTime, представляющий конец дня (23:59:59).

Также имеет псевдоним: at_end_of_day
end_of_hour () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 152
def end_of_hour
  change(min: 59, sec: 59, usec: Rational(999999999, 1000))
end

Возвращает новый DateTime, представляющий конец часа (hh:59:59).

Также имеет псевдоним: at_end_of_hour
end_of_minute () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 164
def end_of_minute
  change(sec: 59, usec: Rational(999999999, 1000))
end

Возвращает новый DateTime, представляющий конец минуты (hh:mm:59).

Также имеет псевдоним: at_end_of_minute
formatted_offset (colon = true, alternate_utc_string = nil) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 53
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

Возвращает строку со смещением относительно UTC в отформатированном виде или альтернативную строку, если часовой пояс уже соответствует UTC.

datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))
datetime.formatted_offset         # => "-06:00"
datetime.formatted_offset(false)  # => "-0600"
getgm ()
Псевдоним для: utc
getlocal (utc_offset = nil)
Псевдоним для: localtime
getutc ()
Псевдоним для: utc
gmtime ()
Псевдоним для: utc
in (seconds)
Псевдоним для: since
inspect ()
Также имеет псевдоним: default_inspect
Псевдоним для: readable_inspect
localtime (utc_offset = nil) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 170
def localtime(utc_offset = nil)
  utc = new_offset(0)

  Time.utc(
    utc.year, utc.month, utc.day,
    utc.hour, utc.min, utc.sec + utc.sec_fraction
  ).getlocal(utc_offset)
end

Возвращает экземпляр Time, соответствующий тому же моменту времени в системном часовом поясе.

Также имеет псевдоним: getlocal
midday ()
Псевдоним для: middle_of_day
middle_of_day () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 130
def middle_of_day
  change(hour: 12)
end

Возвращает новый DateTime, представляющий середину дня (12:00).

Также имеет псевдонимы: midday, noon, at_midday, at_noon, at_middle_of_day
midnight ()
Псевдоним для: beginning_of_day
noon ()
Псевдоним для: middle_of_day
nsec () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 96
def nsec
  (sec_fraction * 1_000_000_000).to_i
end

Возвращает долю секунды в наносекундах

readable_inspect () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 58
def readable_inspect
  to_fs(:rfc822)
end

Заменяет стандартный метод inspect человекочитаемым вариантом, например: «Mon, 21 Feb 2005 14:30:00 +0000».

Также имеет псевдоним: inspect
seconds_since_midnight () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 20
def seconds_since_midnight
  sec + (min * 60) + (hour * 3600)
end

Возвращает количество секунд, прошедших с 00:00:00.

DateTime.new(2012, 8, 29,  0,  0,  0).seconds_since_midnight # => 0
DateTime.new(2012, 8, 29, 12, 34, 56).seconds_since_midnight # => 45296
DateTime.new(2012, 8, 29, 23, 59, 59).seconds_since_midnight # => 86399
seconds_until_end_of_day () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 29
def seconds_until_end_of_day
  end_of_day.to_i - to_i
end

Возвращает количество секунд до 23:59:59.

DateTime.new(2012, 8, 29,  0,  0,  0).seconds_until_end_of_day # => 86399
DateTime.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103
DateTime.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0
since (seconds) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 116
def since(seconds)
  self + Rational(seconds, 86400)
end

Возвращает новый DateTime, представляющий время через указанное количество секунд после момента времени экземпляра. Не используйте этот метод вместе с x.months, вместо него используйте months_since!

Также имеет псевдоним: in
subsec () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 36
def subsec
  sec_fraction
end

Возвращает долю секунды в виде Rational

DateTime.new(2012, 8, 29, 0, 0, 0.5).subsec # => (1/2)
to_f () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 81
def to_f
  seconds_since_unix_epoch.to_f + sec_fraction
end

Преобразует self в число с плавающей точкой, представляющее количество секунд с начала эпохи Unix, включая дробные микросекунды.

to_formatted_s (format = :default)
Псевдоним для: to_fs
to_fs (format = :default) Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 37
def to_fs(format = :default)
  if formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_s
  end
end

Преобразует значение в строку заданного формата. Предопределённые форматы см. в Time::DATE_FORMATS.

Этот метод имеет псевдоним to_formatted_s.

Примеры

datetime = DateTime.civil(2007, 12, 4, 0, 0, 0, 0)   # => Tue, 04 Dec 2007 00:00:00 +0000

datetime.to_fs(:db)            # => "2007-12-04 00:00:00"
datetime.to_formatted_s(:db)   # => "2007-12-04 00:00:00"
datetime.to_fs(:number)        # => "20071204000000"
datetime.to_fs(:short)         # => "04 Dec 00:00"
datetime.to_fs(:long)          # => "December 04, 2007 00:00"
datetime.to_fs(:long_ordinal)  # => "December 4th, 2007 00:00"
datetime.to_fs(:rfc822)        # => "Tue, 04 Dec 2007 00:00:00 +0000"
datetime.to_fs(:iso8601)       # => "2007-12-04T00:00:00+00:00"

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

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

# config/initializers/time_formats.rb
Time::DATE_FORMATS[:month_and_year] = '%B %Y'
Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
Также имеет псевдоним: to_formatted_s
to_i () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 86
def to_i
  seconds_since_unix_epoch.to_i
end

Преобразует self в целое число секунд, прошедших с начала эпохи Unix.

to_time () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/compatibility.rb, line 13
def to_time
  getlocal(utc_offset)
end

Возвращает экземпляр Time с тем же смещением UTC, что и у self.

usec () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 91
def usec
  (sec_fraction * 1_000_000).to_i
end

Возвращает долю секунды в микросекундах

utc () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 184
def utc
  utc = new_offset(0)

  Time.utc(
    utc.year, utc.month, utc.day,
    utc.hour, utc.min, utc.sec + utc.sec_fraction
  )
end

Возвращает экземпляр Time, соответствующий тому же моменту времени в часовом поясе UTC.

DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24))     # => Mon, 21 Feb 2005 10:11:12 -0600
DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24)).utc # => Mon, 21 Feb 2005 16:11:12 UTC
Также имеет псевдонимы: getgm, getutc, gmtime
utc? () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 197
def utc?
  offset == 0
end

Возвращает true, если offset == 0.

utc_offset () Показать исходный код
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 202
def utc_offset
  (offset * 86400).to_i
end

Возвращает значение смещения в секундах.

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

Spec-Zone.ru

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