Spec-Zone.ru › Ruby on Rails 5.0

класс Time

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

Константы

COMMON_YEAR_DAYS_IN_MONTH
DATE_FORMATS

Атрибуты

zone_default[RW]

Публичные методы класса

===(other) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 15
def ===(other)
  super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone))
end

Переопределенный метод сравнения на равенство для того, чтобы он возвращал true для экземпляров ActiveSupport::TimeWithZone

Вызывает метод родительского класса
at(*args)
Также алиас для: at_without_coercion
Алиас для: at_with_coercion
at_with_coercion(*args) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 42
def at_with_coercion(*args)
  return at_without_coercion(*args) if args.size != 1

  # Time.at can be called with a time or numerical value
  time_or_number = args.first

  if time_or_number.is_a?(ActiveSupport::TimeWithZone) || time_or_number.is_a?(DateTime)
    at_without_coercion(time_or_number.to_f).getlocal
  else
    at_without_coercion(time_or_number)
  end
end

Добавляет дополнительное поведение к ::at, чтобы экземпляры ActiveSupport::TimeWithZone и DateTime могли быть использованы при вызове с одним аргументом

Также алиас для: at
at_without_coercion(*args)
Алиас для: at
current() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 36
def current
  ::Time.zone ? ::Time.zone.now : ::Time.now
end

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

days_in_month(month, year = current.year) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 21
def days_in_month(month, year = current.year)
  if month == 2 && ::Date.gregorian_leap?(year)
    29
  else
    COMMON_YEAR_DAYS_IN_MONTH[month]
  end
end

Возвращает количество дней в данном месяце. Если год не указан, используется текущий год.

days_in_year(year = current.year) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 31
def days_in_year(year = current.year)
  days_in_month(2, year) + 337
end

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

find_zone(time_zone) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 107
def find_zone(time_zone)
  find_zone!(time_zone) rescue nil
end

Возвращает экземпляр TimeZone, соответствующий предоставленной временной зоне. Принимает временную зону в любом формате, поддерживаемом Time.zone=. Возвращает nil для неверных временных зон.

Time.find_zone "America/New_York" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
Time.find_zone "NOT-A-TIMEZONE"   # => nil
find_zone!(time_zone) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 80
def find_zone!(time_zone)
  if !time_zone || time_zone.is_a?(ActiveSupport::TimeZone)
    time_zone
  else
    # Look up the timezone based on the identifier (unless we've been
    # passed a TZInfo::Timezone)
    unless time_zone.respond_to?(:period_for_local)
      time_zone = ActiveSupport::TimeZone[time_zone] || TZInfo::Timezone.get(time_zone)
    end

    # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone
    if time_zone.is_a?(ActiveSupport::TimeZone)
      time_zone
    else
      ActiveSupport::TimeZone.create(time_zone.name, nil, time_zone)
    end
  end
rescue TZInfo::InvalidTimezoneIdentifier
  raise ArgumentError, "Invalid Timezone: #{time_zone}"
end

Возвращает экземпляр TimeZone, соответствующий предоставленной временной зоне. Принимает временную зону в любом формате, поддерживаемом Time.zone=. Выбрасывает ArgumentError для неверных временных зон.

Time.find_zone! "America/New_York" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
Time.find_zone! "EST"              # => #<ActiveSupport::TimeZone @name="EST" ...>
Time.find_zone! -5.hours           # => #<ActiveSupport::TimeZone @name="Bogota" ...>
Time.find_zone! nil                # => nil
Time.find_zone! false              # => false
Time.find_zone! "NOT-A-TIMEZONE"   # => ArgumentError: Invalid Timezone: NOT-A-TIMEZONE
use_zone(time_zone) { || ... } Показать исходный код
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 60
def use_zone(time_zone)
  new_zone = find_zone!(time_zone)
  begin
    old_zone, ::Time.zone = ::Time.zone, new_zone
    yield
  ensure
    ::Time.zone = old_zone
  end
end

Позволяет локально переопределить Time.zone внутри переданного блока; сбрасывает Time.zone к существующему значению по завершении.

 class ApplicationController < ActionController::Base
   around_action :set_time_zone

   private

   def set_time_zone
     Time.use_zone(current_user.timezone) { yield }
   end
 end

