tzinfo 1.2.10 → 2.0.6

data/lib/tzinfo/datetime_with_offset.rb

@@ -0,0 +1,153 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'date'
+
+module TZInfo
+  # A subclass of `DateTime` used to represent local times. {DateTimeWithOffset}
+  # holds a reference to the related {TimezoneOffset} and overrides various
+  # methods to return results appropriate for the {TimezoneOffset}. Certain
+  # operations will clear the associated {TimezoneOffset} (if the
+  # {TimezoneOffset} would not necessarily be valid for the result). Once the
+  # {TimezoneOffset} has been cleared, {DateTimeWithOffset} behaves identically
+  # to `DateTime`.
+  #
+  # Arithmetic performed on {DateTimeWithOffset} instances is _not_ time
+  # zone-aware. Regardless of whether transitions in the time zone are crossed,
+  # results of arithmetic operations will always maintain the same offset from
+  # UTC (`offset`). The associated {TimezoneOffset} will aways be cleared.
+  class DateTimeWithOffset < DateTime
+    include WithOffset
+
+    # @return [TimezoneOffset] the {TimezoneOffset} associated with this
+    #   instance.
+    attr_reader :timezone_offset
+
+    # Sets the associated {TimezoneOffset}.
+    #
+    # @param timezone_offset [TimezoneOffset] a {TimezoneOffset} valid at the
+    #   time and for the offset of this {DateTimeWithOffset}.
+    # @return [DateTimeWithOffset] `self`.
+    # @raise [ArgumentError] if `timezone_offset` is `nil`.
+    # @raise [ArgumentError] if `timezone_offset.observed_utc_offset` does not
+    #   equal `self.offset * 86400`.
+    def set_timezone_offset(timezone_offset)
+      raise ArgumentError, 'timezone_offset must be specified' unless timezone_offset
+      raise ArgumentError, 'timezone_offset.observed_utc_offset does not match self.utc_offset' if offset * 86400 != timezone_offset.observed_utc_offset
+      @timezone_offset = timezone_offset
+      self
+    end
+
+    # An overridden version of `DateTime#to_time` that, if there is an
+    # associated {TimezoneOffset}, returns a {DateTimeWithOffset} with that
+    # offset.
+    #
+    # @return [Time] if there is an associated {TimezoneOffset}, a
+    #   {TimeWithOffset} representation of this {DateTimeWithOffset}, otherwise
+    #   a `Time` representation.
+    def to_time
+      if_timezone_offset(super) do |o,t|
+        # Ruby 2.4.0 changed the behaviour of to_time so that it preserves the
+        # offset instead of converting to the system local timezone.
+        #
+        # When self has an associated TimezonePeriod, this implementation will
+        # preserve the offset on all versions of Ruby.
+        TimeWithOffset.at(t.to_i, t.subsec * 1_000_000).set_timezone_offset(o)
+      end
+    end
+
+    # An overridden version of `DateTime#downto` that clears the associated
+    # {TimezoneOffset} of the returned or yielded instances.
+    def downto(min)
+      if block_given?
+        super {|dt| yield dt.clear_timezone_offset }
+      else
+        enum = super
+        enum.each {|dt| dt.clear_timezone_offset }
+        enum
+      end
+    end
+
+    # An overridden version of `DateTime#england` that preserves the associated
+    # {TimezoneOffset}.
+    #
+    # @return [DateTime]
+    def england
+      # super doesn't call #new_start on MRI, so each method has to be
+      # individually overridden.
+      if_timezone_offset(super) {|o,dt| dt.set_timezone_offset(o) }
+    end
+
+    # An overridden version of `DateTime#gregorian` that preserves the
+    # associated {TimezoneOffset}.
+    #
+    # @return [DateTime]
+    def gregorian
+      # super doesn't call #new_start on MRI, so each method has to be
+      # individually overridden.
+      if_timezone_offset(super) {|o,dt| dt.set_timezone_offset(o) }
+    end
+
+    # An overridden version of `DateTime#italy` that preserves the associated
+    # {TimezoneOffset}.
+    #
+    # @return [DateTime]
+    def italy
+      # super doesn't call #new_start on MRI, so each method has to be
+      # individually overridden.
+      if_timezone_offset(super) {|o,dt| dt.set_timezone_offset(o) }
+    end
+
+    # An overridden version of `DateTime#julian` that preserves the associated
+    # {TimezoneOffset}.
+    #
+    # @return [DateTime]
+    def julian
+      # super doesn't call #new_start on MRI, so each method has to be
+      # individually overridden.
+      if_timezone_offset(super) {|o,dt| dt.set_timezone_offset(o) }
+    end
+
+    # An overridden version of `DateTime#new_start` that preserves the
+    # associated {TimezoneOffset}.
+    #
+    # @return [DateTime]
+    def new_start(start = Date::ITALY)
+      if_timezone_offset(super) {|o,dt| dt.set_timezone_offset(o) }
+    end
+
+    # An overridden version of `DateTime#step` that clears the associated
+    # {TimezoneOffset} of the returned or yielded instances.
+    def step(limit, step = 1)
+      if block_given?
+        super {|dt| yield dt.clear_timezone_offset }
+      else
+        enum = super
+        enum.each {|dt| dt.clear_timezone_offset }
+        enum
+      end
+    end
+
+    # An overridden version of `DateTime#upto` that clears the associated
+    # {TimezoneOffset} of the returned or yielded instances.
+    def upto(max)
+      if block_given?
+        super {|dt| yield dt.clear_timezone_offset }
+      else
+        enum = super
+        enum.each {|dt| dt.clear_timezone_offset }
+        enum
+      end
+    end
+
+    protected
+
+    # Clears the associated {TimezoneOffset}.
+    #
+    # @return [DateTimeWithOffset] `self`.
+    def clear_timezone_offset
+      @timezone_offset = nil
+      self
+    end
+  end
+end

data/lib/tzinfo/format1/country_definer.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+module TZInfo
+  module Format1
+    # Instances of {Format1::CountryDefiner} are yielded to the format 1 version
+    # of `TZInfo::Data::Indexes::Countries` by {CountryIndexDefinition} to allow
+    # the zones of a country to be specified.
+    #
+    # @private
+    class CountryDefiner < Format2::CountryDefiner #:nodoc:
+      # Initializes a new {CountryDefiner}.
+      def initialize(identifier_deduper, description_deduper)
+        super(nil, identifier_deduper, description_deduper)
+      end
+    end
+  end
+end

data/lib/tzinfo/format1/country_index_definition.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+
+module TZInfo
+  module Format1
+    # The format 1 TZInfo::Data country index file includes
+    # {Format1::CountryIndexDefinition}, which provides a
+    # {CountryIndexDefinition::ClassMethods#country country} method used to
+    # define each country in the index.
+    #
+    # @private
+    module CountryIndexDefinition #:nodoc:
+      # Adds class methods to the includee and initializes class instance
+      # variables.
+      #
+      # @param base [Module] the includee.
+      def self.append_features(base)
+        super
+        base.extend(ClassMethods)
+        base.instance_eval { @countries = {} }
+      end
+
+      # Class methods for inclusion.
+      #
+      # @private
+      module ClassMethods #:nodoc:
+        # @return [Hash<String, DataSources::CountryInfo>] a frozen `Hash`
+        #   of all the countries that have been defined in the index keyed by
+        #   their codes.
+        def countries
+          @description_deduper = nil
+          @countries.freeze
+        end
+
+        private
+
+        # Defines a country with an ISO 3166-1 alpha-2 country code and name.
+        #
+        # @param code [String] the ISO 3166-1 alpha-2 country code.
+        # @param name [String] the name of the country.
+        # @yield [definer] (optional) to obtain the time zones for the country.
+        # @yieldparam definer [CountryDefiner] a {CountryDefiner} instance.
+        def country(code, name)
+          @description_deduper ||= StringDeduper.new
+
+          zones = if block_given?
+            definer = CountryDefiner.new(StringDeduper.global, @description_deduper)
+            yield definer
+            definer.timezones
+          else
+            []
+          end
+
+          @countries[code.freeze] = DataSources::CountryInfo.new(code, name, zones)
+        end
+      end
+    end
+  end
+
+  # Alias used by TZInfo::Data format1 releases.
+  #
+  # @private
+  CountryIndexDefinition = Format1::CountryIndexDefinition #:nodoc:
+  private_constant :CountryIndexDefinition
+end

