跳至内容 跳至搜索
方法
#
A
B
C
D
E
F
I
M
N
P
R
S
T
U
Z
包含的模块

常量

COMMON_YEAR_DAYS_IN_MONTH = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
 
DATE_FORMATS = { db: "%Y-%m-%d %H:%M:%S", inspect: "%Y-%m-%d %H:%M:%S.%9N %z", number: "%Y%m%d%H%M%S", nsec: "%Y%m%d%H%M%S%9N", usec: "%Y%m%d%H%M%S%6N", time: "%H:%M", short: "%d %b %H:%M", long: "%B %d, %Y %H:%M", long_ordinal: lambda { |time| day_format = ActiveSupport::Inflector.ordinalize(time.day) time.strftime("%B #{day_format}, %Y %H:%M") }, rfc822: lambda { |time| offset_format = time.formatted_offset(false) time.strftime("%a, %d %b %Y %H:%M:%S #{offset_format}") }, iso8601: lambda { |time| time.iso8601 } }
 

属性

[RW] 时区_默认

类公共方法

===(other)

覆盖大小写相等方法,以便对 ActiveSupport::TimeWithZone 实例返回 true

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 18
def ===(other)
  super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone))
end

at(*args, **kwargs)

也别名为:at_without_coercion
别名为:at_with_coercion

at_with_coercion(*args, **kwargs)

Time.at 上分层附加行为,以便在使用单个参数调用时可以使用 ActiveSupport::TimeWithZoneDateTime 实例

也别名为:at
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 45
def at_with_coercion(*args, **kwargs)
  return at_without_coercion(*args, **kwargs) if args.size != 1 || !kwargs.empty?

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

  if time_or_number.is_a?(ActiveSupport::TimeWithZone)
    at_without_coercion(time_or_number.to_r).getlocal
  elsif 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_without_coercion(*args, **kwargs)

别名为:at

current()

当设置了 Time.zoneconfig.time_zone 时返回 Time.zone.now,否则仅返回 Time.now

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 39
def current
  ::Time.zone ? ::Time.zone.now : ::Time.now
end

days_in_month(month, year = current.year)

返回给定月份的天数。如果没有指定年份,则将使用当前年份。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 24
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 34
def days_in_year(year = current.year)
  days_in_month(2, year) + 337
end

find_zone(time_zone)

返回与提供的时区匹配的 TimeZone 实例。接受 Time.zone= 支持的任何格式的时区。对于无效时区,返回 nil

Time.find_zone "America/New_York" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
Time.find_zone "NOT-A-TIMEZONE"   # => nil
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 93
def find_zone(time_zone)
  find_zone!(time_zone) rescue nil
end

find_zone!(time_zone)

返回与提供的时区匹配的 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
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 81
def find_zone!(time_zone)
  return time_zone unless time_zone

  ActiveSupport::TimeZone[time_zone] || raise(ArgumentError, "Invalid Timezone: #{time_zone}")
end

rfc3339(str)

从 RFC 3339 字符串创建 Time 实例。

Time.rfc3339('1999-12-31T14:00:00-10:00') # => 2000-01-01 00:00:00 -1000

如果缺少时间或偏移量组件,则会引发 ArgumentError

Time.rfc3339('1999-12-31') # => ArgumentError: invalid date
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 69
def rfc3339(str)
  parts = Date._rfc3339(str)

  raise ArgumentError, "invalid date" if parts.empty?

  Time.new(
    parts.fetch(:year),
    parts.fetch(:mon),
    parts.fetch(:mday),
    parts.fetch(:hour),
    parts.fetch(:min),
    parts.fetch(:sec) + parts.fetch(:sec_fraction, 0),
    parts.fetch(:offset)
  )
end

use_zone(time_zone)

允许在提供的代码块内局部覆盖 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

注意:这不会影响任何已创建的 ActiveSupport::TimeWithZone 对象,例如,在代码块之前读取的任何模型时间戳属性都将保留在应用程序的默认时区中。

# File activesupport/lib/active_support/core_ext/time/zones.rb, line 61
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

zone()

如果已设置(通过 Time.zone=),则返回当前请求的时区。如果尚未为当前请求设置 Time.zone,则返回 config.time_zone 中指定的时区。

# File activesupport/lib/active_support/core_ext/time/zones.rb, line 14
def zone
  ::ActiveSupport::IsolatedExecutionState[:time_zone] || zone_default
end

zone=(time_zone)

Time.zone 设置为当前请求/线程的时区对象。

此方法接受以下任何一项

  • Rails 时区对象。

  • Rails 时区对象的标识符(例如,“东部 Time(美国和加拿大)”,-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
# File activesupport/lib/active_support/core_ext/time/zones.rb, line 41
def zone=(time_zone)
  ::ActiveSupport::IsolatedExecutionState[:time_zone] = find_zone!(time_zone)
end

实例公共方法

<=>(其他)

acts_like_time?()

鸭子类型作为类似时间类。参见Object#acts_like?

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

advance(选项)

使用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

就像Date#advance,增量按时间单位从大到小顺序应用。此顺序会影响月底附近的结果。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 202
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.gregorian.advance(options)
  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

ago(秒)

返回一个新的Time表示几秒钟前的时间,这基本上是Numeric扩展的包装器

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

at_beginning_of_day()

别名:beginning_of_day

at_beginning_of_hour()

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

返回一个新的 Time,表示一天的开始(0:00)

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 241
def beginning_of_day
  change(hour: 0)
end

beginning_of_hour()

返回一个新的 Time,表示一小时的开始(x:00)

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 270
def beginning_of_hour
  change(min: 0)
end

beginning_of_minute()

返回一个新的 Time,表示一分钟的开始(x:xx:00)

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 286
def beginning_of_minute
  change(sec: 0)
end

ceil(precision = 0)

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 121
def ceil(precision = 0)
  change(nsec: 0) + subsec.ceil(precision)
end

change(options)

返回一个新的 Time,其中一个或多个元素已根据 options 参数进行了更改。时间选项(:hour:min:sec:usec:nsec)级联重置,因此如果只传递小时,则分钟、秒、微秒和纳秒将设置为 0。如果传递小时和分钟,则秒、微秒和纳秒将设置为 0。options 参数采用具有以下任何键的哈希::year:month:day:hour:min:sec:usec:nsec:offset。传递 :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)
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 138
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)
  new_offset = options.fetch(:offset, nil)

  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

  raise ArgumentError, "argument out of range" if new_usec >= 1000000

  new_sec += Rational(new_usec, 1000000)

  if new_offset
    ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, new_offset)
  elsif utc?
    ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec)
  elsif zone&.respond_to?(:utc_to_local)
    new_time = ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, zone)

    # When there are two occurrences of a nominal time due to DST ending,
    # `Time.new` chooses the first chronological occurrence (the one with a
    # larger UTC offset). However, for `change`, we want to choose the
    # occurrence that matches this time's UTC offset.
    #
    # If the new time's UTC offset is larger than this time's UTC offset, the
    # new time might be a first chronological occurrence. So we add the offset
    # difference to fast-forward the new time, and check if the result has the
    # desired UTC offset (i.e. is the second chronological occurrence).
    offset_difference = new_time.utc_offset - utc_offset
    if offset_difference > 0 && (new_time_2 = new_time + offset_difference).utc_offset == utc_offset
      new_time_2
    else
      new_time
    end
  elsif zone
    ::Time.local(new_sec, new_min, new_hour, new_day, new_month, new_year, nil, nil, isdst, nil)
  else
    ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, utc_offset)
  end
end

compare_with_coercion(other)

Time#<=> 上添加了其他行为,以便 DateTimeActiveSupport::TimeWithZone 实例可以按时间顺序与 Time 进行比较

别名:<=>
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 332
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

compare_without_coercion(other)

别名:<=>

end_of_day()

返回一个表示一天结束时间的新 Time,即 23:59:59.999999

别名:at_end_of_day
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 259
def end_of_day
  change(
    hour: 23,
    min: 59,
    sec: 59,
    usec: Rational(999999999, 1000)
  )
end

end_of_hour()

