addressing 1.0.0 → 2.0.1

data/data/country/yue-Hans.json

@@ -5,6 +5,7 @@
 	"AR": "阿根廷",
 	"AE": "阿拉伯联合大公国",
 	"OM": "阿曼王国",
+	"AZ": "阿塞拜疆",
 	"AC": "阿森松岛",
 	"EG": "埃及",
 	"IE": "爱尔兰",
@@ -30,6 +31,7 @@
 	"BG": "保加利亚",
 	"KP": "北韩",
 	"MP": "北马里亚纳群岛",
+	"MK": "北马其顿",
 	"BZ": "贝里斯",
 	"BJ": "贝南",
 	"BE": "比利时",
@@ -74,6 +76,7 @@
 	"CO": "哥伦比亚",
 	"CR": "哥斯大黎加",
 	"GL": "格陵兰",
+	"GE": "格鲁吉亚",
 	"GD": "格瑞那达",
 	"KM": "葛摩",
 	"GG": "根西岛",
@@ -114,10 +117,10 @@
 	"LV": "拉脱维亚",
 	"LR": "赖比瑞亚",
 	"LS": "赖索托",
+	"LA": "老挝",
 	"LB": "黎巴嫩",
 	"LT": "立陶宛",
 	"LY": "利比亚",
-	"LA": "寮国",
 	"LI": "列支敦斯登",
 	"RE": "留尼旺",
 	"RW": "卢安达",
@@ -130,7 +133,6 @@
 	"MW": "马拉威",
 	"MY": "马来西亚",
 	"ML": "马利",
-	"MK": "马其顿",
 	"MH": "马绍尔群岛",
 	"YT": "马约特",
 	"IM": "曼岛",
@@ -163,7 +165,6 @@
 	"NP": "尼泊尔",
 	"NE": "尼日",
 	"NU": "纽埃岛",
-	"NZ": "纽西兰",
 	"NO": "挪威",
 	"NF": "诺福克岛",
 	"NR": "诺鲁",
@@ -171,7 +172,6 @@
 	"PT": "葡萄牙",
 	"BI": "蒲隆地",
 	"TT": "千里达同多巴哥",
-	"GE": "乔治亚共和国",
 	"JP": "日本",
 	"SE": "瑞典",
 	"CH": "瑞士",
@@ -181,7 +181,7 @@
 	"SN": "塞内加尔",
 	"SC": "塞席尔",
 	"CY": "赛普勒斯",
-	"SA": "沙乌地阿拉伯",
+	"SA": "沙特阿拉伯",
 	"ZM": "尚比亚",
 	"BL": "圣巴瑟米",
 	"CX": "圣诞岛",
@@ -229,18 +229,18 @@
 	"ZW": "辛巴威",
 	"SG": "新加坡",
 	"NC": "新喀里多尼亚",
+	"NZ": "新西兰",
 	"HU": "匈牙利",
 	"EA": "休达与梅利利亚",
 	"SY": "叙利亚",
 	"JM": "牙买加",
 	"AM": "亚美尼亚",
-	"AZ": "亚塞拜然",
-	"YE": "叶门",
+	"YE": "也门",
 	"IQ": "伊拉克",
 	"IR": "伊朗",
 	"ET": "衣索比亚",
 	"IL": "以色列",
-	"IT": "义大利",
+	"IT": "意大利",
 	"IN": "印度",
 	"ID": "印尼",
 	"GB": "英国",
@@ -252,7 +252,7 @@
 	"GI": "直布罗陀",
 	"CL": "智利",
 	"CF": "中非共和国",
-	"CN": "中华人民共和国",
-	"MO": "中华人民共和国澳门特别行政区",
-	"HK": "中华人民共和国香港特别行政区"
+	"CN": "中国",
+	"MO": "中国澳门特别行政区",
+	"HK": "中国香港特别行政区"
 }

data/data/country/yue.json