NOTE: This won't affect any <tt>ActiveSupport::TimeWithZone</tt>
objects that have already been created, e.g. any model timestamp
attributes that have been read before the block will remain in
the application's default timezone.
zone() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 12
def zone
  Thread.current[:time_zone] || zone_default
end

Возвращает TimeZone для текущего запроса, если он был задан (через ::zone=). Если Time.zone не был задан для текущего запроса, возвращает TimeZone, указанный в config.time_zone.

zone=(time_zone) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 39
def zone=(time_zone)
  Thread.current[:time_zone] = find_zone!(time_zone)
end

Устанавливает Time.zone на объект TimeZone для текущего запроса/потока.

Этот метод принимает любое из следующего:

  • Объект Rails TimeZone.

  • Идентификатор объекта Rails TimeZone (например, “Eastern Время (США и Канада)”, -5.hours).

  • Объект TZInfo::Timezone.

  • Идентификатор объекта TZInfo::Timezone (например, “America/New_York”).

Вот пример того, как вы можете установить Time.zone для каждого запроса и сбросить его при завершении запроса. current_user.time_zone просто должен возвращать строку, идентифицирующую предпочитаемую временную зону пользователя:

class ApplicationController < ActionController::Base
  around_action :set_time_zone

  def set_time_zone
    if logged_in?
      Time.use_zone(current_user.time_zone) { yield }
    else
      yield
    end
  end
end

Общедоступные методы экземпляров

-(other)
Также использует алиас: minus_without_duration, minus_without_coercion
Алиас для: minus_with_coercion
<=>(other)
Также использует алиас: compare_without_coercion
Алиас для: compare_with_coercion
acts_like_time?() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/acts_like.rb, line 5
def acts_like_time?
  true
end

Имитирует поведение класса Time. См. Object#acts_like?.

advance(options) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 131
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)
  d = d.gregorian if d.julian?
  time_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?
    time_advanced_by_date
  else
    time_advanced_by_date.since(seconds_to_advance)
  end
end

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

Time.new(2015, 8, 1, 14, 35, 0).advance(seconds: 1) # => 2015-08-01 14:35:01 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(minutes: 1) # => 2015-08-01 14:36:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(hours: 1)   # => 2015-08-01 15:35:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(days: 1)    # => 2015-08-02 14:35:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(weeks: 1)   # => 2015-08-08 14:35:00 -0700
ago(seconds) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 158
def ago(seconds)
  since(-seconds)
end

Возвращает новый объект Time, представляющий время, прошедшее определённое количество секунд назад. Это по сути обёртка над расширением Numeric

all_day() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 231
def all_day
  beginning_of_day..end_of_day
end

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

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/time/calculations.rb, line 171
def beginning_of_day
  change(:hour => 0)
end

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

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

Возвращает новый объект Time, представляющий начало часа (x:00)

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

Возвращает новый объект Time, представляющий начало минуты (x:xx:00)

Также использует алиас: at_beginning_of_minute
change(options) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 95
def change(options)
  new_year  = options.fetch(:year, year)
  new_month = options.fetch(:month, month)
  new_day   = options.fetch(:day, day)
  new_hour  = options.fetch(:hour, hour)
  new_min   = options.fetch(:min, options[:hour] ? 0 : min)
  new_sec   = options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec)

  if new_nsec = options[:nsec]
    raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
    new_usec = Rational(new_nsec, 1000)
  else
    new_usec  = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))
  end

  if utc?
    ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  elsif zone
    ::Time.local(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  else
    raise ArgumentError, 'argument out of range' if new_usec >= 1000000
    ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec + (new_usec.to_r / 1000000), utc_offset)
  end
end

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

