validates_zipcode 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dabc7eb750e5922949d9caebe9616e87d2c571f6caa64f56f0779106235c2e89
-  data.tar.gz: 20ff39a51cd9f7d71dbfabef44eaf985c1e77e1df070f78d0fcceccbd052f2da
+  metadata.gz: e698716ffc57c2d3fcdbfcda2dea3817842ed64b10c7739709a7cdad8914789a
+  data.tar.gz: a50c8edeeadf3aa499d92260214fd65cc6e2bb1ed34f866133eb5480ecb89d5c
 SHA512:
-  metadata.gz: dc1fde962b62625f8877f34479fe76e4a9a8e9aac7bd9ed598c52ad68c41a5d3ed01031c83c23bd4c4c30a810450b724c53b4bafc5ee51dc5853688fe64d2638
-  data.tar.gz: ad65f8eec393ce26b63a23c2f82a2e64107e0e869e5ebd7c0b7689e00a9906dd8ba98bc4197364885de332eb49cc68a704b6bd449e3eb46246d0c12f73a6cbca
+  metadata.gz: b50f55f7f3265cf5de4f56292cc4167cd860afa19e28752b830238bb9e622fdf6948f7da0c60dc5d004524a7595029e8cd45da272deb8978c98bf7be080737a6
+  data.tar.gz: 7750e6f341ca45e65cfa0c5fde71e2b5c451fe99a7fa910cfd6c6ab33695864baef875c041587fe5d451b32e8700cc8147bf54b2a75ef796e489e6c2abac8706

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## 0.6.0
+
+**Heads up:** This release changes the behaviour of `ValidatesZipcode.valid?` when an unknown or malformed country code is passed. Previously, passing a country code not recognised by the gem (e.g. `'UKXXXXX'`) would return `true` — no regex to match against meant no failure. It will now return `false`.
+
+If you were relying on the old behaviour (passing arbitrary country codes and expecting `true`), this is a breaking change for those cases. For everyone else, this is the expected fix — an unrecognised country is not a valid one.
+
+- Return `false` when the country code is not a known ISO 3166-1 alpha-2 code, instead of silently returning `true` — fixes #67
+
+## 0.5.3
+
+- See commits up to 4e5a3132061d57d220d1616beb15d15a47d301df
+
 ## 0.5.2
 
 - Added support for Puerto Rico, thanks to ~ @tahanson

data/lib/validates_zipcode/cldr_regex_collection.rb

@@ -154,7 +154,7 @@ module ValidatesZipcode
       BI: /\A([A-Z\d\s]){3,}\z/i,
       BS: /\A([A-Z\d\s]){3,}\z/i,
       BZ: /\A([A-Z\d\s]){3,}\z/i,
-      BR: /\A\d{5}(-?\d{3})?\z/,
+      BR: /\A\d{5}(-?\d{3})\z/,
       BJ: /\A([A-Z\d\s]){3,}\z/i,
       BT: /\A\d{5}\z/,
       BQ: /\A([A-Z\d\s]){3,}\z/i,

data/lib/validates_zipcode/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ValidatesZipcode
-  VERSION = '0.5.4'
+  VERSION = '0.6.0'
 end

data/lib/validates_zipcode/zipcode.rb

@@ -12,6 +12,7 @@ module ValidatesZipcode
 
     def valid?
       return true if @excluded_country_codes.include?(@country_alpha2)
+      return false unless valid_country_alpha2?
       return true unless regexp
 
       zipcode = @format ? formatted_zip : @zipcode
@@ -31,6 +32,13 @@ module ValidatesZipcode
       @regexp ||= regexp_for_country_alpha2(@country_alpha2)
     end
 
+    # ISO 3166-1 alpha-2 codes are exactly 2 uppercase ASCII letters.
+    # Anything longer or shorter (e.g. "UKXXXXX", "G", "12") is not a
+    # valid country code and should fail validation immediately.
+    def valid_country_alpha2?
+      @country_alpha2.to_s.match?(/\A[A-Za-z]{2}\z/)
+    end
+
     def formatted_zip
       @formatted_zip ||= Formatter.new(zipcode: @zipcode, country_alpha2: @country_alpha2).format
     end

data/spec/spec_helper.rb

@@ -554,9 +554,9 @@ TEST_DATA = {
   },
   KH: {
     valid: %w[
-      07113
-      02566
-      66261
+      071131
+      025662
+      662613
     ],
     invalid: [
       nil,
@@ -2168,7 +2168,8 @@ TEST_DATA = {
       '',
       'invalid_zip',
       '1234',
-      '123456789'
+      '123456789',
+      '12345'
     ]
   },
   BJ: {

data/spec/validates_zipcode_spec.rb

@@ -82,6 +82,14 @@ describe ValidatesZipcode, '.valid?' do
       expect(ValidatesZipcode.valid?('12345', 'ZZ')).to eq(true)
     end
 
+    it "is false with a malformed country code that is not a valid ISO 3166-1 alpha-2 code" do
+      expect(ValidatesZipcode.valid?('Sw1A 2aA', 'UKXXXXX')).to eq(false)
+      expect(ValidatesZipcode.valid?('12345', 'USA')).to eq(false)    # 3 letters
+      expect(ValidatesZipcode.valid?('12345', 'U')).to eq(false)      # 1 letter
+      expect(ValidatesZipcode.valid?('12345', '12')).to eq(false)     # digits
+      expect(ValidatesZipcode.valid?('12345', '')).to eq(false)       # empty
+    end
+
     it "is true with an excluded country code -  we don't want those to fail and nil is hairy" do
       expect(ValidatesZipcode.valid?('XXXX!!!XXXX', 'PA', excluded_country_codes: %w[PA])).to eq(true)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validates_zipcode
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - David Gil