TimezoneParser 0.1.0

data/lib/timezone_parser/timezone.rb

@@ -0,0 +1,159 @@
+# encoding: utf-8
+
+module TimezoneParser
+    # Timezone
+    class Timezone < ZoneInfo
+
+        protected
+        @@Locales = []
+        @@Regions = []
+
+        public
+        # Locales which will be used for Timezone methods if not specified there
+        #
+        # Each locale is language identifier based on IETF BCP 47
+        # @return [Array<String>] list containing locale identifiers
+        # @see http://en.wikipedia.org/wiki/IETF_language_tag
+        # @see http://unicode.org/reports/tr35/#Unicode_Language_and_Locale_Identifiers
+        # @see http://www.unicode.org/cldr/charts/latest/supplemental/language_territory_information.html
+        def self.Locales
+            @@Locales
+        end
+
+        # Regions which will be used for Timezone methods if not specified there
+        #
+        # Each region is CLDR territory (UN M.49)
+        # @return [Array<String>] list containing region identifiers
+        # @see http://www.unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html
+        def self.Regions
+            @@Regions
+        end
+
+        attr_accessor :Locales
+        attr_accessor :Regions
+        attr_accessor :All
+
+        # Timezone instance
+        # @param timezone [String] Timezone name
+        def initialize(timezone)
+            @Timezone = timezone
+            @Data = Data.new
+            @Valid = nil
+            setTime
+            set(@@Locales.dup, @@Regions.dup, true)
+        end
+
+        # Set locales, regions and all
+        # @param locales [Array<String>] search only in these locales
+        # @param regions [Array<String>] filter for these regions
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [Timezone] self
+        def set(locales = nil, regions = nil, all = true)
+            @Locales = locales unless locales.nil?
+            @Regions = regions unless regions.nil?
+            @All = all ? true : false
+            self
+        end
+
+        # Check if timezone is valid
+        # @return [Boolean] whether timezone is valid
+        def isValid?
+            if @Valid.nil?
+                locales = @Locales
+                locales = Data::Storage.Timezones.keys if locales.empty?
+                locales.each do |locale|
+                    next unless Data::Storage.Timezones.has_key?(locale)
+                    if Data::Storage.Timezones[locale].has_key?(@Timezone)
+                        @Valid = true
+                        return @Valid
+                    end
+                end
+            end
+            @Valid = false
+        end
+
+        # Abbreviation data
+        # @return [Data] data
+        def getData
+            unless @Loaded
+                @Loaded = true
+                @Valid = false
+                locales = @Locales
+                locales = Data::Storage.Timezones.keys if locales.empty?
+                locales.each do |locale|
+                    next unless Data::Storage.Timezones.has_key?(locale)
+                    entry = Data::Storage.Timezones[locale][@Timezone]
+                    if entry
+                        @Data.processEntry(entry, @ToTime, @FromTime, @Regions)
+                        @Valid = true
+                        return @Data unless @All
+                    end
+                end
+            end
+            @Data
+        end
+
+        # Get UTC offsets in seconds
+        # @return [Array<Fixnum>] list of timezone offsets in seconds
+        def getOffsets
+            if not @Offsets and not getTimezones.empty?
+                types = [@Type] if @Type
+                @Offsets = @Data.findOffsets(@ToTime, @FromTime, @Regions, types).to_a
+            else
+                super
+            end
+            @Offsets
+        end
+
+        # Check if given Timezone name is a valid timezone
+        # @param timezone [String] Timezone name
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @return [Boolean] whether Timezone is valid
+        # @see Locales
+        def self.isValid?(timezone, locales = nil)
+            self.new(timezone).set(locales).isValid?
+        end
+
+        # Get UTC offsets in seconds for given Timezone name
+        # @param timezone [String] Timezone name
+        # @param toTime [DateTime] look for offsets which came into effect before this date, exclusive
+        # @param fromTime [DateTime] look for offsets which came into effect at this date, inclusive
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @param regions [Array<String>] look for offsets only for these regions
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [Array<Fixnum>] list of timezone offsets in seconds
+        # @see Locales
+        # @see Regions
+        def self.getOffsets(timezone, toTime = nil, fromTime = nil, locales = nil, regions = nil, all = true)
+            self.new(timezone).setTime(toTime, fromTime).set(locales, regions, all).getOffsets
+        end
+
+        # Get Timezone identifiers for given Timezone name
+        # @param timezone [String] Timezone name
+        # @param toTime [DateTime] look for timezones which came into effect before this date, exclusive
+        # @param fromTime [DateTime] look for timezones which came into effect at this date, inclusive
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @param regions [Array<String>] look for timezones only for these regions
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [Array<String>] list of timezone identifiers
+        # @see Locales
+        # @see Regions
+        def self.getTimezones(timezone, toTime = nil, fromTime = nil, locales = nil, regions = nil, all = true)
+            self.new(timezone).setTime(toTime, fromTime).set(locales, regions, all).getTimezones
+        end
+
+        # Get Metazone identifiers for given Timezone name
+        # @param timezone [String] Timezone name
+        # @param toTime [DateTime] look for timezones which came into effect before this date, exclusive
+        # @param fromTime [DateTime] look for timezones which came into effect at this date, inclusive
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @param regions [Array<String>] look for timezones only for these regions
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [Array<String>] list of metazone identifiers
+        # @see Locales
+        # @see Regions
+        def self.getMetazones(timezone, toTime = nil, fromTime = nil, locales = nil, regions = nil, all = true)
+            self.new(timezone).setTime(toTime, fromTime).set(locales, regions, all).getMetazones
+        end
+    end
+end