data/lib/tzinfo/format1/timezone_definer.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module TZInfo
+  module Format1
+    # Instances of {Format1::TimezoneDefiner} are yielded to TZInfo::Data
+    # format 1 modules by {TimezoneDefinition} to allow the offsets and
+    # transitions of the time zone to be specified.
+    #
+    # @private
+    class TimezoneDefiner < Format2::TimezoneDefiner #:nodoc:
+      undef_method :subsequent_rules
+
+      # Defines an offset.
+      #
+      # @param id [Symbol] an arbitrary value used identify the offset in
+      #   subsequent calls to transition. It must be unique.
+      # @param utc_offset [Integer] the base offset from UTC of the zone in
+      #   seconds. This does not include daylight savings time.
+      # @param std_offset [Integer] the daylight savings offset from the base
+      #   offset in seconds. Typically either 0 or 3600.
+      # @param abbreviation [Symbol] an abbreviation for the offset, for
+      #   example, `:EST` or `:EDT`.
+      # @raise [ArgumentError] if another offset has already been defined with
+      #   the given id.
+      def offset(id, utc_offset, std_offset, abbreviation)
+        super(id, utc_offset, std_offset, abbreviation.to_s)
+      end
+
+      # Defines a transition to a given offset.
+      #
+      # Transitions must be defined in increasing time order.
+      #
+      # @param year [Integer] the UTC year in which the transition occurs. Used
+      #   in earlier versions of TZInfo, but now ignored.
+      # @param month [Integer] the UTC month in which the transition occurs.
+      #   Used in earlier versions of TZInfo, but now ignored.
+      # @param offset_id [Symbol] references the id of a previously defined
+      #   offset (see #offset).
+      # @param timestamp_value [Integer] the time the transition occurs as an
+      #   Integer number of seconds since 1970-01-01 00:00:00 UTC ignoring leap
+      #   seconds (i.e. each day is treated as if it were 86,400 seconds long).
+      # @param datetime_numerator [Integer] the time of the transition as the
+      #   numerator of the `Rational` returned by `DateTime#ajd`. Used in
+      #   earlier versions of TZInfo, but now ignored.
+      # @param datetime_denominator [Integer] the time of the transition as the
+      #   denominator of the `Rational` returned by `DateTime#ajd`. Used in
+      #   earlier versions of TZInfo, but now ignored.
+      # @raise [ArgumentError] if `offset_id` does not reference a defined
+      #   offset.
+      # @raise [ArgumentError] if `timestamp_value` is not greater than the
+      #   `timestamp_value` of the previously defined transition.
+      # @raise [ArgumentError] if `datetime_numerator` is specified, but
+      #   `datetime_denominator` is not. In older versions of TZInfo, it was
+      #   possible to define a transition with the `DateTime` numerator as the
+      #   4th parameter and the denominator as the 5th parameter. This style of
+      #   definition is not used in released versions of TZInfo::Data.
+      def transition(year, month, offset_id, timestamp_value, datetime_numerator = nil, datetime_denominator = nil)
+        raise ArgumentError, 'DateTime-only transitions are not supported' if datetime_numerator && !datetime_denominator
+        super(offset_id, timestamp_value)
+      end
+    end
+  end
+end

data/lib/tzinfo/format1/timezone_definition.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+module TZInfo
+  module Format1
+    # {Format1::TimezoneDefinition} is included into format 1 time zone
+    # definition modules and provides the methods for defining time zones.
+    #
+    # @private
+    module TimezoneDefinition #:nodoc:
+      # Adds class methods to the includee.
+      #
+      # @param base [Module] the includee.
+      def self.append_features(base)
+        super
+        base.extend(Format2::TimezoneDefinition::ClassMethods)
+        base.extend(ClassMethods)
+      end
+
+      # Class methods for inclusion.
+      #
+      # @private
+      module ClassMethods #:nodoc:
+        private
+
+        # @return the class to be instantiated and yielded by
+        # {Format2::TimezoneDefinition::ClassMethods#timezone}.
+        def timezone_definer_class
+          TimezoneDefiner
+        end
+      end
+    end
+  end
+
+  # Alias used by TZInfo::Data format1 releases.
+  #
+  # @private
+  TimezoneDefinition = Format1::TimezoneDefinition #:nodoc:
+  private_constant :TimezoneDefinition
+end

