dc_address_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14263a461a3fe0f8d380d0e2694fdf0025332b8e
+  data.tar.gz: 01cca92f544be21c6315868c304b9af79dd6aed4
+SHA512:
+  metadata.gz: 6b7158a7cb1d8e8e98698977a80bf7bcb8477c702bc0d708f51e7751e50ea711d1cabf1f1cc03b84ea3d8e577e86c9fcfd6aa34eb01ccc9d18dd9f9ed534fd3b
+  data.tar.gz: ce7e8cb159ceaa92d687a8db3e6f4c7216e1a7c42ae1831598d40a25a20f7a4329debf28e256e355a692d31e8cc87664aa7a80f6a923eecec7199b1d6ac117bb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+before_install: gem install bundler -v 1.11.2
+script: script/cibuild
+cache: bundler
+sudo: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dc_address_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ben Balter
+
+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.md

@@ -0,0 +1,44 @@
+# DC Address Parser
+
+*Parses and normalizes Washington, DC street addresses according to the DC Master Address Repository (MAR) standard.*
+
+[![Build Status](https://travis-ci.org/benbalter/dc-address-parser.svg)](https://travis-ci.org/benbalter/dc-address-parser)
+
+## Usage
+
+```ruby
+address = DcAddressParser.parse "123 main st n.w."
+
+address.number
+=> 123
+
+address.street_name
+=> "MAIN"
+
+address.street_type
+=> "STREET"
+
+address.quadrant
+=> "NW"
+
+address.to_s
+"123 MAIN STREET NW"
+```
+
+## Address standard
+
+The Gem conforms to the [DC Master Address Repository (MAR) address standard](http://octo.dc.gov/sites/default/files/dc/sites/octo/publication/attachments/DCGIS-MarAddressStandards.pdf). You can learn more about the MAR in the [MAR FAQ](http://octo.dc.gov/sites/default/files/dc/sites/octo/publication/attachments/DCGIS-MarFAQ.pdf).
+
+## Looking up addresses in the MAR
+
+The Gem integrates with the [DC Address Lookup](https://github.com/benbalter/dc-address-lookup) gem. To look up an address in the MAR:
+
+```ruby
+address.lookup
+=> #<DcAddressLookup::Location>
+```
+
+## Installing
+
+1. Add `gem 'dc_address_parser'` to your project's Gemfile
+2. `bundle install`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dc_address_parser.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dc_address_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dc_address_parser"
+  spec.version       = DcAddressParser::VERSION
+  spec.authors       = ["Ben Balter"]
+  spec.email         = ["ben.balter@github.com"]
+
+  spec.summary       = "Parses and normalizes Washington, DC street addresses according to the DC Master Address Repository (MAR) standard."
+  spec.homepage      = "https://github.com/benbalter/dc-address-parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.2"
+  spec.add_dependency "dc_address_lookup", "~> 0.2"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "webmock", "~> 1.22"
+end

data/lib/dc_address_parser.rb

@@ -0,0 +1,10 @@
+require "dc_address_parser/version"
+require "dc_address_parser/address"
+require "active_support/inflector"
+require "dc_address_lookup"
+
+module DcAddressParser
+  def self.parse(address)
+    Address.new(address)
+  end
+end

data/lib/dc_address_parser/address.rb

@@ -0,0 +1,195 @@
+module DcAddressParser
+  class Address
+    class InvalidAddress < StandardError; end
+
+    attr_reader :raw_address
+
+    CITY = "WASHINGTON, DC"
+    STREET_TYPES = {
+      "STREET"    => "ST",
+      "AVENUE"    => "AVE",
+      "BOULEVARD" => "BLVD",
+      "ROAD"      => "RD",
+      "PLACE"     => "PL",
+      "DRIVE"     => "DR",
+      "CIRCLE"    => "CIR",
+      "PALZA"     => "PLZ",
+      "COURT"     => "CT",
+      "ALLEY"     => "AL",
+      "TERRACE"   => "TER"
+    }
+
+    DIRECTIONS = {
+      "NORTH" => "N",
+      "SOUTH" => "S",
+      "EAST"  => "E",
+      "WEST"  => "W"
+    }
+
+    NUMBER_REGEX          = /\A(\d+)[A-Z]*/
+    NUMBER_SUFFIX_REGEX   = /(\d+\/\d+|rear)/i
+    STREET_NAME_REGEX     = /([A-Z0-9' ]+)/
+    STREET_TYPE_REGEX     = /\b(#{Regexp.union(STREET_TYPES.keys)})\b/
+    STREET_TYPE_ABV_REGEX = /\b(#{Regexp.union(STREET_TYPES.values)})\b/
+    QUADRANT_REGEX        = /([NS][EW])/
+
+    REQUIRED_PARTS = [:number, :street_name, :street_type, :quadrant]
+
+    def initialize(raw_address)
+      @raw_address = @address = raw_address
+      normalize!
+      REQUIRED_PARTS.each do |part|
+        raise InvalidAddress, "#{part.to_s.sub("_", " ")} is missing" if send(part).nil?
+      end
+    end
+
+    def number
+      @number ||= match(NUMBER_REGEX).to_i
+    end
+
+    def number_suffix
+      @number_suffix ||= match(/#{number}\s#{NUMBER_SUFFIX_REGEX}/)
+    end
+    alias_method :suffix, :number_suffix
+
+    def street_name
+      @street_name ||= begin
+        street_name = match(
+        /#{number}(-?#{unit_number}|\s#{Regexp.escape number_suffix.to_s})?
+        \s#{STREET_NAME_REGEX}\s#{STREET_TYPE_REGEX}/x, 2)
+
+        if street_name =~ /\A[0-9]+\z/
+          street_name = ActiveSupport::Inflector.ordinalize(street_name).upcase
+        end
+
+        street_name
+      end
+    end
+    alias_method :street, :street_name
+
+    def street_type
+      @street_type ||= match STREET_TYPE_REGEX
+    end
+
+    def quadrant
+      @quadrant ||= match QUADRANT_REGEX
+    end
+    alias_method :quad, :quadrant
+
+    def unit_number
+      @unit_number ||= begin
+        unit_number = match(/\A(\d+)(-|–)?([A-Z])\b/) ||
+          match(/\s(UNIT\s|APT\s|#)([A-Z0-9]+)(\s|\z)/, 2) ||
+          match(/#{quadrant}\s([A-Z0-9]+)\z/)
+        if unit_number =~ /\A\d+\z/
+          unit_number.to_i
+        else
+          unit_number
+        end
+      end
+    end
+    alias_method :unit, :unit_number
+
+    def to_h
+      {
+        number: number,
+        number_suffix: number_suffix,
+        street_name: street_name,
+        street_type: street_type,
+        quadrant: quadrant,
+        unit_number: unit_number,
+        city: CITY
+      }
+    end
+
+    def to_s(include_city=false)
+      parts = to_h
+      if include_city
+        parts[:quadrant] << ","
+      else
+        parts.delete(:city)
+      end
+      parts.values.compact.join(" ")
+    end
+
+    def lookup
+      DcAddressLookup.lookup to_s
+    end
+
+    private
+
+    def normalize!
+      normalize_whitespace
+      normalize_case
+      normalize_ranges
+      normalize_quadrant
+      normalize_street_type
+      normalize_rear
+      normalize_space
+      normalize_mlk
+      normalize_directions
+      normalize_mt
+      split
+    end
+
+    def normalize_whitespace
+      @address = @address.strip.squeeze("\s").squeeze("'")
+    end
+
+    def normalize_case
+      @address = @address.upcase
+    end
+
+    def normalize_ranges
+      @address.gsub!(/\A(\d+)\s?(-|–|&)\s?\d+/, '\1')
+      @address.gsub!(/(\d+), \d+,? and \d+/i, '\1')
+    end
+
+    def normalize_quadrant
+      @address.gsub!(/([NS])\.([EW])\.?/, '\1\2')
+      @address.gsub!(/, ([NS][EW])/, ' \1')
+    end
+
+    def normalize_street_type
+      @address.gsub!(STREET_TYPE_ABV_REGEX, STREET_TYPES.invert)
+    end
+
+    def normalize_rear
+      regex = /\AREAR OF (\d+)/
+      return unless @address =~ regex
+      @address.gsub!(/\AREAR OF (\d+)/, '\1')
+      @address << " REAR"
+    end
+
+    def normalize_space
+      @address.gsub!(/\bSPACE\b/, "UNIT")
+    end
+
+    def normalize_mlk
+      @address.gsub!(/\bM\.?L\.? KING\b/, "MARTIN LUTHER KING")
+      @address.gsub!(/\bJR\./, "JR")
+    end
+
+    def normalize_directions
+      regex = /\b(#{Regexp.union DIRECTIONS.values})(?=\s+|\.)/
+      @address.gsub!(regex, DIRECTIONS.invert)
+    end
+
+    def normalize_mt
+      @address.gsub!(/\bMT\b/, "MOUNT")
+    end
+
+    def split
+      @address = @address.split(";").reject { |s| s.empty? }.first.to_s
+      @address = @address.split(/\bAND\b/).first.to_s.strip
+      @address = @address.split(/\b([NS][EW]),/)[0..1].join
+    end
+
+    def match(regex, number=nil)
+      matches = @address.match(regex)
+      return unless matches
+      return matches[number] if number
+      matches.to_a.last
+    end
+  end
+end

data/lib/dc_address_parser/version.rb

@@ -0,0 +1,3 @@
+module DcAddressParser
+  VERSION = "0.1.0"
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle install

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle exec rake spec

data/script/console

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle exec pry -r "./lib/dc_address_parser"

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: dc_address_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: dc_address_lookup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: 
+email:
+- ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dc_address_parser.gemspec
+- lib/dc_address_parser.rb
+- lib/dc_address_parser/address.rb
+- lib/dc_address_parser/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+homepage: https://github.com/benbalter/dc-address-parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Parses and normalizes Washington, DC street addresses according to the DC
+  Master Address Repository (MAR) standard.
+test_files: []