ziptz 2.1.8 → 3.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dd97f760f0ba59d304c4444d9a156117ec7a0603d329d0c176a7c39d75c7e8e
-  data.tar.gz: 1505f07dc5662e8d0952589011006dbdc60705739e829822a676f3d2640a74a2
+  metadata.gz: 8584f30a48d305cf57165059fdf89bc90ff1169b540b07e4810dd08facf3bb76
+  data.tar.gz: 974d31d4c7ab3f17e7e5bf86d875eca5b29f9d44087a09ae9b83c4694fd68945
 SHA512:
-  metadata.gz: 420bf9382484a923daa55b062ca4e2493959d532b58c0363e82ed767a87683217e939fb1be7ddefe194fa48ab570ffabfa1db7d6b36c668329c661398dead825
-  data.tar.gz: add80be0a28baaa305a18af687ec51887942b16b402e6c78847d0797149d7c9cd91c008fe53fa3054428fe3853ea7f12dbc85d00d8b9f16fcc4b60d94f011ddb
+  metadata.gz: e12dbe849abc336a65894be858be518433b97b9b9ac2622581534b7da9078de2f10fe21270dfed58cee58bb7a0f2003f40f86d9d3e1dcf662cad952dd2e41e20
+  data.tar.gz: dd9b487f4a8a868e07c39837732433662879696f12378666d700a69ed561743e47dd5a0bd607b87e381b7abe63ffe6d36ebfba61a7efc848e95fedfd7cf4f0f8

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2020 Keith Morrison <keithm@infused.org>
+Copyright (c) 2015-2023 Keith Morrison <keithm@infused.org>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,12 +1,18 @@
 # Ziptz
 [![Version](http://img.shields.io/gem/v/ziptz.svg?style=flat)](https://rubygems.org/gems/ziptz)
-[![Build Status](http://img.shields.io/travis/infused/ziptz/master.svg?style=flat)](http://travis-ci.org/infused/ziptz)
+[![Build Status](https://github.com/infused/ziptz/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/infused/ziptz/actions/workflows/build.yml)
 [![Total Downloads](https://img.shields.io/gem/dt/ziptz.svg)](https://rubygems.org/gems/ziptz/)
 [![License](https://img.shields.io/github/license/infused/ziptz.svg)](https://github.com/infused/ziptz)
 
-Get time zone and daylight saving time for any US ZIP code.
+Get time zone, daylight saving time, and base offset for any US ZIP code.
 
-<i>ZIP codes are up to date as of <b>July 2020</b>.</i>
+<i>ZIP codes are up to date as of <b>July 2023</b>.</i>
+
+## Compatibility
+
+Ziptz is tested to work with the following versions of Ruby:
+
+* Ruby 2.3.x, 2.4.x, 2.5.x, 2.6.x, 2.7.x, 3.x
 
 ## Installation
 
@@ -24,7 +30,7 @@ Get the time zone name for any ZIP code:
 
 Get the time zone offset for any ZIP code:
 
-    z.time_zone_offset('97213') #=> -8
+    z.time_zone_offset('97213') #=> -28800
 
 <em>Note that offsets do not include daylight saving time.</em>
 
@@ -34,28 +40,106 @@ Determine if the ZIP code uses Daylight Saving Time:
 
 Get all the zip codes in a time zone:
 
-    z.zips('Pacific/Pago_Pago') #=> ["96799", "96941", "96942", "96943", "96944"]
+    z.zips('Pacific/Chuuk') #=> ["96942", "96943"]
 
 
 ## Supported Time Zones
 
-* "America/Puerto_Rico" UTC -04:00
-* "America/New_York" UTC -05:00
-* "America/Chicago" UTC -06:00
-* "America/Denver" UTC -07:00
-* "America/Phoenix" UTC -07:00
-* "America/Los_Angeles" UTC -08:00
-* "America/Anchorage" UTC -09:00
-* "America/Adak" UTC -10:00
-* "Pacific/Honolulu" UTC -10:00
-* "Pacific/Pago_Pago" UTC -11:00
-* "Pacific/Majuro" UTC +12:00
-* "Pacific/Guam" UTC +10:00
-* "Pacific/Palau" UTC +09:00
-* "Pacific/Pohnpei" UTC +11:00
+* America/Adak
+* America/Anchorage
+* America/Boise
+* America/Chicago
+* America/Denver
+* America/Detroit
+* America/Indiana/Indianapolis
+* America/Indiana/Knox
+* America/Indiana/Marengo
+* America/Indiana/Petersburg
+* America/Indiana/Tell_City
+* America/Indiana/Vevay
+* America/Indiana/Vincennes
+* America/Indiana/Winamac
+* America/Juneau
+* America/Kentucky/Louisville
+* America/Kentucky/Monticello
+* America/Los_Angeles
+* America/Menominee
+* America/Metlakatla
+* America/New_York
+* America/Nome
+* America/North_Dakota/Beulah
+* America/North_Dakota/Center
+* America/North_Dakota/New_Salem
+* America/Phoenix
+* America/Puerto_Rico
+* America/Sitka
+* America/St_Thomas
+* America/Yakutat
+* Pacific/Chuuk
+* Pacific/Guam
+* Pacific/Honolulu
+* Pacific/Kosrae
+* Pacific/Kwajalein
+* Pacific/Majuro
+* Pacific/Pago_Pago
+* Pacific/Palau
+* Pacific/Pohnpei
+* Pacific/Saipan
+* Pacific/Wake
 
 <em>Note that APO/FPO zip codes will not return a known time zone offset.</em>
 
+## Prefer raw data?
+
+If you would prefer raw data instead of a gem, see my [ZIP Code Time Zones](https://us-west-2.console.aws.amazon.com/dataexchange/home#/products/prodview-4vcapflqwntdw) product on AWS Data Exchange to subscribe.
+
+## Version 3 breaking changes
+
+* APO, DPO, and FPO zip codes are no longer included, because they are non-geographic.
+* Time zone offsets are now specified in seconds instead of hours.
+* Time zone are now more granular. The full list of time zones is:
+  * America/Adak
+  * America/Anchorage
+  * America/Boise
+  * America/Chicago
+  * America/Denver
+  * America/Detroit
+  * America/Indiana/Indianapolis
+  * America/Indiana/Knox
+  * America/Indiana/Marengo
+  * America/Indiana/Petersburg
+  * America/Indiana/Tell_City
+  * America/Indiana/Vevay
+  * America/Indiana/Vincennes
+  * America/Indiana/Winamac
+  * America/Juneau
+  * America/Kentucky/Louisville
+  * America/Kentucky/Monticello
+  * America/Los_Angeles
+  * America/Menominee
+  * America/Metlakatla
+  * America/New_York
+  * America/Nome
+  * America/North_Dakota/Beulah
+  * America/North_Dakota/Center
+  * America/North_Dakota/New_Salem
+  * America/Phoenix
+  * America/Puerto_Rico
+  * America/Sitka
+  * America/St_Thomas
+  * America/Yakutat
+  * Pacific/Chuuk
+  * Pacific/Guam
+  * Pacific/Honolulu
+  * Pacific/Kosrae
+  * Pacific/Kwajalein
+  * Pacific/Majuro
+  * Pacific/Pago_Pago
+  * Pacific/Palau
+  * Pacific/Pohnpei
+  * Pacific/Saipan
+  * Pacific/Wake
+
 ## Version 2 breaking changes
 
 Time zone names now reflect standard tz-database names.
@@ -76,7 +160,7 @@ Time zone names now reflect standard tz-database names.
 
 ## License
 
-  Copyright (c) 2015-2020 Keith Morrison <<keithm@infused.org>>
+  Copyright (c) 2015-2023 Keith Morrison <<keithm@infused.org>>
 
   Permission is hereby granted, free of charge, to any person
   obtaining a copy of this software and associated documentation

data/lib/ziptz.rb

@@ -1,41 +1,37 @@
 require 'yaml'
+require 'zlib'
 
 class Ziptz
-  VERSION = '2.1.8'.freeze
-
-  TZ_INFO = {
-    '0' => {name: 'APO/FPO (time zone unknown)', offset: 0},
-    '4' => {name: 'America/Puerto_Rico', offset: -4},
-    '5' => {name: 'America/New_York', offset: -5},
-    '6' => {name: 'America/Chicago', offset: -6},
-    '7' => {name: 'America/Denver', offset: -7},
-    '8' => {name: 'America/Los_Angeles', offset: -8},
-    '9' => {name: 'America/Anchorage', offset: -9},
-    '10' => {name: 'Pacific/Honolulu', offset: -10},
-    '11' => {name: 'Pacific/Pago_Pago', offset: -11},
-    '13' => {name: 'Pacific/Majuro', offset: 12},
-    '14' => {name: 'Pacific/Guam', offset: 10},
-    '15' => {name: 'Pacific/Palau', offset: 9},
-    '16' => {name: 'Pacific/Pohnpei', offset: 11},
-    'AZ' => {name: 'America/Phoenix', offset: -7},
-    'AD' => {name: 'America/Adak', offset: -10}
-  }.freeze
+  VERSION = '3.0.18'.freeze
+
+  def self.instance
+    @instance ||= new
+  end
 
   def time_zone_name(zip)
-    get_time_zone(zip)
+    tz_info = time_zone_info(zip)
+    return unless tz_info
+
+    tz_info[:tz]
   end
 
   def time_zone_offset(zip)
-    tz = time_zone_info(zip)
-    tz && tz[:offset]
+    tz_info = time_zone_info(zip)
+    return unless tz_info
+
+    tzm_info = tzm[tz_info[:tz]]
+    tzm_info[:offset] && tzm_info[:offset].to_i
   end
 
   def time_zone_uses_dst?(zip)
-    dst[zip.to_s.slice(0, 5)]
+    tz_info = time_zone_info(zip)
+    return unless tz_info
+
+    tz_info[:dst]
   end
 
   def zips(tz_name)
-    zips_by_code(tz_name)
+    tz.select { |_, v| v[:tz].downcase == tz_name.downcase }.keys
   end
 
   def inspect
@@ -44,45 +40,53 @@ class Ziptz
 
   protected
 
-  def tz
-    @tz ||= load_tz_data
+  def tzm
+    @tzm ||= load_tzm_data
   end
 
-  def dst
-    @dst ||= load_dst_data
+  def lazy_tz
+    @lazy_tz ||= lazy_load_tz_data
   end
 
-  def zips_by_code(tz_code)
-    tz.select { |_, v| v.match(/#{tz_code}/i) }.keys.sort
+  def tz
+    @tz ||= load_tz_data
   end
 
   def time_zone_info(zip)
-    TZ_INFO.values.detect { |v| v[:name] == get_time_zone(zip) }
+    if (data = lazy_tz[zip.to_s.slice(0, 5)])
+      _, tz, dst = data.strip.split('|')
+      {tz: tz, dst: dst == '1'}
+    end
   end
 
-  def get_time_zone(zip)
-    tz[zip.to_s.slice(0, 5)]
+  def tzm_data_path
+    File.join(File.dirname(__FILE__), '..', 'data', 'tzm.data')
   end
 
   def tz_data_path
     File.join(File.dirname(__FILE__), '..', 'data', 'tz.data')
   end
 
-  def load_tz_data
-    File.foreach(tz_data_path).with_object({}) do |line, data|
-      zip, tz = line.strip.split('=')
-      data[zip] = tz
+  def lazy_load_tz_data
+    uncompressed = Zlib::Inflate.inflate(File.read(tz_data_path, encoding: 'ASCII-8BIT'))
+    uncompressed.each_line.with_object({}) do |line, data|
+      data[line.slice(0, 5)] = line
     end
   end
 
-  def dst_data_path
-    File.join(File.dirname(__FILE__), '..', 'data', 'dst.data')
+  def load_tz_data
+    uncompressed = Zlib::Inflate.inflate(File.read(tz_data_path, encoding: 'ASCII-8BIT'))
+    uncompressed.each_line.with_object({}) do |line, data|
+      zip, tz, dst = line.strip.split('|')
+      data[zip] = {tz: tz, dst: dst == '1'}
+    end
   end
 
-  def load_dst_data
-    File.foreach(dst_data_path).with_object({}) do |line, data|
-      zip, dst = line.strip.split('=')
-      data[zip] = dst == '1'
+  def load_tzm_data
+    uncompressed = Zlib::Inflate.inflate(File.read(tzm_data_path, encoding: 'ASCII-8BIT'))
+    uncompressed.each_line.with_object({}) do |line, data|
+      tz, offset = line.strip.split('|')
+      data[tz] = {offset: offset}
     end
   end
 end

data/spec/ziptz_spec.rb

@@ -74,13 +74,13 @@ RSpec.describe Ziptz do
   describe '#time_zone_offset' do
     context 'when given a 5-digit zipcode' do
       it 'returns the time zone number' do
-        expect(ziptz.time_zone_offset('97034')).to eq(-8)
+        expect(ziptz.time_zone_offset('97034')).to eq(-28800)
       end
     end
 
     context 'when given a 9-digit zipcode' do
       it 'returns the time zone number' do
-        expect(ziptz.time_zone_offset('97034-1234')).to eq(-8)
+        expect(ziptz.time_zone_offset('97034-1234')).to eq(-28800)
       end
     end
 
@@ -106,4 +106,18 @@ RSpec.describe Ziptz do
       end
     end
   end
+
+  describe '#instance' do
+    context 'when given a 5 digit zip code' do
+      it 'matches the behavior of Ziptz.new' do
+        expect(Ziptz.instance.time_zone_name('97034')).to eq ziptz.time_zone_name('97034')
+      end
+    end
+
+    context 'when called twice' do
+      it 'returns identical instances' do
+        expect(Ziptz.instance.object_id).to eq Ziptz.instance.object_id
+      end
+    end
+  end
 end

data/ziptz.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
 
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE']
-  s.files = Dir['[A-Z]*', '{data,lib,spec}/**/*', 'ziptz.gemspec']
-  s.test_files = Dir.glob('spec/**/*_spec.rb')
+  s.files = Dir['README.md', 'LICENSE', '{data,lib,spec}/**/*', 'ziptz.gemspec']
   s.require_paths = ['lib']
   s.required_ruby_version = '>= 2.0.0'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ziptz
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 3.0.18
 platform: ruby
 authors:
 - Keith Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies: []
 description: Get timezone info for all 5-digit US zip codes
 email: keithm@infused.org
@@ -18,17 +18,10 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- Gemfile
-- Gemfile.lock
-- Gemfile.travis
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
-- data/dst.data
 - data/tz.data
-- database.yml
-- lib/zip_code.rb
+- data/tzm.data
 - lib/ziptz.rb
 - spec/spec_helper.rb
 - spec/ziptz_spec.rb
@@ -36,7 +29,8 @@ files:
 homepage: http://github.com/infused/ziptz
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
@@ -53,9 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: TimeZone info for any 5-digit US zip code
-test_files:
-- spec/ziptz_spec.rb
+test_files: []

data/Gemfile

@@ -1,18 +0,0 @@
-gemspec
-source 'https://rubygems.org'
-
-group :development, :test do
-  gem 'activerecord'
-  gem 'bundler'
-  gem 'byebug'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'irb'
-  gem 'mysql2'
-  gem 'rake'
-  gem 'rspec'
-  gem 'rubocop'
-  gem 'rubocop-performance'
-  gem 'rubocop-rspec'
-  gem 'tty-spinner'
-end

data/Gemfile.lock

@@ -1,123 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ziptz (2.1.8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    byebug (11.0.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    ffi (1.11.1)
-    formatador (0.2.5)
-    guard (2.15.1)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    i18n (1.7.0)
-      concurrent-ruby (~> 1.0)
-    irb (1.0.0)
-    jaro_winkler (1.5.3)
-    listen (3.2.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
-    minitest (5.12.2)
-    mysql2 (0.5.2)
-    nenv (0.3.0)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (3.0.0)
-    rake (13.0.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
-      ffi (~> 1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.75.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.36.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    shellany (0.0.1)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tty-cursor (0.7.0)
-    tty-spinner (0.9.1)
-      tty-cursor (~> 0.7)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.1.10)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  bundler
-  byebug
-  guard
-  guard-rspec
-  irb
-  mysql2
-  rake
-  rspec
-  rubocop
-  rubocop-performance
-  rubocop-rspec
-  tty-spinner
-  ziptz!
-
-BUNDLED WITH
-   2.1.0.pre.2

data/Gemfile.travis

@@ -1,7 +0,0 @@
-gemspec
-source 'https://rubygems.org'
-
-group :test do
-  gem 'bundler'
-  gem 'rspec'
-end

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :rspec, cmd: 'bundle exec rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { 'spec' }
-end

data/Rakefile

@@ -1,24 +0,0 @@
-require 'bundler/setup'
-Bundler.setup(:default, :development)
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new :spec do |t|
-  t.rspec_opts = %w[--color]
-end
-
-RSpec::Core::RakeTask.new :specdoc do |t|
-  t.rspec_opts = %w[-fl]
-end
-
-task default: :spec
-
-desc 'Open an irb session preloaded with this library'
-task :console do
-  sh 'irb -r rubygems -I lib -r ziptz.rb'
-end
-
-desc 'Create ziptz db from zipcodes database'
-task :create_ziptz do
-  require 'zip_code'
-  ZipCode.import
-end