rails_validations 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 101607105b5fc99a8762be3fc19f1b98c5195706
-  data.tar.gz: d0486ef2ac9c0577b8d79c95c1370a0f7d5ce46d
+  metadata.gz: 951d63d5356bcdf895cef31ec5726e049079bc7a
+  data.tar.gz: bbfbf7c0b5e64858ad78723f1990d205aa40918b
 SHA512:
-  metadata.gz: 1bbb66d567952305ba3d4832e18d7c5d15cc300d09cda5e519b6bda959cb83052e61fbc0771fb64d288ccd16ebe5908e667bce8f660aa3fc0866775ba8063473
-  data.tar.gz: 7fa7a7624e58f7cd31e2e8543c1bc003d9ed9ca1efe972ba303fad0c67caac0517a88738d4a4c0eb55ac9067d37459ef39c097aeed06d72298da67e4590ebbd9
+  metadata.gz: 563d7dfa6e1f2cc9035a7c3b761f8b86a08f452b63ccc8725442f7d6abd7c60a4dc5ca28ff4f5ca2abacbf488fb0098bdae3b1bc42e41c1d6627a6f232e06449
+  data.tar.gz: 09f588a7881780926db041f19f4e8edce501cc1c8d12cc878f06f7bcb087f620a5502820d6eb0734c2440a1590994f85ccf63683ddeb63502cea17c4c4110330

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Martin Tournoij
+Copyright © 2014-2015 LICO Innovations
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -6,16 +6,23 @@
 
 A few extra validations for Ruby on Rails.
 
-We try to do the ‘sane’ thing by not being too strict, when in doubt, we accept
+We try to do the sane thing by not being too strict, when in doubt, we accept
 input as being valid. We never want to reject valid input as invalid.
 
 For many formats doing a 100% foolproof check is not trivial, email addresses
 are a famous example, but it also applies to other formats.  
 Regardless, you can never be sure it’s what the user *intended* anyway. For
 example, email validators will accept `artin@ico.nl` as being ‘valid’, even
-though my email address is `martin@lico.nl.`.  
+though my email address is `martin@lico.nl`.  
 
 
+I18N
+====
+The gem includes English and Dutch error messages. If you want to translate it
+to another language then copy [`config/locales/en.yml`][tr] to your project.
+Please send us your translations so we can add them!
+
+[tr]: https://github.com/bluerail/rails_validations/blob/master/config/locales/en.yml
 
 
 Available validations
@@ -109,8 +116,39 @@ Currently implemented countries:
 - `nl` - The Netherlands
 
 
