address_extractor 0.1.4

data/LICENSE.textile

@@ -0,0 +1,23 @@
+h4. Copyright and License
+
+The MIT License
+
+Copyright (c) 2008 Jim Garvin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest

@@ -0,0 +1,6 @@
+lib/address_extractor.rb
+LICENSE.textile
+Manifest
+Rakefile
+README.textile
+test/test_address_extractor.rb

data/README.textile

@@ -0,0 +1,48 @@
+h1. AddressExtractor
+
+Find and/or replace mailing addresses in strings.
+
+h2. Examples
+
+<pre><code>
+require 'rubygems'
+require 'address_extractor'
+  
+string = <<EOF
+Please send the package to 123 Foo St., Someplace FL
+
+My phone number is 123-1234 and St. Marc of Israel can be reached 
+via mail at:
+  123 Goob Avenue
+  Apt 123
+  Nice Town CA 123456
+EOF
+
+# Find first address
+AddressExtractor.first_address(string) # => { :street1 => "123 Foo St.", :city => "Someplace", :state => "FL" }
+
+# Find all addresses
+AddressExtractor.find_addresses(string) # => 
+  # [
+  #   { :street1 => "123 Foo St.", :city => "Someplace", :state => "FL" }
+  #   { :street1 => "123 Goob Avenue.", :street2 => "Apt 123", :city => "Nice Town", :state => "CA", :zip => "123456" }
+  # ]
+  
+# Do a gsub on first address
+new_string = AddressExtractor.replace_first_address(string) do |address_hash, address_string|
+  map_link_to(address_string)
+end
+
+# Do a gsub on all addresses
+new_string = AddressExtractor.replace_addresses(string) do |address_hash, address_string|
+  map_link_to(address_string)
+end
+</code></pre>
+  
+h3. About
+
+Written by Jim Garvin ("coderifous":http://github.com/coderifous) at RubyConf '08 at the request of Chris Murphy ("chmurph2":http://github.com/chmurph2) and Ryan McGeary ("rmm5t":http://github.com/rmm5t) so they could use it in their awesome "invitation and survey app":http://yarp.com.
+
+You can use it, too.
+
+The address-finding regex may be a bit naive, I'll gladly accept pull requests that add to the test data and tests.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('address_extractor', '0.1.4') do |p|
+  p.description    = "Give it text.  It finds addresses in it."
+  p.url            = "http://github.com/coderifous/address_extractor"
+  p.author         = "Jim Garvin"
+  p.email          = "jim at thegarvin dot com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/address_extractor.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = %q{address_extractor}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jim Garvin"]
+  s.date = %q{2008-11-21}
+  s.description = %q{Give it text.  It finds addresses in it.}
+  s.email = %q{jim at thegarvin dot com}
+  s.extra_rdoc_files = ["lib/address_extractor.rb", "LICENSE.textile", "README.textile"]
+  s.files = ["lib/address_extractor.rb", "LICENSE.textile", "Manifest", "Rakefile", "README.textile", "test/test_address_extractor.rb", "address_extractor.gemspec", "test/test_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/coderifous/address_extractor}
+  s.rdoc_options = ["--line-numbers", "--title", "Address_extractor", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{address_extractor}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Give it text.  It finds addresses in it.}
+  s.test_files = ["test/test_address_extractor.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/lib/address_extractor.rb

@@ -0,0 +1,176 @@
+class AddressExtractor
+  class << self
+
+    # Returns hash for address if address found.
+    # Returns nil if no address found.
+    def first_address(string)
+      hashify_results string.scan(ADDRESS_PATTERN).first
+    end
+
+    # Returns array of hashes for each address found.
+    # Returns empty array if no addresses found.
+    def find_addresses(string)
+      string.scan(ADDRESS_PATTERN).collect { |a| hashify_results(a) }.compact
+    end
+
+    # Pass it a block that recieves 2 parameters:
+    #   address hash
+    #   matched address string ($&)
+    # Whatever your block returns will be used for the substition.
+    # Returns new string with substition applied to first identified address.
+    # If no address found, returns same string unaltered.
+    def replace_first_address(string)
+      hash = first_address(string)
+      string.sub(ADDRESS_PATTERN) do |match|
+        yield(hash, $&)
+      end
+    end
+
+    # Same as +replace_first_address+ but applies substition to all identified addresses.
+    def replace_addresses(string)
+      string.gsub(ADDRESS_PATTERN) do |match|
+        hash = hashify_results match.scan(ADDRESS_PATTERN).first
+        useful_address?(hash) ? yield(hash, $&) : match
+      end
+    end
+
+  private
+
+    def hashify_results(matches)
+      return nil if matches.nil?
+      result = { }
+      capture_index = 0
+      CAPTURE_MAP.each do |field|
+        result[field] = matches[capture_index].to_s.chomp if matches[capture_index]
+        capture_index += 1
+      end
+      useful_address?(result) ? result : nil
+    end
+
+    def useful_address?(hash)
+      hash &&
+      hash[:street1] && ( hash[:zip] || hash[:city] && hash[:state] )
+    end
+
+  end
+
+  CAPTURE_MAP = [ :street1, :street2, :city, :state, :zip, :zip ]
+
+  STATES = <<-EOF
+    ALABAMA  AL
+    ALASKA  AK
+    AMERICAN SAMOA  AS
+    ARIZONA  AZ
+    ARKANSAS  AR
+    CALIFORNIA  CA
+    COLORADO  CO
+    CONNECTICUT  CT
+    DELAWARE  DE
+    DISTRICT OF COLUMBIA  DC
+    FEDERATED STATES OF MICRONESIA  FM
+    FLORIDA  FL
+    GEORGIA  GA
+    GUAM  GU
+    HAWAII  HI
+    IDAHO  ID
+    ILLINOIS  IL
+    INDIANA  IN
+    IOWA  IA
+    KANSAS  KS
+    KENTUCKY  KY
+    LOUISIANA  LA
+    MAINE  ME
+    MARSHALL ISLANDS  MH
+    MARYLAND  MD
+    MASSACHUSETTS  MA
+    MICHIGAN  MI
+    MINNESOTA  MN
+    MISSISSIPPI  MS
+    MISSOURI  MO
+    MONTANA  MT
+    NEBRASKA  NE
+    NEVADA  NV
+    NEW HAMPSHIRE  NH
+    NEW JERSEY  NJ
+    NEW MEXICO  NM
+    NEW YORK  NY
+    NORTH CAROLINA  NC
+    NORTH DAKOTA  ND
+    NORTHERN MARIANA ISLANDS  MP
+    OHIO  OH
+    OKLAHOMA  OK
+    OREGON  OR
+    PALAU  PW
+    PENNSYLVANIA  PA
+    PUERTO RICO  PR
+    RHODE ISLAND  RI
+    SOUTH CAROLINA  SC
+    SOUTH DAKOTA  SD
+    TENNESSEE  TN
+    TEXAS  TX
+    UTAH  UT
+    VERMONT  VT
+    VIRGIN ISLANDS  VI
+    VIRGINIA  VA
+    WASHINGTON  WA
+    WEST VIRGINIA  WV
+    WISCONSIN  WI
+    WYOMING  WY
+  EOF
+
+  STATE_REGEX = STATES.split(/\n/).collect{ |n| n.scan(/(\w.*\w)\s*([A-Z]{2})\s*$/) }.join("|")
+
+  SECONDARY_UNIT_DESIGNATORS = <<-EOF
+    APARTMENT APT
+    BASEMENT BSMT
+    BUILDING BLDG
+    DEPARTMENT DEPT
+    FLOOR FL
+    FRONT FRNT
+    HANGAR HNGR
+    LOBBY LBBY
+    LOT LOT
+    LOWER LOWR
+    OFFICE OFC
+    PENTHOUSE PH
+    PIER PIER
+    REAR REAR
+    ROOM RM
+    SIDE SIDE
+    SLIP SLIP
+    SPACE SPC
+    STOP STOP
+    SUITE STE
+    TRAILER TRLR
+    UNIT UNIT
+    UPPER UPPR
+  EOF
+
+  SECONDARY_UNIT_DESIGNATORS_REGEX = SECONDARY_UNIT_DESIGNATORS.split(/\n/).collect{ |n| n.scan(/(\w+)\s*(\w+)\s*$/) }.join("|")
+
+  ADDRESS_PATTERN = /
+    (
+      \d+                           # A few numbers
+      \s+
+      (?:[A-Za-z'.-]+\s?){1,5}      # Followed by a street name
+    )
+    \s* ,?  \s*                     # a comma, optionally
+    (
+      (?:\d+\s+)?                   # a secondary unit, optionally
+      (?:#{SECONDARY_UNIT_DESIGNATORS_REGEX})
+      (?:\s+\d+)?
+    )?
+    \s* ,?  \s*                     # a comma, optionally
+    (?:
+      (?:
+        ( (?:[A-Za-z]+\s?){0,2} (?:[A-Za-z]+) ) # city
+        \s* ,?  \s*                 # a comma, optionally
+        \b(#{STATE_REGEX})\b        # state
+        \s* ,? \s*                  # a comma, optionally
+        (\d{5})?                    # a zip code, optionally
+      )
+      |                             # or, instead of city and state
+      (\d{5})?                      # a lone zip code will do
+    )
+  /xi
+end

data/test/test_address_extractor.rb

@@ -0,0 +1,89 @@
+require 'address_extractor'
+require 'test_helper'
+include TestDataHelper
+
+class AddressExtractorTest < Test::Unit::TestCase
+  def test_first_address_extraction
+    each_test_data do |test_data|
+      address = AddressExtractor.first_address(test_data[:input])
+      flunk "No address found in:\n#{test_data[:input]}" if address.nil?
+      assert_equal_hashes test_data[:expected_output].first, address
+    end
+  end
+
+  def test_find_addresses
+    each_test_data do |test_data|
+      addresses = AddressExtractor.find_addresses(test_data[:input])
+      assert_equal addresses.size, test_data[:expected_output].size
+      test_data[:expected_output].each do |expected_output|
+        assert_equal_hashes expected_output, addresses.shift
+      end
+    end
+  end
+
+  def test_replace_first_address
+    string = AddressExtractor.replace_first_address(test_data.first[:input]) do |address_hash, address|
+      assert_equal_hashes test_data.first[:expected_output].first, address_hash
+      assert_match /^\s*123 Foo St., Someplace FL\s*/, address
+      "skidoosh"
+    end
+    assert_match /Please send the package to skidoosh/, string
+  end
+
+  def test_replace_addresses
+    string = AddressExtractor.replace_addresses(test_data.first[:input]) do |address_hash, address|
+      "skidoosh"
+    end
+    assert_match /Please send the package to skidoosh/, string
+    assert_match /via mail at:\s+skidoosh/, string
+  end
+
+  def test_no_addresses_found
+    assert_nil AddressExtractor.first_address("foo")
+    assert_equal [], AddressExtractor.find_addresses("foo")
+    assert_equal "foo", AddressExtractor.replace_first_address("foo")
+    assert_equal "foo", AddressExtractor.replace_addresses("foo")
+  end
+end
+
+# Test Input/Expected outputs defined below using test_input helper
+# Expanding the tests will probably start with adding new test input
+
+test_input "
+    Please send the package to 123 Foo St., Someplace FL
+
+    My phone number is 123-1234 and St. Marc of Israel can be reached
+    via mail at:
+      123 Goob Avenue
+      Apt 123
+      Nice Town CA 12345",
+  { :street1 => "123 Foo St.", :street2 => nil, :city => "Someplace", :state => "FL", :zip => nil },
+  { :street1 => "123 Goob Avenue", :street2 => "Apt 123", :city => "Nice Town", :state => "CA", :zip => "12345" }
+
+test_input "Let's meet tomorrow at noon at 123 Foo Bar Street, Scooby NY 12345",
+  { :street1 => "123 Foo Bar Street", :street2 => nil, :city => "Scooby", :state => "NY", :zip => "12345" }
+
+test_input "Let's meet tomorrow at noon at 123 Foo Bar Street, Scooby, NY 12345",
+  { :street1 => "123 Foo Bar Street", :street2 => nil, :city => "Scooby", :state => "NY", :zip => "12345" }
+
+test_input "Let's meet tomorrow at noon at 123 Foo Bar Street, Scooby, NY, 12345",
+  { :street1 => "123 Foo Bar Street", :street2 => nil, :city => "Scooby", :state => "NY", :zip => "12345" }
+
+test_input "Let's meet tomorrow at noon at 123 Foo Bar Street, 12345",
+  { :street1 => "123 Foo Bar Street", :street2 => nil, :city => nil, :state => nil, :zip => "12345" }
+
+test_input "
+  Apple Computer, Inc.
+  1 Infinite Loop
+  Cupertino, CA 95014",
+  { :street1 => "1 Infinite Loop", :street2 => nil, :city => "Cupertino", :state => "CA", :zip => "95014" }
+
+test_input "Apple Computer, Inc. 1 Infinite Loop, Cupertino, CA 95014",
+  { :street1 => "1 Infinite Loop", :street2 => nil, :city => "Cupertino", :state => "CA", :zip => "95014" }
+
+test_input "Ida Lee Park Recreation Center 60 Ida Lee Dr NW, Leesburg, VA",
+  { :street1 => "60 Ida Lee Dr NW", :street2 => nil, :city => "Leesburg", :state => "VA", :zip => nil }
+
+test_input "Ida Lee Park Recreation Center 60 Ida Lee Dr N West, Leesburg, VA",
+  { :street1 => "60 Ida Lee Dr N West", :street2 => nil, :city => "Leesburg", :state => "VA", :zip => nil }
+

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'rubygems'
+begin require 'redgreen' unless ENV['TM_FILENAME']; rescue LoadError; end
+
+module TestDataHelper
+  def test_input(input_string, *expected_outputs)
+    test_data << { :input => input_string, :expected_output => expected_outputs }
+  end
+
+  def each_test_data
+    test_data.each { |t| yield(t) }
+  end
+
+  def test_data
+    @@test_data ||= []
+  end
+end
+
+module Helpers
+  def assert_equal_hashes(expected, hash)
+    (expected.keys + hash.keys).uniq.each do |k|
+      assert_equal expected[k], hash[k], "expected[#{k.inspect}] = #{expected[k].inspect} != hash[#{k.inspect}] = #{hash[k].inspect}"
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  include Helpers
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: address_extractor
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Jim Garvin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-21 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Give it text.  It finds addresses in it.
+email: jim at thegarvin dot com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/address_extractor.rb
+- LICENSE.textile
+- README.textile
+files: 
+- lib/address_extractor.rb
+- LICENSE.textile
+- Manifest
+- Rakefile
+- README.textile
+- test/test_address_extractor.rb
+- address_extractor.gemspec
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/coderifous/address_extractor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --title
+- Address_extractor
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: address_extractor
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Give it text.  It finds addresses in it.
+test_files: 
+- test/test_address_extractor.rb
+- test/test_helper.rb