Class: ActiveSupport::TimeWithZone

Inherits:
Object
  • Object
show all
Includes:
Comparable, DateAndTime::Compatibility
Defined in:
activesupport/lib/active_support/time_with_zone.rb

Overview

Active Support Time With Zone

A Time-like class that can represent a time in any time zone. Necessary because standard Ruby Time instances are limited to UTC and the system’s ENV['TZ'] zone.

You shouldn’t ever need to create a TimeWithZone instance directly via new. Instead use methods local, parse, at, and now on TimeZone instances, and in_time_zone on Time and DateTime instances.

Time.zone = 'Eastern Time (US & Canada)'        # => 'Eastern Time (US & Canada)'
Time.zone.local(2007, 2, 10, 15, 30, 45)        # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.parse('2007-02-10 15:30:45')          # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.at(1171139445)                        # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.now                                   # => Sun, 18 May 2008 13:07:55.754107581 EDT -04:00
Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone  # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00

See Time and TimeZone for further documentation of these methods.

TimeWithZone instances implement the same API as Ruby Time instances, so that Time and TimeWithZone instances are interchangeable.

t = Time.zone.now                     # => Sun, 18 May 2008 13:27:25.031505668 EDT -04:00
t.hour                                # => 13
t.dst?                                # => true
t.utc_offset                          # => -14400
t.zone                                # => "EDT"
t.to_fs(:rfc822)                      # => "Sun, 18 May 2008 13:27:25 -0400"
t + 1.day                             # => Mon, 19 May 2008 13:27:25.031505668 EDT -04:00
t.beginning_of_year                   # => Tue, 01 Jan 2008 00:00:00.000000000 EST -05:00
t > Time.utc(1999)                    # => true
t.is_a?(Time)                         # => true
t.is_a?(ActiveSupport::TimeWithZone)  # => true

Constant Summary collapse

PRECISIONS = 
Hash.new { |h, n| h[n] = "%FT%T.%#{n}N" }

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DateAndTime::Compatibility

preserve_timezone, #preserve_timezone

Constructor Details

#initialize(utc_time, time_zone, local_time = nil, period = nil) ⇒ TimeWithZone

Returns a new instance of TimeWithZone.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 51

def initialize(utc_time, time_zone, local_time = nil, period = nil)
  @time_zone, @time = time_zone, local_time
  if utc_time
    @utc = transfer_time_values_to_utc_constructor(utc_time)
    @period = period
  else
    @utc = nil
    @period = get_period_and_ensure_valid_local_time(period)
  end
  @is_utc = zone == "UTC" || zone == "UCT"
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing ⇒ Object

Send the missing method to time instance, and wrap result in a new TimeWithZone with the existing time_zone.



565
566
567
568
569
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 565

def method_missing(...)
  wrap_with_time_zone time.__send__(...)
rescue NoMethodError => e
  raise e, e.message.sub(time.inspect, inspect).sub("Time", "ActiveSupport::TimeWithZone"), e.backtrace
end

Instance Attribute Details

#time_zone ⇒ Object (readonly)

Returns the value of attribute time_zone.



49
50
51
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 49

def time_zone
  @time_zone
end

Instance Method Details

#+(other) ⇒ Object Also known as: since, in

Adds an interval of time to the current object’s time and returns that value as a new TimeWithZone object.

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now + 1000          # => Sun, 02 Nov 2014 01:43:08.725182881 EDT -04:00

If we’re adding a Duration of variable length (i.e., years, months, days), move forward from #time, otherwise move forward from #utc, for accuracy when moving across DST boundaries.

For instance, a time + 24.hours will advance exactly 24 hours, while a time + 1.day will advance 23-25 hours, depending on the day.

now + 24.hours      # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now + 1.day         # => Mon, 03 Nov 2014 01:26:28.725182881 EST -05:00



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 310

def +(other)
  if duration_of_variable_length?(other)
    method_missing(:+, other)
  else
    begin
      result = utc + other
    rescue TypeError
      result = utc.to_datetime.since(other)
      ActiveSupport.deprecator.warn(
        "Adding an instance of #{other.class} to an instance of #{self.class} is deprecated. This behavior will raise " \
        "a `TypeError` in Rails 8.1."
      )
      result.in_time_zone(time_zone)
    end
    result.in_time_zone(time_zone)
  end
end

#-(other) ⇒ Object

Subtracts an interval of time and returns a new TimeWithZone object unless the other value acts_like? time. In which case, it will subtract the other time and return the difference in seconds as a Float.

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now - 1000          # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00

If subtracting a Duration of variable length (i.e., years, months, days), move backward from #time, otherwise move backward from #utc, for accuracy when moving across DST boundaries.

For instance, a time - 24.hours will go subtract exactly 24 hours, while a time - 1.day will subtract 23-25 hours, depending on the day.

now - 24.hours      # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now - 1.day         # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00

If both the TimeWithZone object and the other value act like Time, a Float will be returned.

Time.zone.now - 1.day.ago # => 86399.999967



353
354
355
356
357
358
359
360
361
362
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 353

def -(other)
  if other.acts_like?(:time)
    getutc - other.getutc
  elsif duration_of_variable_length?(other)
    method_missing(:-, other)
  else
    result = utc - other
    result.in_time_zone(time_zone)
  end
end

#<=>(other) ⇒ Object

Use the time in UTC for comparisons.



243
244
245
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 243

def <=>(other)
  utc <=> other
end

#acts_like_time? ⇒ Boolean

So that self acts_like?(:time).

Returns:

  • (Boolean) 


516
517
518
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 516

def acts_like_time?
  true
end

#advance(options) ⇒ Object

Uses Date to provide precise Time calculations for years, months, and days according to the proleptic Gregorian calendar. The result is returned as a new TimeWithZone object.

The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days, :hours, :minutes, :seconds.

If advancing by a value of variable length (i.e., years, weeks, months, days), move forward from #time, otherwise move forward from #utc, for accuracy when moving across DST boundaries.

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.558049687 EDT -04:00
now.advance(seconds: 1) # => Sun, 02 Nov 2014 01:26:29.558049687 EDT -04:00
now.advance(minutes: 1) # => Sun, 02 Nov 2014 01:27:28.558049687 EDT -04:00
now.advance(hours: 1)   # => Sun, 02 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(days: 1)    # => Mon, 03 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(weeks: 1)   # => Sun, 09 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(months: 1)  # => Tue, 02 Dec 2014 01:26:28.558049687 EST -05:00
now.advance(years: 1)   # => Mon, 02 Nov 2015 01:26:28.558049687 EST -05:00



442
443
444
445
446
447
448
449
450
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 442

def advance(options)
  # If we're advancing a value of variable length (i.e., years, weeks, months, days), advance from #time,
  # otherwise advance from #utc, for accuracy when moving across DST boundaries
  if options.values_at(:years, :weeks, :months, :days).any?
    method_missing(:advance, options)
  else
    utc.advance(options).in_time_zone(time_zone)
  end
end

#ago(other) ⇒ Object

Subtracts an interval of time from the current object’s time and returns the result as a new TimeWithZone object.

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now.ago(1000)       # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00

If we’re subtracting a Duration of variable length (i.e., years, months, days), move backward from #time, otherwise move backward from #utc, for accuracy when moving across DST boundaries.

For instance, time.ago(24.hours) will move back exactly 24 hours, while time.ago(1.day) will move back 23-25 hours, depending on the day.

now.ago(24.hours)   # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now.ago(1.day)      # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00



381
382
383
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 381

def ago(other)
  since(-other)
end

#as_json(options = nil) ⇒ Object

Coerces time to a string for JSON encoding. The default format is ISO 8601. You can get %Y/%m/%d %H:%M:%S +offset style by setting ActiveSupport::JSON::Encoding.use_standard_json_time_format to false.

# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").as_json
# => "2005-02-01T05:15:10.000-10:00"

# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").as_json
# => "2005/02/01 05:15:10 -1000"



178
179
180
181
182
183
184
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 178

