worldwide 0.14.0 → 0.15.0

data/lib/worldwide/region.rb

@@ -34,6 +34,7 @@ module Worldwide
       :zip_regex,
       :zip_requirement,
       :additional_address_fields,
+      :combined_address_format,
     ]
 
     # A region may have more than one parent.
@@ -197,9 +198,12 @@ module Worldwide
     # If true, then the province is optional for addresses in this region.
     attr_accessor :province_optional
 
-    # A hash of additional address fields and the rules for concatening them into the standard fields
+    # An array of the additional address fields that are defined for this region
     attr_accessor :additional_address_fields
 
+    # A hash of the rules for concatening the additional address fields into the standard fields
+    attr_accessor :combined_address_format
+
     def initialize(
       alpha_three: nil,
       continent: false,
@@ -235,7 +239,8 @@ module Worldwide
       @tax_rate = tax_rate
       @use_zone_code_as_short_name = use_zone_code_as_short_name
 
-      @additional_address_fields = {}
+      @additional_address_fields = []
+      @combined_address_format = {}
       @building_number_required = false
       @building_number_may_be_in_address2 = false
       @currency = nil
@@ -414,6 +419,21 @@ module Worldwide
       end
     end
 
+    # is a neighborhood required for this region?
+    def neighborhood_required?
+      additional_field_required?("neighborhood")
+    end
+
+    # is a street name required for this region?
+    def street_name_required?
+      additional_field_required?("streetName")
+    end
+
+    # is a street number required for this region?
+    def street_number_required?
+      additional_field_required?("streetNumber")
+    end
+
     # is the given postal code value valid for this region?
     def valid_zip?(zip, partial_match: false)
       normalized = Zip.normalize(
@@ -441,6 +461,11 @@ module Worldwide
       end
     end
 
+    def additional_field_required?(field_name)
+      field = additional_address_fields.find { |f| f["name"] == field_name }
+      field ? !!field["required"] : false
+    end
+
     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?

data/lib/worldwide/regions_loader.rb

@@ -95,7 +95,8 @@ module Worldwide
     end
 
     def apply_territory_attributes(region, spec)
-      region.additional_address_fields = spec["additional_address_fields"] || {}
+      region.additional_address_fields = spec["additional_address_fields"] || []
+      region.combined_address_format = spec["combined_address_format"] || {}
       region.building_number_required = spec["building_number_required"] || false
       region.building_number_may_be_in_address2 = spec["building_number_may_be_in_address2"] || false
       currency_code = spec["currency"]

data/lib/worldwide/version.rb

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

data/worldwide.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"] = "https://github.com/Shopify/worldwide/blob/main/CHANGELOG.md"
 
   spec.files = %x(git ls-files -z).split("\x0").reject do |f|
-    f.match(%r{^(rake|test|spec|features)/})
+    f.match(%r{^(rake|test|spec|features|lang/typescript)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worldwide
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -64,11 +64,14 @@ files:
 - ".github/CONTRIBUTING.md"
 - ".github/dependabot.yml"
 - ".github/pull_request_template.md"
+- ".github/workflows/ci-typescript.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/cla.yml"
+- ".github/workflows/npm-release.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock