postal_code 0.3.2 → 0.4.0

data/lib/postal_code.rb

@@ -1,6 +1,6 @@
 module PostalCode
 
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 
   CityOffset  = 0
   StateOffset = 1
@@ -45,13 +45,17 @@ module PostalCode
   end
 
   # 
-  # * All postal code parameters must be strings.
-  # * Postal codes are not calculable, therefore should not be numeric.
-  # * A postal code with a leading zero would be an octal. However, *08880* is
-  #   an invalid octal numeric, yet a valid postal code.
+  # Postal codes must be strings because:
+  # 1. Postal codes are not calculable, therefore should not be numeric.
+  # 2. A postal code with a leading zero would be an octal. However, *08880* is
+  #    an invalid octal numeric, yet a valid postal code.
   #
   def self.valid_format? postal_code
-    postal_code =~ /^\d{5}(-\d{4})?$/
+    unless postal_code.is_a? String
+      raise(TypeError, "postal code must be a string")
+    end
+
+    (postal_code =~ /^\d{5}(-\d{4})?$/) ? true : false
   end
 
   #
@@ -74,6 +78,6 @@ module PostalCode
     end
   end
 
-  private_class_method :fetch, :valid_format?
+  private_class_method :fetch
 
 end

data/postal_code.gemspec

@@ -2,11 +2,21 @@ Gem::Specification.new('postal_code') do |s|
   s.version     = File.read('lib/postal_code.rb')[/VERSION = '(.*)'/, 1]
   s.author      = 'Clint Pachl'
   s.email       = 'pachl@ecentryx.com'
-  s.homepage    = 'http://ecentryx.com/gems/postal_code'
+  s.homepage    = 'https://ecentryx.com/gems/postal_code'
   s.license     = 'ISC'
-  s.summary     = 'Postal Code Resolver'
-  s.description = 'Resolves a postal code to a corresponding city or state.'
-  s.files       = Dir['README.rdoc', 'Rakefile', 'postal_code.gemspec',
-                      'lib/**/*.rb', 'test/**/*', 'db/*.tsv']
-  s.test_files  = Dir['test/*.rb']
+  s.summary     = 'Postal (ZIP) Code Resolver'
+  s.description = 'Resolve a postal (ZIP) code to a corresponding city or state.'
+  s.files       = Dir[
+    'Rakefile',
+    'README*',
+    '*.gemspec',
+    'lib/**/*.rb',
+    'test/**/*',
+    'db/*.tsv'
+  ]
+  s.extra_rdoc_files = ['README.rdoc']
+  s.rdoc_options = [
+    '--title', "A Ruby #{s.summary}",
+    '--main', 'README.rdoc'
+  ]
 end

data/test/test_postal_code.rb

@@ -1,7 +1,7 @@
 require 'minitest/autorun'
 require 'postal_code'
 
-class PostalCodeTest < Minitest::Unit::TestCase
+class PostalCodeTest < Minitest::Test
 
   ProductionDB = PostalCode::DB.dup
   TestDB = File.dirname(__FILE__) + '/data/US.tsv'
@@ -43,8 +43,8 @@ class PostalCodeTest < Minitest::Unit::TestCase
 
   def test_postal_code_not_found_in_any_city
     pcode = '99999'
-    assert_equal nil,     PostalCode.city(pcode)
-    assert_equal nil,     PostalCode.state(pcode)
+    assert_nil PostalCode.city(pcode)
+    assert_nil PostalCode.state(pcode)
   end
 
   def test_reactive_cache
@@ -72,15 +72,22 @@ class PostalCodeTest < Minitest::Unit::TestCase
   end
 
   def test_postal_code_validations
-    refute PostalCode.send(:valid_format?, '99999').nil?
-    refute PostalCode.send(:valid_format?, '00001').nil?
-    refute PostalCode.send(:valid_format?, '00001-1234').nil?
-    assert PostalCode.send(:valid_format?, '00001-123').nil?
-    assert PostalCode.send(:valid_format?, '00001-').nil?
-    assert PostalCode.send(:valid_format?, 99999).nil?
-    assert PostalCode.send(:valid_format?, 00001).nil?
-    assert PostalCode.send(:valid_format?, '1').nil?
-    assert PostalCode.send(:valid_format?, 1).nil?
+    assert PostalCode.valid_format?('01234-1234')
+    refute PostalCode.valid_format?('01234-123')
+    refute PostalCode.valid_format?('01234-12')
+    refute PostalCode.valid_format?('01234-1')
+    refute PostalCode.valid_format?('01234-')
+    assert PostalCode.valid_format?('01234')
+    refute PostalCode.valid_format?('0123')
+    refute PostalCode.valid_format?('012')
+    refute PostalCode.valid_format?('01')
+    refute PostalCode.valid_format?('0')
+  end
+
+  def test_postal_code_validation_exceptions
+    assert_raises(TypeError) { PostalCode.valid_format? 99999 }
+    assert_raises(TypeError) { PostalCode.valid_format? 00001 }
+    assert_raises(TypeError) { PostalCode.valid_format? 1 }
   end
 
 end

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: postal_code
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Clint Pachl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2020-10-10 00:00:00.000000000 Z
 dependencies: []
-description: Resolves a postal code to a corresponding city or state.
+description: Resolve a postal (ZIP) code to a corresponding city or state.
 email: pachl@ecentryx.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
 - README.rdoc
 - Rakefile
@@ -24,12 +25,16 @@ files:
 - postal_code.gemspec
 - test/data/US.tsv
 - test/test_postal_code.rb
-homepage: http://ecentryx.com/gems/postal_code
+homepage: https://ecentryx.com/gems/postal_code
 licenses:
 - ISC
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- A Ruby Postal (ZIP) Code Resolver
+- "--main"
+- README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -43,10 +48,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Postal Code Resolver
-test_files:
-- test/test_postal_code.rb
+summary: Postal (ZIP) Code Resolver
+test_files: []