data/lib/timezone_parser/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+module TimezoneParser
+    # Version
+    VERSION = '0.1.0'
+end

data/lib/timezone_parser/windows_zone.rb

@@ -0,0 +1,169 @@
+# encoding: utf-8
+
+module TimezoneParser
+    # Windows Timezone data
+    class WindowsData < Data
+        protected
+        @WindowsZone = nil
+
+        public
+        attr_reader :WindowsZone
+        def processEntry(entry, region)
+            @Types += entry['Types'] if entry['Types']
+            if entry.has_key?('Metazones')
+                entry['Metazones'].each do |zone|
+                    @WindowsZone = zone
+                    @Metazones << zone
+                    @Timezones += Storage.getTimezones2(zone, region)
+                    @Offsets += Storage.getOffsets(zone, entry['Types'])
+                end
+            end
+            self
+        end
+    end
+
+    # Windows Timezone
+    class WindowsZone < ZoneInfo
+        protected
+        @@Locales = []
+        @@Regions = []
+
+        public
+        # Locales which will be used for WindowsZone methods if not specified there
+        #
+        # Each locale consists of language identifier and country/region identifier
+        # @return [Array<String>] list containing locale identifiers
+        # @see http://msdn.microsoft.com/en-us/library/dd318693.aspx
+        def self.Locales
+            @@Locales
+        end
+
+        # Regions which will be used for WindowsZone methods if not specified there
+        #
+        # Each region is either ISO 3166-1 alpha-2 code
+        # @return [Array<String>] list containing region identifiers
+        # @see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+        def self.Regions
+            @@Regions
+        end
+
+        attr_accessor :Locales
+        attr_accessor :Regions
+        attr_accessor :All
+
+        # Windows Timezone instance
+        # @param name [String] Windows Timezone name
+        def initialize(name)
+            @Name = name
+            @Data = WindowsData.new
+            @Valid = nil
+            set(@@Locales.dup, @@Regions.dup, true)
+        end
+
+        # Set locales, regions and all
+        # @param locales [Array<String>] search only in these locales
+        # @param regions [Array<String>] filter for these regions
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [WindowsZone] self
+        # @see Locales
+        # @see Regions
+        def set(locales = nil, regions = nil, all = true)
+            @Locales = locales unless locales.nil?
+            @Regions = regions unless regions.nil?
+            @All = all ? true : false
+            self
+        end
+
+        # Check if timezone is valid
+        # @return [Boolean] whether timezone is valid
+        def isValid?
+            if @Valid.nil?
+                locales = @Locales
+                locales = Data::Storage.WindowsZones.keys if locales.empty?
+                locales.each do |locale|
+                    next unless Data::Storage.WindowsZones.has_key?(locale)
+                    @Valid = Data::Storage.WindowsZones[locale].has_key?(@Name)
+                    return @Valid if @Valid
+                end
+            end
+            @Valid = false
+        end
+
+        # Windows Timezone data
+        # @return [WindowsData] data
+        def getData
+            unless @Loaded
+                @Loaded = true
+                @Valid = false
+                locales = @Locales
+                locales = Data::Storage.WindowsZones.keys if locales.empty?
+                locales.each do |locale|
+                    next unless Data::Storage.WindowsZones.has_key?(locale)
+                    entry = Data::Storage.WindowsZones[locale][@Name]
+                    if entry
+                        @Data.processEntry(entry, @Regions)
+                        @Valid = true
+                        return @Data unless @All
+                    end
+                end
+            end
+            @Data
+        end
+
+        # Windows Timezone identifier
+        # @return [String] Timezone identifier
+        def getZone
+            getData.WindowsZone
+        end
+
+        # Check if given Windows Timezone name is a valid timezone
+        # @param name [String] Windows Timezone name
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @return [Boolean] whether Timezone is valid
+        # @see Locales
+        def self.isValid?(name, locales = nil)
+            self.new(name).set(locales).isValid?
+        end
+
+        # Get UTC offsets in seconds for given Windows Timezone name
+        # @param name [String] Windows Timezone name
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [Array<Fixnum>] list of timezone offsets in seconds
+        # @see Locales
+        def self.getOffsets(name, locales = nil, all = true)
+            self.new(name).set(locales, nil, all).getOffsets
+        end
+
+        # Get Timezone identifiers for given Windows Timezone name
+        # @param name [String] Windows Timezone name
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @param regions [Array<String>] look for timezones only for these regions
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [Array<String>] list of timezone identifiers
+        # @see Locales
+        # @see Regions
+        def self.getTimezones(name, locales = nil, regions = nil, all = true)
+            self.new(name).set(locales, regions, all).getTimezones
+        end
+
+        # Get Metazone identifiers for given Windows Timezone name
+        # @param name [String] Windows Timezone name
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [Array<String>] list of metazone identifiers
+        # @see Locales
+        def self.getMetazones(name, locales = nil, all = true)
+            self.new(name).set(locales, nil, all).getMetazones
+        end
+
+        # Windows Timezone identifier
+        # @param name [String] Windows Timezone name
+        # @param locales [Array<String>] search Timezone name only for these locales
+        # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+        # @return [String] Timezone identifier
+        def self.getZone(name, locales = nil, all = true)
+            self.new(name).set(locales, nil, all).getZone
+        end
+    end
+end

data/lib/timezone_parser/zone_info.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module TimezoneParser
+    # Generic Timezone class
+    class ZoneInfo
+        protected
+        @Data = nil
+        @Loaded = false
+        @Offsets = nil
+        @Timezones = nil
+        @Metazones = nil
+
+        public
+        attr_accessor :ToTime
+        attr_accessor :FromTime
+        # Set time range
+        # @param toTime [DateTime] filter timezones before this date, exclusive
+        # @param fromTime [DateTime] filter timezones at this date, inclusive
+        # @return [ZoneInfo] self
+        def setTime(toTime = nil, fromTime = nil)
+            @ToTime = toTime
+            @ToTime = DateTime.now unless @ToTime
+            @FromTime = fromTime
+            @FromTime = DateTime.new(@ToTime.year - 1) unless @FromTime
+            self
+        end
+
+        # Get Timezone data
+        def getData
+            raise StandardError, '#getData must be implemented in subclass'
+        end
+
+        # Get UTC offsets in seconds
+        # @return [Array<Fixnum>] list of timezone offsets in seconds
+        def getOffsets
+            unless @Offsets
+                @Offsets = getData.Offsets.to_a
+            end
+            @Offsets
+        end
+
+        # Get Timezone identifiers
+        # @return [Array<String>] list of timezone identifiers
+        def getTimezones
+            unless @Timezones
+                @Timezones = getData.Timezones.to_a
+            end
+            @Timezones
+        end
+
+        # Get types
+        # @return [Symbol] types
+        def getTypes
+            unless @Types
+                @Types = getData.Types.to_a
+            end
+            @Types
+        end
+
+        # Get Metazone identifiers
+        # @return [Array<String>] list of Metazone identifiers
+        def getMetazones
+            unless @Metazones
+                @Metazones = getData.Metazones.to_a
+            end
+            @Metazones
+        end
+
+    end
+end

data/spec/abbreviation_spec.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TimezoneParser do
+    describe TimezoneParser::Abbreviation do
+        describe '#new' do
+            it 'should be an instance of a Abbreviation class' do
+                expect(TimezoneParser::Abbreviation.new('CET')).to be_an_instance_of TimezoneParser::Abbreviation
+            end
+        end
+
+        describe '#isValid?' do
+            it 'should be valid abbreviation' do
+                expect(TimezoneParser::Abbreviation.new('CET').isValid?).to be_true
+            end
+
+            it 'should not be valid abbreviation' do
+                expect(TimezoneParser::Abbreviation.new('LOL').isValid?).to be_false
+            end
+
+            it 'should be valid case-insensitive abbreviation' do
+                expect(TimezoneParser::Abbreviation.new('Pst').isValid?).to be_true
+            end
+        end
+
+        describe '#getOffsets' do
+            it 'should return offsets for CET abbreviation' do
+                expect(TimezoneParser::Abbreviation.new('CET').getOffsets).to eq([3600])
+            end
+
+            it 'should return offsets for WEZ abbreviation' do
+                expect(TimezoneParser::Abbreviation.new('WEZ').getOffsets).to eq([0, 3600])
+            end
+
+            context 'before specified time' do
+                it 'should return correct offsets for ADT' do
+                    expect(TimezoneParser::Abbreviation.new('ADT').setTime(DateTime.parse('1982-04-30T21:00:00+00:00')).getOffsets).to eq([-10800])
+                    expect(TimezoneParser::Abbreviation.new('ADT').setTime(DateTime.parse('1982-04-30T21:00:01+00:00')).getOffsets).to eq([-10800, 14400])
+                    expect(TimezoneParser::Abbreviation.new('ADT').setTime(DateTime.parse('1982-09-30T19:59:59+00:00')).getOffsets).to eq([-10800, 14400])
+                    expect(TimezoneParser::Abbreviation.new('ADT').setTime(DateTime.parse('1982-09-30T20:00:00+00:00')).getOffsets).to eq([-10800, 14400])
+                    expect(TimezoneParser::Abbreviation.new('ADT').setTime(DateTime.parse('1983-03-30T21:00:00+00:00'), DateTime.parse('1982-09-30T20:00:00+00:00')).getOffsets).to eq([-10800])
+                end
+            end
+
+            context 'between specified time' do
+                it 'should return correct offsets for SAST' do
+                    expect(TimezoneParser::Abbreviation.new('SAST').setTime(DateTime.parse('1943-09-19T00:00:00+00:00'), DateTime.parse('1943-03-20T23:00:00+00:00')).getOffsets).to eq([7200])
+                    expect(TimezoneParser::Abbreviation.new('SAST').setTime(DateTime.parse('1943-09-19T00:00:00+00:00'), DateTime.parse('1943-03-20T22:59:59+00:00')).getOffsets).to eq([7200, 10800])
+                    expect(TimezoneParser::Abbreviation.new('SAST').setTime(DateTime.parse('1943-09-19T00:00:01+00:00'), DateTime.parse('1943-03-20T23:00:00+00:00')).getOffsets).to eq([7200, 10800])
+                    expect(TimezoneParser::Abbreviation.new('SAST').setTime(DateTime.parse('1943-09-19T00:00:01+00:00'), DateTime.parse('1943-09-19T00:00:00+00:00')).getOffsets).to eq([7200, 10800])
+                    expect(TimezoneParser::Abbreviation.new('SAST').setTime(DateTime.parse('1944-03-18T23:00:00+00:00'), DateTime.parse('1944-03-18T22:59:59+00:00')).getOffsets).to eq([7200, 10800])
+                    expect(TimezoneParser::Abbreviation.new('SAST').setTime(DateTime.now, DateTime.parse('1944-03-18T23:00:00+00:00')).getOffsets).to eq([7200])
+                end
+            end
+
+            context 'in specified region' do
+                it 'should return correct offsets for ADT' do
+                    expect(TimezoneParser::Abbreviation.new('ADT').set([]).getOffsets).to eq([-10800])
+                    expect(TimezoneParser::Abbreviation.new('ADT').set(['IQ']).getOffsets).to eq([14400])
+                    expect(TimezoneParser::Abbreviation.new('ADT').set(['GL']).getOffsets).to eq([-10800])
+                    expect(TimezoneParser::Abbreviation.new('ADT').setTime(DateTime.parse('2007-10-01T00:00:00+00:00')).set(['IQ', 'CA']).getOffsets).to eq([-10800, 14400])
+                end
+            end
+
+            context 'with specified type' do
+                it 'should return correct offsets for HAT' do
+                    expect(TimezoneParser::Abbreviation.new('HAT').setTime(DateTime.parse('2014-02-05T10:00:00+00:00')).set(nil).getOffsets).to eq([-36000, -32400, -12600, -9000])
+                    expect(TimezoneParser::Abbreviation.new('HAT').setTime(DateTime.parse('2014-04-05T10:00:00+00:00')).set(nil).getOffsets).to eq([-36000, -32400, -12600, -9000])
+                    expect(TimezoneParser::Abbreviation.new('HAT').setTime(DateTime.parse('2014-02-05T10:00:00+00:00')).set(nil, :standard ).getOffsets).to eq([-36000, -12600])
+                    expect(TimezoneParser::Abbreviation.new('HAT').setTime(DateTime.parse('2014-02-05T10:00:00+00:00')).set(nil, :daylight ).getOffsets).to eq([-32400, -9000])
+                    expect(TimezoneParser::Abbreviation.new('HAT').setTime(DateTime.parse('2014-04-05T10:00:00+00:00')).set(nil, :standard ).getOffsets).to eq([-36000, -12600])
+                    expect(TimezoneParser::Abbreviation.new('HAT').setTime(DateTime.parse('2014-04-05T10:00:00+00:00')).set(nil, :daylight ).getOffsets).to eq([-32400, -9000])
+                end
+            end
+        end
+
+        describe '#getTimezones' do
+            it 'should return all timezones for KMT abbreviation' do
+                expect(TimezoneParser::Abbreviation.new('KMT').getTimezones).to eq(['Europe/Kiev'])
+            end
+
+            context 'between specified time' do
+                it 'should include correct timezones for EET' do
+                    expect(TimezoneParser::Abbreviation.new('EET').setTime(DateTime.parse('1919-04-15T00:00:00+00:00'), DateTime.parse('1918-09-16T01:00:00+00:00')).getTimezones).to include('Asia/Beirut', 'Europe/Istanbul', 'Europe/Warsaw')
+                    expect(TimezoneParser::Abbreviation.new('EET').setTime(DateTime.parse('1919-09-16T00:00:00+00:00'), DateTime.parse('1919-04-15T00:00:00+00:00')).getTimezones).to_not include('Europe/Warsaw')
+                    expect(TimezoneParser::Abbreviation.new('EET').setTime(DateTime.parse('1985-04-19T21:00:00+00:00'), DateTime.parse('1978-10-14T21:00:00+00:00')).getTimezones).to_not include('Europe/Istanbul')
+                end
+            end
+        end
+
+        describe '#getMetazones' do
+            it 'should return all metazones for HAT abbreviation' do
+                expect(TimezoneParser::Abbreviation.new('HAT').getMetazones).to eq(['Hawaii_Aleutian', 'Newfoundland'])
+            end
+        end
+
+        describe '.isValid?' do
+            it 'should be valid abbreviation' do
+                expect(TimezoneParser::Abbreviation::isValid?('WGT')).to be_true
+            end
+        end
+
+        describe '.getOffsets' do
+            it 'should return offsets for WGT abbreviation in GL region' do
+                expect(TimezoneParser::Abbreviation::getOffsets('WGT', DateTime.now, nil, ['GL'])).to eq([-10800])
+            end
+        end
+
+        describe '.getTimezones' do
+            it 'should return timezones for WGT abbreviation' do
+                expect(TimezoneParser::Abbreviation::getTimezones('WGT', DateTime.parse('1916-07-28T03:26:56+00:00'), DateTime.parse('1916-07-28T01:14:40+00:00'), ['GL'])).to eq(['America/Danmarkshavn'])
+            end
+        end
+
+        describe '.getMetazones' do
+            it 'should return metazones for HKT abbreviation' do
+                expect(TimezoneParser::Abbreviation::getMetazones('HKT')).to eq(['Hong_Kong'])
+            end
+        end
+
+    end
+end