worldwide 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f7f2806122734340656c024d816ec4028060de514b5dc4773529ce8bff4f37
-  data.tar.gz: 3c5c2237879ab05f1a77505432bca89ad50e9d5667ff1d1951b501c07f43050e
+  metadata.gz: 4dca8f095b6020792ecd6186606db9cd6159d03414b735b0c2d4b30f0746b680
+  data.tar.gz: 7e40cbbd862960354faf241a3320c03b1a081fa005f42063bf27951ca94f3c1d
 SHA512:
-  metadata.gz: 1f8e9fa1416ccc24d3818e609acf7d05da6534cdb9b1e780af496151559bbb5e73540df416d85d554a3083a5add5691df2ab512fa023da3ca43d85251a89c18d
-  data.tar.gz: d55d1ed819560e45099c6ae1fc9e1cc5f62e0a6b62c4e9b24aa97daa78b7aae0e6cb8636dc0b6086ca5ba7f3a715badc0e7d4c60ddde09df49cb2b2c00677e8c
+  metadata.gz: 1c385197a1a3239d1d1251a0cb7b45fe3f04f4d9e75dc3ed02227fe9692184b12dc5754c4c5292bfbd24e4a079df48b2ea63689e63b11511ec1f7017627ac15a
+  data.tar.gz: 666f0e760f82cfab270d47328a9600204e7c93c04bd16106b5f6d46cadefcd15f90dc64ea5663f0eeefc2827458aa2b47147468b45da059a57c37dd146893444

data/CHANGELOG.md

@@ -28,6 +28,11 @@ Nil.
 
 ---
 
+[0.4.0] - 2023-11-08
+- Add region name alternates [#32](https://github.com/Shopify/worldwide/pull/32)
+- Cache `Region#parent_name` [#33](https://github.com/Shopify/worldwide/pull/33)
+- Use hash tables to look up regions by code [#36](https://github.com/Shopify/worldwide/pull/36)
+
 [0.3.0] - 2023-11-03
 - Add code alternates for Japan [#23](https://github.com/Shopify/worldwide/pull/23)
 - Add code alternates for Puerto Rico [#24](https://github.com/Shopify/worldwide/pull/24)

data/Gemfile.lock

@@ -13,7 +13,7 @@ GIT
 PATH
   remote: .
   specs:
-    worldwide (0.3.0)
+    worldwide (0.4.0)
       activesupport (~> 7.0)
       i18n (~> 1.12.0)
       phonelib (~> 0.8)

data/db/data/regions/US.yml

@@ -7,6 +7,8 @@ unit_system: imperial
 tax_name: Federal Tax
 group: North American Countries
 group_name: North America
+name_alternates:
+- United States of America
 zip_label: Zip code
 zip_regex: "(?-mix:\\A\\d{5}(-\\d{4})?\\z)|(?i-mx:\\AFPO\\s*A[A-Z]\\s*\\d{5}-\\d{4}\\z)"
 zip_example: '90210'

data/lib/worldwide/region.rb

@@ -110,6 +110,10 @@ module Worldwide
     # This name is the name that was traditionally returned by "country_db".
     attr_reader :legacy_name
 
+    # Other names that may be used to refer to this region.
+    # E.g., "Czech Republic" is also known as "Czechia".
+    attr_accessor :name_alternates
+
     # iso_code values of regions (subdivisions) within the same country that border this region.
     # E.g., for CA-ON, the neighbouring zones are CA-MB, CA-NU and CA-QC.
     attr_accessor :neighbours
@@ -438,7 +442,7 @@ module Worldwide
     end
 
     def parent_country
-      parents.find(&:country?)
+      @parent_country ||= parents.find(&:country?)
     end
 
     # Checks whether the given value is acceptable according to the regular expression defined for the country.

data/lib/worldwide/regions.rb

@@ -16,7 +16,7 @@ module Worldwide
     end
 
     def initialize
-      @regions = RegionsLoader.new.load_regions
+      @regions, @regions_by_cldr_code, @regions_by_iso_code = RegionsLoader.new.load_regions
     end
 
     def all
@@ -29,17 +29,9 @@ module Worldwide
       end
 
       result = if cldr
-        search_code = cldr.to_s.upcase
-
-        @regions.find do |r|
-          r.send(:answers_to_cldr_code, search_code)
-        end
+        @regions_by_cldr_code[cldr.to_s.upcase]
       elsif code
-        search_code = code.to_s.upcase
-
-        @regions.find do |r|
-          r.send(:answers_to_iso_code, search_code) || r.alpha_three == search_code || r.numeric_three == search_code
-        end
+        @regions_by_iso_code[code.to_s.upcase]
       else # search by name
         search_name = name.upcase
 

data/lib/worldwide/regions_loader.rb

@@ -9,6 +9,9 @@ module Worldwide
     WORLD_CODE = "001" # UN code for the whole world
 
     def load_regions
+      @regions_by_cldr_code = {}
+      @regions_by_iso_code = {}
+
       # Load country/region definitions out of the db/data/regions/??.yml files
       @regions = Dir["#{Worldwide::Paths::REGIONS_ROOT}/*.yml"].map do |filename|
         load_territory(filename)
@@ -25,11 +28,39 @@ module Worldwide
 
       construct_unknown
 
-      @regions.freeze
+      @regions.each do |region|
+        construct_lookup_info(region)
+      end
+
+      [@regions.freeze, @regions_by_cldr_code, @regions_by_iso_code]
     end
 
     private
 
+    def construct_lookup_info(region)
+      pc = region.send(:parent_country)
+
+      # Remember CLDR code(s) for later use during lookup
+
+      search_code = region.cldr_code.to_s.upcase
+      @regions_by_cldr_code[search_code] = region if Util.present?(search_code)
+
+      @regions_by_cldr_code["#{pc.cldr_code.upcase}#{search_code}"] = region if Util.present?(pc&.cldr_code)
+
+      # Remember ISO 3166 code(s) for later use during lookup
+
+      iso_code = region.iso_code
+      @regions_by_iso_code[iso_code] = region if Util.present?(iso_code)
+
+      @regions_by_iso_code["#{pc.iso_code}-#{iso_code}"] = region if Util.present?(pc)
+
+      alpha_three = region.alpha_three
+      @regions_by_iso_code[alpha_three] = region if Util.present?(alpha_three)
+
+      numeric_three = region.numeric_three
+      @regions_by_iso_code[numeric_three] = region if Util.present?(numeric_three)
+    end
+
     def apply_hierarchy(parent:, code:, children:)
       current_region = find_region(code: code)
       if current_region.nil?
@@ -82,10 +113,12 @@ module Worldwide
       region.zip_requirement = spec["zip_requirement"]
       region.zip_regex = spec["zip_regex"]
       region.zips_crossing_provinces = spec["zips_crossing_provinces"]
+      region.name_alternates = spec["name_alternates"] || []
     end
 
     def apply_zone_attributes(region, zone)
       region.code_alternates = zone["code_alternates"] || []
+      region.name_alternates = zone["name_alternates"] || []
       region.example_city = zone["example_city"]
       region.neighbours = zone["neighboring_zones"]
       region.zip_prefixes = zone["zip_prefixes"] || []

data/lib/worldwide/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Worldwide
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worldwide
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport