Keys are Rails TimeZone names, values are TZInfo identifiers
Locate a specific time zone object. If the argument is a string, it is interpreted to mean the name of the timezone to locate. If it is a numeric value it is either the hour offset, or the second offset, of the timezone to find. (The first one with that offset will be returned.) Returns nil if no such time zone is known to the system.
# File lib/active_support/values/time_zone.rb, line 351 351: def [](arg) 352: case arg 353: when String 354: begin 355: lazy_zones_map[arg] ||= lookup(arg).tap { |tz| tz.utc_offset } 356: rescue TZInfo::InvalidTimezoneIdentifier 357: nil 358: end 359: when Numeric, ActiveSupport::Duration 360: arg *= 3600 if arg.abs <= 13 361: all.find { |z| z.utc_offset == arg.to_i } 362: else 363: raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}" 364: end 365: end
# File lib/active_support/values/time_zone.rb, line 316 316: def self.find_tzinfo(name) 317: TZInfo::TimezoneProxy.new(MAPPING[name] || name) 318: end
Return a TimeZone instance with the given name, or nil if no such TimeZone instance exists. (This exists to support the use of this class with the composed_of macro.)
# File lib/active_support/values/time_zone.rb, line 326 326: def new(name) 327: self[name] 328: end
Create a new TimeZone object with the given name and offset. The offset is the number of seconds that this time zone is offset from UTC (GMT). Seconds were chosen as the offset unit because that is the unit that Ruby uses to represent time zone offsets (see Time#utc_offset).
# File lib/active_support/values/time_zone.rb, line 199 199: def initialize(name, utc_offset = nil, tzinfo = nil) 200: self.class.send(:require_tzinfo) 201: 202: @name = name 203: @utc_offset = utc_offset 204: @tzinfo = tzinfo || TimeZone.find_tzinfo(name) 205: @current_period = nil 206: end
Assumes self represents an offset from UTC in seconds (as returned from Time#utc_offset) and turns this into an +HH:MM formatted string. Example:
TimeZone.seconds_to_utc_offset(-21_600) # => "-06:00"
# File lib/active_support/values/time_zone.rb, line 183 183: def self.seconds_to_utc_offset(seconds, colon = true) 184: format = colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON 185: sign = (seconds < 0 ? '-' : '+') 186: hours = seconds.abs / 3600 187: minutes = (seconds.abs % 3600) / 60 188: format % [sign, hours, minutes] 189: end
A convenience method for returning a collection of TimeZone objects for time zones in the USA.
# File lib/active_support/values/time_zone.rb, line 369 369: def us_zones 370: @us_zones ||= all.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ } 371: end
# File lib/active_support/values/time_zone.rb, line 337 337: def zones_map 338: @zones_map ||= begin 339: new_zones_names = MAPPING.keys - lazy_zones_map.keys 340: new_zones = Hash[new_zones_names.map { |place| [place, create(place)] }] 341: 342: lazy_zones_map.merge(new_zones) 343: end 344: end
# File lib/active_support/values/time_zone.rb, line 375 375: def require_tzinfo 376: require 'tzinfo' unless defined?(::TZInfo) 377: rescue LoadError 378: $stderr.puts "You don't have tzinfo installed in your application. Please add it to your Gemfile and run bundle install" 379: raise 380: end
Compare this time zone to the parameter. The two are compared first on their offsets, and then by name.
# File lib/active_support/values/time_zone.rb, line 225 225: def <=>(zone) 226: result = (utc_offset <=> zone.utc_offset) 227: result = (name <=> zone.name) if result == 0 228: result 229: end
Compare # and TZInfo identifier to a supplied regexp, returning true if a match is found.
# File lib/active_support/values/time_zone.rb, line 233 233: def =~(re) 234: return true if name =~ re || MAPPING[name] =~ re 235: end
Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from number of seconds since the Unix epoch. Example:
Time.zone = "Hawaii" # => "Hawaii" Time.utc(2000).to_f # => 946684800.0 Time.zone.at(946684800.0) # => Fri, 31 Dec 1999 14:00:00 HST -10:00
# File lib/active_support/values/time_zone.rb, line 256 256: def at(secs) 257: utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs) 258: utc.in_time_zone(self) 259: end
Returns the offset of this time zone as a formatted string, of the format “+HH:MM”.
# File lib/active_support/values/time_zone.rb, line 219 219: def formatted_offset(colon=true, alternate_utc_string = nil) 220: utc_offset == 0 && alternate_utc_string || self.class.seconds_to_utc_offset(utc_offset, colon) 221: end
Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from given values. Example:
Time.zone = "Hawaii" # => "Hawaii" Time.zone.local(2007, 2, 1, 15, 30, 45) # => Thu, 01 Feb 2007 15:30:45 HST -10:00
# File lib/active_support/values/time_zone.rb, line 246 246: def local(*args) 247: time = Time.utc_time(*args) 248: ActiveSupport::TimeWithZone.new(nil, self, time) 249: end
Adjust the given time to the simultaneous time in UTC. Returns a Time.utc() instance.
# File lib/active_support/values/time_zone.rb, line 302 302: def local_to_utc(time, dst=true) 303: tzinfo.local_to_utc(time, dst) 304: end
Returns an ActiveSupport::TimeWithZone instance representing the current time in the time zone represented by self. Example:
Time.zone = 'Hawaii' # => "Hawaii" Time.zone.now # => Wed, 23 Jan 2008 20:24:27 HST -10:00
# File lib/active_support/values/time_zone.rb, line 286 286: def now 287: Time.now.utc.in_time_zone(self) 288: end
Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from parsed string. Example:
Time.zone = "Hawaii" # => "Hawaii" Time.zone.parse('1999-12-31 14:00:00') # => Fri, 31 Dec 1999 14:00:00 HST -10:00
If upper components are missing from the string, they are supplied from TimeZone#now:
Time.zone.now # => Fri, 31 Dec 1999 14:00:00 HST -10:00 Time.zone.parse('22:30:00') # => Fri, 31 Dec 1999 22:30:00 HST -10:00
# File lib/active_support/values/time_zone.rb, line 270 270: def parse(str, now=now) 271: date_parts = Date._parse(str) 272: return if date_parts.blank? 273: time = Time.parse(str, now) rescue DateTime.parse(str) 274: if date_parts[:offset].nil? 275: ActiveSupport::TimeWithZone.new(nil, self, time) 276: else 277: time.in_time_zone(self) 278: end 279: end
Available so that TimeZone instances respond like TZInfo::Timezone instances
# File lib/active_support/values/time_zone.rb, line 312 312: def period_for_local(time, dst=true) 313: tzinfo.period_for_local(time, dst) 314: end
Available so that TimeZone instances respond like TZInfo::Timezone instances
# File lib/active_support/values/time_zone.rb, line 307 307: def period_for_utc(time) 308: tzinfo.period_for_utc(time) 309: end
Returns a textual representation of this time zone.
# File lib/active_support/values/time_zone.rb, line 238 238: def to_s 239: "(GMT#{formatted_offset}) #{name}" 240: end
Return the current date in this time zone.
# File lib/active_support/values/time_zone.rb, line 291 291: def today 292: tzinfo.now.to_date 293: end
# File lib/active_support/values/time_zone.rb, line 208 208: def utc_offset 209: if @utc_offset 210: @utc_offset 211: else 212: @current_period ||= tzinfo.try(:current_period) 213: @current_period.try(:utc_offset) 214: end 215: end
Adjust the given time to the simultaneous time in the time zone represented by self. Returns a Time.utc() instance — if you want an ActiveSupport::TimeWithZone instance, use Time#in_time_zone() instead.
# File lib/active_support/values/time_zone.rb, line 297 297: def utc_to_local(time) 298: tzinfo.utc_to_local(time) 299: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.