返回一个表示一小时结束时间的新 Time,即 x:59:59.999999

别名:at_end_of_hour
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 276
def end_of_hour
  change(
    min: 59,
    sec: 59,
    usec: Rational(999999999, 1000)
  )
end

end_of_minute()

返回一个表示一分钟结束时间的新 Time,即 x:xx:59.999999

别名:at_end_of_minute
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 292
def end_of_minute
  change(
    sec: 59,
    usec: Rational(999999999, 1000)
  )
end

eql?(other)

eql_with_coercion(other)

Time#eql? 上添加了其他行为,以便 ActiveSupport::TimeWithZone 实例可以 eql? 等效的 Time

别名:eql?
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 347
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_without_coercion(other)

别名:eql?

floor(precision = 0)

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 112
def floor(precision = 0)
  change(nsec: 0) + subsec.floor(precision)
end

formatted_offset(colon = true, alternate_utc_string = nil)

返回一个格式化的 UTC 偏移字符串,或者如果时区已经是 UTC,则返回一个备用字符串。

Time.local(2000).formatted_offset        # => "-06:00"
Time.local(2000).formatted_offset(false) # => "-0600"
# File activesupport/lib/active_support/core_ext/time/conversions.rb, line 69
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

in(seconds)

别名:since

midday()

别名:middle_of_day

middle_of_day()

返回一个新的 Time,表示一天的中间时间(12:00)

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 249
def middle_of_day
  change(hour: 12)
end

midnight()

别名:beginning_of_day

minus_with_coercion(other)

Time#- 还可以用于确定两个 Time 实例之间的秒数。我们正在叠加其他行为,以便 ActiveSupport::TimeWithZone 实例被强制转换为 Time#- 将识别的值

别名:-
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 323
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

minus_without_coercion(other)

别名:-

minus_without_duration(other)

别名:-

next_day(days = 1)

返回指定天数后的一个新时间。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 361
def next_day(days = 1)
  advance(days: days)
end

next_month(months = 1)

返回指定月数后的一个新时间。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 371
def next_month(months = 1)
  advance(months: months)
end

next_year(years = 1)

返回指定年数后的一个新时间。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 381
def next_year(years = 1)
  advance(years: years)
end

noon()

别名:middle_of_day

prev_day(days = 1)

返回指定天数前的新的时间。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 356
def prev_day(days = 1)
  advance(days: -days)
end

prev_month(months = 1)

返回指定月数前的新的时间。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 366
def prev_month(months = 1)
  advance(months: -months)
end

prev_year(years = 1)

返回指定年数前的新的时间。

# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 376
def prev_year(years = 1)
  advance(years: -years)
end

sec_fraction()

Rational 返回秒的小数部分

Time.new(2012, 8, 29, 0, 0, 0.5).sec_fraction # => (1/2)
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 107
def sec_fraction
  subsec
end

seconds_since_midnight()

返回自 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
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 91
def seconds_since_midnight
  to_i - change(hour: 0).to_i + (usec / 1.0e+6)
end

seconds_until_end_of_day()

返回到 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
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 100
def seconds_until_end_of_day
  end_of_day.to_i - to_i
end

since(seconds)

返回一个新的 Time,表示自实例时间以来经过的秒数

别名: in
# File activesupport/lib/active_support/core_ext/time/calculations.rb, line 233
def since(seconds)
  self + seconds
rescue
  to_datetime.since(seconds)
end

to_formatted_s(format = :default)

别名:to_fs

to_fs(format = :default)

转换为格式化字符串。有关内置格式,请参见 DATE_FORMATS

此方法别名为 to_formatted_s

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

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

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

to_fs 添加您自己的时间格式

您可以向 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_formatted_s
# File activesupport/lib/active_support/core_ext/time/conversions.rb, line 53
def to_fs(format = :default)
  if formatter = DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_s
  end
end

to_time()

根据 ActiveSupport.to_time_preserves_timezone 的设置,返回 self 或本地系统时区中的时间。

# File activesupport/lib/active_support/core_ext/time/compatibility.rb, line 13
def to_time
  preserve_timezone ? self : getlocal
end