StreetAddress 1.0.1 → 1.0.2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Derrek Long
+
+The MIT License
+
+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/README.rdoc

@@ -0,0 +1,34 @@
+StreetAddress
+    by Derrek Long
+    https://github.com/derrek/street-address
+
+== DESCRIPTION:
+  
+Parses one line street addresses and returns a normalized address object.
+
+This is a near direct port of the of the perl module 
+Geo::StreetAddress::US originally written by Schuyler D. Erle.  
+For more information see
+http://search.cpan.org/~sderle/Geo-StreetAddress-US-0.99/
+
+== SYNOPSIS:
+
+Parse United States addresses.
+
+=== Basic Usage:
+  require 'street_address'
+  address = StreetAddress::US.parse("1600 Pennsylvania Ave, Washington, DC, 20500")
+  address.street # Pennsylvania
+  address.number # 1600
+  address.postal_code # 20500
+  address.city # Washington
+  address.state # DC
+  address.state_name # District of columbia
+  address.street_type # Ave
+  address.intersection? # false
+
+  StreetAddress::US.parse("1600 Pennsylvania Ave") # nil not a full address
+
+=== Gemfile:
+To use from your Gemfile:
+  gem 'StreetAddress', '1.0.2', :require => "street_address

data/Rakefile

@@ -1,22 +1,8 @@
-# -*- ruby -*-
+require 'rake/testtask'
 
-require 'rubygems'
-require 'hoe'
-require './lib/street_address.rb'
-
-Hoe.new('StreetAddress', StreetAddress::VERSION) do |p|
-  p.rubyforge_name = 'streetaddress'
-  p.summary = 'Ruby port of the perl module Geo::StreetAddress::US to parse one line street addresses'
-  p.description = "Parses one line addresses and returns a normalized address object.
-
-This is a near direct port of the of the perl module 
-Geo::StreetAddress::US originally written by Schuyler D. Erle.  
-For more information see
-http://search.cpan.org/~sderle/Geo-StreetAddress-US-0.99/"
-  p.url = "http://streetaddress.rubyforge.org"
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.author = "Derrek Long"
-  p.email = "derrek.long@gmail.com"
+Rake::TestTask.new do |t|
+  t.libs << 'test'
 end
 
-# vim: syntax=Ruby
+desc "Run tests"
+task :default => :test

data/lib/street_address.rb

@@ -63,9 +63,9 @@
 =end
 
 module StreetAddress
-  VERSION = '1.0.1'
   class US
