people_places_things 2.3.0

data/lib/people_places_things/zip_code.rb

@@ -0,0 +1,17 @@
+module PeoplePlacesThings
+  class ZipCode
+    attr_accessor :base, :plus_four, :raw
+  
+    def initialize(str)
+      tokens = str.strip.match(/^(\d{5})(-\d{4})?$/)[0].split('-') rescue nil
+      raise "Unsupported Format" if !tokens
+
+      self.base = tokens.first
+      self.plus_four = tokens[1] rescue nil
+    end
+  
+    def to_s
+      [self.base, self.plus_four].compact.join('-')
+    end
+  end
+end

data/lib/people_places_things.rb

@@ -0,0 +1,11 @@
+require 'people_places_things/street_address'
+require 'people_places_things/person_name'
+require 'people_places_things/ansi_counties'
+require 'people_places_things/phone_number'
+require 'people_places_things/zip_code'
+require 'people_places_things/state'
+require 'people_places_things/location'
+
+module PeoplePlacesThings
+  VERSION = File.read(File.join(File.dirname(__FILE__), 'people_places_things', 'VERSION')).chomp.strip rescue "Unknown"
+end

data/people_places_things.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{people_places_things}
+  s.version = "2.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Danny Burkes"]
+  s.date = %q{2009-09-01}
+  s.description = %q{Parsers and formatters for person names, street addresses, city/state/zip, phone numbers, etc.}
+  s.email = %q{dburkes@netable.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/people_places_things.rb",
+     "lib/people_places_things/VERSION",
+     "lib/people_places_things/ansi_counties.rb",
+     "lib/people_places_things/data/data.yml",
+     "lib/people_places_things/data/process_data.rb",
+     "lib/people_places_things/data/raw.txt",
+     "lib/people_places_things/location.rb",
+     "lib/people_places_things/person_name.rb",
+     "lib/people_places_things/phone_number.rb",
+     "lib/people_places_things/state.rb",
+     "lib/people_places_things/street_address.rb",
+     "lib/people_places_things/zip_code.rb",
+     "people_places_things.gemspec",
+     "spec/ansi_counties_spec.rb",
+     "spec/helper.rb",
+     "spec/location_spec.rb",
+     "spec/person_name_spec.rb",
+     "spec/phone_number_spec.rb",
+     "spec/state_spec.rb",
+     "spec/street_address_spec.rb",
+     "spec/zip_code_spec.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/dburkes/people_places_things}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Parsers and formatters for person names, street addresses, city/state/zip, phone numbers, etc.}
+  s.test_files = [
+    "spec/ansi_counties_spec.rb",
+     "spec/helper.rb",
+     "spec/location_spec.rb",
+     "spec/person_name_spec.rb",
+     "spec/phone_number_spec.rb",
+     "spec/state_spec.rb",
+     "spec/street_address_spec.rb",
+     "spec/zip_code_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/ansi_counties_spec.rb

@@ -0,0 +1,27 @@
+require 'spec/helper'
+
+describe ANSICounties do
+  it "should find code for valid state and county" do
+    ANSICounties.code_for('ga', 'fulton').should == 13121
+  end
+  
+  it "should find code for valid state and county hash" do
+    ANSICounties.code_for(:state => 'ga', :county => 'fulton').should == 13121
+  end
+  
+  it "should return nil for invalid state and county" do
+    ANSICounties.code_for(:state => 'ga', :county => 'fubar').should == nil
+  end
+  
+  it "should find code for alternate st. form" do
+    ANSICounties.code_for(:state => 'MO', :county => 'saint LOUIS').should == 29510
+  end
+  
+  it "should find data for valid code" do 
+    ANSICounties.data_for(13121).should == { :state => 'GA', :county => 'FULTON' }
+  end
+  
+  it "should return nil for invalid code" do 
+    ANSICounties.data_for(1312111).should == nil
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require 'lib/people_places_things'
+include PeoplePlacesThings

data/spec/location_spec.rb

@@ -0,0 +1,52 @@
+require 'spec/helper'
+
+describe Location do
+  it "should parse city" do
+    test_location("san francisco", "san francisco", nil, nil)
+  end
+
+  it "should parse city state abbreviation" do
+    test_location("san francisco ca", "san francisco", "CA", nil)
+  end
+
+  it "should parse city state full" do
+    test_location("san francisco california", "san francisco", "CA", nil)
+  end
+
+  it "should parse city comma state" do
+    test_location("san francisco, ca", "san francisco", "CA", nil)
+  end
+  
+  it "should parse city state zip" do
+    test_location("san francisco ca 94114-1212", "san francisco", "CA", '94114-1212')
+  end
+
+  it "should parse city comma state zip" do
+    test_location("san francisco, ca 94114-1212", "san francisco", "CA", '94114-1212')
+  end
+  
+  it "should parse city zip" do
+    test_location("san francisco 94114-1212", "san francisco", nil, '94114-1212')
+  end
+  
+  it "should parse state zip" do
+    test_location("ca 94114-1212", nil, "CA", '94114-1212')
+  end
+  
+  it "should parse state" do
+    test_location("california", nil, "CA", nil)
+  end
+  
+  it "should parse zip" do
+    test_location("94114-1212", nil, nil, '94114-1212')
+  end
+  
+  private
+  
+  def test_location(str, city, state, zip)
+    l = Location.new(str)
+    l.city.should == city if l.city
+    l.state.to_s(:abbr).should == state.upcase if l.state
+    l.zip.to_s.should == zip if l.zip
+  end
+end

data/spec/person_name_spec.rb

@@ -0,0 +1,175 @@
+require 'spec/helper'
+
+describe PersonName do
+  it "should parse first_middle_last" do
+    name = PersonName.new "george quincy drake peabody", :first_middle_last
+    name.first.should == 'george'
+    name.middle.should == 'quincy drake'
+    name.last.should == 'peabody'
+  end
+  
+  it "should parse last_first_middle" do
+    name = PersonName.new "peabody george quincy drake", :last_first_middle
+    name.first.should == 'george'
+    name.middle.should == 'quincy drake'
+    name.last.should == 'peabody'
+  end
+  
+  it "should parse last only in first_middle_last format" do
+    name = PersonName.new "peabody", :first_middle_last
+    name.first.should == nil
+    name.middle.should == nil
+    name.last.should == 'peabody'
+  end
+  
+  it "should parse last only in last_first_middle format" do
+    name = PersonName.new "peabody", :last_first_middle
+    name.first.should == nil
+    name.middle.should == nil
+    name.last.should == 'peabody'
+  end
+  
+  it "should parse first middle last suffix" do
+    name = PersonName.new "george f. peabody jr"
+    name.first.should == 'george'
+    name.middle.should == 'f.'
+    name.last.should == 'peabody'
+    name.suffix.should == 'jr'
+  end
+
+  it "should parse last suffix first middle" do
+    name = PersonName.new "peabody jr george f.", :last_first_middle
+    name.first.should == 'george'
+    name.middle.should == 'f.'
+    name.last.should == 'peabody'
+    name.suffix.should == 'jr'
+  end
+  
+  it "should default to first_middle_last" do
+    name = PersonName.new "george quincy drake peabody"
+    name.first.should == 'george'
+    name.middle.should == 'quincy drake'
+    name.last.should == 'peabody'
+  end
+  
+  it "should ignore spaces and commas" do
+    name = PersonName.new "  peabody,george  quincy       drake ", :last_first_middle
+    name.first.should == 'george'
+    name.middle.should == 'quincy drake'
+    name.last.should == 'peabody'
+  end
+  
+  it "should strip periods from initials" do 
+    name = PersonName.new "george f. peabody", :first_middle_last
+    name.first.should == 'george'
+    name.middle.should == 'f.'
+    name.middle_i == 'f'
+    name.last.should == 'peabody'
+  end
+  
+  it "should format for :first" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:first).should == 'george'
+  end
+  
+  it "should format for :middle" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:middle).should == 'quincy'
+  end
+  
+  it "should format for :last" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:last).should == 'peabody'
+  end
+  
+  it "should format for :full" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:full).should == 'george quincy peabody'
+  end
+
+  it "should format for :full_reverse" do
+    name = PersonName.new "george quincy peabody jr."
+    name.to_s(:full_reverse).should == 'peabody george quincy jr'
+  end
+  
+  it "should format for :first_space_last" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:first_space_last).should == 'george peabody'
+  end
+  
+  it "should format for :last_space_first" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:last_space_first).should == 'peabody george'
+  end
+  
+  it "should format for :last_comma_first" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:last_comma_first).should == 'peabody,george'
+  end
+  
+  it "should format for :last_comma_space_first" do
+    name = PersonName.new "george quincy peabody"
+    name.to_s(:last_comma_space_first).should == 'peabody, george'
+  end
+  
+  it "should handle missing parts when formatting" do 
+    PersonName.new('peabody').to_s(:last_comma_space_first).should == 'peabody'
+  end
+  
+  it "should respond to individual accessors" do 
+    name = PersonName.new "george quincy peabody"
+    name.first.should == 'george'
+    name.first_i.should == 'g'
+    name.middle.should == 'quincy'
+    name.middle_i.should == 'q'
+    name.last.should == 'peabody'
+    name.last_i.should == 'p'
+  end
+  
+  it "should recognize exact equality" do
+    PersonName.new("george quincy peabody").should be_eql(PersonName.new("george quincy peabody"))
+  end
+
+  it "should ignore case for equality" do
+    PersonName.new("george quincy peabody").should be_eql(PersonName.new("george quincy PEABODY"))
+  end
+  
+  it "should recognize subset equality" do
+    PersonName.new("george quincy peabody").should be_eql(PersonName.new("george peabody"))
+  end
+  
+  it "should parse mc donald for first_middle_last" do
+    name = PersonName.new "george quincy drake mc donald", :first_middle_last
+    name.first.should == 'george'
+    name.middle.should == 'quincy drake'
+    name.last.should == 'mcdonald'
+  end
+  
+  it "should parse mc donald for last_first_middle" do
+    name = PersonName.new "mc donald george quincy drake", :last_first_middle
+    name.first.should == 'george'
+    name.middle.should == 'quincy drake'
+    name.last.should == 'mcdonald'
+  end
+  
+  it "should normalize suffixes" do
+    name = PersonName.new "george quincy peabody jr"
+    name2 = PersonName.new "peabody jr., george quincy", :last_first_middle
+    name.should be_eql(name2)
+  end
+  
+  it "should support auto detect formatting for first_middle_last" do
+    name = PersonName.new "george f. peabody jr"
+    name.first.should == 'george'
+    name.middle.should == 'f.'
+    name.last.should == 'peabody'
+    name.suffix.should == 'jr'
+  end
+  
+  it "should support auto detect formatting for last_first_middle" do
+    name = PersonName.new "peabody, george quincy drake"
+    name.first.should == 'george'
+    name.middle.should == 'quincy drake'
+    name.last.should == 'peabody'
+  end
+end

