worldwide 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5239439f9dda5abcf62fc8cbb59343a420a34ef5abe96c7b6cd23a17a633623a
-  data.tar.gz: 8438623520e1065231f78707ebaadeee25c0bd2f5ec4f795cbde00284a69fd45
+  metadata.gz: 2c3c323e57e56b609ebdc7fe5d7965a2d5348fede9b72110627528529b3b7ab5
+  data.tar.gz: f4007e0986bc9702af7d95f3c352a11937292d9f6fbbd8c21e8a1a635fcc7993
 SHA512:
-  metadata.gz: 578e7e33cf986cda84b85c4d9e2f1092d13e3fd513b63667ee757cc6bbc937b84855ca4718a262ea5b6ecffa4203924a7fc1c5395fde98582c31adda4e1ab78d
-  data.tar.gz: 2e28c5c0b5823979d7114b466e931429ec7376a90d1e1eb7de34c93a9dff059068ae65b548f0f3cf0f75c29c6f16051f9050ae1eb337ac51486ed0949d31c54c
+  metadata.gz: 333628df88179b5d2696634f3dadec1a548a5a2ef4baebcac86832077565f5f826036da107cdf8d5d4ed84323563235265df4b0bf37648f7d7691ef120e81216
+  data.tar.gz: cdbad17228b52fc39d188fdbf2e13800aa4015caf18cd314d9cdfcd7f3a7b63f585c2cbd69eec36bb8c450dae83e649c35a0c661c651e55293c626582e03a785

data/CHANGELOG.md

@@ -28,6 +28,14 @@ Nil.
 
 ---
 
+[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.2.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/lib/worldwide/region.rb

@@ -19,6 +19,8 @@ module Worldwide
       :example_city,
       :flag,
       :format,
+      :group,
+      :group_name,
       :cldr_code,
       :iso_code,
       :languages,
@@ -65,6 +67,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).
@@ -210,6 +220,8 @@ module Worldwide
       @currency = nil
       @flag = nil
       @format = {}
+      @group = nil
+      @group_name = nil
       @languages = []
       @neighbours = []
       @partial_zip_regex = nil
@@ -289,7 +301,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")?
@@ -357,12 +369,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? && parent.iso_code ? parent.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?

data/lib/worldwide/regions_loader.rb

@@ -46,6 +46,9 @@ module Worldwide
         @regions << current_region
       end
 
+      if parent.present? && current_region.parent != parent
+        current_region.parent = parent
+      end
       parent&.add_zone(current_region)
       return current_region if children.nil?
 
@@ -62,6 +65,8 @@ module Worldwide
       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.2.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.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2023-11-01 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: []