worldwide 1.14.4 → 1.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38658a0cbe2fcec35aa5d8d620d9cac02ada5123597d8080733904c0dd371483
-  data.tar.gz: '08b4a6578e559996a928c9ae3600b5b48e806c5ca5e97478d5258aefb4263288'
+  metadata.gz: c3cf97e1bcdf0999cdec177c2d6627b190ed8d8cd55598a676dee463f1cf86ff
+  data.tar.gz: a7f767ba103009a596ca24c969ed7459e0a6f3235d2cbd75a137cd4d2afdfe29
 SHA512:
-  metadata.gz: 9dcf39bb1680898cacc8da3ac4c07f89edcec9c090c4aba0b3c66040d91ed4042e349cbbab64dd7f4f0971aea325dc57a465ea673be154d175786664a85990f9
-  data.tar.gz: c1d8df6382fa989b8c0f1dc710c85f14b4f7e2968c81d26d361038090ca95d812e1c09e46a798114bef33fcd839dcc01955ce4f0ba35801a60ba8e323e55760b
+  metadata.gz: 85217f6eae5ff93bffa23de787d6131e22daa5614a61560c115d3b45c701b70e905543bc7385a3b20d144003cdae4e93eddb72a3db026927cc12cd4eff59576a
+  data.tar.gz: ac164a247f5eb618b189ead2912d427069f33d98911e45317919ce1fd127835bf432192480a77f386c6c7809428d1a983514a9f2c4acda35dbca3f96d2c3a9d1

data/CHANGELOG.md

@@ -28,8 +28,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ## [Unreleased]
 
 Nil.
