ziptz 5.1.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b310de1d20cfb9b20cba87249ee230e5baff3efbab063fd7c87b21e7c5e458af
-  data.tar.gz: 7434225f05490776ced760c84f522b41b7ff2afc903a2cb4c1729c7b5a71d748
+  metadata.gz: ab5db4fd6e68687e6761f890c37122d5ba3c393f267c2efdf7320f66cdf81b9e
+  data.tar.gz: 153766d2364660656ca42179ce52d649a179c600ea21ea1713d97381af10c874
 SHA512:
-  metadata.gz: ded78e81fcfcad3917c824512de4c0e8eb902ef37f45fc7300610796100e4d367a338fabe1e4aa18b8237012208268bb3c55efc016021099b055ffddcd3ab34c
-  data.tar.gz: 81050bfeefe7dc5aa8ad492cece4975c8382178037a445f97957005e11f9242f1d6291073650031687fa90fa79df87403587368946b23c33787200789a33a8fe
+  metadata.gz: 5680d6235c68c8d70d8c89b45d23844db662b3dad0a8090bbf9abed9c23be48f835ae6bbb260a55eac74af3bb11ea61a9ae3ab53adb88e7831b0b4292dddf5d5
+  data.tar.gz: 3a04b0ee0c20e672059eef0122279b5cc8f082baab15b910cc547b39cb4af349065804605d83ee3e90c66d1b2e4ddef5077cb63f446ffad9f4ad187d26dad1a0

data/README.md

