validates_zipcode 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433bed9455e92a8d15ee319afaf7e40f25eb188af84f8a480691a3f5ba030f2d
-  data.tar.gz: 625157e0787d574631dd74b82d47c550105831dcd542e296b598a40fe9ff533f
+  metadata.gz: da88fce714c50ac27abe1f64ce191dd48e274627db7a1499fec7a303a717ea08
+  data.tar.gz: 4ffc0f1f1435f9a16a41fe99e2124c2694cd014d46a98751fa1fc0fc203222c9
 SHA512:
-  metadata.gz: 427e1f62ff4cffe6a37d35cc5258b4f456442c59acf17779aa4c3e90e9b836bc12dbf095f17f8569eaabfe7d3fecee0311f7a9e87b26d608256dd6976627dc40
-  data.tar.gz: 16af43886485c7444d8c305f135a8b8112b3bcfd99738543144295d3df5df98b44c31ee87084ddb419ea942f13f511a70517f18e2880ee24623087b12728cadd
+  metadata.gz: de68bd2086e4ff55b2da3848ae25f1d051dd066fb1afcdc517c8a191382ec7b1379256724a537ab7b7d4e129b2915896c72d6a73c4c2c31c80b14d9280599102
+  data.tar.gz: d1d76356f263fcfda47ff0c6bb33e55df6a1fd2ecdc8c87d7c0d976ccd54362e9c49a9a23722834ebd52dbf87e6ad89fdab4619e3cc96eddaa7c36935331cd2b

data/.rubocop.yml

@@ -5,9 +5,12 @@ inherit_from:
 #  - enabled.yml
 #  - disabled.yml
 
+require:
+- rubocop-rails
+
 # Common configuration.
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
   TargetRailsVersion: 4.2
 
@@ -58,7 +61,7 @@ Layout/AccessModifierIndentation:
     - indent
 
 # Align the elements of a hash literal if they span more than one line.
-Layout/AlignHash:
+Layout/HashAlignment:
   # Alignment of entries using hash rocket as separator. Valid values are:
   #
   # key - left alignment of keys
@@ -126,7 +129,7 @@ Layout/AlignHash:
 Style/Alias:
   Enabled: false
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   # Alignment of parameters in multi-line method calls.
   #
   # The `with_first_parameter` style aligns the following lines along the same
@@ -227,20 +230,6 @@ Style/BlockDelimiters:
     - proc
     - it
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: no_braces
-  SupportedStyles:
-    # The `braces` style enforces braces around all method parameters that are
-    # hashes.
-    - braces
-    # The `no_braces` style checks that the last parameter doesn't have braces
-    # around it.
-    - no_braces
-    # The `context_dependent` style checks that the last parameter doesn't have
-    # braces around it, but requires braces if the second to last parameter is
-    # also a hash literal.
-    - context_dependent
-
 # Indentation of `when`.
 Layout/CaseIndentation:
   SupportedStyles:
@@ -387,25 +376,18 @@ Layout/EmptyLinesAroundModuleBody:
     - empty_lines
     - no_empty_lines
 
-Style/FileName:
+Naming/FileName:
   # File names listed in AllCops:Include are excluded by default. Add extra
   # excludes here.
   Exclude: []
 
 Layout/FirstParameterIndentation:
-  EnforcedStyle: special_for_inner_method_call_in_parentheses
+  EnforcedStyle: consistent
   SupportedStyles:
     # The first parameter should always be indented one step more than the
     # preceding line.
     - consistent
-    # The first parameter should normally be indented one step more than the
-    # preceding line, but if it's a parameter for a method call that is itself
-    # a parameter in a method call, then the inner parameter should be indented
-    # relative to the inner method.
-    - special_for_inner_method_call
-    # Same as special_for_inner_method_call except that the special rule only
-    # applies if the outer method call encloses its arguments in parentheses.
-    - special_for_inner_method_call_in_parentheses
+    - align_parentheses
 
 Style/EmptyMethod:
   EnforcedStyle: expanded
