addressing 1.1.0 → 2.1.0

data/data/subdivision/GT.json

@@ -0,0 +1,71 @@
+{
+	"country_code": "GT",
+	"subdivisions": {
+		"16": {
+			"name": "Alta Verapaz"
+		},
+		"15": {
+			"name": "Baja Verapaz"
+		},
+		"04": {
+			"name": "Chimaltenango"
+		},
+		"20": {
+			"name": "Chiquimula"
+		},
+		"02": {
+			"name": "El Progreso"
+		},
+		"05": {
+			"name": "Escuintla"
+		},
+		"01": {
+			"name": "Guatemala"
+		},
+		"13": {
+			"name": "Huehuetenango"
+		},
+		"18": {
+			"name": "Izabal"
+		},
+		"21": {
+			"name": "Jalapa"
+		},
+		"22": {
+			"name": "Jutiapa"
+		},
+		"17": {
+			"name": "Petén"
+		},
+		"09": {
+			"name": "Quetzaltenango"
+		},
+		"14": {
+			"name": "Quiché"
+		},
+		"11": {
+			"name": "Retalhuleu"
+		},
+		"03": {
+			"name": "Sacatepéquez"
+		},
+		"12": {
+			"name": "San Marcos"
+		},
+		"06": {
+			"name": "Santa Rosa"
+		},
+		"07": {
+			"name": "Sololá"
+		},
+		"10": {
+			"name": "Suchitepéquez"
+		},
+		"08": {
+			"name": "Totonicapán"
+		},
+		"19": {
+			"name": "Zacapa"
+		}
+	}
+}

data/data/subdivision/IT.json

@@ -149,6 +149,10 @@
 			"code": "FR",
 			"name": "Frosinone"
 		},
+		"OT": {
+			"code": "OT",
+			"name": "Gallura Nord-Est Sardegna"
+		},
 		"GE": {
 			"code": "GE",
 			"name": "Genova"
@@ -217,6 +221,10 @@
 			"code": "MT",
 			"name": "Matera"
 		},
+		"VS": {
+			"code": "VS",
+			"name": "Medio Campidano"
+		},
 		"ME": {
 			"code": "ME",
 			"name": "Messina"
@@ -245,6 +253,10 @@
 			"code": "NU",
 			"name": "Nuoro"
 		},
+		"OG": {
+			"code": "OG",
+			"name": "Ogliastra"
+		},
 		"OR": {
 			"code": "OR",
 			"name": "Oristano"
@@ -359,7 +371,7 @@
 		},
 		"SU": {
 			"code": "SU",
-			"name": "Sud Sardegna"
+			"name": "Sulcis Iglesiente"
 		},
 		"TA": {
 			"code": "TA",

data/data/subdivision/NG.json

@@ -83,7 +83,7 @@
 			"name": "Niger"
 		},
 		"OG": {
-			"name": "Ogun State"
+			"name": "Ogun"
 		},
 		"ON": {
 			"name": "Ondo"

data/data/subdivision/RU.json

@@ -240,10 +240,6 @@
 			"name": "Tyva Republits",
 			"local_name": "Республика Тыва"
 		},
-		"UD": {
-			"name": "Udmurtskaja Respublika",
-			"local_name": "Республика Удмуртия"
-		},
 		"KK": {
 			"name": "Khakasiya Republits",
 			"local_name": "Республика Хакасия"
@@ -308,6 +304,10 @@
 			"name": "Tyumenskaya oblast'",
 			"local_name": "Тюменская область"
 		},
+		"UD": {
+			"name": "Udmurtskaja Respublika",
+			"local_name": "Удмуртская Республика"
+		},
 		"ULY": {
 			"name": "Ulyanovskaya oblast'",
 			"local_name": "Ульяновская область"

data/data/subdivision/TH.json

@@ -26,10 +26,6 @@
 			"name": "Khon Kaen",
 			"local_name": "ขอนแก่น"
 		},
-		"38": {
-			"name": "Bueng Kan",
-			"local_name": "จังหวัด บึงกาฬ"
-		},
 		"22": {
 			"name": "Chanthaburi",
 			"local_name": "จันทบุรี"
@@ -51,7 +47,7 @@
 			"local_name": "ชัยภูมิ"
 		},
 		"86": {
-			"name": "Chumpon",
+			"name": "Chumphon",
 			"local_name": "ชุมพร"
 		},
 		"57": {
@@ -110,6 +106,10 @@
 			"name": "Nan",
 			"local_name": "น่าน"
 		},
