sundawg_country_codes 0.0.2 → 0.0.3

data/Manifest

@@ -1,6 +1,11 @@
+Manifest
 README
 Rakefile
 lib/countries.yml
 lib/country_iso_translater.rb
+lib/usa_state_translater.rb
+lib/usa_states.yml
+sundawg_country_codes.gemspec
 test/country_iso_translater_test.rb
-Manifest
+test/test_helper.rb
+test/usa_translater_test.rb

data/README

@@ -64,6 +64,11 @@ To build the unicode HTML for a symbol:
 currency = SunDawg::CountryIsoTranslater.get_iso4217_currency_by_iso3166_alpha2("UZ")
 assert_equal SunDawg::CountryIsoTranslater.build_html_unicode(currency["unicode_hex"]), "&#x43b&#x432"
 
+To translate to and from USA state name and the 2-digit code:
+
+SunDawg::USAStateTranslater.translate_name_to_code('New York')
+SunDawg::USAStateTranslater.translate_code_to_name('NY')
+
 DATA
 ----
 All country code and names are stored in a countries.yml file that can be changed as you need. The latest codes and country names are derived from:
@@ -87,6 +92,7 @@ config.gem 'sundawg_country_codes', :lib => 'country_iso_translater'
 
 VERSION HISTORY
 ---------------
+v0.0.3 - Added USA State translater and cleaned up unit tests.
 v0.0.2b - Completed all currency information, unicode HTML utility, and bug fixes. Gem version re-published as 0.0.2.
 v0.0.2 - Added ISO 4217 currency information.
 v0.0.1 - Allows basic ISO 3166 translation.

data/Rakefile

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('sundawg_country_codes', '0.0.2') do |p|
+Echoe.new('sundawg_country_codes', '0.0.3') do |p|
   p.description    = "Manage ISO 3166 Country Names and Codes."
   p.url            = "http://github.com/SunDawg/country_codes"
   p.author         = "Christopher Sun"

data/lib/usa_state_translater.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+module SunDawg 
+  module USAStateTranslater
+    # allows client application to override YAML hash
+    FILE = File.expand_path(File.join(File.dirname(__FILE__), 'usa_states.yml')) unless defined?(FILE)
+    USA_STATES = YAML.load_file(FILE) unless defined?(USA_STATES)
+
+    # O(N) translation from state name to 2-digit code
+    def self.translate_name_to_code(name)
+      USA_STATES.each_pair { |key, value| 
+        return key if value["name"] == name 
+      }
+      raise NoStateError.new("[#{name}] IS NOT VALID")
+    end
+
+    # O(1) translation of 2-digit code to name
+    def self.translate_code_to_name(code)
+      state = USA_STATES[code]
+      raise NoStateError.new("[#{code}] IS NOT VALID") if state.nil?
+      state["name"]
+    end
+
+    class NoStateError < StandardError
+    end
+  end
+end

data/lib/usa_states.yml

@@ -0,0 +1,100 @@
+AL:
+  name: Alabama
+AK:
+  name: Alaska
+AZ:
+  name: Arizona
+AR:
+  name: Arkansas
+CA:
+  name: California
+CO:
+  name: Colorado
+CT:
+  name: Connecticut
+DE:
+  name: Delaware
+FL:
+  name: Florida
+GA:
+  name: Georgia
+HI:
+  name: Hawaii
+ID:
+  name: Idaho
+IL:
+  name: Illinois
+IN:
+  name: Indiana
+IA:
+  name: Iowa
+KS:
+  name: Kansas
+KY:
+  name: Kentucky
+LA:
+  name: Louisiana
+ME:
+  name: Maine
+MD:
+  name: Maryland
+MA:
+  name: Massachusetts
+MI:
+  name: Michigan
+MN:
+  name: Minnesota
+MS:
+  name: Mississippi
+MO:
+  name: Missouri
+MT:
+  name: Montana
+NE:
+  name: Nebraska
+NV:
+  name: Nevada
+NH:
+  name: New Hampshire
+NJ:
+  name: New Jersey
+NM:
+  name: New Mexico
+NY:
+  name: New York
+NC:
+  name: North Carolina
+ND:
+  name: North Dakota
+OH:
+  name: Ohio
+OK:
+  name: Oklahoma
+OR:
+  name: Oregon
+PA:
+  name: Pennsylvania
+RI:
+  name: Rhode Island
+SC:
+  name: South Carolina
+SD:
+  name: South Dakota
+TN:
+  name: Tennessee
+TX:
+  name: Texas
+UT:
+  name: Utah
+VT:
+  name: Vermont
+VA:
+  name: Virginia
+WA:
+  name: Washington
+WV:
+  name: West Virginia
+WI:
+  name: Wisconsin
+WY:
+  name: Wyoming

data/sundawg_country_codes.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sundawg_country_codes}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christopher Sun"]
-  s.date = %q{2009-12-04}
+  s.date = %q{2010-01-11}
   s.description = %q{Manage ISO 3166 Country Names and Codes.}
   s.email = %q{christopher.sun@gmail.com}
-  s.extra_rdoc_files = ["README", "lib/countries.yml", "lib/country_iso_translater.rb"]
-  s.files = ["README", "Rakefile", "lib/countries.yml", "lib/country_iso_translater.rb", "test/country_iso_translater_test.rb", "Manifest", "sundawg_country_codes.gemspec", "test/test_helper.rb"]
+  s.extra_rdoc_files = ["README", "lib/countries.yml", "lib/country_iso_translater.rb", "lib/usa_state_translater.rb", "lib/usa_states.yml"]
+  s.files = ["Manifest", "README", "Rakefile", "lib/countries.yml", "lib/country_iso_translater.rb", "lib/usa_state_translater.rb", "lib/usa_states.yml", "sundawg_country_codes.gemspec", "test/country_iso_translater_test.rb", "test/test_helper.rb", "test/usa_translater_test.rb"]
   s.homepage = %q{http://github.com/SunDawg/country_codes}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sundawg_country_codes", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{sundawg_country_codes}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Manage ISO 3166 Country Names and Codes.}
-  s.test_files = ["test/country_iso_translater_test.rb", "test/test_helper.rb"]
+  s.test_files = ["test/country_iso_translater_test.rb", "test/test_helper.rb", "test/usa_translater_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/country_iso_translater_test.rb

@@ -90,44 +90,24 @@ class CountryIsoTranslaterTest < Test::Unit::TestCase
   end
 
   def test_error_on_invalid_currency
-    begin
+    assert_raise SunDawg::CountryIsoTranslater::NoCountryError do
       client.get_iso4217_currency_by_iso3166_alpha2("XX")
-      fail "Expected client::NoCountryError"
-    rescue client::NoCountryError => e
-      assert_equal e.to_s, "[XX] IS NOT VALID"
-    rescue => e
-      fail "Expected client::NoCountryError"
     end
 
-    begin
+    assert_raise SunDawg::CountryIsoTranslater::NoCurrencyError do
       client.get_iso4217_currency_by_iso3166_alpha2("AX")
-      fail "Expected client::NoCurrencyError"
-    rescue client::NoCurrencyError => e
-      assert_equal e.to_s, "[AX] HAS NO ISO4217 CURRENCY"
-    rescue => e
-      fail "Expected client::NoCurrencyError"
     end
   end
 
   def test_error_on_invalid_country
-    begin
+    assert_raise SunDawg::CountryIsoTranslater::NoCountryError do
       client.translate_iso3166_name_to_alpha2("Candyland")
-      fail "Expected client::NoCountryError"
-    rescue client::NoCountryError => e
-      assert_equal e.to_s, "[Candyland] IS NOT VALID"
-    rescue => e
-      fail "Expected client::NoCountryError"
     end
   end
 
   def test_error_on_invalid_alpha2
-    begin
+    assert_raise SunDawg::CountryIsoTranslater::NoCountryError do
       client.translate_iso3166_alpha2_to_name("XX")
-      fail "Expected client::NoCountryError"
-    rescue client::NoCountryError => e
-      assert_equal e.to_s, "[XX] IS NOT VALID"
-    rescue => e
-      fail "Expected client::NoCountryError"
     end
   end
 

data/test/usa_translater_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+# allows override of FILE
+module SunDawg 
+  module USAStateTranslater
+    FILE = "lib/usa_states.yml"
+  end
+end
+
+require 'usa_state_translater'
+
+class USAStateTranslaterTest < Test::Unit::TestCase 
+  def test_code_to_name
+    assert_equal 'California', client.translate_code_to_name('CA')
+    assert_equal 'New York', client.translate_code_to_name('NY')
+  end
+
+  def test_name_to_code
+    assert_equal 'TX', client.translate_name_to_code('Texas')
+    assert_equal 'UT', client.translate_name_to_code('Utah')
+  end
+
+  def test_data_integrity
+    assert_equal 50, SunDawg::USAStateTranslater::USA_STATES.size
+  end
+
+  def test_error_on_invalid_name
+    assert_raise SunDawg::USAStateTranslater::NoStateError do
+      client.translate_name_to_code('Petertopia')
+    end
+  end
+
+  def test_error_on_invalid_state
+    assert_raise SunDawg::USAStateTranslater::NoStateError do
+      client.translate_code_to_name('XX')
+    end
+  end
+
+  protected
+
+  def client
+    SunDawg::USAStateTranslater
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sundawg_country_codes
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Christopher Sun
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-04 00:00:00 -05:00
+date: 2010-01-11 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -23,14 +23,20 @@ extra_rdoc_files:
 - README
 - lib/countries.yml
 - lib/country_iso_translater.rb
+- lib/usa_state_translater.rb
+- lib/usa_states.yml
 files: 
+- Manifest
 - README
 - Rakefile
 - lib/countries.yml
 - lib/country_iso_translater.rb
-- test/country_iso_translater_test.rb
-- Manifest
+- lib/usa_state_translater.rb
+- lib/usa_states.yml
 - sundawg_country_codes.gemspec
+- test/country_iso_translater_test.rb
+- test/test_helper.rb
+- test/usa_translater_test.rb
 has_rdoc: true
 homepage: http://github.com/SunDawg/country_codes
 licenses: []
@@ -67,3 +73,4 @@ summary: Manage ISO 3166 Country Names and Codes.
 test_files: 
 - test/country_iso_translater_test.rb
 - test/test_helper.rb
+- test/usa_translater_test.rb