data/lib/tzinfo/format1/timezone_index_definition.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+
+module TZInfo
+  module Format1
+    # The format 1 TZInfo::Data time zone index file includes
+    # {Format1::TimezoneIndexDefinition}, which provides methods used to define
+    # time zones in the index.
+    #
+    # @private
+    module TimezoneIndexDefinition #:nodoc:
+      # Adds class methods to the includee and initializes class instance
+      # variables.
+      #
+      # @param base [Module] the includee.
+      def self.append_features(base)
+        super
+        base.extend(ClassMethods)
+        base.instance_eval do
+          @timezones = []
+          @data_timezones = []
+          @linked_timezones = []
+        end
+      end
+
+      # Class methods for inclusion.
+      #
+      # @private
+      module ClassMethods #:nodoc:
+        # @return [Array<String>] a frozen `Array` containing the identifiers of
+        #   all data time zones. Identifiers are sorted according to
+        #   `String#<=>`.
+        def data_timezones
+          unless @data_timezones.frozen?
+            @data_timezones = @data_timezones.sort.freeze
+          end
+          @data_timezones
+        end
+
+        # @return [Array<String>] a frozen `Array` containing the identifiers of
+        #   all linked time zones. Identifiers are sorted according to
+        #   `String#<=>`.
+        def linked_timezones
+          unless @linked_timezones.frozen?
+            @linked_timezones = @linked_timezones.sort.freeze
+          end
+          @linked_timezones
+        end
+
+        private
+
+        # Adds a data time zone to the index.
+        #
+        # @param identifier [String] the time zone identifier.
+        def timezone(identifier)
+          identifier = StringDeduper.global.dedupe(identifier)
+          @timezones << identifier
+          @data_timezones << identifier
+        end
+
+        # Adds a linked time zone to the index.
+        #
+        # @param identifier [String] the time zone identifier.
+        def linked_timezone(identifier)
+          identifier = StringDeduper.global.dedupe(identifier)
+          @timezones << identifier
+          @linked_timezones << identifier
+        end
+      end
+    end
+  end
+
+  # Alias used by TZInfo::Data format 1 releases.
+  #
+  # @private
+  TimezoneIndexDefinition = Format1::TimezoneIndexDefinition #:nodoc:
+  private_constant :TimezoneIndexDefinition
+end

data/lib/tzinfo/format1.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+module TZInfo
+  # Modules and classes used by the format 1 version of TZInfo::Data.
+  #
+  # @private
+  module Format1 #:nodoc:
+  end
+  private_constant :Format1
+end

data/lib/tzinfo/format2/country_definer.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module TZInfo
+  module Format2
+    # Instances of {Format2::CountryDefiner} are yielded to the format 2 version
+    # of `TZInfo::Data::Indexes::Countries` by {CountryIndexDefiner} to allow
+    # the zones of a country to be specified.
+    #
+    # @private
+    class CountryDefiner #:nodoc:
+      # @return [Array<CountryTimezone>] the time zones observed in the country.
+      attr_reader :timezones
+
+      # Initializes a new {CountryDefiner}.
+      #
+      # @param shared_timezones [Hash<Symbol, CountryTimezone>] a `Hash`
+      #   containing time zones shared by more than one country, keyed by a
+      #   unique reference.
+      # @param identifier_deduper [StringDeduper] a {StringDeduper} instance to
+      #   use when deduping time zone identifiers.
+      # @param description_deduper [StringDeduper] a {StringDeduper} instance to
+      #   use when deduping time zone descriptions.
+      def initialize(shared_timezones, identifier_deduper, description_deduper)
+        @shared_timezones = shared_timezones
+        @identifier_deduper = identifier_deduper
+        @description_deduper = description_deduper
+        @timezones = []
+      end
+
+      # @overload timezone(reference)
+      #   Defines a time zone of a country as a reference to a pre-defined
+      #   shared time zone.
+      #   @param reference [Symbol] a reference for a pre-defined shared time
+      #     zone.
+      # @overload timezone(identifier, latitude_numerator, latitude_denominator, longitude_numerator, longitude_denominator, description)
+      #   Defines a (non-shared) time zone of a country. The latitude and
+      #   longitude are given as the numerator and denominator of a `Rational`.
+      #   @param identifier [String] the time zone identifier.
+      #   @param latitude_numerator [Integer] the numerator of the latitude.
+      #   @param latitude_denominator [Integer] the denominator of the latitude.
+      #   @param longitude_numerator [Integer] the numerator of the longitude.
+      #   @param longitude_denominator [Integer] the denominator of the
+      #     longitude.
+      #   @param description [String] an optional description for the time zone.
+      def timezone(identifier_or_reference, latitude_numerator = nil,
+                  latitude_denominator = nil, longitude_numerator = nil,
+                  longitude_denominator = nil, description = nil)
+        if latitude_numerator
+          unless latitude_denominator && longitude_numerator && longitude_denominator
+            raise ArgumentError, 'Either just a reference should be supplied, or the identifier, latitude and longitude must all be specified'
+          end
+
+          # Dedupe non-frozen literals from format 1 on all Ruby versions and
+          # format 2 on Ruby < 2.3 (without frozen_string_literal support).
+
+          @timezones << CountryTimezone.new(@identifier_deduper.dedupe(identifier_or_reference),
+            Rational(latitude_numerator, latitude_denominator),
+            Rational(longitude_numerator, longitude_denominator), description && @description_deduper.dedupe(description))
+        else
+          shared_timezone = @shared_timezones[identifier_or_reference]
+          raise ArgumentError, "Unknown shared timezone: #{identifier_or_reference}" unless shared_timezone
+          @timezones << shared_timezone
+        end
+      end
+    end
+  end
+end