@@ -439,11 +421,9 @@ Style/FormatStringToken:
     - template
 
 Style/FrozenStringLiteralComment:
-  EnforcedStyle: when_needed
+  EnforcedStyle: always
   SupportedStyles:
-    # `when_needed` will add the frozen string literal comment to files
-    # only when the `TargetRubyVersion` is set to 2.3+.
-    - when_needed
+    - always_true
     # `always` will always add the frozen string literal comment to a file
     # regardless of the Ruby version or if `freeze` or `<<` are called on a
     # string literal. If you run code against multiple versions of Ruby, it is
@@ -483,7 +463,7 @@ Layout/IndentationWidth:
   Width: 2
 
 # Checks the indentation of the first key in a hash literal.
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   # The value `special_inside_parentheses` means that hash literals with braces
   # that have their opening brace on the same line as a surrounding opening
   # round parenthesis, shall have their first key indented relative to the
@@ -532,7 +512,7 @@ Style/MethodDefParentheses:
     - require_parentheses
     - require_no_parentheses
 
-Style/MethodName:
+Naming/MethodName:
   EnforcedStyle: snake_case
   SupportedStyles:
     - snake_case
@@ -569,14 +549,14 @@ Style/PercentQLiterals:
     - lower_case_q # Use %q when possible, %Q when necessary
     - upper_case_q # Always use %Q
 
-Style/PredicateName:
+Naming/PredicateName:
   # Predicate name prefices.
   NamePrefix:
     - is_
     - has_
     - have_
   # Predicate name prefices that should be removed.
-  NamePrefixBlacklist:
+  ForbiddenPrefixes:
     - is_
     - has_
     - have_
@@ -694,7 +674,7 @@ Style/SymbolProc:
   IgnoredMethods:
     - respond_to
 
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   EnforcedStyle: final_newline
   SupportedStyles:
     - final_newline
@@ -756,7 +736,7 @@ Style/TrivialAccessors:
   # Commonly used in DSLs
   AllowDSLWriters: false
   IgnoreClassMethods: false
-  Whitelist:
+  AllowedMethods:
     - to_ary
     - to_a
     - to_c
@@ -775,7 +755,7 @@ Style/TrivialAccessors:
     - to_s
     - to_sym
 
-Style/VariableName:
+Naming/VariableName:
   EnforcedStyle: snake_case
   SupportedStyles:
     - snake_case
@@ -825,7 +805,7 @@ Metrics/CyclomaticComplexity:
   Max: 6
 
 # Second-wave metric. Disabled now to prevent noise.
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
   Max: 120
   # To make it possible to copy or click on URIs in the code, we allow lines
@@ -856,7 +836,7 @@ Lint/AssignmentInCondition:
   AllowSafeAssignment: true
 
 # Align ends correctly.
-Lint/EndAlignment:
+Layout/EndAlignment:
   # The value `keyword` means that `end` should be aligned with the matching
   # keyword (if, while, etc.).
   # The value `variable` means that in assignments, `end` should be aligned
@@ -869,7 +849,7 @@ Lint/EndAlignment:
     - start_of_line
   AutoCorrect: false
 
-Lint/DefEndAlignment:
+Layout/DefEndAlignment:
   # The value `def` means that `end` should be aligned with the def keyword.
   # The value `start_of_line` means that `end` should be aligned with method
   # calls like `private`, `public`, etc, if present in front of the `def`

data/.travis.yml

@@ -7,10 +7,10 @@ cache: bundler
 bundler_args: --jobs 3 --retry 3
 
 before_install:
-  - "travis_retry gem update --system"
-  - "travis_retry gem install bundler"
+  - 'travis_retry gem update --system'
+  - 'travis_retry gem install bundler'
 
-script: "bundle exec rake"
+script: 'bundle exec rake'
 
 rvm:
   - 2.4.9

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.3.0
+
+- Adds zipcode formatting feature ~ @aiomaster
+- Drops support for EoL Rails < 4.2 and Ruby < 2.4. ~ @dgilperez
+
+## 0.2.5
+
+- Allows for a custom message passed to the validator ~ @andychongyz
+
 ## 0.2.4
 
 - Fixes LV postal code format