+		"38": {
+			"name": "Bueng Kan",
+			"local_name": "บึงกาฬ"
+		},
 		"31": {
 			"name": "Buri Ram",
 			"local_name": "บุรีรัมย์"
@@ -143,7 +143,7 @@
 			"local_name": "พังงา"
 		},
 		"93": {
-			"name": "Phattalung",
+			"name": "Phatthalung",
 			"local_name": "พัทลุง"
 		},
 		"66": {
@@ -267,7 +267,7 @@
 			"local_name": "สุโขทัย"
 		},
 		"72": {
-			"name": "Suphanburi",
+			"name": "Suphan Buri",
 			"local_name": "สุพรรณบุรี"
 		},
 		"84": {

data/data/subdivision/TR.json

@@ -8,7 +8,7 @@
 			"name": "Adıyaman"
 		},
 		"03": {
-			"name": "Afyon"
+			"name": "Afyonkarahisar"
 		},
 		"04": {
 			"name": "Ağrı"

data/data/subdivision/VE.json

@@ -32,7 +32,7 @@
 			"name": "Dependencias Federales"
 		},
 		"A": {
-			"name": "Distrito Federal"
+			"name": "Distrito Capital"
 		},
 		"I": {
 			"name": "Falcón"
@@ -40,6 +40,9 @@
 		"J": {
 			"name": "Guárico"
 		},
+		"X": {
+			"name": "La Guaira"
+		},
 		"K": {
 			"name": "Lara"
 		},
@@ -67,9 +70,6 @@
 		"T": {
 			"name": "Trujillo"
 		},
-		"X": {
-			"name": "La Guaira"
-		},
 		"U": {
 			"name": "Yaracuy"
 		},

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": "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_format.rb

@@ -8,9 +8,17 @@ module Addressing
   #
   # @example Get address format for Brazil
   #   format = Addressing::AddressFormat.get('BR')
-  #   format.used_fields      # => ["given_name", "family_name", ...]
-  #   format.required_fields  # => ["address_line1", "locality", ...]
+  #   format.used_fields        # => ["given_name", "family_name", ...]
+  #   format.required_fields    # => ["address_line1", "locality", ...]
+  #   format.subdivision_fields # => ["administrative_area", "locality"]
   class AddressFormat
+    # The subdivision fields, ordered from the top level down.
+    SUBDIVISION_FIELDS = [
+      AddressField::ADMINISTRATIVE_AREA,
+      AddressField::LOCALITY,
+      AddressField::DEPENDENT_LOCALITY
+    ].freeze
+
     class << self
       # Gets the address format for the provided country code.
       #
@@ -63,13 +71,28 @@ module Addressing
           administrative_area_type: "province",
           locality_type: "city",
           dependent_locality_type: "suburb",
-          postal_code_type: "postal",
-          subdivision_depth: 0
+          postal_code_type: "postal"
         }
       end
     end
 
-    attr_reader :country_code, :locale, :format, :local_format, :required_fields, :uppercase_fields, :default_values, :administrative_area_type, :locality_type, :dependent_locality_type, :postal_code_type, :postal_code_pattern, :postal_code_prefix, :subdivision_depth
+    attr_reader :country_code, :locale, :format, :local_format, :required_fields, :uppercase_fields, :default_values, :administrative_area_type, :locality_type, :dependent_locality_type, :postal_code_type, :postal_code_pattern, :postal_code_prefix
+
+    # The subdivision fields for which there is predefined subdivision data.
+    #
+    # This is more precise than #used_subdivision_fields, which returns all
+    # subdivision fields used by the format regardless of whether data exists.
+    #
+    # @return [Array<String>] e.g. ["administrative_area", "locality"]
+    attr_reader :subdivision_fields
+
+    # The number of subdivision fields with predefined data used by the format.
+    #
+    # @deprecated Use #subdivision_fields instead.
+    # @return [Integer]
+    def subdivision_depth
+      (subdivision_fields & used_subdivision_fields).size
+    end
 
     def initialize(definition = {})
       # Validate the presence of required properties.
@@ -87,13 +110,16 @@ module Addressing
         uppercase_fields: [],
         default_values: {},
         postal_code_pattern: nil,
-        postal_code_prefix: nil,
-        subdivision_depth: 0
+        postal_code_prefix: nil
       }.merge(definition)
 
+      # Backwards compatibility: derive the subdivision fields from a depth.
+      definition[:subdivision_fields] ||= SUBDIVISION_FIELDS.first(definition[:subdivision_depth] || 0)
+
       AddressField.assert_all_exist(definition[:required_fields])
       AddressField.assert_all_exist(definition[:uppercase_fields])
       AddressField.assert_all_exist(definition[:default_values].keys)
+      AddressField.assert_all_exist(definition[:subdivision_fields])
 
       @country_code = definition[:country_code]
       @locale = definition[:locale]
@@ -102,7 +128,7 @@ module Addressing
       @required_fields = definition[:required_fields]
       @uppercase_fields = definition[:uppercase_fields]
       @default_values = definition[:default_values]
-      @subdivision_depth = definition[:subdivision_depth]
+      @subdivision_fields = definition[:subdivision_fields]
 
       if used_fields.include?(AddressField::ADMINISTRATIVE_AREA)
         if definition[:administrative_area_type]
@@ -144,15 +170,11 @@ module Addressing
     end
 
     # Gets the list of used subdivision fields.
+    #
+    # Note that a country might use a subdivision field without having
+    # predefined subdivisions for it, see #subdivision_fields.
     def used_subdivision_fields
-      fields = [
-        AddressField::ADMINISTRATIVE_AREA,
-        AddressField::LOCALITY,
-        AddressField::DEPENDENT_LOCALITY
-      ]
-
-      # Remove fields not used by the format.
-      fields & used_fields
+      SUBDIVISION_FIELDS & used_fields
     end
   end