worldwide 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5239439f9dda5abcf62fc8cbb59343a420a34ef5abe96c7b6cd23a17a633623a
-  data.tar.gz: 8438623520e1065231f78707ebaadeee25c0bd2f5ec4f795cbde00284a69fd45
+  metadata.gz: 70f7f2806122734340656c024d816ec4028060de514b5dc4773529ce8bff4f37
+  data.tar.gz: 3c5c2237879ab05f1a77505432bca89ad50e9d5667ff1d1951b501c07f43050e
 SHA512:
-  metadata.gz: 578e7e33cf986cda84b85c4d9e2f1092d13e3fd513b63667ee757cc6bbc937b84855ca4718a262ea5b6ecffa4203924a7fc1c5395fde98582c31adda4e1ab78d
-  data.tar.gz: 2e28c5c0b5823979d7114b466e931429ec7376a90d1e1eb7de34c93a9dff059068ae65b548f0f3cf0f75c29c6f16051f9050ae1eb337ac51486ed0949d31c54c
+  metadata.gz: 1f8e9fa1416ccc24d3818e609acf7d05da6534cdb9b1e780af496151559bbb5e73540df416d85d554a3083a5add5691df2ab512fa023da3ca43d85251a89c18d
+  data.tar.gz: d55d1ed819560e45099c6ae1fc9e1cc5f62e0a6b62c4e9b24aa97daa78b7aae0e6cb8636dc0b6086ca5ba7f3a715badc0e7d4c60ddde09df49cb2b2c00677e8c

data/CHANGELOG.md

@@ -28,6 +28,24 @@ Nil.
 
 ---
 