data/README.md

@@ -4,13 +4,14 @@ Adds zipcode / postal code validation support to Rails (ActiveModel), considerin
 
 ``ValidatesZipcode`` currently support **233 country codes**. Regex data taken from several sources, being the main source the [CLDR](http://unicode.org/cldr/trac/browser/tags/release-27-d05/common/supplemental/postalCodeData.xml) database (release 27, around 159). Any other country's postal code will validate without errors.
 
-``ValidatesZipcode`` supports Rails >= 4.2 and Ruby >= 2.0. It could probably work unsupported in Rails 3.2 and Ruby 1.9.3 as well. Truffleruby is also tested, but no reports of working in production apps for now.
+``ValidatesZipcode`` supports Rails >= 4.2 and Ruby >= 2.4. This gem could work in Rails 3.2 and Ruby 1.9.3 as well, yet unsupported; try v0.2 series if having trouble with later versions. Truffleruby is also tested, but no reports of working in production apps for now.
 
 ## Installation
 
 Add this line to your application's Gemfile:
-
-    gem 'validates_zipcode'
+```ruby
+gem 'validates_zipcode'
+```
 
 And then execute:
 
@@ -22,23 +23,56 @@ Or install it yourself as:
 
 ## Usage
 
-    validates_zipcode :zipcode
+### With ActiveModel::Validations
+
+```ruby
+validates_zipcode :zipcode
 
-    validates :zipcode, zipcode: true
+validates :zipcode, zipcode: true
+```
 
 ``ValidatesZipcode`` expects the model to have an attribute called ``country_alpha2`` to contain the country code.
 You can provide your own country_code using ``:country_code`` option, or specify which attribute contains this information
 using ``:country_code_attribute`` option.
 
-    validates :zipcode, zipcode: { country_code: :es }
+```ruby
+validates :zipcode, zipcode: { country_code: :es }
 
-    validates :zipcode, zipcode: { country_code_attribute: :my_country_code_column }
+validates :zipcode, zipcode: { country_code_attribute: :my_country_code_column }
+```
 
 If you need to localize the error message, just add this to your I18n locale file:
 
-    errors:
-      messages:
-        invalid_zipcode: Your zipcode error message.
+```yaml
+errors:
+  messages:
+    invalid_zipcode: Your zipcode error message.
+```
+
+### Without ActiveModel::Validations
+
+```ruby
+ValidatesZipcode.valid?('93108', 'ES')
+# => true
+```
+
+### Formatting
+
+This gem can also be used for formatting zipcodes according to country specific rules.
+
+```ruby
+ValidatesZipcode.format('Sw1A 2aA', 'UK')
+# => 'SW1A 2AA'
+```
+
+If the zipcode is not valid an exception is raised.
+
+```ruby
+ValidatesZipcode.format('Sw1A 2aA', 'FR')
+# => raises ValidatesZipcode::InvalidZipcodeError
+```
+
+At the moment not every country is supported. See [lib/validates_zipcode/formatter.rb](lib/validates_zipcode/formatter.rb) to find all available countries.
 
 ## Contributing
 

data/gemfiles/rails_4.2.gemfile

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "activemodel", "~> 4.2.0"
+gem 'activemodel', '~> 4.2.0'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_4.2.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    validates_zipcode (0.2.4)
-      activemodel (>= 3.2.0)
+    validates_zipcode (0.3.0)
+      activemodel (>= 4.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -19,13 +19,20 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
+    ast (2.4.0)
     builder (3.2.3)
     concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
-    rake (12.2.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -39,10 +46,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.10.1)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -51,9 +74,11 @@ DEPENDENCIES
   activemodel (~> 4.2.0)
   appraisal
   bundler
-  rake (~> 12.2.1)
+  rake (>= 12.3.3)
   rspec
+  rubocop
+  rubocop-rails
   validates_zipcode!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/gemfiles/rails_5.2.gemfile

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "activemodel", "~> 5.2.0"
+gem 'activemodel', '~> 5.2.0'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_5.2.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    validates_zipcode (0.2.4)
-      activemodel (>= 3.2.0)
+    validates_zipcode (0.3.0)
+      activemodel (>= 4.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,12 +18,19 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
+    ast (2.4.0)
     concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     i18n (1.5.3)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
-    rake (12.2.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -37,10 +44,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.10.1)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -49,9 +72,11 @@ DEPENDENCIES
   activemodel (~> 5.2.0)
   appraisal
   bundler
-  rake (~> 12.2.1)
+  rake (>= 12.3.3)
   rspec
+  rubocop
+  rubocop-rails
   validates_zipcode!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/gemfiles/rails_6.0.gemfile

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "activemodel", "~> 5.2.0"
+gem 'activemodel', '~> 5.2.0'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_6.0.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    validates_zipcode (0.2.4)
-      activemodel (>= 3.2.0)
+    validates_zipcode (0.3.0)
+      activemodel (>= 4.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,12 +18,19 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
+    ast (2.4.0)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
-    rake (12.2.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -37,10 +44,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.10.1)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -49,9 +72,11 @@ DEPENDENCIES
   activemodel (~> 5.2.0)
   appraisal
   bundler
-  rake (~> 12.2.1)
+  rake (>= 12.3.3)
   rspec
+  rubocop
+  rubocop-rails
   validates_zipcode!
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/gemfiles/rails_edge.gemfile

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "activemodel", github: "rails/rails"
+gem 'activemodel', github: 'rails/rails'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_edge.gemfile.lock

@@ -14,8 +14,8 @@ GIT
 PATH
   remote: ..
   specs:
-    validates_zipcode (0.2.2)
-      activemodel (>= 3.2.0)
+    validates_zipcode (0.3.0)
+      activemodel (>= 4.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -24,12 +24,19 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
+    ast (2.4.0)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
-    rake (12.2.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -43,10 +50,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.10.1)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
     zeitwerk (2.1.6)
 
 PLATFORMS
@@ -56,9 +79,11 @@ DEPENDENCIES
   activemodel!
   appraisal
   bundler
-  rake (~> 12.2.1)
+  rake (>= 12.3.3)
   rspec
+  rubocop
+  rubocop-rails
   validates_zipcode!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/lib/validates_zipcode.rb

@@ -1,13 +1,23 @@
 # frozen_string_literal: true
 require 'validates_zipcode/railtie' if defined?(Rails)
 require 'validates_zipcode/cldr_regex_collection'
+require 'validates_zipcode/invalid_zipcode_error'
 require 'validates_zipcode/validator'
 require 'validates_zipcode/helper_methods'
 require 'validates_zipcode/version'
 require 'validates_zipcode/zipcode'
+require 'validates_zipcode/formatter'
 
 module ValidatesZipcode
-  def self.valid?(zipcode, country_alpha2, options = {})
-    ValidatesZipcode::Zipcode.new(options.merge(zipcode: zipcode, country_alpha2: country_alpha2)).valid?
+  def self.valid?(*args)
+    build_zipcode(*args).valid?
+  end
+
+  def self.format(*args)
+    build_zipcode(*args).format
+  end
+
+  def self.build_zipcode(zipcode, country_alpha2, options = {})
+    ValidatesZipcode::Zipcode.new(options.merge(zipcode: zipcode, country_alpha2: country_alpha2))
   end
 end

data/lib/validates_zipcode/formatter.rb

@@ -0,0 +1,38 @@
+module ValidatesZipcode
+  class Formatter
+
+    ZIPCODES_TRANSFORMATIONS = {
+      AT: ->(z) { z.scan(/\d/).join },
+      CZ: ->(z) { z.scan(/\d/).insert(3, ' ').join },
+      DE: ->(z) { z.scan(/\d/).join.rjust(5, "0") },
+      GB: ->(z) { z.upcase.scan(/[A-Z0-9]/).insert(-4, ' ').join },
+      NL: ->(z) { z.upcase.scan(/[A-Z0-9]/).insert(4, ' ').join },
+      PL: ->(z) { z.scan(/\d/).insert(2, '-').join },
+      SK: :CZ,
+      UK: :GB,
+      US: ->(z) {
+        digits = z.scan(/\d/)
+        digits.insert(5, '-') if digits.count > 5
+        digits.join
+      }
+    }
+
+    def initialize(args = {})
+      @zipcode        = args.fetch(:zipcode).to_s
+      @country_alpha2 = args.fetch(:country_alpha2).to_s.upcase.to_sym
+    end
+
+    def format
+      transformation = ZIPCODES_TRANSFORMATIONS[@country_alpha2]
+      case transformation
+      when Proc
+        transformation.call(@zipcode)
+      when Symbol
+        ZIPCODES_TRANSFORMATIONS[transformation].call(@zipcode)
+      else
+        @zipcode.strip
+      end
+    end
+
+  end
+end

data/lib/validates_zipcode/invalid_zipcode_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module ValidatesZipcode
+  class InvalidZipcodeError < RuntimeError
+  end
+end

data/lib/validates_zipcode/validator.rb

@@ -21,7 +21,7 @@ module ValidatesZipcode
       @country_code           = options.fetch(:country_code, nil)
       @country_code_attribute = options.fetch(:country_code_attribute, :country_alpha2)
       @excluded_country_codes = options.fetch(:excluded_country_codes, [])
-
+      @message                = options.fetch(:message, nil)
       super
     end
 
@@ -32,9 +32,8 @@ module ValidatesZipcode
                   excluded_country_codes: @excluded_country_codes }
 
       unless ValidatesZipcode::Zipcode.new(options).valid?
-        record.errors.add(attribute, :invalid_zipcode, message: I18n.t('errors.messages.invalid_zipcode',
-          value: value,
-          default: 'Zipcode is invalid'))
+        message = @message || I18n.t('errors.messages.invalid_zipcode', value: value, default: 'Zipcode is invalid')
+        record.errors.add(attribute, :invalid_zipcode, message: message)
       end
     end
   end

data/lib/validates_zipcode/version.rb

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

data/lib/validates_zipcode/zipcode.rb

@@ -16,6 +16,11 @@ module ValidatesZipcode
     end
     alias_method :validate, :valid?
 
+    def format
+      raise InvalidZipcodeError, "invalid zipcode #{@zipcode} for country #{@country_alpha2.to_s.upcase}" unless valid?
+      Formatter.new(zipcode: @zipcode, country_alpha2: @country_alpha2).format
+    end
+
     private
 
     def regexp

data/spec/format_zipcode_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe ValidatesZipcode::Formatter, '#format' do
+  context 'Czech' do
+    it { check_format('CZ', '12000' => '120 00') }
+    it { check_format(:cz, '721 00' => '721 00') }
+  end
+
+  context 'Germany' do
+    it { check_format('DE', 1309 => '01309') }
+  end
+
+  context 'Netherlands' do
+    it { check_format('NL', '1000ap' => '1000 AP') }
+    it { check_format('nl', '9104-BR' => '9104 BR') }
+    it { check_format(:nl, '6832_AM' => '6832 AM') }
+  end
+
+  context 'UK' do
+    it { check_format('UK', 'CB224RG' => 'CB22 4RG') }
+    it { check_format('UK', 'Sw1A 2aA' => 'SW1A 2AA') }
+    it { check_format('GB', 'id11qd' => 'ID1 1QD') }
+  end
+
+  context 'US' do
+    it { check_format('US', '221	62	–	10	10' => '22162-1010') }
+    it { check_format('US', '22162' => '22162') }
+    it { check_format('US', '22162 1010' => '22162-1010') }
+  end
+
+  def check_format(country, formatting)
+    from_zip, to_zip = formatting.first
+    expect(::ValidatesZipcode::Formatter.new(zipcode: from_zip, country_alpha2: country).format).to eq(to_zip)
+  end
+end

data/spec/validates_zipcode_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
+# NOTE: Spain has the full case specs.
+#       Do not apply all checks to all countries for suite speed.
 describe ValidatesZipcode, '#validate_each' do
   context 'Argentina' do
     it 'does not add errors with a valid zipcode' do
@@ -265,6 +267,8 @@ describe ValidatesZipcode, '#validate_each' do
       ['1234', '12345-12345', 'D0D0D0', 'invalid_zip'].each do |zipcode|
         record = build_record(zipcode, 'ES')
         zipcode_should_be_invalid(record, zipcode)
+        record.errors.clear
+        zipcode_should_be_invalid_with_custom_message(record, zipcode)
       end
     end
   end
@@ -409,6 +413,16 @@ describe ValidatesZipcode, '.valid?' do
   end
 end
 
+describe ValidatesZipcode, '.format' do
+  it "formats valid zipcodes" do
+    expect(ValidatesZipcode.format('Ka9 2dj', 'UK')).to eq('KA9 2DJ')
+  end
+
+  it "raises for invalid zipcodes" do
+    expect { ValidatesZipcode.format('KA9 1tr', 'DE') }.to raise_error(ValidatesZipcode::InvalidZipcodeError)
+  end
+end
+
 def zipcode_should_be_valid(record, options = {})
   ValidatesZipcode::Validator.new(options.merge(attributes: :zipcode)).validate(record)
 
@@ -422,6 +436,14 @@ def zipcode_should_be_invalid(record, _zipcode, options = {})
   expect(record.errors.messages[:zipcode]).to include 'Zipcode is invalid'
 end
 
+def zipcode_should_be_invalid_with_custom_message(record, _zipcode, options = {})
+  custom_message = 'is really wrong'
+  ValidatesZipcode::Validator.new(options.merge(attributes: :zipcode, message: custom_message)).validate(record)
+
+  expect(record.errors.size).to eq 1
+  expect(record.errors.messages[:zipcode]).to include custom_message
+end
+
 def build_record(zipcode, country_alpha2)
   ValidationDummyClass.new.tap do |object|
     object.country_alpha2 = country_alpha2

data/validates_zipcode.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'validates_zipcode/version'
 
@@ -17,14 +17,16 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files -z`.split("\x0")
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
+  s.require_paths = %w[lib]
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.4'
 
-  s.add_dependency 'activemodel', '>= 3.2.0'
+  s.add_dependency 'activemodel', '>= 4.2.0'
 
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake', '~> 12.2.1'
+  s.add_development_dependency 'rake', '>= 12.3.3'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-rails'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validates_zipcode
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - David Gil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 12.2.1
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 12.2.1
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Adds zipcode validation methods to ActiveModel considering different
   country zipcode formats.
 email:
@@ -110,11 +138,14 @@ files:
 - gemfiles/rails_edge.gemfile.lock
 - lib/validates_zipcode.rb
 - lib/validates_zipcode/cldr_regex_collection.rb
+- lib/validates_zipcode/formatter.rb
 - lib/validates_zipcode/helper_methods.rb
+- lib/validates_zipcode/invalid_zipcode_error.rb
 - lib/validates_zipcode/railtie.rb
 - lib/validates_zipcode/validator.rb
 - lib/validates_zipcode/version.rb
 - lib/validates_zipcode/zipcode.rb
+- spec/format_zipcode_spec.rb
 - spec/spec_helper.rb
 - spec/validates_zipcode_spec.rb
 - validates_zipcode.gemspec
@@ -130,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -142,5 +173,6 @@ signing_key:
 specification_version: 4
 summary: Localizable zipcode validation for Rails.
 test_files:
+- spec/format_zipcode_spec.rb
 - spec/spec_helper.rb
 - spec/validates_zipcode_spec.rb