TimezoneParser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 283ce418cd48824722fa6ec6ee89a6edf454a4b8
+  data.tar.gz: f7a5c691908249119b2408624421b6f0d072f9c1
+SHA512:
+  metadata.gz: 27f8e4337def4fabed6c8217586c16757ace85bf6846de00f800f359bb590183c43bac98a7c783e1aeff1deb9efb63d9def216ffeed8c0aa42bfc7158b308dcf
+  data.tar.gz: 8bfd9f2032bb67c576a4d6e60a66a0c90ee8833e1e2b2adad0b8f7fc6d26c5f080c7ed3ad226165f01259f8901a0689aadda65ad1b548ca76586e7f055511e5f

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+vendor/
+tmp
+/data/*.dat

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+    gem 'redcarpet',  :platforms => [:ruby, :mswin, :mingw]
+    gem 'kramdown',   :platforms => :jruby
+    gem 'coveralls',  require: false if ENV['CI']
+end
+
+# Specify your gem's dependencies in TimezoneParser.gemspec
+gemspec

data/README.md

@@ -0,0 +1,133 @@
+# TimezoneParser
+
+## Probably the best, most complete Timezone parsing library ever made!
+
+Library for parsing Timezone names and abbreviations to corresponding UTC offsets and much more. Supports multiple languages.
+
+## Features
+
+* Parse Timezone name to UTC offset
+* Support for all TZ database abbreviations
+* Ruby on Rails Timezone names supported
+* Recognition of localized timezone names
+* Check if string is a valid Timezone or abbreviation
+* Present and Historical Timezones and offsets
+* Filter results by Time, Region, Locale and DST
+
+
+Input formats:
+
+* Timezone abbreviations (eg. "EST")
+* Timezone names (eg. "China Summer Time")
+* Localized Timezone names in different languages (eg. "阿尤恩")
+* Windows zone names (eg. "Azerbaijan Summer Time")
+* Localized Windows zone names (eg. "كوريا - التوقيت الرسمي")
+* Ruby on Rails Timezone names (eg. "Eastern Time (US & Canada)")
+* Translated Ruby on Rails Timezone names (eg. "노보시비르스크")
+
+
+Output formats:
+
+* UTC offsets (eg. "-18000")
+* Timezone identifiers (eg. "Europe/Istanbul")
+* Original Zone (eg. "Mid-Atlantic Standard Time")
+* Metazones (eg. "North_Mariana")
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'TimezoneParser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install TimezoneParser
+
+
+### Dependencies
+
+* tzinfo (only required for Timezone offsets in some cases)
+* insensitive_hash
+
+## Usage Example
+
+### To get UTC offsets from Timezone abbreviations
+
+```ruby
+> require 'timezone_parser'
+=> true
+> offsets = TimezoneParser::Abbreviation.new('FKT').getOffsets
+=> [-14400]
+> offsets.first
+=> -14400
+```
+
+### Timezone name to Timezone identifier
+
+```ruby
+> TimezoneParser::Timezone.new('Nord-Marianene-tid').getTimezones
+=> ["Pacific/Saipan"]
+```
+
+### Localized Windows zone to original Windows zone identifier
+
+```ruby
+> TimezoneParser::WindowsZone.new('Jerusalem (normaltid)').getZone
+=> "Israel Standard Time"
+```
+
+### Find actual Timezones from uknown platform-dependent Ruby zone
+
+```ruby
+> tz = Time.now.zone # on localized Windows
+=> "FLE standarta laiks"
+> TimezoneParser::getTimezones(tz)
+=> ["Europe/Helsinki", "Europe/Kiev", "Europe/Mariehamn", "Europe/Riga", "Europe/Simferopol", "Europe/Sofia", "Europe/Tallinn", "Europe/Uzhgorod", "Europe/Vilnius", "Europe/Zaporozhye"]
+```
+
+## Documentation
+
+YARD with markdown is used for documentation (`redcarpet` required)
+
+## Specs
+
+RSpec and simplecov are required, to run tests just `rake spec`
+code coverage will also be generated
+
+## Code status
+[![Gem Version](https://badge.fury.io/rb/TimezoneParser.png)](http://badge.fury.io/rb/TimezoneParser)
+[![Build Status](https://travis-ci.org/davispuh/TimezoneParser.png?branch=master)](https://travis-ci.org/davispuh/TimezoneParser)
+[![Dependency Status](https://gemnasium.com/davispuh/TimezoneParser.png)](https://gemnasium.com/davispuh/TimezoneParser)
+[![Coverage Status](https://coveralls.io/repos/davispuh/TimezoneParser/badge.png)](https://coveralls.io/r/davispuh/TimezoneParser)
+[![Code Climate](https://codeclimate.com/github/davispuh/TimezoneParser.png)](https://codeclimate.com/github/davispuh/TimezoneParser)
+
+## Unlicense
+
+![Copyright-Free](http://unlicense.org/pd-icon.png)
+
+All text, documentation, code and files in this repository are in public domain (including this text, README).
+It means you can copy, modify, distribute and include in your own work/code, even for commercial purposes, all without asking permission.
+
+[About Unlicense](http://unlicense.org/)
+
+## Contributing
+
+Feel free to improve as you see.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+**Warning**: By sending pull request to this repository you dedicate any and all copyright interest in pull request (code files and all other) to the public domain. (files will be in public domain even if pull request doesn't get merged)
+
+Also before sending pull request you acknowledge that you own all copyrights or have authorization to dedicate them to public domain.
+
+If you don't want to dedicate code to public domain or if you're not allowed to (eg. you don't own required copyrights) then DON'T send pull request.

data/Rakefile

@@ -0,0 +1,160 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yaml'
+require 'pathname'
+require 'timezone_parser/data'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+end
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+def data_location
+    TimezoneParser::Data::DataDir
+end
+
+def vendor_location
+    TimezoneParser::Data::VendorDir
+end
+
+def repo_location
+    TimezoneParser::Data::RootDir.parent.parent
+end
+
+def update
+    require 'timezone_parser/data/tzinfo'
+    require 'timezone_parser/data/cldr'
+    require 'active_support/time'
+    TimezoneParser::TZInfo::init
+    countries = TimezoneParser::TZInfo::getTimezoneCountries
+    abbreviations = TimezoneParser::TZInfo::getAbbreviations
+    timezones = TimezoneParser::CLDR::getTimezones
+    metazones = TimezoneParser::CLDR::getMetazones
+    windowsZones = TimezoneParser::CLDR::getWindowsZones
+    TimezoneParser::CLDR::updateAbbreviations(abbreviations)
+    version = { 'TZInfo' => TimezoneParser::TZInfo::getVersion, 'CLDR' => TimezoneParser::CLDR::getVersion, 'Rails' => ActiveSupport::VERSION::STRING, 'WindowsZones' => nil }
+    File.write(data_location + 'countries.yml', countries.to_yaml)
+    File.write(data_location + 'timezones.yml', timezones.to_yaml)
+    File.write(data_location + 'metazones.yml', metazones.to_yaml)
+    File.write(data_location + 'windows_timezones.yml', windowsZones.to_yaml)
+    abbreviations = Hash[abbreviations.to_a.sort_by { |d| d.first } ]
+    File.write(data_location + 'abbreviations.yml', abbreviations.to_yaml)
+    rails = Hash[ActiveSupport::TimeZone::MAPPING.to_a.sort_by { |d| d.first } ]
+    File.write(data_location + 'rails.yml', rails.to_yaml)
+    File.write(data_location + 'version.yml', version.to_yaml)
+end
+
+def update_rails
+    timezone_path = repo_location + 'i18n-timezones' + 'rails' + 'locale'
+    names = {}
+    timezone_path.each_child(false) do |file|
+        YAML.load_file(timezone_path + file).each do |locale, data|
+            namesArray = data['timezones'].invert.to_a
+            namesArray.map { |e| e.map!(&:strip) }
+            names[locale] = Hash[namesArray.sort_by { |d| d.first } ]
+        end
+    end
+    File.write(data_location + 'rails_i18n.yml', names.to_yaml)
+end
+
+def update_windows
+    os = Gem::Platform.local.os
+    if (os == 'mingw32' or os == 'mingw64')
+        require 'timezone_parser/data/windows'
+        version = YAML.load_file(data_location + 'version.yml')
+        version['WindowsZones'] = TimezoneParser::Windows.getVersion
+        if version['WindowsZones'].nil?
+            $stderr.puts TimezoneParser::Windows.errors
+        else
+            timezones = TimezoneParser::Windows.getTimezones
+            File.write(data_location + 'windows_offsets.yml', timezones.to_yaml)
+            File.write(data_location + 'version.yml', version.to_yaml)
+        end
+    else
+        puts 'Sorry, you must be running Windows'
+    end
+end
+
+def import_timezones
+    require 'timezone_parser/data/windows'
+    os = Gem::Platform.local.os
+    if (os == 'mingw32' or os == 'mingw64')
+        metazones = YAML.load_file(vendor_location + 'tzres.yml')
+        offsets = TimezoneParser::Windows.getMUIOffsets
+        metazone_names = TimezoneParser::Windows.parseMetazones(metazones, offsets)
+        File.write(data_location + 'windows_zonenames.yml', metazone_names.to_yaml)
+    else
+        puts 'Sorry, you must be running Windows'
+    end
+end
+
+def download_tz
+    require 'timezone_parser/data/tzinfo'
+    TimezoneParser::TZInfo::download
+end
+
+def download_cldr
+    require 'timezone_parser/data/cldr'
+    TimezoneParser::CLDR::download
+end
+
+desc 'Download TZ data'
+task 'download:tz' do
+    download_tz
+end
+
+desc 'Download CLDR data'
+task 'download:cldr' do
+    download_cldr
+end
+
+desc 'Download TZ and CLDR data'
+task :download do
+    download_tz
+    download_cldr
+end
+
+desc 'Update data'
+task :update do
+    update
+end
+
+desc 'Update Rails data'
+task 'update:rails' do
+    update_rails
+end
+
+desc 'Update Windows data'
+task 'update:windows' do
+    update_windows
+end
+
+desc 'Import Windows localized timezones from tzres.yml'
+task 'update:windowszones' do
+    import_timezones
+end
+
+desc 'Update all data'
+task 'update:all' do
+    update
+    update_rails
+    update_windows
+    import_timezones
+end
+
+desc 'Export data'
+task 'export' do
+    ['abbreviations.yml', 'timezones.yml', 'countries.yml', 'metazones.yml',
+        'windows_zonenames.yml', 'windows_timezones.yml', 'windows_offsets.yml',
+        'rails.yml', 'rails_i18n.yml'].each do |name|
+        path = data_location + name
+        Marshal.dump(YAML.load_file(path), File.open(path.dirname + (path.basename('.*').to_s + '.dat'), 'wb'))
+    end
+end

data/TimezoneParser.gemspec

@@ -0,0 +1,40 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'timezone_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'TimezoneParser'
+  spec.version       = TimezoneParser::VERSION
+  spec.authors       = ['Dāvis']
+  spec.email         = ['davispuh@gmail.com']
+  spec.description   = 'Library for parsing Timezone names and abbrevations to corresponding UTC offsets and much more'
+  spec.summary       = 'Parse Timezone names written in any language to offsets and TimeZone identifiers'
+  spec.homepage      = 'https://github.com/davispuh/TimezoneParser'
+  spec.license       = 'UNLICENSE'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.files.delete_if { |name| name[-4, 4] == '.yml' }
+  spec.files         << 'data/version.yml'
+  ['abbreviations.dat', 'countries.dat', 'metazones.dat',
+  'rails.dat', 'rails_i18n.dat', 'timezones.dat',
+  'windows_offsets.dat', 'windows_timezones.dat', 'windows_zonenames.dat'].each do |name|
+    spec.files       << 'data/' + name
+  end
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'tzinfo'
+  spec.add_runtime_dependency 'insensitive_hash'
+
+  spec.add_development_dependency 'bundler', '>= 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'tzinfo-data'
+  spec.add_development_dependency 'ruby-cldr'
+  spec.add_development_dependency 'activesupport'
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/data/version.yml

@@ -0,0 +1,5 @@
+---
+TZInfo: 2013i
+CLDR: 24
+Rails: 4.1.0.rc1
+WindowsZones: 7de0000

data/lib/timezone_parser.rb

@@ -0,0 +1,159 @@
+# encoding: utf-8
+require 'timezone_parser/version'
+require 'timezone_parser/data'
+require 'timezone_parser/zone_info'
+require 'timezone_parser/abbreviation'
+require 'timezone_parser/timezone'
+require 'timezone_parser/windows_zone'
+require 'timezone_parser/rails_zone'
+
+# TimezoneParser module
+module TimezoneParser
+
+    protected
+    @@Modules = []
+    @@Regions = []
+    @@Locales = []
+
+    public
+
+    # Modules which to use by default when no modules are specified
+    AllModules = [:Abbreviations, :Timezones, :WindowsZones, :RailsZones].freeze
+
+    # Modules which will be used for TimezoneParser methods if not specified there
+    # @return [Array<Symbol>] list containing symbol names for modules to use
+    # @see AllModules
+    def self.Modules
+        @@Modules
+    end
+
+    # Regions which will be used for TimezoneParser methods if not specified there
+    #
+    # Each region is either ISO 3166-1 alpha-2 code or CLDR territory (UN M.49)
+    # @return [Array<String>] list containing region identifiers
+    # @see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+    # @see http://www.unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html
+    def self.Regions
+        @@Regions
+    end
+
+    # Locales which will be used for TimezoneParser methods if not specified there
+    #
+    # Each locale is language identifier based on IETF BCP 47. Usually is either language identifier or language and country/region identifier
+    # @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
+    # @see http://msdn.microsoft.com/en-us/library/dd318693.aspx
+    def self.Locales
+        @@Locales
+    end
+
+    # Load Timezone data in memory from files
+    #
+    # If no modules are specified it will load default modules
+    # @param modules [Array<Symbol>] list of modules
+    # @see Modules
+    # @see AllModules
+    def self.preload(modules = @@Modules)
+        modules = AllModules if modules.nil? or modules.empty?
+        Data::Storage.preload(modules)
+    end
+
+    # Check if given Timezone name is a valid timezone
+    # @param name [String] either Timezone name or abbreviation
+    # @param locales [Array<String>] check only for these locales
+    # @param modules [Array<Symbol>] list of modules from which to check
+    # @return [Boolean] whether Timezone is valid
+    # @see Locales
+    # @see Modules
+    # @see AllModules
+    # @see Abbreviation.isValid?
+    # @see Timezone.isValid?
+    # @see WindowsZone.isValid?
+    # @see RailsZone.isValid?
+    def self.isValid?(name, locales = @@Locales, modules = @@Modules)
+        valid = false
+        modules = AllModules if modules.nil? or modules.empty?
+        valid = Abbreviation::isValid?(name) if modules.include?(:Abbreviations)
+        return valid if valid
+
+        valid = Timezone::isValid?(name, locales) if modules.include?(:Timezones)
+        return valid if valid
+
+        valid = WindowsZone::isValid?(name, locales) if modules.include?(:WindowsZones)
+        return valid if valid
+
+        valid = RailsZone::isValid?(name, locales) if modules.include?(:RailsZones)
+        valid
+    end
+
+    # Get UTC offsets in seconds for given Timezone name
+    # @param name [String] either Timezone name or abbreviation
+    # @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 regions [Array<String>] look for offsets only for these regions
+    # @param locales [Array<String>] search Timezone name only for these locales
+    # @param type [Symbol] specify whether offset should be :standard time or :daylight
+    # @param all [Boolean] specify whether should search for all offsets or return as soon as found any
+    # @param modules [Array<Symbol>] list of modules from which to search
+    # @return [Array<Fixnum>] list of timezone offsets in seconds
+    # @see Regions
+    # @see Locales
+    # @see Modules
+    # @see AllModules
+    # @see Abbreviation.getOffsets
+    # @see Timezone.getOffsets
+    # @see WindowsZone.getOffsets
+    # @see RailsZone.getOffsets
+    def self.getOffsets(name, toTime = nil, fromTime = nil, regions = @@Regions, locales = @@Locales, type = nil, all = true, modules = @@Modules)
+        offsets = SortedSet.new
+        modules = AllModules if modules.nil? or modules.empty?
+        offsets += Abbreviation::getOffsets(name, toTime, fromTime, regions, type) if modules.include?(:Abbreviations)
+        return offsets.to_a if not all and not offsets.empty?
+
+        offsets += Timezone::getOffsets(name, toTime, fromTime, locales, regions, all) if modules.include?(:Timezones)
+        return offsets.to_a if not all and not offsets.empty?
+
+        offsets += WindowsZone::getOffsets(name, locales, all) if modules.include?(:WindowsZones)
+        return offsets.to_a if not all and not offsets.empty?
+
+        offsets += RailsZone::getOffsets(name, toTime, fromTime, locales, all) if modules.include?(:RailsZones)
+        offsets.to_a
+    end
+
+    # Get Timezone identifiers for given Timezone name
+    # @param name [String] either Timezone name or abbreviation
+    # @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 regions [Array<String>] look for timezones only for these regions
+    # @param locales [Array<String>] search Timezone name only for these locales
+    # @param type [Symbol] specify whether timezones should be :standard time or :daylight
+    # @param all [Boolean] specify whether should search for all timezones or return as soon as found any
+    # @param modules [Array<Symbol>] list of modules from which to search
+    # @return [Array<String>] list of timezone identifiers
+    # @see Regions
+    # @see Locales
+    # @see Modules
+    # @see AllModules
+    # @see Abbreviation.getTimezones
+    # @see Timezone.getTimezones
+    # @see WindowsZone.getTimezones
+    # @see RailsZone.getTimezones
+    def self.getTimezones(name, toTime = nil, fromTime = nil, regions = @@Regions, locales = @@Locales, type = nil, all = true, modules = @@Modules)
+        timezones = SortedSet.new
+        modules = AllModules if modules.nil? or modules.empty?
+        timezones += Abbreviation::getTimezones(name, toTime, fromTime, regions, type) if modules.include?(:Abbreviations)
+        return timezones.to_a if not all and not timezones.empty?
+
+        timezones += Timezone::getTimezones(name, toTime, fromTime, locales, regions, all) if modules.include?(:Timezones)
+        return timezones.to_a if not all and not timezones.empty?
+
+        timezones += WindowsZone::getTimezones(name, locales, regions, all) if modules.include?(:WindowsZones)
+        return timezones.to_a if not all and not timezones.empty?
+
+        timezones += RailsZone::getTimezones(name, locales, all) if modules.include?(:RailsZones)
+        timezones.to_a
+    end
+end
+