addressing 1.1.0 → 2.1.0

data/lib/addressing/country.rb

@@ -18,21 +18,23 @@ module Addressing
   class Country
     class << self
       AVAILABLE_LOCALES = [
-        "af", "am", "ar", "ar-LY", "ar-SA", "as", "az", "be", "bg", "bn",
-        "bn-IN", "bs", "ca", "chr", "cs", "cy", "da", "de", "de-AT", "de-CH",
-        "dsb", "el", "el-polyton", "en", "en-001", "en-AU", "en-CA", "en-ID",
-        "en-MV", "es", "es-419", "es-AR", "es-BO", "es-CL", "es-CO", "es-CR",
-        "es-DO", "es-EC", "es-GT", "es-HN", "es-MX", "es-NI", "es-PA", "es-PE",
-        "es-PR", "es-PY", "es-SV", "es-US", "es-VE", "et", "eu", "fa", "fa-AF",
-        "fi", "fil", "fr", "fr-BE", "fr-CA", "ga", "gd", "gl", "gu", "he",
-        "hi", "hi-Latn", "hr", "hsb", "hu", "hy", "id", "ig", "is", "it", "ja",
-        "ka", "kk", "km", "ko", "ko-KP", "kok", "ky", "lo", "lt", "lv", "mk",
-        "ml", "mn", "mr", "ms", "my", "ne", "nl", "nn", "no", "or", "pa", "pl",
-        "ps", "ps-PK", "pt", "pt-PT", "ro", "ro-MD", "ru", "ru-UA", "si", "sk",
-        "sl", "so", "sq", "sr", "sr-Cyrl-BA", "sr-Cyrl-ME", "sr-Cyrl-XK",
-        "sr-Latn", "sr-Latn-BA", "sr-Latn-ME", "sr-Latn-XK", "sv", "sw",
-        "sw-CD", "sw-KE", "ta", "te", "th", "tk", "tr", "uk", "ur", "ur-IN",
-        "uz", "vi", "yue", "yue-Hans", "zh", "zh-Hant", "zh-Hant-HK", "zu"
+        "af", "ak", "am", "ar", "ar-LY", "ar-SA", "as", "az", "ba", "be", "bg",
+        "bn", "bn-IN", "bs", "ca", "chr", "cs", "cv", "cy", "da", "de",
+        "de-AT", "de-CH", "dsb", "el", "el-polyton", "en", "en-001", "en-AU",
+        "en-CA", "en-EE", "en-GE", "en-LT", "en-LV", "en-UA", "es", "es-419",
+        "es-AR", "es-BO", "es-CL", "es-CO", "es-CR", "es-DO", "es-EC", "es-GT",
+        "es-HN", "es-MX", "es-NI", "es-PA", "es-PE", "es-PR", "es-PY", "es-SV",
+        "es-US", "es-VE", "et", "eu", "fa", "fa-AF", "fi", "fil", "fr",
+        "fr-BE", "fr-CA", "ga", "gd", "gl", "gu", "he", "hi", "hi-Latn", "hr",
+        "hsb", "hu", "hy", "id", "ig", "is", "it", "ja", "ka", "kk", "kk-Arab",
+        "km", "ko", "ko-KP", "kok", "ky", "lo", "lt", "lv", "mk", "ml", "mn",
+        "mr", "ms", "my", "ne", "nl", "nn", "no", "or", "pa", "pl", "ps",
+        "ps-PK", "pt", "pt-PT", "qu", "rm", "ro", "ro-MD", "ru", "ru-UA",
+        "shn", "si", "sk", "sl", "so", "sq", "sr", "sr-Cyrl-BA", "sr-Cyrl-ME",
+        "sr-Cyrl-XK", "sr-Latn", "sr-Latn-BA", "sr-Latn-ME", "sr-Latn-XK",
+        "sv", "sw", "sw-CD", "sw-KE", "ta", "te", "th", "tk", "tr", "uk", "ur",
+        "ur-IN", "uz", "vi", "yue", "yue-Hans", "zh", "zh-Hant", "zh-Hant-HK",
+        "zu"
       ]
 
       # Gets a Country instance for the provided country code.
@@ -137,7 +139,7 @@ module Addressing
           "BD" => ["BGD", "050", "BDT"],
           "BE" => ["BEL", "056", "EUR"],
           "BF" => ["BFA", "854", "XOF"],
-          "BG" => ["BGR", "100", "BGN"],
+          "BG" => ["BGR", "100", "EUR"],
           "BH" => ["BHR", "048", "BHD"],
           "BI" => ["BDI", "108", "BIF"],
           "BJ" => ["BEN", "204", "XOF"],
@@ -264,7 +266,7 @@ module Addressing
           "MG" => ["MDG", "450", "MGA"],
           "MH" => ["MHL", "584", "USD"],
           "MK" => ["MKD", "807", "MKD"],
-          "ML" => ["MLI", "466", "XOF"],
+          "ML" => ["MLI", "466", nil],
           "MM" => ["MMR", "104", "MMK"],
           "MN" => ["MNG", "496", "MNT"],
           "MO" => ["MAC", "446", "MOP"],
@@ -302,7 +304,7 @@ module Addressing
           "PM" => ["SPM", "666", "EUR"],
           "PN" => ["PCN", "612", "NZD"],
           "PR" => ["PRI", "630", "USD"],
-          "PS" => ["PSE", "275", "JOD"],
+          "PS" => ["PSE", "275", "ILS"],
           "PT" => ["PRT", "620", "EUR"],
           "PW" => ["PLW", "585", "USD"],
           "PY" => ["PRY", "600", "PYG"],
@@ -370,7 +372,7 @@ module Addressing
           "YT" => ["MYT", "175", "EUR"],
           "ZA" => ["ZAF", "710", "ZAR"],
           "ZM" => ["ZMB", "894", "ZMW"],
-          "ZW" => ["ZWE", "716", "USD"]
+          "ZW" => ["ZWE", "716", "ZWG"]
         }
       end
     end

data/lib/addressing/default_formatter.rb

@@ -4,6 +4,7 @@ module Addressing
   class DefaultFormatter
     DEFAULT_LOCALE = "en"
     FORMAT_PLACEHOLDER_PATTERN = /%[a-z1-9_]+/
+    FORMAT_SPLIT_PATTERN = /(#{FORMAT_PLACEHOLDER_PATTERN})/
     LEADING_TRAILING_PUNCTUATION_PATTERN = /\A[ \-,]+|[ \-,]+\z/
     MULTIPLE_SPACES_PATTERN = /\s\s+/
 
@@ -39,7 +40,7 @@ module Addressing
       view = render_view(view)
 
       replacements = view.map { |key, element| ["%#{key}", element] }.to_h
-      output = format_string.gsub(FORMAT_PLACEHOLDER_PATTERN) { |m| replacements[m] }
+      output = insert_values(format_string, replacements)
       output = clean_output(output)
 
       if options[:html]
@@ -99,6 +100,39 @@ module Addressing
       end.join(" ")
     end
 
+    # Inserts the rendered address fields into the format string.
+    #
+    # Empty fields need special handling. When one falls between two values,
+    # keep the separator before it and discard the one after it.
+    def insert_values(format_string, replacements)
+      format_string.split("\n", -1).map do |line|
+        rendered = +""
+        separator = ""
+        skipped = false
+
+        line.split(FORMAT_SPLIT_PATTERN, -1).each do |part|
+          unless replacements.key?(part)
+            # A separator before an empty field usually belongs to
+            # the value that came before it, so keep that one.
+            separator = part unless skipped
+            next
+          end
+
+          if replacements[part].empty?
+            skipped = true
+            next
+          end
+
+          rendered << separator if !rendered.empty? || !skipped
+          rendered << replacements[part]
+          separator = ""
+          skipped = false
+        end
+
+        rendered
+      end.join("\n")
+    end
+
     # Removes empty lines, leading punctuation, excess whitespace.
     def clean_output(output)
       output.split("\n").map { |line| line.gsub(LEADING_TRAILING_PUNCTUATION_PATTERN, "").strip.gsub(MULTIPLE_SPACES_PATTERN, " ") }.reject(&:empty?).join("\n")
@@ -116,22 +150,18 @@ module Addressing
       AddressField.all.map { |_, field| [field, address.send(field)] }.to_h
     end
 
-    # Resolves subdivision values to their display codes.
+    # Replaces the subdivision values with the codes of any predefined ones.
     def resolve_subdivision_values(values, address, address_format)
-      subdivision_fields = address_format.used_subdivision_fields
+      parents = [address.country_code]
 
-      # Replace the subdivision values with the names of any predefined ones.
-      subdivision_fields.each_with_index.inject([{}, []]) do |(original_values, parents), (field, index)|
+      address_format.subdivision_fields.each do |field|
         # This level is empty, so there can be no sublevels.
-        break if values[field].nil?
-
-        parents << ((index > 0) ? original_values[subdivision_fields[index - 1]] : address.country_code)
+        break if values[field].nil? || values[field].empty?
 
         subdivision = Subdivision.get(values[field], parents)
         break if subdivision.nil?
 
-        # Remember the original value so that it can be used for parents.
-        original_values[field] = values[field]
+        parents << values[field]
 
         # Replace the value with the expected code.
         use_local_name = Locale.match_candidates(address.locale, subdivision.locale)
@@ -139,8 +169,6 @@ module Addressing
 
         # The current subdivision has no children, stop.
         break unless subdivision.children?
-
-        [original_values, parents]
       end
     end
 

data/lib/addressing/locale.rb

@@ -52,36 +52,49 @@ module Addressing
       "en-150" => "en-001",
       "en-AG" => "en-001",
       "en-AI" => "en-001",
+      "en-AT" => "en-150",
       "en-AU" => "en-001",
       "en-BB" => "en-001",
+      "en-BE" => "en-150",
       "en-BM" => "en-001",
       "en-BS" => "en-001",
       "en-BW" => "en-001",
       "en-BZ" => "en-001",
       "en-CC" => "en-001",
+      "en-CH" => "en-150",
       "en-CK" => "en-001",
       "en-CM" => "en-001",
       "en-CX" => "en-001",
       "en-CY" => "en-001",
+      "en-CZ" => "en-150",
+      "en-DE" => "en-150",
       "en-DG" => "en-001",
+      "en-DK" => "en-150",
       "en-DM" => "en-001",
       "en-ER" => "en-001",
+      "en-ES" => "en-150",
+      "en-FI" => "en-150",
       "en-FJ" => "en-001",
       "en-FK" => "en-001",
       "en-FM" => "en-001",
+      "en-FR" => "en-150",
       "en-GB" => "en-001",
       "en-GD" => "en-001",
       "en-GG" => "en-001",
       "en-GH" => "en-001",
       "en-GI" => "en-001",
       "en-GM" => "en-001",
+      "en-GS" => "en-001",
       "en-GY" => "en-001",
       "en-HK" => "en-001",
+      "en-HU" => "en-150",
+      "en-ID" => "en-001",
       "en-IE" => "en-001",
       "en-IL" => "en-001",
       "en-IM" => "en-001",
       "en-IN" => "en-001",
       "en-IO" => "en-001",
+      "en-IT" => "en-150",
       "en-JE" => "en-001",
       "en-JM" => "en-001",
       "en-KE" => "en-001",
@@ -96,24 +109,33 @@ module Addressing
       "en-MS" => "en-001",
       "en-MT" => "en-001",
       "en-MU" => "en-001",
+      "en-MV" => "en-001",
       "en-MW" => "en-001",
       "en-MY" => "en-001",
       "en-NA" => "en-001",
       "en-NF" => "en-001",
       "en-NG" => "en-001",
+      "en-NL" => "en-150",
+      "en-NO" => "en-150",
       "en-NR" => "en-001",
       "en-NU" => "en-001",
       "en-NZ" => "en-001",
       "en-PG" => "en-001",
       "en-PK" => "en-001",
+      "en-PL" => "en-150",
       "en-PN" => "en-001",
+      "en-PT" => "en-150",
       "en-PW" => "en-001",
+      "en-RO" => "en-150",
       "en-RW" => "en-001",
       "en-SB" => "en-001",
       "en-SC" => "en-001",
       "en-SD" => "en-001",
+      "en-SE" => "en-150",
       "en-SG" => "en-001",
       "en-SH" => "en-001",
+      "en-SI" => "en-150",
+      "en-SK" => "en-150",
       "en-SL" => "en-001",
       "en-SS" => "en-001",
       "en-SX" => "en-001",
@@ -132,15 +154,6 @@ module Addressing
       "en-ZA" => "en-001",
       "en-ZM" => "en-001",
       "en-ZW" => "en-001",
-      "en-AT" => "en-150",
-      "en-BE" => "en-150",
-      "en-CH" => "en-150",
-      "en-DE" => "en-150",
-      "en-DK" => "en-150",
-      "en-FI" => "en-150",
-      "en-NL" => "en-150",
-      "en-SE" => "en-150",
-      "en-SI" => "en-150",
       "es-AR" => "es-419",
       "es-BO" => "es-419",
       "es-BR" => "es-419",
@@ -163,12 +176,13 @@ module Addressing
       "es-US" => "es-419",
       "es-UY" => "es-419",
       "es-VE" => "es-419",
+      "hi-Latn" => "und",
+      "ht" => "fr-HT",
       "nb" => "no",
       "nn" => "no",
       "pt-AO" => "pt-PT",
       "pt-CH" => "pt-PT",
       "pt-CV" => "pt-PT",
-      "pt-FR" => "pt-PT",
       "pt-GQ" => "pt-PT",
       "pt-GW" => "pt-PT",
       "pt-LU" => "pt-PT",
@@ -184,7 +198,6 @@ module Addressing
       "byn-Latn" => "und",
       "en-Dsrt" => "und",
       "en-Shaw" => "und",
-      "hi-Latn" => "und",
       "iu-Latn" => "und",
       "kk-Arab" => "und",
       "ks-Deva" => "und",

data/lib/addressing/model.rb

@@ -46,25 +46,24 @@ module Addressing
         end
 
         define_method :verify_subdivisions do |address, address_format, field_overrides|
-          # No predefined subdivisions exist, nothing to validate against.
-          return [] if address_format.subdivision_depth < 1
+          parents = [address_format.country_code]
+          subdivisions = []
 
-          subdivisions, _parents = address_format.used_subdivision_fields.each_with_index.inject([[], []]) do |(subdivisions, parents), (field, index)|
+          address_format.subdivision_fields.each do |field|
+            value = address.send(field)
             # The field is empty or validation is disabled.
-            break [subdivisions, parents] if address.send(field).blank? || field_overrides.hidden_fields.include?(field)
+            break if value.blank? || field_overrides.hidden_fields.include?(field)
 
-            parents << ((index > 0) ? address.send(address_format.used_subdivision_fields[index - 1]) : address_format.country_code)
-            subdivision = Subdivision.get(address.send(field), parents)
+            subdivision = Subdivision.get(value, parents)
             if subdivision.nil?
               errors.add(field, "should be valid")
-              break [subdivisions, parents]
+              break
             end
 
+            parents << value
             subdivisions << subdivision
             # No predefined subdivisions below this level, stop here.
-            break [subdivisions, parents] if subdivision.children.empty?
-
-            [subdivisions, parents]
+            break unless subdivision.children?
           end
 
           subdivisions

data/lib/addressing/subdivision.rb

@@ -58,8 +58,8 @@ module Addressing
       def has_data(parents)
         country_code = parents[0]
 
-        depth = AddressFormat.get(country_code).subdivision_depth
-        return false if depth == 0
+        subdivision_fields = AddressFormat.get(country_code).subdivision_fields
+        return false if subdivision_fields.empty?
 
         if parents.size > 1
           # After the first level it is possible for predefined subdivisions
@@ -74,8 +74,9 @@ module Addressing
             definition = @definitions[parent_group]["subdivisions"][parent_id]
             return !!definition["has_children"]
           else
-            # The parent definition wasn't loaded previously, fallback to guessing based on depth.
-            return parents.size <= depth
+            # The parent definition wasn't loaded previously, fallback to
+            # guessing based on the count of subdivision data fields.
+            return parents.size <= subdivision_fields.size
           end
         end
 
@@ -98,19 +99,30 @@ module Addressing
           filename = File.join(File.expand_path("../../../data/subdivision", __FILE__).to_s, "#{group}.json")
 
           if File.exist?(filename)
-            raw_definition = File.read(filename)
-            @definitions[group] = JSON.parse(raw_definition)
-            @definitions[group] = process_definitions(@definitions[group])
+            @definitions[group] = process_definitions(parse_definitions(File.read(filename)))
           end
         end
 
         @definitions[group]
       end
 
+      # Parses a raw definition file.
+      #
+      # Malformed JSON is treated as if the file didn't exist.
+      def parse_definitions(raw_definition)
+        definitions = JSON.parse(raw_definition)
+        definitions.is_a?(Hash) ? definitions : {}
+      rescue JSON::ParserError
+        {}
+      end
+
       # Processes the loaded definitions.
       #
       # Adds keys and values that were removed from the JSON files for brevity.
       def process_definitions(definitions)
+        # Malformed definitions are treated as if they didn't exist.
+        return {} unless definitions["subdivisions"].is_a?(Hash)
+
         definitions["subdivisions"].each do |id, definition|
           # Add common keys from the root level.
           definition["country_code"] = definitions["country_code"]
@@ -124,6 +136,12 @@ module Addressing
             definition["name"] = id
           end
 
+          # The local_name value is only specified if it doesn't match
+          # the name one.
+          if definitions.key?("locale") && !definition.key?("local_name")
+            definition["local_name"] = definition["name"]
+          end
+
           # The code and local_code values are only specified if they
           # don't match the name and local_name ones.
           if !definition.key?("code") && definition.key?("name")

data/lib/addressing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Addressing
-  VERSION = "1.1.0"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: addressing
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Robin van der Vleuten
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-09-18 00:00:00.000000000 Z
 dependencies: []
+description:
 email: robinvdvleuten@gmail.com
 executables: []
 extensions: []
@@ -20,12 +22,14 @@ files:
 - data/address_formats.dump
 - data/address_formats.json
 - data/country/af.json
+- data/country/ak.json
 - data/country/am.json
 - data/country/ar-LY.json
 - data/country/ar-SA.json
 - data/country/ar.json
 - data/country/as.json
 - data/country/az.json
+- data/country/ba.json
 - data/country/be.json
 - data/country/bg.json
 - data/country/bn-IN.json
@@ -34,6 +38,7 @@ files:
 - data/country/ca.json
 - data/country/chr.json
 - data/country/cs.json
+- data/country/cv.json
 - data/country/cy.json
 - data/country/da.json
 - data/country/de-AT.json
@@ -45,8 +50,11 @@ files:
 - data/country/en-001.json
 - data/country/en-AU.json
 - data/country/en-CA.json
-- data/country/en-ID.json
-- data/country/en-MV.json
+- data/country/en-EE.json
+- data/country/en-GE.json
+- data/country/en-LT.json
+- data/country/en-LV.json
+- data/country/en-UA.json
 - data/country/en.json
 - data/country/es-419.json
 - data/country/es-AR.json
@@ -94,6 +102,7 @@ files:
 - data/country/it.json
 - data/country/ja.json
 - data/country/ka.json
+- data/country/kk-Arab.json
 - data/country/kk.json
 - data/country/km.json
 - data/country/ko-KP.json
@@ -120,10 +129,13 @@ files:
 - data/country/ps.json
 - data/country/pt-PT.json
 - data/country/pt.json
+- data/country/qu.json
+- data/country/rm.json
 - data/country/ro-MD.json
 - data/country/ro.json
 - data/country/ru-UA.json
 - data/country/ru.json
+- data/country/shn.json
 - data/country/si.json
 - data/country/sk.json
 - data/country/sl.json
@@ -605,6 +617,8 @@ files:
 - data/subdivision/EG.json
 - data/subdivision/ES.json
 - data/subdivision/FM.json
+- data/subdivision/GB.json
+- data/subdivision/GT.json
 - data/subdivision/HK-2705954f46a43ef0ad522412afe6ed6ee8196fe4.json
 - data/subdivision/HK-29ceaf41d01206ba481b188116cbb302b82663cf.json
 - data/subdivision/HK-ff51a84233701e6a1d18f70acf4b3f909e4c6a09.json
@@ -726,6 +740,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/robinvdvleuten/addressing/issues
   changelog_uri: https://github.com/robinvdvleuten/addressing/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -733,14 +748,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Addressing library powered by CLDR and Google's address data
 test_files: []