-    @@directional = {
+    VERSION = '1.0.2'
+    DIRECTIONAL = {
       "north" => "N",
       "northeast" => "NE",
       "east" => "E",
@@ -75,9 +75,9 @@ module StreetAddress
       "west" => "W",
       "northwest" => "NW"
     }
-    @@direction_code = @@directional.invert
+    DIRECTION_CODES = DIRECTIONAL.invert
 
-    @@street_type = {
+    STREET_TYPES = {
       "allee" => "aly",
       "alley" => "aly",
       "ally" => "aly",
@@ -442,10 +442,13 @@ module StreetAddress
       "wy" => "way"
     }
   
-    @@street_type_list = {}
-    @@street_type.to_a.each{|item| @@street_type_list[item[0]] = true; @@street_type_list[item[1]] = true}
+    STREET_TYPES_LIST = {}
+    STREET_TYPES.to_a.each do |item| 
+      STREET_TYPES_LIST[item[0]] = true
+      STREET_TYPES_LIST[item[1]] = true
+    end
 
-    @@state_code = {
+    STATE_CODES = {
       "alabama" => "AL",
       "alaska" => "AK",
       "american samoa" => "AS",
@@ -507,9 +510,9 @@ module StreetAddress
       "wyoming" => "WY"
     }
 
-    @@state_name = @@state_code.invert
+    STATE_NAMES = STATE_CODES.invert
     
-    @@state_fips = {
+    STATE_FIPS = {
       "01" => "AL",
       "02" => "AK",
       "04" => "AZ",
@@ -565,52 +568,74 @@ module StreetAddress
       "78" => "VI"
     }
 
-    @@fips_state = @@state_fips.invert
+    FIPS_STATES = STATE_FIPS.invert
     
-    @@street_type_regexp = @@street_type_list.keys.join("|")
-    @@number_regexp = '\d+-?\d*'
-    @@fraction_regexp = '\d+\/\d+'
-    @@state_regexp = @@state_code.to_a.join("|").gsub(/ /, "\\s")
-    @@direct_regexp = @@directional.keys.join("|") + "|" + @@directional.values.sort{|a,b| b.length <=> a.length }.map{|x| f = x.gsub(/(\w)/, '\1.'); [Regexp::quote(f), Regexp::quote(x)] }.join("|")
-    @@zip_regexp = '(\d{5})(?:-(\d{4}))?'
-    @@corner_regexp = '(?:\band\b|\bat\b|&|\@)'
-    @@unit_regexp = '(?:(su?i?te|p\W*[om]\W*b(?:ox)?|dept|apt|apartment|ro*m|fl|unit|box)\W+|\#\W*)([\w-]+)'
-    @@street_regexp = 
+    class << self
+      attr_accessor(
+        :street_type_regexp,
+        :number_regexp,
+        :fraction_regexp,
+        :state_regexp,
+        :direct_regexp, 
+        :zip_regexp,
+        :corner_regexp,
+        :unit_regexp,
+        :street_regexp,
+        :place_regexp,
+        :address_regexp
+      )
+    end
+      
+    self.street_type_regexp = STREET_TYPES_LIST.keys.join("|")
+    self.number_regexp = '\d+-?\d*'
+    self.fraction_regexp = '\d+\/\d+'
+    self.state_regexp = STATE_CODES.to_a.join("|").gsub(/ /, "\\s")
+    self.direct_regexp = DIRECTIONAL.keys.join("|") + 
+      "|" + 
+      DIRECTIONAL.values.sort{ |a,b| 
+        b.length <=> a.length 
+      }.map{ |x| 
+        f = x.gsub(/(\w)/, '\1.')
+        [Regexp::quote(f), Regexp::quote(x)] 
+      }.join("|")
+    self.zip_regexp = '(\d{5})(?:-(\d{4}))?'
+    self.corner_regexp = '(?:\band\b|\bat\b|&|\@)'
+    self.unit_regexp = '(?:(su?i?te|p\W*[om]\W*b(?:ox)?|dept|apt|apartment|ro*m|fl|unit|box)\W+|\#\W*)([\w-]+)'
+    self.street_regexp = 
       '(?:
-          (?:(' + @@direct_regexp + ')\W+
-          (' + @@street_type_regexp + ')\b)
+          (?:(' + direct_regexp + ')\W+
+          (' + street_type_regexp + ')\b)
           |
-          (?:(' + @@direct_regexp + ')\W+)?
+          (?:(' + direct_regexp + ')\W+)?
           (?:
             ([^,]+)
-            (?:[^\w,]+(' + @@street_type_regexp + ')\b)
-            (?:[^\w,]+(' + @@direct_regexp + ')\b)?
+            (?:[^\w,]+(' + street_type_regexp + ')\b)
+            (?:[^\w,]+(' + direct_regexp + ')\b)?
            |
             ([^,]*\d)
-            (' + @@direct_regexp + ')\b
+            (' + direct_regexp + ')\b
            |
             ([^,]+?)
-            (?:[^\w,]+(' + @@street_type_regexp + ')\b)?
-            (?:[^\w,]+(' + @@direct_regexp + ')\b)?
+            (?:[^\w,]+(' + street_type_regexp + ')\b)?
+            (?:[^\w,]+(' + direct_regexp + ')\b)?
           )
         )'
-    @@place_regexp = 
+    self.place_regexp = 
       '(?:
        ([^\d,]+?)\W+
-       ($' + @@state_regexp + ')\W*
+       ($' + state_regexp + ')\W*
        )?
-       (?:' + @@zip_regexp + ')?'
+       (?:' + zip_regexp + ')?'
     
-    @@address_regexp =
+    self.address_regexp =
       '\A\W*
-        (' + @@number_regexp + ')\W*
-        (?:' + @@fraction_regexp + '\W*)?' +
-        @@street_regexp + '\W+
-        (?:' + @@unit_regexp + '\W+)?' +
-        @@place_regexp +
+        (' + number_regexp + ')\W*
+        (?:' + fraction_regexp + '\W*)?' +
+        street_regexp + '\W+
+        (?:' + unit_regexp + '\W+)?' +
+        place_regexp +
       '\W*\Z'
       
-    class << self
 =begin rdoc
 
     parses either an address or intersection and returns an instance of
@@ -622,10 +647,9 @@ module StreetAddress
     StreetAddress::US.parse('Hollywood & Vine, Los Angeles, CA')
     
 =end
+    class << self
       def parse(location)
-        regex = Regexp.new(@@corner_regexp, Regexp::IGNORECASE)
-        if  regex.match(location)
-          z = regex.match(location)
+        if Regexp.new(corner_regexp, Regexp::IGNORECASE).match(location)
           parse_intersection(location);
         else 
           parse_address(location);
@@ -644,13 +668,14 @@ module StreetAddress
 =end
       def parse_intersection(inter)
         regex = Regexp.new(
-          '\A\W*' + @@street_regexp + '\W*?
-          \s+' + @@corner_regexp + '\s+' +
-          @@street_regexp + '\W+' +
-          @@place_regexp + '\W*\Z', Regexp::IGNORECASE + Regexp::EXTENDED)
-        match = regex.match(inter)
-        return if match.nil?
-
+          '\A\W*' + street_regexp + '\W*?
+          \s+' + corner_regexp + '\s+' +
+          street_regexp + '\W+' +
+          place_regexp + '\W*\Z', Regexp::IGNORECASE + Regexp::EXTENDED
+        )
+        
+        return unless match = regex.match(inter)
+        
         normalize_address(
           StreetAddress::US::Address.new(
             :street => match[4] || match[9],
@@ -679,9 +704,9 @@ module StreetAddress
 
 =end
       def parse_address(addr)
-         regex = Regexp.new(@@address_regexp, Regexp::IGNORECASE + Regexp::EXTENDED)
-         match = regex.match(addr)
-         return if match.nil?
+         regex = Regexp.new(address_regexp, Regexp::IGNORECASE + Regexp::EXTENDED)
+
+         return unless match = regex.match(addr)
 
          normalize_address(
            StreetAddress::US::Address.new(
@@ -700,14 +725,6 @@ module StreetAddress
         )
       end
       
-      def state_name #:nodoc:
-        @@state_name
-      end
-      
-      def fips_state #:nodoc:
-        @@fips_state
-      end
-      
       private
       def normalize_address(addr)
         addr.state = normalize_state(addr.state) unless addr.state.nil?
@@ -728,13 +745,13 @@ module StreetAddress
         if state.length < 3
           state.upcase
         else
-          @@state_code[state.downcase]
+          STATE_CODES[state.downcase]
         end
       end
       
       def normalize_street_type(s_type)
         s_type.downcase!
-        s_type = @@street_type[s_type] || s_type if @@street_type_list[s_type]
+        s_type = STREET_TYPES[s_type] || s_type if STREET_TYPES_LIST[s_type]
         s_type.capitalize
       end
       
@@ -742,7 +759,7 @@ module StreetAddress
         if dir.length < 3
           dir.upcase
         else
-          @@directional[dir.downcase]
+          DIRECTIONAL[dir.downcase]
         end
       end
     end
@@ -755,19 +772,37 @@ module StreetAddress
   
 =end
     class Address
-      attr_accessor :number, :street, :street_type, :unit, :unit_prefix, :suffix, :prefix, :city, :state, :postal_code, :postal_code_ext, :street2, :street_type2, :suffix2, :prefix2
+      attr_accessor(
+        :number, 
+        :street, 
+        :street_type, 
+        :unit, 
+        :unit_prefix, 
+        :suffix, 
+        :prefix, 
+        :city, 
+        :state, 
+        :postal_code, 
+        :postal_code_ext, 
+        :street2, 
+        :street_type2, 
+        :suffix2, 
+        :prefix2
+      )
 
       def initialize(args)
-        args.keys.each { |attrib| self.send("#{attrib}=", args[attrib]) }
+        args.keys.each do |attrib| 
+          self.send("#{attrib}=", args[attrib]) 
+        end
+        return
       end
 
       def state_fips
-        StreetAddress::US::fips_state[@state]
+        StreetAddress::US::FIPS_STATES[state]
       end
 
       def state_name
-        s_name = StreetAddress::US.state_name[state]     
-        s_name.capitalize unless s_name.nil?
+        name = StreetAddress::US::STATE_NAMES[state] and name.capitalize
       end
 
       def intersection?

data/test/test_street_address.rb

@@ -1,8 +1,8 @@
-require 'test/unit/testcase'
-require File.dirname(__FILE__) + '/../lib/street_address'
+require 'test/unit'
+require 'street_address'
 
 
-class StreetAddressUs < Test::Unit::TestCase
+class StreetAddressUsTest < Test::Unit::TestCase
   def setup
     @addr1 = "2730 S Veitch St Apt 207, Arlington, VA 22206"
     @addr2 = "44 Canal Center Plaza Suite 500, Alexandria, VA 22314"

metadata

@@ -1,69 +1,76 @@
 --- !ruby/object:Gem::Specification 
 name: StreetAddress
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  hash: 19
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Derrek Long
+- Nicholas Schleuter
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-02-29 00:00:00 -05:00
+date: 2011-08-07 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.5.0
-    version: 
-description: Parses one line addresses and returns a normalized address object.  This is a near direct port of the of the perl module  Geo::StreetAddress::US originally written by Schuyler D. Erle.   For more information see http://search.cpan.org/~sderle/Geo-StreetAddress-US-0.99/
-email: derrek.long@gmail.com
+dependencies: []
+
+description: |
+  StreetAddress::US allows you to send any string to parse and if the string is a US address returns an object of the address broken into it's substituent parts.
+  
+  A port of Geo::StreetAddress::US by Schuyler D. Erle and Tim Bunce.
+
+email: derreklong@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+extra_rdoc_files: []
+
 files: 
-- History.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
+- LICENSE
 - lib/street_address.rb
 - test/test_street_address.rb
 has_rdoc: true
-homepage: http://streetaddress.rubyforge.org
+homepage: https://github.com/derrek/street-address
+licenses: []
+
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: streetaddress
-rubygems_version: 1.0.1
+rubyforge_project: 
+rubygems_version: 1.4.2
 signing_key: 
-specification_version: 2
-summary: Ruby port of the perl module Geo::StreetAddress::US to parse one line street addresses
+specification_version: 3
+summary: Parse Addresses into substituent parts. This gem includes US only.
 test_files: 
 - test/test_street_address.rb

data/History.txt

@@ -1,8 +0,0 @@
-== 1.0.1 / 2008-02-29
-
-* BUG FIX: Parse two word states correctly
-
-== 1.0.0 / 2007-06-28
-
-* Initial Version
-

data/Manifest.txt

@@ -1,6 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/street_address.rb
-test/test_street_address.rb

data/README.txt

@@ -1,45 +0,0 @@
-StreetAddress
-    by Riderway (Derrek Long, Nicholas Schlueter)
-    http://streetaddress.rubyforge.org
-
-== DESCRIPTION:
-  
-Parses one line street addresses and returns a normalized address object.
-
-This is a near direct port of the of the perl module 
-Geo::StreetAddress::US originally written by Schuyler D. Erle.  
-For more information see
-http://search.cpan.org/~sderle/Geo-StreetAddress-US-0.99/
-
-== SYNOPSIS:
-
-Currently parses United States Addresses.
-
-=== Basic Usage:
-
-StreetAddress::US.parse("1600 Pennsylvania Ave, Washington, DC, 2006")
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2007 Riderway
-
-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.