+
+---
+
+## [1.15.1] - 2024-12-20
+- Set Malaysia and Singapore as tax_inclusive [#323](https://github.com/Shopify/worldwide/pull/323)
+- Update or correct example zips [#324](https://github.com/Shopify/worldwide/pull/324)
+- Correct zip regex patterns and make them Javascript-compatible [#325](https://github.com/Shopify/worldwide/pull/325)
 ---
 
+## [1.15.0] - 2024-12-16
+- Add zip requirement and tax inclusive methods to country regions [#320](https://github.com/Shopify/worldwide/pull/320)
+- Set Ireland (IE) zip as a required address field [#321](https://github.com/Shopify/worldwide/pull/321)
+
 ## [1.14.4] - 2024-12-12
 - Speed up configure_i18n by precomputing paths and indexing descendants [#316](https://github.com/Shopify/worldwide/pull/316)
 - Update BV phone number prefix to 47 (Norway) [#318](https://github.com/Shopify/worldwide/pull/318)

data/Gemfile.lock

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

data/data/regions/AC.yml

@@ -10,7 +10,7 @@ code: AC
 unit_system: metric
 currency: SHP
 zip_example: ASCN 1ZZ
-zip_regex: "\\A[Aa][Ss][Cc][Nn]\\s*1[Zz][Zz]\\z"
+zip_regex: "^[Aa][Ss][Cc][Nn]\\s*1[Zz][Zz]$"
 phone_number_prefix: 247
 zip_autofill_enabled: true
 format:

data/data/regions/BB.yml

@@ -7,7 +7,7 @@ unit_system: metric
 tax_name: VAT
 group: Central American Countries
 group_name: Central America
-zip_example: BB2306
+zip_example: BB15028
 zip_regex: "^(BB-?)?\\d{5,5}$"
 zip_requirement: optional
 phone_number_prefix: 1

data/data/regions/BF.yml

@@ -8,7 +8,7 @@ tax_name: VAT
 group: African Countries
 group_name: Africa
 zip_regex: "^[1-9]\\d{4}$"
-zip_example: 10010
+zip_example: "10010"
 zip_requirement: optional
 phone_number_prefix: 226
 format:

data/data/regions/BL.yml

@@ -11,8 +11,8 @@ unit_system: metric
 tags:
 - EU-OCT
 currency: EUR
-zip_example: '97100'
-zip_regex: "^(BL-?)?97133$"
+zip_example: '97091'
+zip_regex: "^(BL-?)?(97133|9709\\d)$"
 phone_number_prefix: 590
 format:
   edit: "{country}_{firstName}{lastName}_{company}_{address1}_{address2}_{zip}{city}_{phone}"

data/data/regions/CA.yml

@@ -5,7 +5,7 @@ tax: 0.05
 currency: CAD
 unit_system: metric
 tax_name: GST
-zip_regex: "\\A[A-Za-z]\\d[A-Za-z]\\s*\\d[A-Za-z]\\d\\z"
+zip_regex: "^[A-Za-z]\\d[A-Za-z]\\s*\\d[A-Za-z]\\d$"
 partial_zip_regex: "^[A-Z][0-9][A-Z]$"
 group: North American Countries
 group_name: North America

data/data/regions/CR.yml

@@ -7,7 +7,7 @@ unit_system: metric
 tax_name: VAT
 group: Central American Countries
 group_name: Central America
-zip_example: '1000'
+zip_example: '10108'
 phone_number_prefix: 506
 week_start_day: sunday
 format:

data/data/regions/GB.yml

@@ -11,7 +11,7 @@ ignore_zones: true
 group: European Countries
 group_name: Europe
 zip_label: Postcode
-zip_regex: '\A[A-Za-z]{1,2}[\d]{1,2}(?:[A-Za-z])?\s?[\d][A-Za-z]{2}\z'
+zip_regex: "^[A-Za-z]{1,2}[\\d]{1,2}(?:[A-Za-z])?\\s?[\\d][A-Za-z]{2}$"
 partial_zip_regex: "^[A-Z]{1,2}[0-9]{1,2}[A-Z]?$"
 zip_example: SE22 8DL
 phone_number_prefix: 44

data/data/regions/IE.yml

@@ -13,7 +13,6 @@ tags:
 zip_regex: "^(D6W|[AC-FHKNPRT-Z]\\d{2}) ?[0-9AC-FHKNPRT-Z]{4}$"
 partial_zip_regex: "^(D6W|[AC-FHKNPRT-Z]\\d{2})$"
 zip_example: A65 F4E2
-zip_requirement: recommended
 phone_number_prefix: 353
 week_start_day: monday
 format:

data/data/regions/IN.yml

@@ -8,7 +8,7 @@ tax_name: CGST
 tax_inclusive: true
 group: Asian Countries
 group_name: Asia
-zip_regex: "\\A\\d{6}\\z"
+zip_regex: "^\\d{6}$"
 zip_example: '110034'
 phone_number_prefix: 91
 week_start_day: monday

data/data/regions/JE.yml

@@ -9,8 +9,8 @@ tax_inclusive: true
 group: European Countries
 group_name: Europe
 zip_example: JE1 1AA
-zip_regex: "^JE[1-6] {0,2}\\d[A-Z]{2}$"
-partial_zip_regex: "^JE[1-6]$"
+zip_regex: "^JE\\d{1,2} {0,2}\\d[A-Z]{2}$"
+partial_zip_regex: "^JE\\d{1,2}$"
 phone_number_prefix: 44
 format:
   edit: "{country}_{firstName}{lastName}_{company}_{address1}_{address2}_{city}{zip}_{phone}"

data/data/regions/JP.yml

@@ -9,8 +9,8 @@ tax_inclusive: true
 group: Asian Countries
 group_name: Asia
 zip_example: 154-0023
-zip_regex: "\\A〒?(\\d{7}|[0-9|０-９]{3}(-|ー)[0-9|０-９]{4})\\z"
-partial_zip_regex: "\\A〒?([0-9|０-９]{0,3})(-|ー?)([0-9|０-９]{0,4})\\z"
+zip_regex: "^〒?(\\d{7}|[0-9|０-９]{3}(-|ー)[0-9|０-９]{4})$"
+partial_zip_regex: "^〒?([0-9|０-９]{0,3})(-|ー?)([0-9|０-９]{0,4})$"
 phone_number_prefix: 81
 building_number_required: true
 building_number_may_be_in_address2: true

data/data/regions/KH.yml

@@ -7,7 +7,7 @@ unit_system: metric
 tax_name: VAT
 group: Asian Countries
 group_name: Asia
-zip_example: '12203'
+zip_example: '120203'
 phone_number_prefix: 855
 format:
   edit: "{country}_{firstName}{lastName}_{company}_{address1}_{address2}_{city}{zip}_{phone}"

data/data/regions/KR.yml

@@ -7,7 +7,7 @@ unit_system: metric
 tax_name: VAT
 group: Asian Countries
 group_name: Asia
-zip_regex: "(\\A\\d{5}\\z|\\A\\d{3}-\\d{3}\\z)"
+zip_regex: "^(\\d{5}|\\d{3}-\\d{3})$"
 zip_example: '01600'
 phone_number_prefix: 82
 week_start_day: sunday

data/data/regions/MM.yml

@@ -7,7 +7,7 @@ unit_system: metric
 tax_name: GST
 group: Asian Countries
 group_name: Asia
-zip_example: '11181'
+zip_example: '1508203'
 phone_number_prefix: 95
 format:
   edit: "{country}_{firstName}{lastName}_{company}_{address1}_{address2}_{city}{zip}_{phone}"

data/data/regions/MQ.yml

@@ -13,14 +13,14 @@ group_name: Central America
 tags:
 - EU-OMR
 zip_example: '97220'
-zip_regex: "\\A(MQ-?)?((972)\\d{2,2})\\Z"
+zip_regex: "^(MQ-?)?((972)\\d{2,2})$"
 phone_number_prefix: 596
 format:
   edit: "{country}_{firstName}{lastName}_{company}_{address1}_{address2}_{zip}{city}_{phone}"
   show: "{firstName} {lastName}_{company}_{address1}_{address2}_{zip} {city}_{country}_{phone}"
 # The only flag with official standing in Martinique is the French flag.
 # The emoji flag sequence MQ renders as the "snake flag", which is resented by some as a symbol
-# of the slave trade.  A new local flag, the Iséité flag, was brought into use in 2019, but 
+# of the slave trade.  A new local flag, the Iséité flag, was brought into use in 2019, but
 # revoked in 2021.  At this point, the safest course of action seems to be to use the French flag.
 # Sources:  https://en.wikipedia.org/wiki/Flag_of_Martinique
 # https://www.rci.fm/martinique/infos/Justice/La-justice-annule-lutilisation-du-drapeau-et-de-lhymne-choisis-en-2019-par-la-CTM#

data/data/regions/MS.yml

@@ -7,7 +7,7 @@ code: MS
 unit_system: metric
 currency: XCD
 zip_regex: "^MSR ?1[1-3][1235]0$"
-zip_example: MSR 1210
+zip_example: MSR1210
 phone_number_prefix: 1
 format:
   edit: "{country}_{firstName}{lastName}_{company}_{address1}_{address2}_{city}{zip}_{phone}"

data/data/regions/MU.yml

@@ -8,7 +8,7 @@ tax_name: VAT
 tax_inclusive: true
 group: African Countries
 group_name: Africa
-zip_example: 11106
+zip_example: "11106"
 zip_regex: "^[1-9AR]\\d{4}$"
 zip_requirement: optional
 phone_number_prefix: 230

data/data/regions/MW.yml

@@ -11,7 +11,7 @@ group_name: Africa
 #   https://macra.mw/malawi-post-codes/
 #   https://www.grcdi.nl/gsb/malawi.html
 zip_regex: "^[1-3]\\d{5}$"
-zip_example: 207201
+zip_example: "207201"
 zip_requirement: optional
 phone_number_prefix: 265
 format:

data/data/regions/MY.yml

@@ -2,6 +2,7 @@
 name: Malaysia
 code: MY
 tax: 0.1
+tax_inclusive: true
 currency: MYR
 unit_system: metric
 tax_name: SST

data/data/regions/NL.yml

@@ -10,7 +10,7 @@ group: European Countries
 group_name: Europe
 tags:
 - EU-member
-zip_regex: "(?-mix:\\A[1-9][0-9]{3} ?[A-Z]{2}\\z)"
+zip_regex: "^[1-9][0-9]{3} ?[A-Z]{2}$"
 partial_zip_regex: "^\\d{4}$"
 zip_example: 1065 AM
 phone_number_prefix: 31

data/data/regions/NZ.yml

@@ -8,7 +8,7 @@ tax_name: GST
 tax_inclusive: true
 group: Oceanian Countries
 group_name: Oceania
-zip_regex: "\\A\\d{4}\\z"
+zip_regex: "^\\d{4}$"
 zip_example: '6001'
 phone_number_prefix: 64
 building_number_required: true

data/data/regions/PH.yml

@@ -8,7 +8,7 @@ tax_name: VAT
 zone_key: province
 group: Asian Countries
 group_name: Asia
-zip_regex: "\\A\\d{4}\\z"
+zip_regex: "^\\d{4}$"
 zip_example: '1008'
 phone_number_prefix: 63
 week_start_day: sunday

data/data/regions/PM.yml

@@ -12,7 +12,7 @@ tags:
 - EU-OCT
 zip_example: '97500'
 phone_number_prefix: 508
-zip_regex: "\\A(PM-?)?((975)\\d{2,2})\\Z"
+zip_regex: "^(PM-?)?((975)\\d{2,2})$"
 format:
   edit: "{country}_{firstName}{lastName}_{company}_{address1}_{address2}_{zip}{city}_{phone}"
   show: "{firstName} {lastName}_{company}_{address1}_{address2}_{zip} {city}_{country}_{phone}"

data/data/regions/PY.yml

@@ -5,7 +5,7 @@ tax: 0.1
 currency: PYG
 unit_system: metric
 tax_name: IVA
-zip_example: '1536'
+zip_example: '001015'
 group: South American Countries
 group_name: South America
 phone_number_prefix: 595

data/data/regions/SA.yml

@@ -5,7 +5,7 @@ tax: 0.15
 currency: SAR
 unit_system: metric
 tax_name: VAT
-zip_regex: "(?-mix:\\A\\d{5}(-\\d{4})?\\z)"
+zip_regex: "^\\d{5}(-\\d{4})?$"
 zip_requirement: optional
 group: Asian Countries
 group_name: Asia

data/data/regions/SG.yml

@@ -2,6 +2,7 @@
 name: Singapore
 code: SG
 tax: 0.09
+tax_inclusive: true
 currency: SGD
 unit_system: metric
 tax_name: GST

data/data/regions/SS.yml

@@ -11,7 +11,7 @@ group_name: Africa
 # It is possible that some people may still be using old Sudan postcodes for addresses in South Sudan.
 # For that reason, we permit the entry of a postal code, but it is optional.
 zip_regex: "^\\d{5}$"
-zip_example: 81111 # Juba
+zip_example: "81111" # Juba
 zip_requirement: optional
 phone_number_prefix: 211
 format:

data/data/regions/TA.yml

@@ -9,7 +9,7 @@ unit_system: metric
 # Source: https://en.wikipedia.org/wiki/Saint_Helena_pound
 currency: GBP
 zip_example: TDCU 1ZZ
-zip_regex: "\\A[Tt][Dd][Cc][Uu]\\s*1[Zz][Zz]\\z"
+zip_regex: "^[Tt][Dd][Cc][Uu]\\s*1[Zz][Zz]$"
 phone_number_prefix: 2908
 zip_autofill_enabled: true
 autofill_city_enabled: true

data/data/regions/UA.yml

@@ -9,7 +9,7 @@ tax_inclusive: true
 group: European Countries
 group_name: Europe
 zip_example: '15432'
-zip_regex: "\\A\\d{5}\\z"
+zip_regex: "^\\d{5}$"
 phone_number_prefix: 380
 week_start_day: monday
 format:

data/data/regions/US.yml

@@ -10,7 +10,7 @@ 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_regex: "^\\d{5}(-\\d{4})?$"
 zip_example: '90210'
 phone_number_prefix: 1
 building_number_required: true

data/data/regions/UZ.yml

@@ -7,7 +7,7 @@ unit_system: metric
 tax_name: VAT
 group: Asian Countries
 group_name: Asia
-zip_example: '702100'
+zip_example: '140100'
 zip_regex: "^(100|11[0-2]|12[01]|13[01]|14[01]|15[01]|16[01]|17[01]|18[01]|19[01]|20[01]|21[01]|22[01]|23[01])\\d{3}$"
 zip_requirement: optional
 phone_number_prefix: 998

data/data/regions/XK.yml

@@ -11,7 +11,7 @@ tax_inclusive: true
 group: European Countries
 group_name: Europe
 zip_regex: "^((RKS|XK)-?)?[1-7]\\d{4}$"
-zip_example: 10000
+zip_example: "10000"
 phone_number_prefix: 383
 week_start_day: monday
 zip_requirement: recommended

data/lib/worldwide/region.rb

@@ -163,6 +163,9 @@ module Worldwide
     # Note that this should really be translated; showing this untranslated name to users is a bad idea.
     attr_reader :tax_name
 
+    # Whether the region uses tax-inclusive pricing.
+    attr_accessor :tax_inclusive
+
     # "generic" VAT tax rate on "most" goods
     attr_reader :tax_rate
 
@@ -198,7 +201,7 @@ module Worldwide
     attr_accessor :zip_example
 
     # Is a zip value required in this region?  (Possible values:  "optional", "recommended", "required")
-    attr_accessor :zip_requirement
+    attr_writer :zip_requirement
 
     # A list of character sequences with which a postal code in this region may start.
     attr_accessor :zip_prefixes
@@ -276,6 +279,7 @@ module Worldwide
       @partial_zip_regex = nil
       @phone_number_prefix = nil
       @tags = []
+      @tax_inclusive = false
       @timezone = nil
       @timezones = {}
       @unit_system = nil
@@ -435,13 +439,23 @@ module Worldwide
 
     # is a postal code required for this region?
     def zip_required?
-      if zip_requirement.nil?
+      if @zip_requirement.nil?
         !zip_regex.nil?
       else
-        REQUIRED == zip_requirement
+        REQUIRED == @zip_requirement
       end
     end
 
+    # Returns whether (and how firmly) we require a value in the zip field
+    # Possible returns:
+    #  - "required" means a value must be supplied
+    #  - "recommended" means a value is optional, but we recommend providing one
+    #  - "optional" means a value is optional, and we say it is optional
+    # @return [String]
+    def zip_requirement
+      @zip_requirement || (zip_required? ? REQUIRED : OPTIONAL)
+    end
+
     # is a neighborhood required for this region?
     def neighborhood_required?
       additional_field_required?("neighborhood")

data/lib/worldwide/regions_loader.rb

@@ -114,6 +114,7 @@ module Worldwide
       region.partial_zip_regex = spec["partial_zip_regex"]
       region.phone_number_prefix = spec["phone_number_prefix"]
       region.tags = spec["tags"] || []
+      region.tax_inclusive = spec["tax_inclusive"] || false
       region.timezone = spec["timezone"]
       region.timezones = spec["timezones"] || {}
       region.week_start_day = spec["week_start_day"] || "sunday"

data/lib/worldwide/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: worldwide
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.15.1
 platform: ruby
 authors:
 - Shopify
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -8494,7 +8493,6 @@ licenses: []
 metadata:
   allowed_push_host: https://rubygems.org/
   changelog_uri: https://github.com/Shopify/worldwide/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -8509,8 +8507,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Internationalization and localization APIs
 test_files: []