StreetAddress 1.0.5 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b39341a1cc71e0b60638cb25159114b89c2bfc73fd86311663a346e729a96e13
+  data.tar.gz: 1c0a33da1d9fb744cef41f7e8f439d01681f1fb3500e14eaf695efdfa1740e39
+SHA512:
+  metadata.gz: e7888fa1e2419e5e0e67177f9099c4e68d8e45ab6d45c710066803b7d092035ac78d8c2e78116555d735d370eacad6af4c09e9906a309639962cef9bdc3260f2
+  data.tar.gz: '056349ebed8575a764dac7a8130dd6150a5385d8b9e6949bbf8c6882d06fe0bb480f7a31861bdb512811453d5273f14ab87745c5d129c96384b2a064581f542b'

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
+
+## [2.0.0] - 2026-03-23
+
+### Added
+- `line1` and `line2` methods for USPS-formatted address lines
+- `to_s` with format argument (`:line1`, `:line2`, `:default`)
+- `to_h` method to convert address to a hash
+- `full_postal_code` method (returns "12345" or "12345-6789")
+- `==` comparison operator for Address objects
+- `state_fips` and `state_name` methods
+- `avoid_redundant_street_type` option for `parse`
+- ZIP+4 support (with or without hyphen)
+- Informal address parsing (partial addresses without city/state)
+- City directional expansion ("e San Jose" → "East San Jose")
+- Word capitalization normalization for street, city, unit_prefix
+- GitHub Actions CI (Ruby 3.3 and 3.4)
+- CHANGELOG.md
+
+### Changed
+- Minimum Ruby version is now 3.3 (dropped support for Ruby < 3.3)
+- Named capture groups in regexes replace positional match indices
+- `\A`/`\z` anchors replace `^`/`$` for correctness with multiline strings
+- Modernized gemspec (removed shell commands, added metadata)
+- Replaced CircleCI with GitHub Actions
+
+### Removed
+- CircleCI configuration (replaced by GitHub Actions)
+- Inline rdoc blocks (moved to README)
+
+### Fixed
+- `MiniTest::Test` → `Minitest::Test` for modern Minitest compatibility
+- Duplicate `unit_regexp` declaration in `attr_accessor` block
+- `assert_equal nil` → `assert_nil` in tests for modern Minitest
+
+## [1.0.6] - 2014-12-21
+
+### Fixed
+- Various bug fixes and improvements
+
+## [1.0.0] - 2011-08-05
+
+- Initial release as a Ruby gem
+- Port of Perl module Geo::StreetAddress::US

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2007-2026 Derrek Long and Contributors
+
+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,103 @@
+[![Gem Version](https://img.shields.io/gem/v/StreetAddress.svg)](https://rubygems.org/gems/StreetAddress)
+[![CI](https://github.com/street-address-rb/street-address/actions/workflows/ci.yml/badge.svg)](https://github.com/street-address-rb/street-address/actions/workflows/ci.yml)
+
+# StreetAddress
+
+Parses a US street address string and returns a normalized Address object. Returns `nil` when the string is not a recognized US address format.
+
+This is a port of the Perl module [Geo::StreetAddress::US](https://github.com/timbunce/Geo-StreetAddress-US) originally written by Schuyler D. Erle.
+
+## Ruby Version
+
+Requires Ruby 3.3 or later. For Ruby 2.x support, use gem version 1.0.6.
+
+## Installation
+
+```shell
+gem install StreetAddress
+```
+
+then in your code
+
+```ruby
+require 'street_address'
+```
+
+or in your Gemfile
+
+```ruby
+gem 'StreetAddress', require: 'street_address'
+```
+
+## Basic Usage
+
+```ruby
+require 'street_address'
+
+address = StreetAddress::US.parse("1600 Pennsylvania Ave, Washington, DC, 20500")
+address.number      # "1600"
+address.street      # "Pennsylvania"
+address.street_type # "Ave"
+address.city        # "Washington"
+address.state       # "DC"
+address.state_name  # "District Of Columbia"
+address.postal_code # "20500"
+address.intersection? # false
+address.to_s        # "1600 Pennsylvania Ave, Washington, DC 20500"
+address.to_s(:line1) # "1600 Pennsylvania Ave"
+address.to_s(:line2) # "Washington, DC 20500"
+address.to_h        # { number: "1600", street: "Pennsylvania", ... }
+
+address = StreetAddress::US.parse("1600 Pennsylvania Ave")
+address.street # "Pennsylvania"
+address.number # "1600"
+address.state  # nil
+```
+
+## ZIP+4 Support
+
+```ruby
+address = StreetAddress::US.parse("5904 Richmond Hwy Ste 340 Alexandria VA 22303-1864")
+address.postal_code     # "22303"
+address.postal_code_ext # "1864"
+address.full_postal_code # "22303-1864"
+
+# Also works without the hyphen
+address = StreetAddress::US.parse("5904 Richmond Hwy Ste 340 Alexandria VA 223031864")
+address.postal_code_ext # "1864"
+```
+
+## Intersection Parsing
+
+```ruby
+address = StreetAddress::US.parse("Hollywood Blvd and Vine St, Los Angeles, CA")
+address.intersection? # true
+address.street        # "Hollywood"
+address.street_type   # "Blvd"
+address.street2       # "Vine"
+address.street_type2  # "St"
+```
+
+## Stricter Parsing
+
+```ruby
+address = StreetAddress::US.parse_address("1600 Pennsylvania Avenue")
+# nil - not enough information to be a full address
+
+address = StreetAddress::US.parse_address("1600 Pennsylvania Ave, Washington, DC, 20500")
+# Returns Address object - full address provided
+```
+
+## Known Limitations
+
+- US addresses only (returns `nil` for international addresses)
+- PO Boxes are not supported
+- Military addresses (APO/FPO) are not supported
+- Rural routes (RR) and highway contract routes (HC) are not supported
+- Addresses ending in "United States" or "USA" may not parse correctly
+
+## License
+
+The [MIT License](http://opensource.org/licenses/MIT)
+
+Copyright (c) 2007-2026 Derrek Long and Contributors