def as_json(options = nil)
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema(ActiveSupport::JSON::Encoding.time_precision)
  else
    %(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end

#between?(min, max) ⇒ Boolean

Returns true if the current object’s time is within the specified min and max time.

Returns:

  • (Boolean) 


251
252
253
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 251

def between?(min, max)
  utc.between?(min, max)
end

#blank? ⇒ Boolean

An instance of ActiveSupport::TimeWithZone is never blank

Returns:

  • (Boolean) 


527
528
529
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 527

def blank?
  false
end

#change(options) ⇒ Object

Returns a new ActiveSupport::TimeWithZone where one or more of the elements have been changed according to the options parameter. The time options (:hour, :min, :sec, :usec, :nsec) reset cascadingly, so if only the hour is passed, then minute, sec, usec, and nsec is set to 0. If the hour and minute is passed, then sec, usec, and nsec is set to 0. The options parameter takes a hash with any of these keys: :year, :month, :day, :hour, :min, :sec, :usec, :nsec, :offset, :zone. Pass either :usec or :nsec, not both. Similarly, pass either :zone or :offset, not both.

t = Time.zone.now          # => Fri, 14 Apr 2017 11:45:15.116992711 EST -05:00
t.change(year: 2020)       # => Tue, 14 Apr 2020 11:45:15.116992711 EST -05:00
t.change(hour: 12)         # => Fri, 14 Apr 2017 12:00:00.000000000 EST -05:00
t.change(min: 30)          # => Fri, 14 Apr 2017 11:30:00.000000000 EST -05:00
t.change(offset: "-10:00") # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00
t.change(zone: "Hawaii")   # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 402

def change(options)
  if options[:zone] && options[:offset]
    raise ArgumentError, "Can't change both :offset and :zone at the same time: #{options.inspect}"
  end

  new_time = time.change(options)

  if options[:zone]
    new_zone = ::Time.find_zone(options[:zone])
  elsif options[:offset]
    new_zone = ::Time.find_zone(new_time.utc_offset)
  end

  new_zone ||= time_zone
  periods = new_zone.periods_for_local(new_time)

  self.class.new(nil, new_zone, new_time, periods.include?(period) ? period : nil)
end

#dst? ⇒ Boolean Also known as: isdst

Returns true if the current time is within Daylight Savings Time for the specified time zone.

Time.zone = 'Eastern Time (US & Canada)'    # => 'Eastern Time (US & Canada)'
Time.zone.parse("2012-5-30").dst?           # => true
Time.zone.parse("2012-11-30").dst?          # => false

Returns:

  • (Boolean) 


100
101
102
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 100

def dst?
  period.dst?
end

#encode_with(coder) ⇒ Object

:nodoc:



190
191
192
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 190

def encode_with(coder) # :nodoc:
  coder.map = { "utc" => utc, "zone" => time_zone, "time" => time }
end

#eql?(other) ⇒ Boolean

Returns true if other is equal to current object.

Returns:

  • (Boolean) 


286
287
288
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 286

def eql?(other)
  other.eql?(utc)
end

#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object

Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.

Time.zone = 'Eastern Time (US & Canada)'   # => "Eastern Time (US & Canada)"
Time.zone.now.formatted_offset(true)       # => "-05:00"
Time.zone.now.formatted_offset(false)      # => "-0500"
Time.zone = 'UTC'                          # => "UTC"
Time.zone.now.formatted_offset(true, "0")  # => "0"



131
132
133
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 131

def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

#freeze ⇒ Object 



535
536
537
538
539
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 535

def freeze
  # preload instance variables before freezing
  period; utc; time; to_datetime; to_time
  super
end

#future? ⇒ Boolean

Returns true if the current object’s time is in the future.

Returns:

  • (Boolean) 


281
282
283
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 281

def future?
  utc.future?
end

#hash ⇒ Object 



290
291
292
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 290

def hash
  utc.hash
end

#httpdate ⇒ Object

Returns a string of the object’s date and time in the format used by HTTP requests.

Time.zone.now.httpdate  # => "Tue, 01 Jan 2013 04:39:43 GMT"



198
199
200
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 198

def httpdate
  utc.httpdate
end

#in_time_zone(new_zone = ::Time.zone) ⇒ Object

Returns the simultaneous time in Time.zone, or the specified zone.



83
84
85
86
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 83

def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end

#init_with(coder) ⇒ Object

:nodoc:



186
187
188
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 186

def init_with(coder) # :nodoc:
  initialize(coder["utc"], coder["zone"], coder["time"])
end

#inspect ⇒ Object

Returns a string of the object’s date, time, zone, and offset from UTC.

Time.zone.now.inspect # => "2024-11-13 07:00:10.528054960 UTC +00:00"



146
147
148
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 146

def inspect
  "#{time.strftime('%F %H:%M:%S.%9N')} #{zone} #{formatted_offset}"
end

#is_a?(klass) ⇒ Boolean Also known as: kind_of?

Say we’re a Time to thwart type checking.

Returns:

  • (Boolean) 


521
522
523
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 521

def is_a?(klass)
  klass == ::Time || super
end

#localtime(utc_offset = nil) ⇒ Object Also known as: getlocal

Returns a Time instance of the simultaneous time in the system timezone.



89
90
91
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 89

def localtime(utc_offset = nil)
  utc.getlocal(utc_offset)
end

#marshal_dump ⇒ Object 



541
542
543
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 541

def marshal_dump
  [utc, time_zone.name, time]
end

#marshal_load(variables) ⇒ Object 



545
546
547
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 545

def marshal_load(variables)
  initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc)