data/spec/phone_number_spec.rb

@@ -0,0 +1,59 @@
+require 'spec/helper'
+
+describe PhoneNumber do
+  it "should parse ten digits" do
+    phone = PhoneNumber.new '4045551212'
+    phone.area_code.should == '404'
+    phone.number.should == '5551212'
+    phone.exchange.should == '555'
+    phone.suffix.should == '1212'
+  end
+
+  it "should parse eleven digits" do
+    phone = PhoneNumber.new '14045551212'
+    phone.area_code.should == '404'
+    phone.number.should == '5551212'
+    phone.exchange.should == '555'
+    phone.suffix.should == '1212'
+  end
+  
+  it "should ignore certain characters" do
+    phone = PhoneNumber.new '1 (404) 555-1212'
+    phone.area_code.should == '404'
+    phone.number.should == '5551212'
+    phone.exchange.should == '555'
+    phone.suffix.should == '1212'
+  end
+  
+  it "should support international format, at least for US numbers, for now" do
+    phone = PhoneNumber.new '+1 404 555-1212'
+    phone.area_code.should == '404'
+    phone.number.should == '5551212'
+    phone.exchange.should == '555'
+    phone.suffix.should == '1212'
+  end
+  
+  it "should throw exception on unsupported parse format" do
+    lambda { PhoneNumber.new('40455512') }.should raise_error
+  end
+  
+  it "should format :full_digits" do
+    PhoneNumber.new('14045551212').to_s(:full_digits).should == '14045551212'
+  end
+
+  it "should format :local_digits" do
+    PhoneNumber.new('14045551212').to_s(:local_digits).should == '5551212'
+  end
+
+  it "should format :full_formatted" do
+    PhoneNumber.new('14045551212').to_s(:full_formatted).should == '1 (404) 555-1212'
+  end
+
+  it "should format :local_formatted" do
+    PhoneNumber.new('14045551212').to_s(:local_formatted).should == '555-1212'
+  end
+
+  it "should throw exception on unsupported to_sformat" do
+    lambda { PhoneNumber.new('14045551212').to_s(:bogus) }.should raise_error
+  end
+end

data/spec/state_spec.rb

@@ -0,0 +1,29 @@
+require 'spec/helper'
+
+describe State do
+  it "should parse abbreviation" do
+    state = State.new 'ga'
+    state.sym.should == :ga
+  end
+
+  it "should parse full" do
+    state = State.new 'georgia'
+    state.sym.should == :ga
+  end
+
+  it "should throw exception on unsupported state" do
+    lambda { State.new('foo') }.should raise_error
+  end
+
+  it "should format :abbr" do 
+    State.new('ga').to_s(:abbr).should == 'GA'
+  end
+
+  it "should format :full" do 
+    State.new('ga').to_s(:full).should == 'Georgia'
+  end
+
+  it "should throw exception on unsupported to_s format" do
+    lambda { State.new('ga').to_s(:bogus) }.should raise_error
+  end
+end