costa_rica_address_utils 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5499eeebb373e3b50ca5eb2c4e566830f157e390a39893a3f55f613b968a7466
-  data.tar.gz: 5b7ae3823faf5a3792398aeca1d7226db12d9659c95245ca2b97f8299ee722c2
+  metadata.gz: 661047580043bfd115648fe2fcbcbb9bff5fc1fb2cbf2693db4dd857d5cc0e72
+  data.tar.gz: 33fd1761a163939173e07e2ae9dd0a9848782ed49e92d9c652c93ccbbc0403dc
 SHA512:
-  metadata.gz: e237a271be1b395114a457b55ec458e4a8bead6d01f256ea7bcc5abaa47de0839a7fa8728abf56cb738e6922951da0d69b5b01b9fc5efc4c801cdd085dbf50e1
-  data.tar.gz: 208affcee44657c5f423d9c13e4fa49111a34580bf5d72c0ce3829574198345d44ddd1968a7536b07cef462a79d3386ec100fa31a7c6b6a1d52a7d4619a47e9b
+  metadata.gz: e1f3776f9511351fa049dde22c031fdc361020ab4d9789de9f66af502ebc363c0f34742b11ff30463dadd5f1af024c4b84fcb4e3e865fe4225495c29f064606e
+  data.tar.gz: 6c620ebcb5220c43ad6639cdc8f252eb511782a473b743e14bfd8f1bd9a87b8203392d91e20f503671e5f80c75a182ebee7c121448d6906cc634325a4b2259b2

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-## [Unreleased]
+## [0.5.0]
+
+* Changed datasets form to be uncompressed for more clarity (performance shouldn't be affected)
+* Fixed original Costa Rica dataset `locations_dataset.json` zip codes for some districts on `Desamparados` canton
+* Updated new Costa Rica dataset `costa_rica_dataset.json` to match original dataset, there were multiple typos on the location names.
+  * Apply the same fix of zip codes for `Desamparados` canton
+* Added new optional param `new_dataset` on `fetch_address_from_zip` method to use the new Costa Rica dataset and prepare for the eventual migration to the new dataset.
+* Added several tests to cover the whole Costa Rica dataset zip code match with the whole locations data per zip code (improve change control of the datasets)
+
+## [0.4.0]
+
+* Move existing logic for main module to its own module called `CostaRica`
+* Create new module `Guatemala` for Guatemala address logic
+* New method `for_country` to explicitly use methods for each country
+* Extract method `build_address_from_provider` as a global method instead of per region to build an address from an external provider (Shopify, Brightpearl, etc)
+
+> To avoid breaking calls of older versions, if the methods are called directly with `CostaRicaAddressUtils` it will automatically use the methods from `CostaRica` module.
 
 ## [0.3.2]
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    costa_rica_address_utils (0.3.2)
+    costa_rica_address_utils (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -40,11 +40,17 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. 
 
-To release a new version, update the version number in `version.rb` and `Gemfile.lock` (using bundle), and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Release
 
-> `Gemfile.lock` update for version is done after running `bundle install` with the `version.rb` updated
+To release a new version follow these steps:,
+1. Update CHANGELOG.md with the new version changes
+2. Update the version number in `version.rb` 
+3. Execute bundle to update version on `Gemfile.lock` automatically
+4. Commit the changes and change the branch to `main`
+5. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 > Remember to execute `bundle exec rake release` on `main` branch
+> `Gemfile.lock` update for version is done after running `bundle install` with the `version.rb` updated
 
 ## Contributing