end

#past? ⇒ Boolean

Returns true if the current object’s time is in the past.

Returns:

  • (Boolean) 


256
257
258
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 256

def past?
  utc.past?
end

#period ⇒ Object

Returns the underlying TZInfo::TimezonePeriod.



78
79
80
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 78

def period
  @period ||= time_zone.period_for_utc(@utc)
end

#present? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


531
532
533
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 531

def present? # :nodoc:
  true
end

#respond_to?(sym, include_priv = false) ⇒ Boolean

respond_to_missing? is not called in some cases, such as when type conversion is performed with Kernel#String

Returns:

  • (Boolean) 


551
552
553
554
555
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 551

def respond_to?(sym, include_priv = false)
  # ensure that we're not going to throw and rescue from NoMethodError in method_missing which is slow
  return false if sym.to_sym == :to_str
  super
end

#respond_to_missing?(sym, include_priv) ⇒ Boolean

Ensure proxy class responds to all methods that underlying time instance responds to.

Returns:

  • (Boolean) 


559
560
561
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 559

def respond_to_missing?(sym, include_priv)
  time.respond_to?(sym, include_priv)
end

#rfc2822 ⇒ Object Also known as: rfc822

Returns a string of the object’s date and time in the RFC 2822 standard format.

Time.zone.now.rfc2822  # => "Tue, 01 Jan 2013 04:51:39 +0000"



206
207
208
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 206

def rfc2822
  to_fs(:rfc822)
end

#strftime(format) ⇒ Object

Replaces %Z directive with +zone before passing to Time#strftime, so that zone information is correct.



237
238
239
240
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 237

def strftime(format)
  format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}")
  getlocal(utc_offset).strftime(format)
end

#time ⇒ Object

Returns a Time instance that represents the time in time_zone.



64
65
66
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 64

def time
  @time ||= incorporate_utc_offset(@utc, utc_offset)
end

#to_a ⇒ Object

Returns Array of parts of Time in sequence of [seconds, minutes, hours, day, month, year, weekday, yearday, dst?, zone].

now = Time.zone.now     # => Tue, 18 Aug 2015 02:29:27.485278555 UTC +00:00
now.to_a                # => [27, 29, 2, 18, 8, 2015, 2, 230, false, "UTC"]



465
466
467
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 465

