Indirizzo 0.1.1 → 0.1.3

data/Indirizzo.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{Indirizzo}
-  s.version = "0.1.1"
+  s.version = "0.1.3"
 
   s.authors = [%q{Dave Worth}]
   s.date = %q{2011-12-14}

data/README.md

@@ -27,6 +27,28 @@ require 'Indirizzo'
 Indirizzo::Address.new("some address")
 ```
 
+### Options
+
+`#new` takes a string or a (pre-parsed address) hash as its first parameter and
+an options hash.
+
+In the case of a string specifying and address, Indirizzo will do its best to
+parse any matter of string, though results can be complicated.  In the cases
+where things are complicated the various attributes in Indirizzo do their best
+to keep all reasonable answers in an array which you can inspect.  (ex: "1600
+Pensylvania Washington", in this case the state is difficult to determine so
+both "Pennsylvania" and "Washington" are returned for City and Street)
+
+In the case of the pre-parsed address hash the keys of the
+hash be symbols matching the various Address fields in Indirizzo (specifically
+`:prenum`, :`number`, `:sufnum`, `:street`, `:city`, `:state`, `:zip`, `:plus4`,
+and `:country`)
+
+Currently only one option is supported for the option hash:
+
+* `:expand_streets` - a boolean which determines if "1 First St"'s street parameter
+  is expanded into "1 st", "first st", and "one st" or simply left as "first st"
+
 ## License
 
 Indirizzo is a direct derivative of [Geocoder::US 2.0](https://github.com/geocommons/geocoder)

data/lib/indirizzo/address.rb

@@ -25,9 +25,12 @@ module Indirizzo
     attr_accessor :state
     attr_accessor :zip, :plus4
     attr_accessor :country
+    attr_accessor :options
 
     # Takes an address or place name string as its sole argument.
-    def initialize (text)
+    def initialize (text, options={})
+      @options = {:expand_streets => true}.merge(options)
+
       raise ArgumentError, "no text provided" unless text and !text.empty?
       if text.class == Hash
         @text = ""
@@ -59,16 +62,16 @@ module Indirizzo
         @number = ""
         if !@street.nil?
           if text[:number].nil?
-             @street.map! { |single_street|
-               single_street.downcase!
-               @number = single_street.scan(Match[:number])[0].reject{|n| n.nil? || n.empty?}.first.to_s
-               single_street.sub! @number, ""
-               single_street.sub! /^\s*,?\s*/o, ""
-              }
-         else
+            @street.map! { |single_street|
+              single_street.downcase!
+              @number = single_street.scan(Match[:number])[0].reject{|n| n.nil? || n.empty?}.first.to_s
+              single_street.sub! @number, ""
+              single_street.sub! /^\s*,?\s*/o, ""
+            }
+          else
             @number = text[:number].to_s
           end
-         @street = expand_streets(@street)
+          @street = expand_streets(@street) if @options[:expand_streets]
           street_parts
         end
         @city = []
@@ -79,10 +82,10 @@ module Indirizzo
           @city.push("")
         end
         if !text[:region].nil?
-         # @state = []
-         @state = text[:region]
+          # @state = []
+          @state = text[:region]
           if @state.length > 2
-           # full_state = @state.strip # special case: New York
+            # full_state = @state.strip # special case: New York
             @state = State[@state]
           end
         elsif !text[:country].nil?
@@ -94,7 +97,7 @@ module Indirizzo
         @zip = text[:postal_code]
         @plus4 = text[:plus4]
         if !@zip
-           @zip = @plus4 = ""
+          @zip = @plus4 = ""
         end
       end
     end
@@ -180,7 +183,7 @@ module Indirizzo
       street_search_end_index = [state_index,zip_index,text.length].reject(&:nil?).min-1
       @street = text[number_end_index+1..street_search_end_index].scan(Match[:street]).map { |s| s and s.strip }
 
-      @street = expand_streets(@street)
+      @street = expand_streets(@street) if @options[:expand_streets]
       # SPECIAL CASE: 1600 Pennsylvania 20050
       @street << @full_state if @street.empty? and @state.downcase != @full_state.downcase
 

data/test/test_address.rb

@@ -5,10 +5,12 @@ require 'indirizzo/address'
 include Indirizzo
 
 class TestAddress < Test::Unit::TestCase
+
   def test_new
     addr = Address.new("1600 Pennsylvania Av., Washington DC")
     assert_equal "1600 Pennsylvania Av, Washington DC", addr.text
   end
+
   def test_expand_numbers
     num_list = ["5", "fifth", "five"]
     num_list.each {|n|
@@ -17,6 +19,19 @@ class TestAddress < Test::Unit::TestCase
     }
   end
 
+  def test_expand_street
+    addr = Address.new("1 First St, Atlanta GA, 12345")
+    expected_streets = ["1 st", "first st", "one st"]
+    expected_streets.each_with_index do |street, index|
+      addr.street[index] = expected_streets[index]
+    end
+  end
+
+  def test_no_expand_street
+    addr = Address.new("1 First St, Atlanta GA, 12345", :expand_streets => false)
+    assert_equal addr.street.first, "first st"
+  end
+
   def test_po_box
     addr_po = Address.new "PO Box 1111 Herndon VA 20171"
     assert addr_po.po_box?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Indirizzo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70302219305600 !ruby/object:Gem::Requirement
+  requirement: &70264404189660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70302219305600
+  version_requirements: *70264404189660
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &70302219305160 !ruby/object:Gem::Requirement
+  requirement: &70264404189220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70302219305160
+  version_requirements: *70264404189220
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70302219304740 !ruby/object:Gem::Requirement
+  requirement: &70264404188800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70302219304740
+  version_requirements: *70264404188800
 description: Indirizzo is simply an extraction of the US Street Address parsing code
   from Geocoder::US
 email: dave@highgroove.com