valvat 0.0.3 → 0.1.0

data/CHANGES.md

@@ -1,10 +1,20 @@
 ### dev
 
-[full changelog](http://github.com/yolk/valvat/compare/v0.0.2...0.0.3)
+[full changelog](http://github.com/yolk/valvat/compare/v0.1.0...master)
+
+### 0.1.0 / 2011-01-07
+
+[full changelog](http://github.com/yolk/valvat/compare/v0.0.3...v0.1.0)
+
+* ActiveModel validation: added optional lookup support
+* ActiveModel validation: I18n support with country specific messages
+* ActiveModel validation: I18n locales in english and german
+* Fixed bug with wrong iso country code on greek vat number (EL != GR)
+* Valvat::Util.split only returns countries from europe
 
 ### 0.0.3 / 2011-01-06
 
-[full changelog](http://github.com/yolk/valvat/compare/v0.0.1...v0.0.2)
+[full changelog](http://github.com/yolk/valvat/compare/v0.0.2...v0.0.3)
 
 * Basic support for ActiveModel validation
 

data/lib/locale/de.yml

@@ -0,0 +1,34 @@
+de:
+  errors:
+    messages:
+      invalid_vat: ist kein gültige %{country_adjective} UStId-Nr.
+  valvat:
+    country_adjectives:
+      eu: europäische
+      at: österreichische
+      be: belgische
+      bg: bulgarische
+      cy: zypriotische
+      cz: tschechische
+      de: deutsche
+      dk: dänische
+      ee: estnisch
+      es: spanisch
+      fi: finnische
+      fr: französische
+      gb: britische
+      gr: griechische
+      hu: ungarische
+      ie: irische
+      it: italienische
+      lt: litauisch
+      lu: luxemburgisch
+      lv: lettische
+      mt: malteser
+      nl: niederländische
+      pl: polnische
+      pt: portugiesische
+      ro: rumänische
+      se: schwedische
+      si: slowenische
+      sk: slowakische

data/lib/locale/en.yml

@@ -0,0 +1,34 @@
+en:
+  errors:
+    messages:
+      invalid_vat: is not a valid %{country_adjective} vat number
+  valvat:
+    country_adjectives:
+      eu: european
+      at: austrian
+      be: belgian
+      bg: bulgarian
+      cy: cypriot
+      cz: czech
+      de: german
+      dk: danish
+      ee: estonian
+      es: spanish
+      fi: finnish
+      fr: french
+      gb: british
+      gr: greek
+      hu: hungarian
+      ie: irish
+      it: italian
+      lt: lithuanian
+      lu: luxembourg
+      lv: latvian
+      mt: maltese
+      nl: dutch
+      pl: polish
+      pt: portuguese
+      ro: rumanian
+      se: swedish
+      si: slovenian
+      sk: slovakian

data/lib/valvat/active_model.rb

@@ -1,7 +1,31 @@
-class ValvatValidator < ::ActiveModel::EachValidator
-  def validate_each(record, attribute, value)
-    unless Valvat::Syntax.validate(value)
-      record.errors.add(attribute, options[:message])
+require 'active_model'
+require 'valvat/syntax'
+require 'valvat/lookup'
+
+module ActiveModel
+  module Validations
+    class ValvatValidator < ::ActiveModel::EachValidator
+      
+      def validate_each(record, attribute, value)
+        is_valid = Valvat::Syntax.validate(value)
+        
+        if is_valid && options[:lookup]
+          is_valid = Valvat::Lookup.validate(value)
+          is_valid.nil? && is_valid = (options[:lookup] != :fail_if_down)
+        end
+        
+        unless is_valid
+          record.errors.add(attribute, :invalid_vat, 
+            :message => options[:message], 
+            :country_adjective => I18n.t(
+              :"valvat.country_adjectives.#{(Valvat::Utils.split(value)[0] || "eu").downcase}", 
+              :default => [:"valvat.country_adjectives.eu", "european"]
+            )
+          )
+        end
+      end
     end
   end
-end
+end
+
+I18n.load_path << File.dirname(__FILE__) + '/../locale/en.yml'

data/lib/valvat/syntax.rb

@@ -1,8 +1,6 @@
 require 'valvat/utils'
 
 module Valvat
-  class InvalidSyntax < StandardError;end
-  
   module Syntax
     
     VAT_PATTERNS = {
@@ -14,7 +12,7 @@ module Valvat
         'DE' => /\ADE[0-9]{9}\Z/,                                           # Germany
         'DK' => /\ADK[0-9]{8}\Z/,                                           # Denmark
         'EE' => /\AEE[0-9]{9}\Z/,                                           # Estonia
-        'EL' => /\AEL[0-9]{9}\Z/,                                           # Greece
+        'GR' => /\AEL[0-9]{9}\Z/,                                           # Greece
         'ES' => /\AES([A-Z][0-9]{8}|[0-9]{8}[A-Z]|[A-Z][0-9]{7}[A-Z])\Z/,   # Spain
         'FI' => /\AFI[0-9]{8}\Z/,                                           # Finland
         'FR' => /\AFR[A-Z0-9]{2}[0-9]{9}\Z/,                                # France
@@ -39,10 +37,6 @@ module Valvat
       pattern = VAT_PATTERNS[Valvat::Utils.split(vat)[0]]
       !!(pattern && pattern =~ vat)
     end
-  
-    def self.validate!(vat)
-      validate(vat) || raise(Valvat::InvalidSyntax.new("#{vat.inspect} is an invalid vat number!"))
-    end
   end
 
 end

data/lib/valvat/utils.rb

@@ -1,11 +1,15 @@
 module Valvat
   module Utils
     
+    EU_COUNTRIES = %w(AT BE BG CY CZ DE DK EE ES FI FR GB GR HU IE IT LT LU LV MT NL PL PT RO SE SI SK)
     COUNTRY_PATTERN = /\A([A-Z]{2})(.+)\Z/
     
     def self.split(vat)
       COUNTRY_PATTERN =~ vat 
-      [$1, $2]
+      result = [$1, $2]
+      result[0] = "GR" if result[0] == "EL"
+      return [nil, nil] unless EU_COUNTRIES.include?(result[0])
+      result
     end
     
     def self.normalize(vat)

data/lib/valvat/version.rb

@@ -1,3 +1,3 @@
 module Valvat
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/valvat/active_model_spec.rb

@@ -4,6 +4,22 @@ class Invoice < ModelBase
   validates :vat_number, :valvat => true
 end
 
+class InvoiceWithLookup < ModelBase  
+  validates :vat_number, :valvat => {:lookup => true}
+end
+
+class InvoiceWithLookupAndFailIfDown < ModelBase  
+  validates :vat_number, :valvat => {:lookup => :fail_if_down}
+end
+
+class InvoiceAllowBlank < ModelBase  
+  validates :vat_number, :valvat => {:allow_blank => true}
+end
+
+class InvoiceAllowBlankOnAll < ModelBase  
+  validates :vat_number, :valvat => true, :allow_blank => true
+end
+
 describe Invoice do
   context "with valid vat number" do
     before do
@@ -11,7 +27,7 @@ describe Invoice do
     end
     
     it "should be valid" do
-      Invoice.new(:vat_number => "DE345889003").should be_valid
+      Invoice.new(:vat_number => "DE123").should be_valid
     end
   end
   
@@ -20,8 +36,125 @@ describe Invoice do
       Valvat::Syntax.stub(:validate => false)
     end
     
+    it "should not be valid" do
+      Invoice.new(:vat_number => "DE123").should_not be_valid
+    end
+    
+    it "should add default (country specific) error message" do
+      i = Invoice.new(:vat_number => "DE123")
+      i.valid?
+      i.errors[:vat_number].should eql(["is not a valid german vat number"])
+    end
+    
+    context "with i18n translation in place" do
+      before do
+        I18n.backend.store_translations(:en, :activemodel => {
+          :errors => {:models => {:invoice => {:invalid_vat => "is ugly."}}}
+        })
+      end
+      
+      after { I18n.reload! }
+      
+      it "should use translation" do
+        i = Invoice.new(:vat_number => "DE123")
+        i.valid?
+        i.errors[:vat_number].should eql(["is ugly."])
+      end
+    end
+    
+    context "with i18n translation with country adjective placeholder in place" do
+      before do
+        I18n.backend.store_translations(:en, :activemodel => {
+          :errors => {:models => {:invoice => {:invalid_vat => "is not a %{country_adjective} vat"}}}
+        })
+      end
+
+      after { I18n.reload! }
+
+      it "should replace country adjective placeholder" do
+        i = Invoice.new(:vat_number => "IE123")
+        i.valid?
+        i.errors[:vat_number].should eql(["is not a irish vat"])
+      end
+
+      it "should fall back to 'european' if country is missing" do
+        i = Invoice.new(:vat_number => "XX123")
+        i.valid?
+        i.errors[:vat_number].should eql(["is not a european vat"])
+      end
+    end
+  end
+  
+  context "with blank vat number" do
+    it "should not be valid" do
+      Invoice.new(:vat_number => "").should_not be_valid
+      Invoice.new(:vat_number => nil).should_not be_valid
+    end
+  end
+end
+
+describe InvoiceWithLookup do
+  context "with valid but not existing vat number" do
+    before do
+      Valvat::Syntax.stub(:validate => true)
+      Valvat::Lookup.stub(:validate => false)
+    end
+    
+    it "should not be valid" do
+      InvoiceWithLookup.new(:vat_number => "DE123").should_not be_valid
+    end
+  end
+  
+  context "with valid and existing vat number" do
+    before do
+      Valvat::Syntax.stub(:validate => true)
+      Valvat::Lookup.stub(:validate => true)
+    end
+    
+    it "should be valid" do
+      InvoiceWithLookup.new(:vat_number => "DE123").should be_valid
+    end
+  end
+  
+  context "with valid vat number and VIES country service down" do
+    before do
+      Valvat::Syntax.stub(:validate => true)
+      Valvat::Lookup.stub(:validate => nil)
+    end
+    
+    it "should be valid" do
+      InvoiceWithLookup.new(:vat_number => "DE123").should be_valid
+    end
+  end
+end
+
+describe InvoiceWithLookupAndFailIfDown do
+  context "with valid vat number and VIES country service down" do
+    before do
+      Valvat::Syntax.stub(:validate => true)
+      Valvat::Lookup.stub(:validate => nil)
+    end
+    
+    it "should not be valid" do
+      InvoiceWithLookupAndFailIfDown.new(:vat_number => "DE123").should_not be_valid
+    end
+  end
+end
+
+describe InvoiceAllowBlank do
+  context "with blank vat number" do
+    it "should be valid" do
+      InvoiceAllowBlank.new(:vat_number => "").should be_valid
+      InvoiceAllowBlank.new(:vat_number => nil).should be_valid
+    end
+  end
+end
+
+describe InvoiceAllowBlankOnAll do
+  context "with blank vat number" do
     it "should be valid" do
-      Invoice.new(:vat_number => "DE345889003").should_not be_valid
+      InvoiceAllowBlankOnAll.new(:vat_number => "").should be_valid
+      InvoiceAllowBlankOnAll.new(:vat_number => nil).should be_valid
     end
   end
 end

data/spec/valvat/syntax_spec.rb

@@ -267,14 +267,4 @@ describe Valvat::Syntax do
       Valvat::Syntax.validate("BEFR").should eql(false)
     end
   end
-
-  context "#validate!" do
-    it "returns true on valid vat number" do
-      Valvat::Syntax.validate!("DE345889003").should eql(true)
-    end
-    
-    it "raises Valvat::InvalidSyntax on invalid vat number" do
-      lambda { Valvat::Syntax.validate!("DE34588900") }.should raise_error(Valvat::InvalidSyntax)
-    end
-  end
 end

data/spec/valvat/utils_spec.rb

@@ -4,7 +4,12 @@ describe Valvat::Utils do
   context "#split" do
     it "returns country and rest on vat number as array" do
       Valvat::Utils.split("DE345889003").should eql(["DE", "345889003"])
-      Valvat::Utils.split("XY345889003").should eql(["XY", "345889003"])
+      Valvat::Utils.split("ESX4588900X").should eql(["ES", "X4588900X"])
+    end
+    
+    it "returns two nils on non-european iso codes as array" do
+      Valvat::Utils.split("US345889003").should eql([nil, nil])
+      Valvat::Utils.split("RUX4588900X").should eql([nil, nil])
     end
     
     it "returns two nils on non-sense input as array" do
@@ -14,6 +19,10 @@ describe Valvat::Utils do
       Valvat::Utils.split("1234").should eql([nil, nil])
       Valvat::Utils.split(" ").should eql([nil, nil])
     end
+    
+    it "returns GR on greek vat" do
+      Valvat::Utils.split("EL999999999").should eql(["GR", "999999999"])
+    end
   end
   
   context "#normalize" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Sebastian Munz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 +01:00
+date: 2011-01-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -109,6 +109,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/locale/de.yml
+- lib/locale/en.yml
 - lib/valvat.rb
 - lib/valvat/active_model.rb
 - lib/valvat/lookup.rb