worldwide 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34f7bb3c955716343037d30822b2652a535c68be3fada2a11967cc7d6b40763a
-  data.tar.gz: d4bcd46d48d03279e5e297571a6b65dbefe846e23c877e2a05df526192d5f5eb
+  metadata.gz: 38296da25beecf36a785ee19594e62e093eda9bf7b188851304644891600a4c7
+  data.tar.gz: 1d0d28aada01f52bfa3b439ffe1c54fd3bfd5af2bf2c78ea7e560f7858655319
 SHA512:
-  metadata.gz: c58b180cb67553facc810f2a59a5ba9e2dc16d36ee04f7b8e1961c9cd52484edb2a987739b06551cc7f14326e39f80d1e6afbbcf340f1d5e9c80622fb4dfd029
-  data.tar.gz: 422f9b02f981eecf17bbbbfe2cbd25a8187c12f9f041808f30a7d39eed28ea1bd421c2f97f69016747a744fee60bfd62817e5418c2ec0ab4310dac15cbd537ca
+  metadata.gz: 32586456f377f80533c8f4a79aec8b5e49a3abd841947d88459b908696d484690a9efe9b93e561b6b6ad45dff79c917aa26cf52423c5949aa2611fea539d139a
+  data.tar.gz: 927ffd197d06049ff64026bc4ac8daf175a2a30288aadfdc3366b2f311e5cbac3cb908882511a3cd59ece64e1d7b73957a93d3fb1500e13bae070ee503ba571f

data/CHANGELOG.md

@@ -29,6 +29,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ---
 
+## [1.19.0] - 2025-10-15
+- Add new method zip_type to determine if a postal code is `NUMERICAL`, `ALPHANUMERICAL`, or `NUMERICAL_WITH_PUNCTUATIONS`[#395](https://github.com/Shopify/worldwide/pull/395)
+
 ## [1.18.0] - 2025-10-08
 - Fix broken CLDR data rake tasks [#389](https://github.com/Shopify/worldwide/pull/389)
 - Read paths files in `configure_i18n` instead of at module initialization (ibid.)

data/Gemfile.lock

@@ -13,7 +13,7 @@ GIT
 PATH
   remote: .
   specs:
-    worldwide (1.18.0)
+    worldwide (1.19.0)
       activesupport (>= 7.0)
       i18n
       phonelib (~> 0.8)

data/lib/worldwide/region.rb

@@ -9,6 +9,13 @@ module Worldwide
     RECOMMENDED = "recommended"
     OPTIONAL = "optional"
 
+    # Accpetable format types of the postal code.
+    FORMAT_TYPES = {
+      ALPHANUMERIC: "ALPHANUMERIC",
+      NUMERIC: "NUMERIC",
+      NUMERIC_AND_PUNCTUATION: "NUMERIC_AND_PUNCTUATION",
+    }
+
     # The default `.inspect` isn't a good fit for Region, because it can end up dumping a lot of info
     # as it walks the hierarchy of descendants.  So, instead, we provide our own `.inspect` that
     # only shows a restricted subset of the object's fields.
@@ -460,6 +467,24 @@ module Worldwide
       end
     end
 
+    # Returns the format type of the postal code.
+    # Analyzes the postal code example and regex pattern to determine if it contains
+    # only numbers, alphanumeric characters, or numbers with punctuation/spaces.
+    # Mainly used to determine the type of keyboard to show on mobile views.
+    #
+    # @return [String, nil] One of "ALPHANUMERIC", "NUMERIC", "NUMERIC_AND_PUNCTUATION", or nil if no zip_example
+    def zip_type
+      return nil if zip_example.nil?
+
+      if zip_example.match?(/[A-Za-z]/)
+        FORMAT_TYPES[:ALPHANUMERIC]
+      elsif zip_example.match?(/[[:punct:]\s]/) || zip_regex&.match?(/}-|\\-|-[?+*]|\(-/)
+        FORMAT_TYPES[:NUMERIC_AND_PUNCTUATION]
+      else
+        FORMAT_TYPES[:NUMERIC]
+      end
+    end
+
     # Returns whether (and how firmly) we require a value in the zip field
     # Possible returns:
     #  - "required" means a value must be supplied

data/lib/worldwide/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worldwide
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Shopify