@@ -1,13 +1,14 @@
 {
+	"YE": "也門",
 	"TT": "千里達同多巴哥",
 	"TR": "土耳其",
 	"TC": "土克斯及開科斯群島",
 	"TM": "土庫曼",
 	"BT": "不丹",
 	"CF": "中非共和國",
-	"CN": "中華人民共和國",
-	"HK": "中華人民共和國香港特別行政區",
-	"MO": "中華人民共和國澳門特別行政區",
+	"CN": "中國",
+	"HK": "中國香港特別行政區",
+	"MO": "中國澳門特別行政區",
 	"DK": "丹麥",
 	"EC": "厄瓜多",
 	"ER": "厄利垂亞",
@@ -67,6 +68,7 @@
 	"AD": "安道爾",
 	"TK": "托克勞群島",
 	"BM": "百慕達",
+	"LA": "老撾",
 	"ET": "衣索比亞",
 	"ES": "西班牙",
 	"EH": "西撒哈拉",
@@ -76,13 +78,12 @@
 	"HN": "宏都拉斯",
 	"GR": "希臘",
 	"BN": "汶萊",
-	"SA": "沙烏地阿拉伯",
+	"SA": "沙特阿拉伯",
 	"BZ": "貝里斯",
 	"BJ": "貝南",
 	"GQ": "赤道幾內亞",
 	"ZW": "辛巴威",
 	"AM": "亞美尼亞",
-	"AZ": "亞塞拜然",
 	"TZ": "坦尚尼亞",
 	"NG": "奈及利亞",
 	"VE": "委內瑞拉",
@@ -110,6 +111,7 @@
 	"OM": "阿曼王國",
 	"AF": "阿富汗",
 	"AC": "阿森松島",
+	"AZ": "阿塞拜疆",
 	"DZ": "阿爾及利亞",
 	"AL": "阿爾巴尼亞",
 	"RU": "俄羅斯",
@@ -149,6 +151,7 @@
 	"GG": "根西島",
 	"GL": "格陵蘭",
 	"GD": "格瑞那達",
+	"GE": "格魯吉亞",
 	"TH": "泰國",
 	"HT": "海地",
 	"UG": "烏干達",
@@ -159,7 +162,6 @@
 	"RE": "留尼旺",
 	"PE": "秘魯",
 	"NA": "納米比亞",
-	"NZ": "紐西蘭",
 	"NU": "紐埃島",
 	"SO": "索馬利亞",
 	"SB": "索羅門群島",
@@ -183,7 +185,6 @@
 	"BQ": "荷蘭加勒比區",
 	"MZ": "莫三比克",
 	"CM": "喀麥隆",
-	"GE": "喬治亞共和國",
 	"GN": "幾內亞",
 	"GW": "幾內亞比索",
 	"FJ": "斐濟",
@@ -202,15 +203,16 @@
 	"RS": "塞爾維亞",
 	"AT": "奧地利",
 	"AX": "奧蘭群島",
+	"IT": "意大利",
 	"EE": "愛沙尼亞",
 	"IE": "愛爾蘭",
 	"SG": "新加坡",
+	"NZ": "新西蘭",
 	"NC": "新喀里多尼亞",
 	"SL": "獅子山",
 	"CH": "瑞士",
 	"SE": "瑞典",
 	"VU": "萬那杜",
-	"IT": "義大利",
 	"BL": "聖巴瑟米",
 	"VC": "聖文森特同格林納丁斯",
 	"PM": "聖皮埃爾同密克隆群島",
@@ -220,7 +222,6 @@
 	"SH": "聖赫勒拿島",
 	"CX": "聖誕島",
 	"LC": "聖露西亞",
-	"YE": "葉門",
 	"KM": "葛摩",
 	"PT": "葡萄牙",
 	"FK": "福克蘭群島",
@@ -231,7 +232,6 @@
 	"BI": "蒲隆地",
 	"GY": "蓋亞那",
 	"HM": "赫德島同麥克唐納群島",
-	"LA": "寮國",
 	"DE": "德國",
 	"MA": "摩洛哥",
 	"MC": "摩納哥",

data/data/subdivision/VN.json

@@ -2,51 +2,15 @@
 	"country_code": "VN",
 	"locale": "vi",
 	"subdivisions": {
-		"44": {
+		"91": {
 			"name": "An Giang Province",
 			"local_name": "An Giang"
 		},
-		"43": {
-			"name": "Ba Ria-Vung Tau Province",
-			"local_name": "Bà Rịa–Vũng Tàu"
-		},
-		"55": {
-			"name": "Bac Lieu Province",
-			"local_name": "Bạc Liêu"
-		},
-		"54": {
-			"name": "Bac Giang Province",
-			"local_name": "Bắc Giang"
-		},
-		"53": {
-			"name": "Bac Kan Province",
-			"local_name": "Bắc Kạn"
-		},
-		"56": {
+		"24": {
 			"name": "Bac Ninh Province",
 			"local_name": "Bắc Ninh"
 		},
-		"50": {
-			"name": "Ben Tre Province",
-			"local_name": "Bến Tre"
-		},
-		"57": {
-			"name": "Binh Duong Province",
-			"local_name": "Bình Dương"
-		},
-		"31": {
-			"name": "Binh Dinh Province",
-			"local_name": "Bình Định"
-		},
-		"58": {
-			"name": "Binh Phuoc Province",
-			"local_name": "Bình Phước"
-		},
-		"40": {
-			"name": "Binh Thuan Province",
-			"local_name": "Bình Thuận"
-		},
-		"59": {
+		"96": {
 			"name": "Ca Mau Province",
 			"local_name": "Cà Mau"
 		},
@@ -54,71 +18,55 @@
 			"name": "Cao Bang Province",
 			"local_name": "Cao Bằng"
 		},
-		"CT": {
+		"92": {
 			"name": "Can Tho City",
 			"local_name": "Cần Thơ"
 		},
-		"DN": {
+		"48": {
 			"name": "Da Nang City",
 			"local_name": "Đà Nẵng"
 		},
-		"33": {
+		"66": {
 			"name": "Dak Lak Province",
 			"local_name": "Đắk Lắk"
 		},
-		"72": {
-			"name": "Dak Nong Province",
-			"local_name": "Đăk Nông"
-		},
-		"71": {
+		"11": {
 			"name": "Dien Bien Province",
 			"local_name": "Điện Biên"
 		},
-		"39": {
+		"75": {
 			"name": "Dong Nai Province",
 			"local_name": "Đồng Nai"
 		},
-		"45": {
+		"82": {
 			"name": "Dong Thap Province",
 			"local_name": "Đồng Tháp"
 		},
-		"30": {
+		"52": {
 			"name": "Gia Lai Province",
 			"local_name": "Gia Lai"
 		},
-		"03": {
-			"name": "Ha Giang Province",
-			"local_name": "Hà Giang"
-		},
-		"63": {
-			"name": "Ha Nam Province",
-			"local_name": "Hà Nam"
-		},
-		"HN": {
+		"01": {
 			"name": "Hanoi City",
 			"local_name": "Hà Nội"
 		},
-		"23": {
+		"42": {
 			"name": "Ha Tinh Province",
 			"local_name": "Hà Tĩnh"
 		},
-		"61": {
-			"name": "Hai Duong Province",
-			"local_name": "Hải Dương"
-		},
-		"HP": {
-			"name": "Haiphong City",
+		"31": {
+			"name": "Hai Phong City",
 			"local_name": "Hải Phòng"
 		},
-		"73": {
-			"name": "Hau Giang Province",
-			"local_name": "Hậu Giang"
+		"79": {
+			"name": "Ho Chi Minh City",
+			"local_name": "Thành phố Hồ Chí Minh"
 		},
-		"14": {
-			"name": "Hoa Binh Province",
-			"local_name": "Hòa Bình"
+		"46": {
+			"name": "Hue City",
+			"local_name": "Huế"
 		},
-		"66": {
+		"56": {
 			"name": "Hung Yen Province",
 			"local_name": "Hưng Yên"
 		},
@@ -126,23 +74,15 @@
 			"name": "Khanh Hoa Province",
 			"local_name": "Khánh Hòa"
 		},
-		"47": {
-			"name": "Kien Giang Province",
-			"local_name": "Kiên Giang"
-		},
-		"28": {
-			"name": "Kon Tum Province",
-			"local_name": "Kon Tum"
-		},
-		"01": {
+		"12": {
 			"name": "Lai Chau Province",
 			"local_name": "Lai Châu"
 		},
-		"09": {
-			"name": "Lang Song Province",
+		"20": {
+			"name": "Lang Son Province",
 			"local_name": "Lạng Sơn"
 		},
-		"02": {
+		"68": {
 			"name": "Lao Cai Province",
 			"local_name": "Lào Cai"
 		},
@@ -150,109 +90,53 @@
 			"name": "Lam Dong Province",
 			"local_name": "Lâm Đồng"
 		},
-		"41": {
-			"name": "Long An Province",
-			"local_name": "Long An"
-		},
-		"67": {
-			"name": "Nam Dinh Province",
-			"local_name": "Nam Định"
-		},
-		"22": {
+		"40": {
 			"name": "Nghe An Province",
 			"local_name": "Nghệ An"
 		},
-		"18": {
+		"37": {
 			"name": "Ninh Binh Province",
 			"local_name": "Ninh Bình"
 		},
-		"36": {
-			"name": "Ninh Thuan Province",
-			"local_name": "Ninh Thuận"
-		},
-		"68": {
+		"25": {
 			"name": "Phu Tho Province",
 			"local_name": "Phú Thọ"
 		},
-		"32": {
-			"name": "Phu Yen Province",
-			"local_name": "Phú Yên"
-		},
-		"24": {
-			"name": "Quang Binh Province",
-			"local_name": "Quảng Bình"
-		},
-		"27": {
-			"name": "Quang Nam Province",
-			"local_name": "Quảng Nam"
-		},
-		"29": {
+		"51": {
 			"name": "Quang Ngai Province",
 			"local_name": "Quảng Ngãi"
 		},
-		"13": {
+		"22": {
 			"name": "Quang Ninh Province",
 			"local_name": "Quảng Ninh"
 		},
-		"25": {
+		"44": {
 			"name": "Quang Tri Province",
 			"local_name": "Quảng Trị"
 		},
-		"52": {
-			"name": "Soc Trang Province",
-			"local_name": "Sóc Trăng"
-		},
-		"05": {
+		"14": {
 			"name": "Son La Province",
 			"local_name": "Sơn La"
 		},
-		"37": {
+		"80": {
 			"name": "Tay Ninh Province",
 			"local_name": "Tây Ninh"
 		},
-		"20": {
-			"name": "Thai Binh Province",
-			"local_name": "Thái Bình"
-		},
-		"69": {
+		"19": {
 			"name": "Thai Nguyen Province",
 			"local_name": "Thái Nguyên"
 		},
-		"21": {
+		"38": {
 			"name": "Thanh Hoa Province",
 			"local_name": "Thanh Hóa"
-		},
-		"SG": {
-			"name": "Ho Chi Minh City",
-			"local_name": "Thành phố Hồ Chí Minh"
-		},
-		"26": {
-			"name": "Thua Thien-Hue Province",
-			"local_name": "Thừa Thiên–Huế"
-		},
-		"46": {
-			"name": "Tien Giang Province",
-			"local_name": "Tiền Giang"
-		},
-		"51": {
-			"name": "Tra Vinh Province",
-			"local_name": "Trà Vinh"
-		},
-		"07": {
+		},				
+		"08": {
 			"name": "Tuyen Quang Province",
 			"local_name": "Tuyên Quang"
 		},
-		"49": {
+		"86": {
 			"name": "Vinh Long Province",
 			"local_name": "Vĩnh Long"
-		},
-		"70": {
-			"name": "Vinh Phuc Province",
-			"local_name": "Vĩnh Phúc"
-		},
-		"06": {
-			"name": "Yen Bai Province",
-			"local_name": "Yên Bái"
 		}
 	}
 }

data/lib/addressing/address.rb

@@ -1,9 +1,47 @@
 # frozen_string_literal: true
 
 module Addressing
+  # Represents a postal address with attributes for country, administrative areas,
+  # postal code, address lines, and recipient information.
+  #
+  # Address objects are immutable - use the +with_*+ methods to create modified copies.
+  #
+  # @example Creating an address
+  #   address = Addressing::Address.new(
+  #     country_code: "US",
+  #     administrative_area: "CA",
+  #     locality: "Mountain View",
+  #     postal_code: "94043",
+  #     address_line1: "1600 Amphitheatre Parkway"
+  #   )
+  #
+  # @example Modifying an address
+  #   updated = address.with_postal_code("94044")
   class Address
-    attr_reader :country_code, :administrative_area, :locality, :dependent_locality, :postal_code, :sorting_code, :address_line1, :address_line2, :address_line3, :organization, :given_name, :additional_name, :family_name, :locale
-
+    FIELDS = %i[
+      country_code administrative_area locality dependent_locality
+      postal_code sorting_code address_line1 address_line2 address_line3
+      organization given_name additional_name family_name locale
+    ].freeze
+
+    attr_reader(*FIELDS)
+
+    # Creates a new Address instance.
+    #
+    # @param country_code [String] ISO 3166-1 alpha-2 country code
+    # @param administrative_area [String] Top-level administrative subdivision (state, province, etc.)
+    # @param locality [String] City or locality
+    # @param dependent_locality [String] Dependent locality (neighborhood, suburb, district, etc.)
+    # @param postal_code [String] Postal code
+    # @param sorting_code [String] Sorting code (used in some countries)
+    # @param address_line1 [String] First line of the street address
+    # @param address_line2 [String] Second line of the street address
+    # @param address_line3 [String] Third line of the street address
+    # @param organization [String] Organization name
+    # @param given_name [String] Given name (first name)
+    # @param additional_name [String] Additional name (middle name, patronymic)
+    # @param family_name [String] Family name (last name)
+    # @param locale [String] Locale code for the address
     def initialize(country_code: "", administrative_area: "", locality: "", dependent_locality: "", postal_code: "", sorting_code: "", address_line1: "", address_line2: "", address_line3: "", organization: "", given_name: "", additional_name: "", family_name: "", locale: "und")
       @country_code = country_code
       @administrative_area = administrative_area
@@ -21,92 +59,42 @@ module Addressing
       @locale = locale
     end
 
-    def with_country_code(country_code)
-      address = clone
-      address.country_code = country_code
-      address
-    end
-
-    def with_administrative_area(administrative_area)
-      address = clone
-      address.administrative_area = administrative_area
-      address
-    end
-
-    def with_locality(locality)
-      address = clone
-      address.locality = locality
-      address
-    end
-
-    def with_dependent_locality(dependent_locality)
-      address = clone
-      address.dependent_locality = dependent_locality
-      address
-    end
-
-    def with_postal_code(postal_code)
-      address = clone
-      address.postal_code = postal_code
-      address
-    end
-
-    def with_sorting_code(sorting_code)
-      address = clone
-      address.sorting_code = sorting_code
-      address
-    end
-
-    def with_address_line1(address_line1)
-      address = clone
-      address.address_line1 = address_line1
-      address
-    end
-
-    def with_address_line2(address_line2)
-      address = clone
-      address.address_line2 = address_line2
-      address
+    # Define with_* methods for all fields
+    FIELDS.each do |field|
+      define_method(:"with_#{field}") do |value|
+        address = clone
+        address.send(:"#{field}=", value)
+        address
+      end
     end
 
-    def with_address_line3(address_line3)
-      address = clone
-      address.address_line3 = address_line3
-      address
-    end
-
-    def with_organization(organization)
-      address = clone
-      address.organization = organization
-      address
-    end
-
-    def with_given_name(given_name)
-      address = clone
-      address.given_name = given_name
-      address
-    end
+    # Compares two addresses for equality based on all field values.
+    #
+    # @param other [Object] The object to compare with
+    # @return [Boolean] true if all fields are equal
+    def ==(other)
+      return false unless other.is_a?(Address)
 
-    def with_additional_name(additional_name)
-      address = clone
-      address.additional_name = additional_name
-      address
+      FIELDS.all? { |field| send(field) == other.send(field) }
     end
 
-    def with_family_name(family_name)
-      address = clone
-      address.family_name = family_name
-      address
+    # Compares two addresses for equality (alias for ==).
+    #
+    # @param other [Object] The object to compare with
+    # @return [Boolean] true if all fields are equal
+    def eql?(other)
+      self == other
     end
 
-    def with_locale(locale)
-      address = clone
-      address.locale = locale
-      address
+    # Generates a hash code for the address based on all field values.
+    #
+    # @return [Integer] hash code
+    def hash
+      FIELDS.map { |field| send(field) }.hash
     end
 
     protected
 
-    attr_writer :country_code, :administrative_area, :locality, :dependent_locality, :postal_code, :sorting_code, :address_line1, :address_line2, :address_line3, :organization, :given_name, :additional_name, :family_name, :locale
+    attr_writer(*FIELDS)
   end
 end