Time.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => Time.new(2012, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => Time.new(1981, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => Time.new(1981, 8, 29, 0, 0, 0)
compare_with_coercion(other) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 267
def compare_with_coercion(other)
  # we're avoiding Time#to_datetime and Time#to_time because they're expensive
  if other.class == Time
    compare_without_coercion(other)
  elsif other.is_a?(Time)
    compare_without_coercion(other.to_time)
  else
    to_datetime <=> other
  end
end

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

Также использует алиас: <=>
compare_without_coercion(other)
Алиас для: <=>
end_of_day() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 189
def end_of_day
  change(
    :hour => 23,
    :min => 59,
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

Возвращает новый объект Time, представляющий конец дня, 23:59:59.999999

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

Возвращает новый объект Time, представляющий конец часа, x:59:59.999999

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

Возвращает новый объект Time, представляющий конец минуты, x:xx:59.999999

Также алиасирован как: at_end_of_minute
eql?(other)
Также алиасирован как: eql_without_coercion
Псевдоним для: eql_with_coercion
eql_with_coercion(other) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 282
def eql_with_coercion(other)
  # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do eql? comparison
  other = other.comparable_time if other.respond_to?(:comparable_time)
  eql_without_coercion(other)
end

Добавляет дополнительное поведение к методу #eql?, чтобы объекты ActiveSupport::TimeWithZone можно было сравнить с эквивалентными объектами Time

Также алиасирован как: eql?
eql_without_coercion(other)
Псевдоним для: eql?
formatted_offset(colon = true, alternate_utc_string = nil) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/conversions.rb, line 64
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.

Time.local(2000).formatted_offset        # => "-06:00"
Time.local(2000).formatted_offset(false) # => "-0600"
in(seconds)
Псевдоним для: since
midday()
Псевдоним для: middle_of_day
middle_of_day() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 179
def middle_of_day
  change(:hour => 12)
end

Возвращает новый объект Time, представляющий полдень (12:00)

Также алиасирован как: midday, noon, at_midday, at_noon, at_middle_of_day
midnight()
Псевдоним для: beginning_of_day
minus_with_coercion(other) Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 258
def minus_with_coercion(other)
  other = other.comparable_time if other.respond_to?(:comparable_time)
  other.is_a?(DateTime) ? to_f - other.to_f : minus_without_coercion(other)
end

Оператор Time#- также используется для определения количества секунд между двумя объектами Time. Мы добавляем дополнительное поведение, чтобы объекты ActiveSupport::TimeWithZone были преобразованы в значения, которые Time#- сможет распознать

Также алиасирован как: -
minus_without_coercion(other)
Псевдоним для: -
minus_without_duration(other)
Псевдоним для: -
noon()
Псевдоним для: middle_of_day
sec_fraction() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 79
def sec_fraction
  subsec
end

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

Time.new(2012, 8, 29, 0, 0, 0.5).sec_fraction # => (1/2)
seconds_since_midnight() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 63
def seconds_since_midnight
  to_i - change(:hour => 0).to_i + (usec / 1.0e+6)
end

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

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

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

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

Возвращает новый объект Time, представляющий время, прошедшее через заданное количество секунд от текущего времени

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

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

Этот метод является алиасом для to_s.

time = Time.now                    # => 2007-01-18 06:10:17 -06:00

time.to_formatted_s(:time)         # => "06:10"
time.to_s(:time)                   # => "06:10"

time.to_formatted_s(:db)           # => "2007-01-18 06:10:17"
time.to_formatted_s(:number)       # => "20070118061017"
time.to_formatted_s(:short)        # => "18 Jan 06:10"
time.to_formatted_s(:long)         # => "January 18, 2007 06:10"
time.to_formatted_s(:long_ordinal) # => "January 18th, 2007 06:10"
time.to_formatted_s(:rfc822)       # => "Thu, 18 Jan 2007 06:10:17 -0600"
time.to_formatted_s(:iso8601)      # => "2007-01-18T06:10:17-06:00"

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

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

# config/initializers/time_formats.rb
Time::DATE_FORMATS[:month_and_year] = '%B %Y'
Time::DATE_FORMATS[:short_ordinal]  = ->(time) { time.strftime("%B #{time.day.ordinalize}") }
Также алиасирован как: to_s
to_s(format = :default)
Также алиасирован как: to_default_s
Псевдоним для: to_formatted_s
to_time() Показать исходный код
# File activesupport/lib/active_support/core_ext/time/compatibility.rb, line 11
def to_time
  preserve_timezone ? self : getlocal
end

Возвращает либо self, либо время в локальном часовом поясе системы в зависимости от настройки ActiveSupport.to_time_preserves_timezone.

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

Spec-Zone.ru

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