+commerce\_number
+---------------
+Check if this is a valid chamber of commerce identification number.
+
+    validates :commerce_number_column, commerce_number: { country: :nl }
+
+Currently implemented countries:
+
+- `nl` - The Netherlands
+
+
+vat\_number
+-----------
+Check if this is a valid [VAT identification number](https://en.wikipedia.org/wiki/VAT_identification_number)
+
+    validates :vat_number_column, vat_number: { country: :nl }
+
+Currently implemented countries:
+
+- `nl` - The Netherlands
+
+
 ChangeLog
 =========
+
+Version 1.3, 2015-05-22
+-----------------------
+- Add `commerce_number` validation.
+- Add `vat_number` validation.
+- The `postal_code` validation will now raise an error if an invalid country
+  code is given.
+
+
 Version 1.2, 2015-03-07
 -----------------------
 - The IBAN check will now defaults to just a "is invalid" message, set the

data/config/locales/en.yml

@@ -27,3 +27,9 @@ en:
       invalid: not a valid domain
       max_domain_parts: only %{max} domain parts are allowed
       min_domain_parts: needs to have at least %{min} domain parts
+
+    vat_number:
+      invalid: not a valid VAT identification number
+
+    commerce_number:
+      invalid: not a valid chamber of commerce number

data/config/locales/nl.yml

@@ -27,3 +27,9 @@ nl:
       invalid: geen geldig domain
       max_domain_parts: er zijn %{max} domeinstukken toegestaan
       min_domain_parts: er moeten minimaal %{min} domeinstukken zijn
+
+    vat_number:
+      invalid: geen geldig BTW nummer
+
+    commerce_number:
+      invalid: geen geldig KvK nummer

data/lib/rails_validations.rb

@@ -1,10 +1,11 @@
+require 'validators/commerce_number_validator'
 require 'validators/date_validator'
 require 'validators/domain_validator'
 require 'validators/email_validator'
 require 'validators/iban_validator'
 require 'validators/phone_validator'
 require 'validators/postal_code_validator'
-#require 'validators/presence_of_validator'
+require 'validators/vat_number_validator'
 
 I18n.load_path += Dir["#{File.dirname(__FILE__)}/../config/locales/*.yml"]
 

data/lib/validators/check_digit_validator.rb

@@ -0,0 +1,18 @@
+# Check digit for BSN, but see if we can make this more generic
+#class ElevenProofValidator < ActiveModel::EachValidator
+#  # The eleven-proof of a BSN is as follows:
+#  # Given: BSN presented as ABCDEFGHI with length is 9:
+#  # 9xA+8xB+7xC+6xD+5xE+4xF+3xG+2xH-1xI (caveat: the minus!)
+#
+#  def validate_each(record, attribute, value)
+#    return if value.to_s.empty?
+#
+#    total = 0
+#    if value.to_s.length == 9
+#      8.times { |x| total += value[x].to_i * (9-x) }
+#      total -= value[8].to_i
+#    end
+#
+#    record.errors.add(attribute, I18n.t('errors.messages.eleven_proof_error')) if total.modulo(11)!=0 || value.length != 9
+#  end
+#end

data/lib/validators/commerce_number_validator.rb

@@ -0,0 +1,28 @@
+# Chamber of commerce number
+class CommerceNumberValidator < ActiveModel::EachValidator
+  # keys are ISO-3366-1 alpha2
+  REGEXP = {
+    # KvK nummer; 8 digits. Allow space, -, and . for formatting
+    nl: -> (v) { v.gsub(/[.\- ]/, '') =~ /\A\d{8}\z/ },
+  }.freeze
+
+
+  def validate_each record, attribute, value 
+    key = (options[:country] || I18n.locale).downcase.to_sym
+    key = :gb if key == :uk  # Since it's easy to get this wrong
+    raise ArgumentError, "There is no validation for the country `#{key}'" if REGEXP[key].nil?
+
+    value = value.to_s
+
+    valid = true
+    if REGEXP[key].respond_to? :call
+      valid = false unless REGEXP[key].call value
+    elsif value !=~ REGEXP[key]
+      valid = false
+    end
+
+    if !valid
+      record.errors.add attribute, (options[:message] || I18n.t('rails_validations.commerce_number.invalid'))
+    end
+  end
+end

data/lib/validators/postal_code_validator.rb

@@ -8,6 +8,7 @@ class PostalCodeValidator < ActiveModel::EachValidator
   def validate_each record, attribute, value 
     key = (options[:country] || I18n.locale).downcase.to_sym
     key = :gb if key == :uk  # Since it's easy to get this wrong
+    raise ArgumentError, "There is no validation for the country `#{key}'" if REGEXP[key].nil?
 
     record.errors.add attribute, (options[:message] || I18n.t('rails_validations.postal_code.invalid')) unless value =~ REGEXP[key]
   end

data/lib/validators/vat_number_validator.rb

@@ -0,0 +1,32 @@
+# https://en.wikipedia.org/wiki/VAT_identification_number
+# http://ec.europa.eu/taxation_customs/vies/faqvies.do#item_7
+class VatNumberValidator < ActiveModel::EachValidator
+  # keys are ISO-3366-1 alpha2
+  REGEXP = {
+    # 'NL' + 9 digits + B + 2-digit company index – e.g. NL999999999B99
+    # Allow space, -, and . for formatting
+    # TODO: I think this also has a check digit?
+    nl: -> (v) { v.upcase.gsub(/[.\- ]/, '') =~ /\ANL\d{9}B\d{2}\z/ },
+  }.freeze
+
+
+  def validate_each record, attribute, value 
+    key = (options[:country] || I18n.locale).downcase.to_sym
+    key = :gb if key == :uk  # Since it's easy to get this wrong
+    raise ArgumentError, "There is no validation for the country `#{key}'" if REGEXP[key].nil?
+
+    value = value.to_s
+
+    valid = true
+    if REGEXP[key].respond_to? :call
+      valid = false unless REGEXP[key].call value
+    elsif value !=~ REGEXP[key]
+      valid = false
+    end
+
+    if !valid
+      record.errors.add attribute, (options[:message] || I18n.t('rails_validations.vat_number.invalid'))
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -82,10 +82,19 @@ end
 
 shared_examples :validation do |validation|
   it 'accepts a custom error message' do
-    with_validation "#{validation}: { message: 'foobar' }" do
+    with_validation "#{validation}: { country: :nl, message: 'foobar' }" do
       m = described_class.new v: 'not even remotely valid'
       expect(m.valid?).to eq(false)
       expect(m.errors[:v].first).to eq('foobar')
     end
   end
 end
+
+
+shared_examples :country_code do |validation|
+  it 'raises an error on an invalid country' do
+    with_validation "#{validation}: { country: :not_a_country_code }" do
+      expect { described_class.new(v: 123).valid? }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/validations/commerce_number_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module ValidationsSpecHelper
+  class CommerceNumber < ValidationsSpecHelper::Record
+  end
+end
+
+describe ValidationsSpecHelper::CommerceNumber do
+  include ValidationsSpecHelper
+  
+  it_behaves_like :validation, 'commerce_number'
+  it_behaves_like :country_code, 'commerce_number'
+
+  it 'works for nl codes' do
+    with_validation 'commerce_number: { country: :nl }' do
+      [
+        12345678,
+        '12345678',
+        :'12345678',
+        '123 45-6.78',
+      ].each do |v|
+        expect(model(v)).to be_valid
+      end
+    end
+  end
+
+
+  it 'gives an error for nl codes' do
+    with_validation 'commerce_number: { country: :nl }' do
+      %w{
+        whoops
+        1234567
+        123456789
+      }.each do |v|
+        expect(model(v)).to be_invalid('commerce_number.invalid')
+      end
+    end
+  end
+end

data/spec/validations/postal_code_spec.rb

@@ -10,6 +10,7 @@ describe ValidationsSpecHelper::PostalCode do
   include ValidationsSpecHelper
 
   it_behaves_like :validation, 'postal_code'
+  it_behaves_like :country_code, 'postal_code'
 
   it 'works for nl codes' do
     with_validation 'postal_code: { country: :nl }' do

data/spec/validations/vat_number_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module ValidationsSpecHelper
+  class VatNumber < ValidationsSpecHelper::Record
+  end
+end
+
+describe ValidationsSpecHelper::VatNumber do
+  include ValidationsSpecHelper
+  
+  it_behaves_like :validation, 'vat_number'
+  it_behaves_like :country_code, 'vat_number'
+
+  it 'works for nl codes' do
+    with_validation 'vat_number: { country: :nl }' do
+      %w{
+        NL123456789B00
+        NL123456789B99
+        NL.00-00\ 01\ 34-0B.57
+        nl123456789b00
+      }.each do |v|
+        expect(model(v)).to be_valid
+      end
+    end
+  end
+
+
+  it 'gives an error for nl codes' do
+    with_validation 'vat_number: { country: :nl }' do
+      %w{
+        NL123456789A00
+        NL123456789B9
+        NL23456789B99
+        NL1234567890B99
+        NLL1234567890B99
+      }.each do |v|
+        expect(model(v)).to be_invalid('vat_number.invalid')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_validations
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Martin Tournoij
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -79,19 +79,24 @@ files:
 - config/locales/en.yml
 - config/locales/nl.yml
 - lib/rails_validations.rb
+- lib/validators/check_digit_validator.rb
+- lib/validators/commerce_number_validator.rb
 - lib/validators/date_validator.rb
 - lib/validators/domain_validator.rb
 - lib/validators/email_validator.rb
 - lib/validators/iban_validator.rb
 - lib/validators/phone_validator.rb
 - lib/validators/postal_code_validator.rb
+- lib/validators/vat_number_validator.rb
 - spec/spec_helper.rb
+- spec/validations/commerce_number_spec.rb
 - spec/validations/date_spec.rb
 - spec/validations/domain_spec.rb
 - spec/validations/email_spec.rb
 - spec/validations/iban_spec.rb
 - spec/validations/phone_spec.rb
 - spec/validations/postal_code_spec.rb
+- spec/validations/vat_number_spec.rb
 homepage: https://github.com/bluerail/rails_validations
 licenses:
 - MIT
@@ -124,3 +129,5 @@ test_files:
 - spec/validations/phone_spec.rb
 - spec/validations/postal_code_spec.rb
 - spec/validations/domain_spec.rb
+- spec/validations/commerce_number_spec.rb
+- spec/validations/vat_number_spec.rb