+[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)
+- Record multiple parents per region [#27](https://github.com/Shopify/worldwide/pull/27)
+- Add region.building_number_may_be_in_address2 [#28](https://github.com/Shopify/worldwide/pull/28)
+- Lookup by parent-child ISO and CLDR codes for dual-status territories
+  [#29](https://github.com/Shopify/worldwide/pull/29)
+- Handle ISO_CODE only zones lookup [#26](https://github.com/Shopify/worldwide/pull/26)
+
+
+[0.2.0] - 2023-11-01
+
+- Add Region#group and Region#group_name [#15](https://github.com/Shopify/worldwide/pull/15)
+- Ensure Region#has_zip? returns a boolean for all regions [#17](https://github.com/Shopify/worldwide/pull/17)
+- Zip normalization bugfix when parent isocode is not set [#6](https://github.com/Shopify/worldwide/pull/6)
+- Update region parent when alternates are defined [#18](https://github.com/Shopify/worldwide/pull/18)
+- Add partial matching for Region#valid_zip? [#19](https://github.com/Shopify/worldwide/pull/19)
+
 [0.1.1] - 2023-10-27
 
 - Fix issue with deploy to rubygems.org failing

data/Gemfile.lock

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

data/README.md

@@ -99,7 +99,7 @@ Worldwide exposes the notion of a "region", or political subdivision.  This can
 
 Note that, when exposing geographic information to users, you should be careful what you refer
 to as a "country".  For backward compatibility with historical APIs, we use the term "country"
-to refer to what CLDR refers to as a "territory", and what we describe in our user interfarce as
+to refer to what CLDR refers to as a "territory", and what we describe in our user interface as
 a "country / region".  Examples of such entities include Canada, the United States, and Russia,
 but also territories with a "dual" status such as Guernsey, Hong Kong, and Martinique.
 

data/db/data/regions/IT.yml

@@ -14,6 +14,7 @@ zip_regex: "^(IT?-?)?\\d{5}$"
 zip_example: '00144'
 phone_number_prefix: 39
 building_number_required: true
+building_number_may_be_in_address2: true
 week_start_day: monday
 languages:
   - it

data/lib/worldwide/region.rb

@@ -19,6 +19,8 @@ module Worldwide
       :example_city,
       :flag,
       :format,
+      :group,
+      :group_name,
       :cldr_code,
       :iso_code,
       :languages,
@@ -32,7 +34,9 @@ module Worldwide
       :zip_requirement,
     ]
 
-    attr_accessor :parent
+    # A region may have more than one parent.
+    # For example, Puerto Rico (PR/US-PR) is associated with both the US and the Caribbean (029)
+    attr_accessor :parents
 
     # ISO-3166 three-letter code for this region, if there is one.
     # Otherwise, nil.
@@ -43,6 +47,10 @@ module Worldwide
     # If we require a building number in an address, then this will be true.
     attr_accessor :building_number_required
 
+    # In some countries, an address may have the building number in address2.
+    # If we are allowed to have a building number in address2, then this will be true.
+    attr_accessor :building_number_may_be_in_address2
+
     # Alternate codes which may be used to designate this region
     attr_accessor :code_alternates
 
@@ -65,6 +73,14 @@ module Worldwide
     #   - show: how to arrange the fields when formatting an address for display
     attr_accessor :format
 
+    # The string that results from appending " Countries" to the adjectival form of the {group_name}
+    # @example
+    #   CountryDb.country(code: "CA").group == "North American Countries"
+    attr_accessor :group
+
+    # The continent that this region is part of.
+    attr_accessor :group_name
+
     # If this flag is set, then we support provinces "under the hood" for this country, but we do not
     # show them as part of a formatted address.  If the province is missing, we will auto-infer it
     # based on the zip (note that this auto-inference may be wrong for some addresses near a border).
@@ -207,9 +223,12 @@ module Worldwide
       @use_zone_code_as_short_name = use_zone_code_as_short_name
 
       @building_number_required = false
+      @building_number_may_be_in_address2 = false
       @currency = nil
       @flag = nil
       @format = {}
+      @group = nil
+      @group_name = nil
       @languages = []
       @neighbours = []
       @partial_zip_regex = nil
@@ -224,7 +243,7 @@ module Worldwide
       @zip_prefixes = []
       @zip_regex = nil
 
-      @parent = nil
+      @parents = [].to_set
       @zones = []
     end
 
@@ -237,12 +256,18 @@ module Worldwide
     def add_zone(region)
       return if @zones.include?(region)
 
-      region.parent = self
+      region.parents << self
       @zones.append(region)
     end
 
     # Attributes
 
+    def associated_country
+      return self if country?
+
+      parent_country
+    end
+
     # The value with which to autofill the zip, if this region has zip autofill active;
     # otherwise, nil.
     def autofill_zip
@@ -289,7 +314,7 @@ module Worldwide
 
     # Does this region have postal codes?
     def has_zip?
-      format["show"]&.include?("{zip}")
+      !!format["show"]&.include?("{zip}")
     end
 
     # Is this Region considered a "province" (political subdivision of a "country")?
@@ -321,7 +346,8 @@ module Worldwide
 
         zones.find do |region|
           [search_code, alt_search_code].any? do |candidate|
-            candidate == region.alpha_three ||
+            candidate == subdivision_code(region.iso_code) ||
+              candidate == region.alpha_three ||
               candidate == region.iso_code ||
               candidate == region.legacy_code ||
               candidate == region.numeric_three ||
@@ -357,12 +383,12 @@ module Worldwide
     end
 
     # is the given postal code value valid for this region?
-    def valid_zip?(zip)
+    def valid_zip?(zip, partial_match: false)
       normalized = Zip.normalize(
-        country_code: province? ? parent.iso_code : iso_code,
+        country_code: province? && associated_country.iso_code ? associated_country.iso_code : iso_code,
         zip: zip,
       )
-      valid_normalized_zip?(normalized)
+      valid_normalized_zip?(normalized, partial_match: partial_match)
     end
 
     # are zones optional for this region?
@@ -372,6 +398,21 @@ module Worldwide
 
     private
 
+    def answers_to_cldr_code(search_code)
+      return false if Util.blank?(search_code) || Util.blank?(cldr_code)
+      return true if search_code.casecmp(cldr_code).zero?
+
+      pc = parent_country
+      "#{pc&.cldr_code&.downcase}#{cldr_code.downcase}" == search_code.downcase
+    end
+
+    def answers_to_iso_code(search_code)
+      return true if search_code == iso_code
+
+      pc = parent_country
+      "#{pc&.iso_code}-#{iso_code}" == search_code
+    end
+
     def cross_border_zip_includes_province?(zip:, province_code:)
       return false unless country?
 
@@ -396,11 +437,17 @@ module Worldwide
       INSPECTION_FIELDS.map { |field_name| "@#{field_name}=#{send(field_name).inspect}" }.join(", ")
     end
 
+    def parent_country
+      parents.find(&:country?)
+    end
+
     # Checks whether the given value is acceptable according to the regular expression defined for the country.
     # @param value [String] for the postal code
     # @return [Boolean]
     def passes_country_zip_regexp?(value:, partial_match: false)
-      return parent.send(:passes_country_zip_regexp?, value: value, partial_match: partial_match) if province?
+      if province?
+        return associated_country.send(:passes_country_zip_regexp?, value: value, partial_match: partial_match)
+      end
 
       return false if partial_match && partial_zip_regex.nil?
 
@@ -433,11 +480,18 @@ module Worldwide
       end&.first
     end
 
+    def subdivision_code(iso_code)
+      return iso_code if iso_code.nil? || iso_code.length < 3
+
+      country_code, subdivision_code = iso_code.split("-")
+      return subdivision_code if country_code.casecmp(associated_country.iso_code).zero?
+    end
+
     def valid_normalized_zip?(normalized, province_code: nil, partial_match: false)
       if country?
         country = self
       elsif province?
-        country = parent
+        country = associated_country
         province_code ||= legacy_code
       end
 

data/lib/worldwide/regions.rb

@@ -32,13 +32,13 @@ module Worldwide
         search_code = cldr.to_s.upcase
 
         @regions.find do |r|
-          r.cldr_code.upcase == search_code
+          r.send(:answers_to_cldr_code, search_code)
         end
       elsif code
         search_code = code.to_s.upcase
 
         @regions.find do |r|
-          r.iso_code == search_code || r.alpha_three == search_code || r.numeric_three == search_code
+          r.send(:answers_to_iso_code, search_code) || r.alpha_three == search_code || r.numeric_three == search_code
         end
       else # search by name
         search_name = name.upcase

data/lib/worldwide/regions_loader.rb

@@ -46,6 +46,7 @@ module Worldwide
         @regions << current_region
       end
 
+      current_region.parents << parent if Util.present?(parent)
       parent&.add_zone(current_region)
       return current_region if children.nil?
 
@@ -58,10 +59,13 @@ module Worldwide
 
     def apply_territory_attributes(region, spec)
       region.building_number_required = spec["building_number_required"] || true
+      region.building_number_may_be_in_address2 = spec["building_number_may_be_in_address2"] || false
       currency_code = spec["currency"]
       region.currency = Worldwide.currency(code: currency_code) unless currency_code.nil?
       region.flag = spec["emoji"]
       region.format = spec["format"]
+      region.group = spec["group"]
+      region.group_name = spec["group_name"]
       region.hide_provinces_from_addresses = spec["hide_provinces_from_addresses"] || false
       region.languages = spec["languages"]
       region.partial_zip_regex = spec["partial_zip_regex"]

data/lib/worldwide/version.rb

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

data/worldwide.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = "developers@shopify.com"
 
   spec.summary       = "Internationalization and localization APIs"
-  spec.description   = "APIs to support i18n and l10n of Ruby code"
+  spec.description   = "APIs for I18n, I10n, and mailing address operations in Ruby."
   spec.homepage      = "https://github.com/Shopify/worldwide"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worldwide
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: APIs to support i18n and l10n of Ruby code
+description: APIs for I18n, I10n, and mailing address operations in Ruby.
 email: developers@shopify.com
 executables: []
 extensions: []