StreetAddress项目技术文档

1. 安装指南

要安装StreetAddress项目，请使用以下命令：

gem install StreetAddress

在您的Ruby代码中，您可以这样引入StreetAddress库：

require 'street_address'

如果您使用的是Gemfile，可以按照以下方式添加依赖：

gem 'StreetAddress', :require => "street_address"

2. 项目使用说明

StreetAddress项目是一个用于解析字符串并返回标准化地址对象的库。如果输入的字符串不是美国地址，它会返回nil。

以下是基本的使用方法：

require 'street_address'

address = StreetAddress::US.parse("1600 Pennsylvania Ave, Washington, DC, 20500")
puts address.street        # 输出: Pennsylvania
puts address.number        # 输出: 1600
puts address.postal_code   # 输出: 20500
puts address.city          # 输出: Washington
puts address.state         # 输出: DC
puts address.state_name    # 输出: District of columbia
puts address.street_type   # 输出: Ave
puts address.intersection? # 输出: false
puts address.to_s          # 输出: "1600 Pennsylvania Ave, Washington, DC 20500"
puts address.to_s(:line1)  # 输出: 1600 Pennsylvania Ave

如果解析的字符串不包含完整地址信息，StreetAddress也能处理：

address = StreetAddress::US.parse("1600 Pennsylvania Ave")
puts address.street # 输出: Pennsylvania
puts address.number # 输出: 1600
puts address.state  # 输出: nil

对于更复杂的地址，StreetAddress也能正确解析：

address = StreetAddress::US.parse("5904 Richmond Hwy Ste 340 Alexandria VA 22303-1864")
puts address.postal_code_ext # 输出: 1846

3. 项目API使用文档

以下是StreetAddress项目的API使用文档：

• StreetAddress::US.parse(address_string)：解析给定的地址字符串。
• address.street：返回街道名称。
• address.number：返回街道号码。
• address.postal_code：返回邮政编码。
• address.city：返回城市名称。
• address.state：返回州缩写。
• address.state_name：返回完整的州名称。
• address.street_type：返回街道类型。
• address.intersection?：判断是否是街道交叉口。
• address.to_s：返回格式化的地址字符串。
• address.to_s(:line1)：返回地址的第一行。

4. 项目安装方式

项目的安装方式在“安装指南”部分已有详细说明。您可以使用Ruby的gem包管理器来安装StreetAddress项目。具体命令如下：

gem install StreetAddress

在项目中引入StreetAddress库：

require 'street_address'

或者在Gemfile中添加依赖：

gem 'StreetAddress', :require => "street_address"