data/lib/tzinfo/format2/country_index_definer.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+
+module TZInfo
+  module Format2
+    # Instances of {Format2::CountryIndexDefiner} are yielded to the format 2
+    # version of `TZInfo::Data::Indexes::Countries` by {CountryIndexDefinition}
+    # to allow countries and their time zones to be specified.
+    #
+    # @private
+    class CountryIndexDefiner #:nodoc:
+      # @return [Hash<String, CountryInfo>] a `Hash` of all the countries that
+      #     have been defined in the index keyed by their codes.
+      attr_reader :countries
+
+      # Initializes a new {CountryIndexDefiner}.
+      #
+      # @param identifier_deduper [StringDeduper] a {StringDeduper} instance to
+      #   use when deduping time zone identifiers.
+      # @param description_deduper [StringDeduper] a {StringDeduper} instance to
+      #   use when deduping time zone descriptions.
+      def initialize(identifier_deduper, description_deduper)
+        @identifier_deduper = identifier_deduper
+        @description_deduper = description_deduper
+        @shared_timezones = {}
+        @countries = {}
+      end
+
+      # Defines a time zone shared by many countries with an reference for
+      # subsequent use in country definitions. The latitude and longitude are
+      # given as the numerator and denominator of a `Rational`.
+      #
+      # @param reference [Symbol] a unique reference for the time zone.
+      # @param identifier [String] the time zone identifier.
+      # @param latitude_numerator [Integer] the numerator of the latitude.
+      # @param latitude_denominator [Integer] the denominator of the latitude.
+      # @param longitude_numerator [Integer] the numerator of the longitude.
+      # @param longitude_denominator [Integer] the denominator of the longitude.
+      # @param description [String] an optional description for the time zone.
+      def timezone(reference, identifier, latitude_numerator, latitude_denominator,
+                    longitude_numerator, longitude_denominator, description = nil)
+        # Dedupe non-frozen literals from format 1 on all Ruby versions and
+        # format 2 on Ruby < 2.3 (without frozen_string_literal support).
+        @shared_timezones[reference] = CountryTimezone.new(@identifier_deduper.dedupe(identifier),
+          Rational(latitude_numerator, latitude_denominator),
+          Rational(longitude_numerator, longitude_denominator), description && @description_deduper.dedupe(description))
+      end
+
+      # Defines a country.
+      #
+      # @param code [String] The ISO 3166-1 alpha-2 code of the country.
+      # @param name [String] Then name of the country.
+      # @yield [definer] yields (optional) to obtain the time zones for the
+      #   country.
+      # @yieldparam definer [CountryDefiner] a {CountryDefiner}
+      #   instance that should be used to specify the time zones of the country.
+      def country(code, name)
+        timezones = if block_given?
+          definer = CountryDefiner.new(@shared_timezones, @identifier_deduper, @description_deduper)
+          yield definer
+          definer.timezones
+        else
+          []
+        end
+        @countries[code.freeze] = DataSources::CountryInfo.new(code, name, timezones)
+      end
+    end
+  end
+end

data/lib/tzinfo/format2/country_index_definition.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+module TZInfo
+  module Format2
+    # The format 2 country index file includes
+    # {Format2::CountryIndexDefinition}, which provides a
+    # {CountryIndexDefinition::ClassMethods#country_index country_index} method
+    # used to define the country index.
+    #
+    # @private
+    module CountryIndexDefinition #:nodoc:
+      # Adds class methods to the includee and initializes class instance
+      # variables.
+      #
+      # @param base [Module] the includee.
+      def self.append_features(base)
+        super
+        base.extend(ClassMethods)
+        base.instance_eval { @countries = {}.freeze }
+      end
+
+      # Class methods for inclusion.
+      #
+      # @private
+      module ClassMethods #:nodoc:
+        # @return [Hash<String, DataSources::CountryInfo>] a frozen `Hash`
+        #   of all the countries that have been defined in the index keyed by
+        #   their codes.
+        attr_reader :countries
+
+        private
+
+        # Defines the index.
+        #
+        # @yield [definer] yields to allow the index to be defined.
+        # @yieldparam definer [CountryIndexDefiner] a {CountryIndexDefiner}
+        #   instance that should be used to define the index.
+        def country_index
+          definer = CountryIndexDefiner.new(StringDeduper.global, StringDeduper.new)
+          yield definer
+          @countries = definer.countries.freeze
+        end
+      end
+    end
+  end
+end