@@ -1,6 +1,6 @@
 # Ziptz
 [![Version](http://img.shields.io/gem/v/ziptz.svg?style=flat)](https://rubygems.org/gems/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)
+[![Build Status](https://github.com/infused/ziptz/actions/workflows/build.yml/badge.svg?branch=main)](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)
 
@@ -20,11 +20,21 @@ Add the gem to your Gemfile:
 
     gem 'ziptz'
 
+## Data File Requirement
+
+Starting with version 6.0.0, you'll need to supply your own time zone SQLite database file. You can subscribe to the required dataset here:
+[ZIP Code Time Zones Dataset](https://www.infused-data.com/zip-code-time-zones/)
+
 ## Usage
 
+First, initialize Ziptz with the path to your time zone database file:
+
+    z = Ziptz.new('/path/to/your/tz.db')
+    # or using keyword argument
+    z = Ziptz.new(db: '/path/to/your/tz.db')
+
 Get the time zone name for any ZIP code:
 
-    z = Ziptz.new
     z.time_zone_name('97213') #=> "America/Los_Angeles"
 
 Get the time zone offset for any ZIP code:

data/lib/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ziptz
-  VERSION = '5.1.2'.freeze
+  VERSION = '6.1.0'
 end

data/lib/ziptz.rb

@@ -1,36 +1,39 @@
+# frozen_string_literal: true
+
 require 'sqlite3'
 require 'version'
 
 class Ziptz
-  def self.instance
-    @instance ||= new
+  class ZipNotFound < StandardError; end
+
+  def initialize(*args, db: nil)
+    @db_path = args[0] || db
+    raise ArgumentError, 'Database path is required' if @db_path.nil? || @db_path.empty?
+    raise ArgumentError, 'Database file does not exist' unless File.exist?(@db_path)
   end
 
   def db
-    @db ||= begin
-      db = SQLite3::Database.open(tz_data_path)
+    Thread.current[:ziptz_db] ||= begin
+      db = SQLite3::Database.open(@db_path)
       db.results_as_hash = true
       db
     end
   end
 
   def time_zone_name(zip)
-    time_zone_info(zip)&.dig('time_zone')
+    time_zone_info(zip).dig('time_zone')
   end
 
   def time_zone_offset(zip)
-    time_zone_info(zip)&.dig('offset')
+    time_zone_info(zip).dig('offset')
   end
 
   def time_zone_uses_dst?(zip)
-    tz_info = time_zone_info(zip)
-    return unless tz_info
-
-    tz_info['observes_dst'] == 1
+    time_zone_info(zip)['observes_dst'] == 1
   end
 
   def zips(tz_name)
-    sql = <<-SQL
+    sql = <<~SQL
       select zip_code
       from zip_codes
       where time_zone = ?
@@ -46,12 +49,11 @@ class Ziptz
   protected
 
   def time_zone_info(zip)
-    return unless zip
+    raise ZipNotFound, "Zip code not found: #{zip.inspect}" if zip.nil?
 
-    db.get_first_row('select * from zip_codes where zip_code = ? limit 1', zip[0, 5])
-  end
+    result = db.get_first_row('select * from zip_codes where zip_code = ? limit 1', zip[0, 5])
+    raise ZipNotFound, "Zip code not found: #{zip}" unless result
 
-  def tz_data_path
-    File.join(File.dirname(__FILE__), '..', 'data', 'tz.db')
+    result
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ziptz'
 require 'yaml'
 require 'rspec'

data/spec/ziptz_spec.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Ziptz do
-  let(:ziptz) { described_class.new }
+  let(:db_path) { File.join(File.dirname(__FILE__), 'fixtures', 'tz.db') }
+  let(:ziptz) { described_class.new(db_path) }
 
   describe 'when inspected' do
     it 'does not show internal instance variables' do
@@ -23,14 +26,14 @@ RSpec.describe Ziptz do
     end
 
     context 'when there is no matching zipcode' do
-      it 'returns nil' do
-        expect(ziptz.time_zone_name('xyz')).to be_nil
+      it 'raises ZipNotFound' do
+        expect { ziptz.time_zone_name('xyz') }.to raise_error(Ziptz::ZipNotFound)
       end
     end
 
     context 'when nil is passed' do
-      it 'returns nil' do
-        expect(ziptz.time_zone_name(nil)).to be_nil
+      it 'raises ZipNotFound' do
+        expect { ziptz.time_zone_name(nil) }.to raise_error(Ziptz::ZipNotFound)
       end
     end
   end
@@ -38,31 +41,31 @@ RSpec.describe Ziptz do
   describe '#time_zone_uses_dst?' do
     context 'when given a valid 5-digit zipcode' do
       it 'returns true' do
-        expect(ziptz.time_zone_uses_dst?('97034')).to eq true
+        expect(ziptz.time_zone_uses_dst?('97034')).to be true
       end
     end
 
     context 'when given an invalid 5-digit zipcode' do
       it 'returns false' do
-        expect(ziptz.time_zone_uses_dst?('85004')).to eq false
+        expect(ziptz.time_zone_uses_dst?('85004')).to be false
       end
     end
 
     context 'when given a valid 9-digit zipcode' do
       it 'returns a true' do
-        expect(ziptz.time_zone_uses_dst?('97034-1234')).to eq true
+        expect(ziptz.time_zone_uses_dst?('97034-1234')).to be true
       end
     end
 
     context 'when given an invalid 9-digit zipcode' do
       it 'returns false' do
-        expect(ziptz.time_zone_uses_dst?('85004-1234')).to eq false
+        expect(ziptz.time_zone_uses_dst?('85004-1234')).to be false
       end
     end
 
     context 'when there is no matching zipcode' do
-      it 'returns nil' do
-        expect(ziptz.time_zone_uses_dst?('xyz')).to be_nil
+      it 'raises ZipNotFound' do
+        expect { ziptz.time_zone_uses_dst?('xyz') }.to raise_error(Ziptz::ZipNotFound)
       end
     end
   end
@@ -81,8 +84,8 @@ RSpec.describe Ziptz do
     end
 
     context 'when there is no matching zipcode' do
-      it 'returns nil' do
-        expect(ziptz.time_zone_offset('xyz')).to be_nil
+      it 'raises ZipNotFound' do
+        expect { ziptz.time_zone_offset('xyz') }.to raise_error(Ziptz::ZipNotFound)
       end
     end
   end
@@ -103,17 +106,28 @@ RSpec.describe Ziptz do
     end
   end
 
-  describe '#instance' do
-    context 'when given a 5 digit zip code' do
-      it 'matches the behavior of Ziptz.new' do
-        expect(described_class.instance.time_zone_name('97034')).to eq ziptz.time_zone_name('97034')
-      end
+  describe 'initialization' do
+    it 'accepts database path as first argument' do
+      expect { described_class.new(db_path) }.to_not raise_error
     end
 
-    context 'when called twice' do
-      it 'returns identical instances' do
-        expect(described_class.instance.object_id).to eq described_class.instance.object_id
-      end
+    it 'accepts database path as keyword argument' do
+      expect { described_class.new(db: db_path) }.to_not raise_error
+    end
+
+    it 'raises an error when database path is nil' do
+      expect { described_class.new }.to raise_error(ArgumentError, 'Database path is required')
+      expect { described_class.new(db: nil) }.to raise_error(ArgumentError, 'Database path is required')
+    end
+
+    it 'raises an error when database path is empty' do
+      expect { described_class.new('') }.to raise_error(ArgumentError, 'Database path is required')
+      expect { described_class.new(db: '') }.to raise_error(ArgumentError, 'Database path is required')
+    end
+
+    it 'raises an error when database file does not exist' do
+      expect { described_class.new('nonexistent.db') }.to raise_error(ArgumentError, 'Database file does not exist')
+      expect { described_class.new(db: 'nonexistent.db') }.to raise_error(ArgumentError, 'Database file does not exist')
     end
   end
 end

data/ziptz.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 require 'version'
@@ -17,7 +19,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md', 'LICENSE']
   s.files = Dir['README.md', 'LICENSE', '{data,lib,spec}/**/*', 'ziptz.gemspec']
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 3.1.0'
+  s.required_ruby_version = '>= 3.3.0'
   s.metadata['rubygems_mfa_required'] = 'true'
   s.add_dependency 'sqlite3', '~> 2.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ziptz
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 6.1.0
 platform: ruby
 authors:
 - Keith Morrison
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -29,14 +28,14 @@ email: keithm@infused.org
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - LICENSE
 - README.md
-- data/tz.db
 - lib/version.rb
 - lib/ziptz.rb
+- spec/fixtures/tz.db
 - spec/spec_helper.rb
 - spec/ziptz_spec.rb
 - ziptz.gemspec
@@ -45,7 +44,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -54,15 +52,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: TimeZone info for any 5-digit US zip code
 test_files: []