worldwide 1.14.4 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38658a0cbe2fcec35aa5d8d620d9cac02ada5123597d8080733904c0dd371483
-  data.tar.gz: '08b4a6578e559996a928c9ae3600b5b48e806c5ca5e97478d5258aefb4263288'
+  metadata.gz: d10d81c9b857f86106cd5bd152abbe999ca045435d904a932eb8f3df69a52293
+  data.tar.gz: 7a2fa0a560b361db7ab472c6cc5676c9dd68518dc6fe49fe3b1c98f3dea1b98f
 SHA512:
-  metadata.gz: 9dcf39bb1680898cacc8da3ac4c07f89edcec9c090c4aba0b3c66040d91ed4042e349cbbab64dd7f4f0971aea325dc57a465ea673be154d175786664a85990f9
-  data.tar.gz: c1d8df6382fa989b8c0f1dc710c85f14b4f7e2968c81d26d361038090ca95d812e1c09e46a798114bef33fcd839dcc01955ce4f0ba35801a60ba8e323e55760b
+  metadata.gz: e672163556eacb4fcdbbdef8859242fdd26f8575ed6c4d9c0c24fe16938b06d6c8e125fb2c8876f36829efe08ec3f09bbe78e8a3aab0d3ea763708f26c3422e7
+  data.tar.gz: 7dda9172548c84533eb716b1c84fb26bf6383d5b31afc69da71efe7128b34a7ac72cfbc2b9231e9ebc415e57e91bf975067f28ae2a48d5186ffd883c8f29c4ad

data/CHANGELOG.md

@@ -28,8 +28,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ## [Unreleased]
 
 Nil.
+
 ---
 
+## [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.0)
       activesupport (>= 7.0)
       i18n
       phonelib (~> 0.8)

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/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.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worldwide
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.15.0
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport