validates_zipcode 0.2.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433bed9455e92a8d15ee319afaf7e40f25eb188af84f8a480691a3f5ba030f2d
-  data.tar.gz: 625157e0787d574631dd74b82d47c550105831dcd542e296b598a40fe9ff533f
+  metadata.gz: 214ffb965fb27983b44b38dbac18b42041d665e313862b10e809bf3f598c7698
+  data.tar.gz: bf2137923c16d09823dfb1fac10c372c2cb0f6f0fbb4c9053b7be5ee38098a2e
 SHA512:
-  metadata.gz: 427e1f62ff4cffe6a37d35cc5258b4f456442c59acf17779aa4c3e90e9b836bc12dbf095f17f8569eaabfe7d3fecee0311f7a9e87b26d608256dd6976627dc40
-  data.tar.gz: 16af43886485c7444d8c305f135a8b8112b3bcfd99738543144295d3df5df98b44c31ee87084ddb419ea942f13f511a70517f18e2880ee24623087b12728cadd
+  metadata.gz: 40bdbcb70fc0284c0b3f4d1ab3ad626a5f8fe37cd7ef893d5d38ff80961c30bd8736df59752cb4de8367768fa9a57b872a91af09e1376386af33c652b7629cf0
+  data.tar.gz: b359270f28b23d87c69f8af0646b7ad0e59140e09bd85b4fadb994b8fce94252c40a32b461f46c3d5fa6b16c806a7fd09c040ab37bbc7491b90b055ccf306edf

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.dccache

data/.rubocop.yml

@@ -5,11 +5,14 @@ inherit_from:
 #  - enabled.yml
 #  - disabled.yml
 
+require:
+- rubocop-rails
+
 # Common configuration.
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
-  TargetRailsVersion: 4.2
+  TargetRailsVersion: 5.2
 
   # Include common Ruby source files.
   Include:
@@ -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`
@@ -882,7 +862,7 @@ Lint/DefEndAlignment:
 
 ##################### Rails ##################################
 Rails:
-  Enabled: true
+  Enabled: false
 
 Rails/ActionFilter:
   EnforcedStyle: action

data/.travis.yml

@@ -7,23 +7,24 @@ 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
   - 2.5.7
   - 2.6.5
-  - 2.7.0
+  - 2.7.2
+  - 3.0.0
   - ruby-head
   - truffleruby
 
 gemfile:
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
+  - gemfiles/rails_6.1.gemfile
   - gemfiles/rails_edge.gemfile
 
 matrix:
@@ -32,6 +33,8 @@ matrix:
     - rvm: ruby-head
   exclude:
     - rvm: 2.4.9
-      gemfile: gemfiles/rails_6.gemfile
+      gemfile: gemfiles/rails_6.1.gemfile
     - rvm: 2.4.9
       gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 3.0.0
+      gemfile: gemfiles/rails_edge.gemfile

data/Appraisals

@@ -8,8 +8,8 @@ appraise 'rails-5.2' do
   gem 'activemodel', '~> 5.2.0'
 end
 
-appraise 'rails-6.0' do
-  gem 'activemodel', '~> 5.2.0'
+appraise 'rails-6.1' do
+  gem 'activemodel', '~> 6.1.0'
 end
 
 appraise 'rails_edge' do

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.5.0
+
+- Pass `format: true` option to the `validates_zipcode` or the constructor to attempt for format a given code using the (uncomplete) list of formatters by country. This process will happen before the validation takes place, dealing with case sensitive formats and whitespace, amongst others. This option is false by default for backwards compatibility. ~ @chloe-meister
+- Fixed unconsistent behaviour by which the `ValidatesZipcode.format` and `ValidatesZipcode::Formatter.new(..).format` where formatting an invalid code, the former, and raising a validity error, the latter. ~ @chloe-meister
+
+## 0.4.0
+
+**HEADS UP**: While I don't think this update would break any system for anyone, many formats where revisited to make them more loose or strict, potentially rendering your data invalid, particularly in edge cases or with data that was already incorrect in the first place and not flagges as such. I recommend you check your data with the new version in case these validations are critical to you. I am not releasing this as a 1.0 because there are no breaking changes in the API though. See PR #54 for more details.
+
+- Many regexps where modified to include recent changes in postal services, fix issues, narrow down formats that where unnecessary broad, allow for some looser cases such as optional whitespaces and making many of them case insensitive and removing countries with no postal codes - See PR #54. Thanks to ~ @ojsdude with some help from @dgilperez
+- Allow the gem to generate test data from the formatters. See README ~ @ojsdude
+- Officially support Ruby 3 and Rails 6.1
+
+## 0.3.3
+
+- Fixes AR regex
+
+## 0.3.2
+
+- Adds formatter for CA ~ @devthiago
+
+## 0.3.1
+
+- Removes forbidden combinations in the Netherlands ~ @gerard76
+
+## 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,81 @@ 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 }
+#### Error Messaging
 
 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.
+```
+
+You can override this on a per-model basis by passing in a ``:message`` key with the validation:
+
+```ruby
+validates :zipcode, zipcode: { message: 'Your per-model 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.
+
+### Test data
+
+In order to generate test data, we suggest using the [regexp-examples gem](https://github.com/tom-lord/regexp-examples)
+This dependency will allow you to create examples as follows:
+
+```ruby
+require "regexp-examples"
+
+ValidatesZipcode::CldrRegexpCollection::ZIPCODES_REGEX[:ES].examples
+
+# => ["00000", "00001", "00002", "00003", ..., "44443", "44444"]
+
+ValidatesZipcode::CldrRegexpCollection::ZIPCODES_REGEX[:ES].random_example
+
+# => "27072"
+```
 
 ## 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.5.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