Merge pull request #300 from Shopify/df.add_tax_type

Add Region#tax_type accessor, cut v1.14.0

Author: DominiqueFlaaa

CHANGELOG.md

@@ -26,10 +26,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Security in case of vulnerabilities.
 
 ## [Unreleased]
-- Add example_city_zip and priority accessors to Regions [#298](https://github.com/Shopify/worldwide/pull/298)
+- Nil.
 
 ---
 
+## [1.14.0] - 2024-11-07
+- Add example_city_zip and priority accessors to Regions [#298](https://github.com/Shopify/worldwide/pull/298)
+- Add tax_type accessor to Regions [#299](https://github.com/Shopify/worldwide/pull/299)
+
 ## [1.13.0] - 2024-11-06
 - Add `zip_prefixes` for Spain. [#295](https://github.com/Shopify/worldwide/pull/295)
 - Move expensive resource initialization into an explicit `eager_load!` namespace method

Gemfile.lock

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

lib/worldwide/region.rb

@@ -166,6 +166,9 @@ class Region
     # "generic" VAT tax rate on "most" goods
     attr_reader :tax_rate
 
+    # The type of tax for this region, e.g. "harmonized"
+    attr_accessor :tax_type
+
     # tags that help us group the region, e.g. "EU-member"
     attr_accessor :tags
 

lib/worldwide/regions_loader.rb

@@ -134,6 +134,7 @@ def apply_zone_attributes(region, zone)
       region.example_city = zone["example_city"]
       region.example_city_zip = zone["example_city_zip"]
       region.priority = zone["priority"]
+      region.tax_type = zone["tax_type"] || nil
       region.neighbours = zone["neighboring_zones"]
       region.zip_prefixes = zone["zip_prefixes"] || []
     end

lib/worldwide/version.rb

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

test/worldwide/region_test.rb

@@ -86,8 +86,12 @@ class RegionTest < ActiveSupport::TestCase
       assert_empty region.zip_prefixes
       assert_nil region.zip_regex
       assert_nil region.example_address
+      assert_nil region.example_city
+      assert_nil region.example_city_zip
       assert_empty region.parents
       assert_empty region.zones
+      assert_nil region.tax_name
+      assert_equal 0, (region.tax_rate * 100).floor
     end
 
     test "#short_name returns values as expected" do
@@ -508,5 +512,17 @@ class RegionTest < ActiveSupport::TestCase
     test "#priority returns values as expected" do
       assert_equal 47, Worldwide.region(code: "JP").zone(code: "JP-01").priority
     end
+
+    test "#tax_type returns values as expected" do
+      assert_equal "harmonized", Worldwide.region(code: "CA").zone(code: "ON").tax_type
+    end
+
+    test "#tax_name returns values as expected" do
+      assert_equal "HST", Worldwide.region(code: "CA").zone(code: "ON").tax_name
+    end
+
+    test "#tax_rate returns values as expected" do
+      assert_in_delta(0.13, Worldwide.region(code: "CA").zone(code: "ON").tax_rate)
+    end
   end
 end