geo_states 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b757132bddec9472e730189fa998a1ef255440bb12eec76f407c9242b07b685
-  data.tar.gz: 0b5f64fde99b17656d2ced4965c5f766dbcc9b9f533d7ee14389ce83e0c93baa
+  metadata.gz: 23f5adf00ed40e770fefae1b152febf5de3f6cf0e3fd0db046f749040372582a
+  data.tar.gz: 9bd7ee1dcb2378dc300d8ac94a0aa08fb76bce1d74daa0629865607efe0e27cb
 SHA512:
-  metadata.gz: 29f3e3ccc65d2b2f7b5c03f2ec807e754dc4f3c3a4d79b940a2bb91dd32b485e7d5da378a62d511c7e3999cb14babdc661f0b310c7c053870dc4e49a81d897fc
-  data.tar.gz: b06009b62f7580a61cbaba751652c820963046b116d334c0208e45eec37316e45d031c8974caeffd6bb1051f88ed7f0ac28e2cb3bd25c03421526739099c3196
+  metadata.gz: f141eeec003f3b685b15ea5f1d56c0c529f167426cba1e989bbee07df14dcd539dc50dc8b2b37ab5ca45328d54ee5a95f9f8f944f1d0c8cc044626f56c8e1096
+  data.tar.gz: 0ea2455867a0d1e41eb3e82c2c5630aadb5b54fc62043af7c8bbd5ffe948d6f1f15d16ec41839f3ee97ec6e0f7c3351348d314d3f329e0f8d82b34a8472c8ceb

data/lib/geo_states/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GeoStates
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/geo_states.rb

@@ -59,8 +59,9 @@ module GeoStates
     country&.dig(:states) || []
   end
 
-  # Find a state within a country. Accepts user YAML config for aliases (e.g. CDMX => CMX).
+  # Find a state within a country. Accepts user YAML config for aliases (e.g. CDMX => DF).
   # Config file: config/geo_states.yml or geo_states.yml, or GEO_STATES_CONFIG_PATH env.
+  # When resolved via alias (config or built-in), the returned hash uses the alias as state_code (e.g. "DF").
   # @param country_id [String] ISO2, ISO3, M49, or country name (e.g. "MX", "Mexico")
   # @param state_id [String] state_code, name, or alias from user config (e.g. "CMX", "CDMX", "Mexico City")
   # @return [Hash, nil] state hash with :name, :state_code, :iso2, :iso3, or nil
@@ -68,28 +69,47 @@ module GeoStates
     country = find_country(country_id)
     return nil unless country
 
-    canonical = resolve_state_id(country[:iso2], state_id.to_s)
-    return nil if canonical.nil? || canonical.empty?
+    lookup_key, preferred_state_code, from_alias = resolve_state_id(country[:iso2], state_id.to_s)
+    return nil if lookup_key.nil? || lookup_key.empty?
 
     states = country[:states] || []
-    states.find do |s|
-      s[:state_code].to_s.casecmp(canonical) == 0 ||
-        s[:name].to_s.casecmp(canonical) == 0
+    state = states.find do |s|
+      s[:state_code].to_s.casecmp(lookup_key) == 0 ||
+        s[:name].to_s.casecmp(lookup_key) == 0
     end
+    return nil unless state
+
+    # Use alias value (e.g. DF) in result when resolved via config or built-in alias
+    if from_alias && preferred_state_code && preferred_state_code != state[:state_code]
+      state = state.merge(
+        state_code: preferred_state_code,
+        iso3: preferred_state_code,
+        iso2: preferred_state_code.length >= 2 ? preferred_state_code[0, 2].upcase : preferred_state_code.upcase
+      )
+    end
+    state
   end
 
   # Resolve state identifier: user config first, then built-in aliases (e.g. DF -> CMX for Mexico).
+  # Returns [lookup_key, preferred_state_code, from_alias].
   # @param iso2 [String] country ISO2
   # @param state_id [String] user input
-  # @return [String] canonical state_code for lookup
+  # @return [Array] [lookup_key, preferred_state_code, from_alias]
   def self.resolve_state_id(iso2, state_id)
     id = state_id.to_s.strip
-    return nil if id.empty?
+    return [nil, nil, false] if id.empty?
+
+    from_config = ConfigLoader.resolve_alias(iso2, id)
+    canonical = from_config || id
 
-    canonical = ConfigLoader.resolve_alias(iso2, id) || id
     # Built-in: Mexico DF -> CMX (bundled data uses CMX; user config may map CDMX => DF)
-    return 'CMX' if iso2.to_s.upcase == 'MX' && canonical.to_s.upcase == 'DF'
+    if iso2.to_s.upcase == 'MX' && canonical.to_s.upcase == 'DF'
+      return ['CMX', 'DF', true]
+    end
 
-    canonical
+    # When from config, use that as preferred and mark as from_alias
+    from_alias = !from_config.nil?
+    preferred = from_config || canonical
+    [canonical, preferred, from_alias]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_states
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alberto Osnaya (@elosnaya)