street_sweeper 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'street_sweeper' # and any other gems you need

data/spec/street_sweeper_spec.rb

@@ -0,0 +1,637 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe StreetSweeper do
+  NORMAL = {
+    '1005 Gravenstein Hwy 95472' => {
+      number: '1005',
+      street: 'Gravenstein',
+      postal_code: '95472',
+      street_type: 'Hwy'
+    },
+    '1005 Gravenstein Hwy, 95472' => {
+      number: '1005',
+      street: 'Gravenstein',
+      postal_code: '95472',
+      street_type: 'Hwy'
+    },
+    '1005 Gravenstein Hwy N, 95472' => {
+      number: '1005',
+      street: 'Gravenstein',
+      postal_code: '95472',
+      suffix: 'N',
+      street_type: 'Hwy'
+    },
+    '1005 Gravenstein Highway North, 95472' => {
+      number: '1005',
+      street: 'Gravenstein',
+      postal_code: '95472',
+      suffix: 'N',
+      street_type: 'Hwy'
+    },
+    '1005 N Gravenstein Highway, Sebastopol, CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      street_type: 'Hwy',
+      prefix: 'N'
+    },
+    '1005 N Gravenstein Highway, Suite 500, Sebastopol, CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      street_type: 'Hwy',
+      prefix: 'N',
+      unit_prefix: 'Ste',
+      unit: '500'
+    },
+    '1005 N Gravenstein Hwy Suite 500 Sebastopol, CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      street_type: 'Hwy',
+      prefix: 'N',
+      unit_prefix: 'Ste',
+      unit: '500'
+    },
+    '1005 N Gravenstein Highway, Sebastopol, CA, 95472' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      postal_code: '95472',
+      street_type: 'Hwy',
+      prefix: 'N'
+    },
+    '1005 N Gravenstein Highway Sebastopol CA 95472' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      postal_code: '95472',
+      street_type: 'Hwy',
+      prefix: 'N'
+    },
+    '1005 Gravenstein Hwy N Sebastopol CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      suffix: 'N',
+      street_type: 'Hwy'
+    },
+    '1005 Gravenstein Hwy N, Sebastopol CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      suffix: 'N',
+      street_type: 'Hwy'
+    },
+    '1005 Gravenstein Hwy, N Sebastopol CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'North Sebastopol',
+      street_type: 'Hwy'
+    },
+    '1005 Gravenstein Hwy, North Sebastopol CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'North Sebastopol',
+      street_type: 'Hwy'
+    },
+    '1005 Gravenstein Hwy Sebastopol CA' => {
+      number: '1005',
+      street: 'Gravenstein',
+      state: 'CA',
+      city: 'Sebastopol',
+      street_type: 'Hwy'
+    },
+    '115 Broadway San Francisco CA' => {
+      street_type: nil,
+      number: '115',
+      street: 'Broadway',
+      state: 'CA',
+      city: 'San Francisco'
+    },
+    '7800 Mill Station Rd, Sebastopol, CA 95472' => {
+      number: '7800',
+      street: 'Mill Station',
+      state: 'CA',
+      city: 'Sebastopol',
+      postal_code: '95472',
+      street_type: 'Rd'
+    },
+    '7800 Mill Station Rd Sebastopol CA 95472' => {
+      number: '7800',
+      street: 'Mill Station',
+      state: 'CA',
+      city: 'Sebastopol',
+      postal_code: '95472',
+      street_type: 'Rd'
+    },
+    '1005 State Highway 116 Sebastopol CA 95472' => {
+      number: '1005',
+      street: 'State Highway 116',
+      state: 'CA',
+      city: 'Sebastopol',
+      postal_code: '95472',
+      street_type: 'Hwy'
+    },
+    '1600 Pennsylvania Ave. Washington DC' => {
+      number: '1600',
+      street: 'Pennsylvania',
+      state: 'DC',
+      city: 'Washington',
+      street_type: 'Ave'
+    },
+    '1600 Pennsylvania Avenue Washington DC' => {
+      number: '1600',
+      street: 'Pennsylvania',
+      state: 'DC',
+      city: 'Washington',
+      street_type: 'Ave'
+    },
+    '48S 400E, Salt Lake City UT' => {
+      street_type: nil,
+      number: '48',
+      street: '400',
+      state: 'UT',
+      city: 'Salt Lake City',
+      suffix: 'E',
+      prefix: 'S'
+    },
+    '550 S 400 E #3206, Salt Lake City UT 84111' => {
+      number: '550',
+      street: '400',
+      state: 'UT',
+      unit: '3206',
+      postal_code: '84111',
+      city: 'Salt Lake City',
+      suffix: 'E',
+      street_type: nil,
+      unit_prefix: '#',
+      prefix: 'S'
+    },
+    '6641 N 2200 W Apt D304 Park City, UT 84098' => {
+      number: '6641',
+      street: '2200',
+      state: 'UT',
+      unit: 'D304',
+      postal_code: '84098',
+      city: 'Park City',
+      suffix: 'W',
+      street_type: nil,
+      unit_prefix: 'Apt',
+      prefix: 'N'
+    },
+    '100 South St, Philadelphia, PA' => {
+      number: '100',
+      street: 'South',
+      state: 'PA',
+      city: 'Philadelphia',
+      street_type: 'St'
+    },
+    '100 S.E. Washington Ave, Minneapolis, MN' => {
+      number: '100',
+      street: 'Washington',
+      state: 'MN',
+      city: 'Minneapolis',
+      street_type: 'Ave',
+      prefix: 'SE'
+    },
+    '3813 1/2 Some Road, Los Angeles, CA' => {
+      number: '3813',
+      street: 'Some',
+      state: 'CA',
+      city: 'Los Angeles',
+      street_type: 'Rd'
+    },
+    '1 First St, e San Jose CA' => { # lower case city direction
+      number: '1',
+      street: '1st',
+      state: 'CA',
+      city: 'East San Jose',
+      street_type: 'St'
+    },
+    '123 Maple Rochester, New York' => { # space in state name
+      street_type: nil,
+      number: '123',
+      street: 'Maple',
+      state: 'NY',
+      city: 'Rochester'
+    },
+    '233 S Wacker Dr 60606-6306' => { # zip+4 with hyphen
+      number: '233',
+      street: 'Wacker',
+      postal_code: '60606',
+      postal_code_ext: '6306',
+      street_type: 'Dr',
+      prefix: 'S'
+    },
+    '233 S Wacker Dr 606066306' => { # zip+4 without hyphen
+      number: '233',
+      street: 'Wacker',
+      postal_code: '60606',
+      postal_code_ext: '6306',
+      street_type: 'Dr',
+      prefix: 'S'
+    },
+    'lt42 99 Some Road, Some City LA' => { # no space before sec_unit_num
+      unit: '42',
+      city: 'Some City',
+      number: '99',
+      street: 'Some',
+      unit_prefix: 'Lot',
+      street_type: 'Rd',
+      state: 'LA'
+    },
+    '36401 County Road 43, Eaton, CO 80615' => { # numbered County Road
+      city: 'Eaton',
+      postal_code: '80615',
+      number: '36401',
+      street: 'County Road 43',
+      street_type: 'Rd',
+      state: 'CO'
+    },
+    "14168 W RIVER RD   \nCOLUMBIA STATION, OH 44028-9430" => { # overlapping street type and road name
+      city: 'Columbia Station',
+      postal_code: '44028',
+      postal_code_ext: '9430',
+      number: '14168',
+      street: 'River',
+      street_type: 'Rd',
+      state: 'OH',
+      prefix: 'W'
+    },
+    "555 E LAKE AVE    \nBELLEFONTAINE, OH 43311-2509" => {
+      city: 'Bellefontaine',
+      postal_code: '43311',
+      postal_code_ext: '2509',
+      number: '555',
+      street: 'Lake',
+      street_type: 'Ave',
+      state: 'OH',
+      prefix: 'E'
+    },
+    "19600 N PARK BLVD    \nSHAKER HEIGHTS, OH 44122-1825" => {
+      city: 'Shaker Heights',
+      postal_code: '44122',
+      postal_code_ext: '1825',
+      number: '19600',
+      street: 'Park',
+      street_type: 'Blvd',
+      state: 'OH',
+      prefix: 'N'
+    },
+    '1234 COUNTY HWY 60E, Town, CO 12345' => {
+      city: 'Town',
+      postal_code: '12345',
+      number: '1234',
+      street: 'County Hwy 60',
+      suffix: 'E',
+      street_type: 'Hwy',
+      state: 'CO'
+    },
+    "'45 Quaker Ave, Ste 105'" => { # RT#73397
+      number: '45',
+      street: 'Quaker',
+      street_type: 'Ave',
+      unit: '105',
+      unit_prefix: 'Ste'
+    },
+    ##### pre-existing tests from ruby library
+    '2730 S Veitch St Apt 207, Arlington, VA 22206' => {
+      number: '2730',
+      postal_code: '22206',
+      prefix: 'S',
+      state: 'VA',
+      street: 'Veitch',
+      street_type: 'St',
+      unit: '207',
+      unit_prefix: 'Apt',
+      city: 'Arlington',
+      prefix2: nil,
+      postal_code_ext: nil
+    },
+    '44 Canal Center Plaza Suite 500, Alexandria, VA 22314' => {
+      number: '44',
+      postal_code: '22314',
+      prefix: nil,
+      state: 'VA',
+      street: 'Canal Center',
+      street_type: 'Plz',
+      unit: '500',
+      unit_prefix: 'Ste',
+      city: 'Alexandria',
+      street2: nil
+    },
+    '1600 Pennsylvania Ave NW Washington DC' => {
+      number: '1600',
+      postal_code: nil,
+      prefix: nil,
+      state: 'DC',
+      street: 'Pennsylvania',
+      street_type: 'Ave',
+      unit: nil,
+      unit_prefix: nil,
+      city: 'Washington',
+      street2: nil,
+      suffix: 'NW'
+    },
+    '1005 Gravenstein Hwy N, Sebastopol CA 95472' => {
+      number: '1005',
+      postal_code: '95472',
+      prefix: nil,
+      state: 'CA',
+      street: 'Gravenstein',
+      street_type: 'Hwy',
+      unit: nil,
+      unit_prefix: nil,
+      city: 'Sebastopol',
+      street2: nil,
+      suffix: 'N'
+    },
+    '2730 S Veitch St #207, Arlington, VA 22206' => {
+      number: '2730',
+      street: 'Veitch',
+      street_type: 'St',
+      unit: '207',
+      unit_prefix: '#',
+      suffix: nil,
+      prefix: 'S',
+      city: 'Arlington',
+      state: 'VA',
+      postal_code: '22206',
+      postal_code_ext: nil
+    },
+
+    'P.O. BOX 293930, ARLINGTON, VA 22206' => {
+      number: nil,
+      street: 'PO Box 293930',
+      street_type: nil,
+      unit: nil,
+      unit_prefix: nil,
+      suffix: nil,
+      prefix: nil,
+      city: 'Arlington',
+      state: 'VA',
+      postal_code: '22206',
+      postal_code_ext: nil
+    }
+  }.freeze
+
+  PARSEABLE_INTERSECTIONS = {
+    'Mission & Valencia San Francisco CA' => {
+      street_type: nil,
+      street_type2: nil,
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    },
+
+    'Mission & Valencia, San Francisco CA' => {
+      street_type: nil,
+      street_type2: nil,
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    },
+    'Mission St and Valencia St San Francisco CA' => {
+      street_type: 'St',
+      street_type2: 'St',
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    },
+    'Hollywood Blvd and Vine St Los Angeles, CA' => {
+      street_type: 'Blvd',
+      street_type2: 'St',
+      street: 'Hollywood',
+      state: 'CA',
+      city: 'Los Angeles',
+      street2: 'Vine'
+    },
+    'Mission St & Valencia St San Francisco CA' => {
+      street_type: 'St',
+      street_type2: 'St',
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    },
+    'Mission and Valencia Sts San Francisco CA' => {
+      street_type: 'St',
+      street_type2: 'St',
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    },
+    'Mission & Valencia Sts. San Francisco CA' => {
+      street_type: 'St',
+      street_type2: 'St',
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    },
+    'Mission & Valencia Streets San Francisco CA' => {
+      street_type: 'St',
+      street_type2: 'St',
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    },
+    'Mission Avenue and Valencia Street San Francisco CA' => {
+      street_type: 'Ave',
+      street_type2: 'St',
+      street: 'Mission',
+      state: 'CA',
+      city: 'San Francisco',
+      street2: 'Valencia'
+    }
+  }.freeze
+
+  INFORMAL = {
+    '#42 233 S Wacker Dr 60606' => {
+      number: '233',
+      postal_code: '60606',
+      prefix: 'S',
+      state: nil,
+      street: 'Wacker',
+      street_type: 'Dr',
+      unit: '42',
+      unit_prefix: '#',
+      city: nil,
+      street2: nil,
+      suffix: nil
+    },
+    'Apt. 42, 233 S Wacker Dr 60606' => {
+      number: '233',
+      postal_code: '60606',
+      prefix: 'S',
+      state: nil,
+      street: 'Wacker',
+      street_type: 'Dr',
+      unit: '42',
+      unit_prefix: 'Apt',
+      city: nil,
+      street2: nil,
+      suffix: nil
+    },
+    '2730 S Veitch St #207' => {
+      number: '2730',
+      street: 'Veitch',
+      street_type: 'St',
+      unit: '207',
+      unit_prefix: '#',
+      suffix: nil,
+      prefix: 'S',
+      city: nil,
+      state: nil,
+      postal_code: nil
+    },
+    '321 S. Washington' => { # RT#82146
+      street_type: nil,
+      prefix: 'S',
+      street: 'Washington',
+      number: '321'
+    },
+    '233 S Wacker Dr lobby 60606' => { # unnumbered secondary unit type
+      number: '233',
+      street: 'Wacker',
+      postal_code: '60606',
+      street_type: 'Dr',
+      prefix: 'S',
+      unit_prefix: 'Lbby'
+    },
+    '(233 S Wacker Dr lobby 60606)' => { # surrounding punctuation
+      number: '233',
+      street: 'Wacker',
+      postal_code: '60606',
+      street_type: 'Dr',
+      prefix: 'S',
+      unit_prefix: 'Lbby'
+    }
+  }.freeze
+
+  EXPECTED_FAILURES = [
+    '1005 N Gravenstein Hwy Sebastopol',
+    '1005 N Gravenstein Hwy Sebastopol CZ',
+    'Gravenstein Hwy 95472',
+    'E1005 Gravenstein Hwy 95472'
+  ].freeze
+
+  ACCESSIBLE_ATTRIBUTES = %w[number street street_type unit unit_prefix suffix
+                             prefix city state postal_code postal_code_ext
+                             street2 street_type2 suffix2 prefix2].freeze
+
+  ADDRESSES = NORMAL.merge(INFORMAL)
+  ALL_ADDRESSES = ADDRESSES.merge(PARSEABLE_INTERSECTIONS)
+
+  describe '#parse_address' do
+    EXPECTED_FAILURES.each do |address|
+      context address.to_s do
+        it 'returns nil' do
+          expect(StreetSweeper.parse_address(address)).to be_nil
+        end
+      end
+    end
+  end
+
+  describe '#parse' do
+    context 'with default settings' do
+      ALL_ADDRESSES.each_pair do |address, expected|
+        context address.to_s do
+          ACCESSIBLE_ATTRIBUTES.each do |attribute|
+            next if expected[attribute.to_sym].to_s == ''
+            it "#{attribute}: #{expected[attribute.to_sym]}" do
+              compare_expected_to_actual(expected, address, attribute)
+            end
+          end
+        end
+      end
+    end
+
+    context 'avoid_redundant_street_type: true' do
+      context '36401 County Road 43, Eaton, CO 80615' do
+        it 'returns street_type: nil' do
+          address = '36401 County Road 43, Eaton, CO 80615'
+          expected_results = {
+            number: '36401',
+            street: 'County Road 43',
+            city: 'Eaton',
+            state: 'CO',
+            postal_code: '80615',
+            street_type: nil
+          }
+          parsed_address = StreetSweeper.parse(address, avoid_redundant_street_type: true)
+          compare_expected_to_actual_hash(expected_results, parsed_address.to_h, address)
+        end
+      end
+    end
+
+    context 'informal: true' do
+      ALL_ADDRESSES.each_pair do |address, expected|
+        context address.to_s do
+          ACCESSIBLE_ATTRIBUTES.each do |attribute|
+            next if expected[attribute.to_sym].to_s == ''
+            it "#{attribute}: #{expected[attribute.to_sym]}" do
+              compare_expected_to_actual(expected, address, attribute, true)
+            end
+          end
+        end
+      end
+
+      it 'receiving a valid standard address, parses the input' do
+        a = StreetSweeper.parse('2730 S Veitch St, Arlington, VA 222064444', informal: true)
+        expect(a.number).to eq('2730')
+        expect(a.prefix).to eq('S')
+        expect(a.street).to eq('Veitch')
+        expect(a.street_type).to eq('St')
+        expect(a.city).to eq('Arlington')
+        expect(a.state).to eq('VA')
+        expect(a.postal_code).to eq('22206')
+        expect(a.postal_code_ext).to eq('4444')
+      end
+
+      it 'receiving a valid informal address, parses the input' do
+        a = StreetSweeper.parse('2730 S Veitch St', informal: true)
+        expect(a.number).to eq('2730')
+        expect(a.prefix).to eq('S')
+        expect(a.street).to eq('Veitch')
+        expect(a.street_type).to eq('St')
+      end
+
+      it 'receiving a valid informal address with trailing words, parses the input' do
+        a = StreetSweeper.parse('2730 S Veitch St in the south of arlington', informal: true)
+        expect(a.number).to eq('2730')
+        expect(a.prefix).to eq('S')
+        expect(a.street).to eq('Veitch')
+        expect(a.street_type).to eq('St')
+      end
+    end
+  end
+
+  def compare_expected_to_actual_hash(expected, actual, _address)
+    expected.each_pair do |expected_key, expected_value|
+      expect(actual[expected_key]).to eq(expected_value)
+    end
+  end
+
+  def compare_expected_to_actual(expected, address, attribute, informal = false, redundant = false)
+    addr = StreetSweeper.parse(address, informal: informal, avoid_redundant_street_type: redundant)
+    expect(addr.send(attribute)).to eq(expected[attribute.to_sym])
+  end
+end