def to_a
  [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
end

#to_datetime ⇒ Object

Returns an instance of DateTime with the timezone’s UTC offset

Time.zone.now.to_datetime                         # => Tue, 18 Aug 2015 02:32:20 +0000
Time.current.in_time_zone('Hawaii').to_datetime   # => Mon, 17 Aug 2015 16:32:20 -1000



498
499
500
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 498

def to_datetime
  @to_datetime ||= utc.to_datetime.new_offset(Rational(utc_offset, 86_400))
end

#to_f ⇒ Object

Returns the object’s date and time as a floating-point number of seconds since the Epoch (January 1, 1970 00:00 UTC).

Time.zone.now.to_f # => 1417709320.285418



473
474
475
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 473

def to_f
  utc.to_f
end

#to_fs(format = :default) ⇒ Object Also known as: to_formatted_s

Returns a string of the object’s date and time.

This method is aliased to to_formatted_s.

Accepts an optional format:

  • :default - default value, mimics Ruby Time#to_s format.

  • :db - format outputs time in UTC :db time. See Time#to_fs(:db).

  • Any key in Time::DATE_FORMATS can be used. See active_support/core_ext/time/conversions.rb.



224
225
226
227
228
229
230
231
232
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 224

def to_fs(format = :default)
  if format == :db
    utc.to_fs(format)
  elsif formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_s
  end
end

#to_i ⇒ Object Also known as: tv_sec

Returns the object’s date and time as an integer number of seconds since the Epoch (January 1, 1970 00:00 UTC).

Time.zone.now.to_i # => 1417709320



481
482
483
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 481

def to_i
  utc.to_i
end

#to_r ⇒ Object

Returns the object’s date and time as a rational number of seconds since the Epoch (January 1, 1970 00:00 UTC).

Time.zone.now.to_r # => (708854548642709/500000)



490
491
492
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 490

def to_r
  utc.to_r
end

#to_s ⇒ Object

Returns a string of the object’s date and time.



212
213
214
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 212

def to_s
  "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby Time#to_s format
end

#to_time ⇒ Object

Returns an instance of Time, either with the same timezone as self, with the same UTC offset as self or in the local system timezone depending on the setting of ActiveSupport.to_time_preserves_timezone.



505
506
507
508
509
510
511
512
513
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 505

def to_time
  if preserve_timezone == :zone
    @to_time_with_timezone ||= getlocal(time_zone)
  elsif preserve_timezone
    @to_time_with_instance_offset ||= getlocal(utc_offset)
  else
    @to_time_with_system_offset ||= getlocal
  end
end

#today? ⇒ Boolean

Returns true if the current object’s time falls within the current day.

Returns:

  • (Boolean) 


262
263
264
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 262

def today?
  time.today?
end

#tomorrow? ⇒ Boolean Also known as: next_day?

Returns true if the current object’s time falls within the next day (tomorrow).

Returns:

  • (Boolean) 


268
269
270
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 268

def tomorrow?
  time.tomorrow?
end

#utc ⇒ Object Also known as: comparable_time, getgm, getutc, gmtime

Returns a Time instance of the simultaneous time in the UTC timezone.



69
70
71
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 69

def utc
  @utc ||= incorporate_utc_offset(@time, -utc_offset)
end

#utc? ⇒ Boolean Also known as: gmt?

Returns true if the current time zone is set to UTC.

Time.zone = 'UTC'                           # => 'UTC'
Time.zone.now.utc?                          # => true
Time.zone = 'Eastern Time (US & Canada)'    # => 'Eastern Time (US & Canada)'
Time.zone.now.utc?                          # => false

Returns:

  • (Boolean) 


111
112
113
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 111

def utc?
  @is_utc
end

#utc_offset ⇒ Object Also known as: gmt_offset, gmtoff

Returns the offset from current time to UTC time in seconds.



117
118
119
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 117

def utc_offset
  period.observed_utc_offset
end

#xmlschema(fraction_digits = 0) ⇒ Object Also known as: iso8601, rfc3339

Returns a string of the object’s date and time in the ISO 8601 standard format.

Time.zone.now.xmlschema  # => "2014-12-04T11:02:37-05:00"



154
155
156
157
158
159
160
161
162
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 154

def xmlschema(fraction_digits = 0)
  if @is_utc
    utc.iso8601(fraction_digits || 0)
  else
    str = time.iso8601(fraction_digits || 0)
    str[-1] = formatted_offset(true, "Z")
    str
  end
end

#yesterday? ⇒ Boolean Also known as: prev_day?

Returns true if the current object’s time falls within the previous day (yesterday).

Returns:

  • (Boolean) 


275
276
277
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 275

def yesterday?
  time.yesterday?
end

#zone ⇒ Object

Returns the time zone abbreviation.

Time.zone = 'Eastern Time (US & Canada)'   # => "Eastern Time (US & Canada)"
Time.zone.now.zone # => "EST"



139
140
141
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 139

def zone
  period.abbreviation
end