valvat 0.2.3 → 0.3.0

data/CHANGES.md

@@ -1,6 +1,12 @@
 ### dev
 
-[full changelog](http://github.com/yolk/valvat/compare/v0.2.3...master)
+[full changelog](http://github.com/yolk/valvat/compare/v0.3.0...master)
+
+### 0.3.0 / 2011-01-12
+
+[full changelog](http://github.com/yolk/valvat/compare/v0.2.3...v0.3.0)
+
+* ActiveModel validation: added _match_counrty_ option to validate if iso country code of vat number matches another attribute.
 
 ### 0.2.3 / 2011-01-10
 

data/README.md

@@ -1,8 +1,8 @@
-## valvat
+# valvat
 
 Validates european vat numbers. Standalone or as a ActiveModel validator.
 
-### Features
+## Features
 
 * Simple syntax verification
 * Lookup via the VIES web service
@@ -12,11 +12,11 @@ Validates european vat numbers. Standalone or as a ActiveModel validator.
 
 valvat is tested and works with ruby 1.8.7/1.9.2 and ActiveModel 3.0.
 
-### Installation
+## Installation
 
     gem install valvat
 
-### Basic Usage
+## Basic Usage
 
 To verify the syntax of a vat number:
 
@@ -42,19 +42,25 @@ Or to lookup a vat number string directly via VIES web service:
     Valvat::Lookup.validate("DE345789003")
     => true or false or nil
 
-### ActiveModel/Rails3 Usage
+## ActiveModel/Rails3 Usage
+
+### Loading
 
 When the valvat gem is required and ActiveModel is already loaded, everything will work fine out of the box. If your load order differs just add
 
     require 'valvat/active_model'
   
 after ActiveModel has been loaded.
+
+### Simple syntax validation
   
 To validate the attribute `vat_number` add this to your model:
 
     class MyModel < ActiveRecord::Base
       validates :vat_number, :valvat => true
     end
+
+### Additional lookup validation
   
 To additionally perform a lookup via VIES:
 
@@ -63,12 +69,24 @@ To additionally perform a lookup via VIES:
 By default this will validate to true if the VIES web service is down. To fail in this case simply add the `:fail_if_down` option:
 
     validates :vat_number, :valvat => {:lookup => :fail_if_down}
-  
+
+### Additional ISO country code validation
+
+If you want the vat number’s (ISO) country to match another country attribute, use the _match_country_ option: 
+
+    validates :vat_number, :valvat => {:match_country => :country}
+
+where it is supposed that your model has a method named _country_ which returns the country ISO code you want to match.
+
+### Allow blank
+
 By default blank vat numbers validate to false. To change this add the `:allow_blank` option:
 
     validates :vat_number, :valvat => {:allow_blank => true}
-    
-To allow vat numbers from outside of europe, add something like this to your model (country_code should return a upcase iso country code):
+
+### Allow vat numbers outside of europe
+  
+To allow vat numbers from outside of europe, add something like this to your model (country_code should return a upcase ISO country code):
 
     class MyModel < ActiveRecord::Base
       validates :vat_number, :valvat => true, :if => :eu?
@@ -77,8 +95,8 @@ To allow vat numbers from outside of europe, add something like this to your mod
         Valvat::Utils::EU_COUNTRIES.include?(country_code)
       end
     end
-
-### Utilities
+    
+## Utilities
 
 To split a vat number into the country code and the remaining chars:
 
@@ -90,9 +108,9 @@ or
     Valvat.new("ATU345789003").to_a
     => ["AT", "U345789003"]
   
-Both methods always return an array. If it can not detect the country or the given country is located outside of europe it returns `[nil, nil]`. Please note that this does not strictly return the iso country code: for greek vat numbers this returns the iso language code 'EL' instead of the iso country code 'GR'.
+Both methods always return an array. If it can not detect the country or the given country is located outside of europe it returns `[nil, nil]`. Please note that this does not strictly return the ISO country code: for greek vat numbers this returns the ISO language code 'EL' instead of the ISO country code 'GR'.
 
-To extract the iso country code of a given vat number:
+To extract the ISO country code of a given vat number:
 
     Valvat.new("EL7345789003").iso_country_code
     => "GR"
@@ -109,13 +127,13 @@ To normalize a vat number:
   
 This basically just removes trailing spaces and ensures all chars are uppercase.
 
-### Links
+## Links
 
 * [VIES web service](http://ec.europa.eu/taxation_customs/vies)
 * [European vat number formats (german)](http://bzst.de/DE/Steuern_International/USt_Identifikationsnummer/Merkblaetter/Aufbau_USt_IdNr.html)
 * [European vat number formats on Wikipedia](http://en.wikipedia.org/wiki/European_Union_Value_Added_Tax)
 
-### BlaBla
+## BlaBla
 
 Copyright (c) 2011 Yolk Sebastian Munz & Julia Soergel GbR
 

data/lib/valvat/active_model.rb

@@ -8,9 +8,15 @@ module ActiveModel
       
       def validate_each(record, attribute, value)
         vat = Valvat(value)
-        
         is_valid = options[:lookup] ? vat.valid? && vat.exists? : vat.valid?
-        is_valid.nil? && is_valid = (options[:lookup] != :fail_if_down)
+        
+        if is_valid.nil?
+          is_valid = options[:lookup] != :fail_if_down
+        end
+        
+        if is_valid && options[:match_country]
+          is_valid = (record.send(options[:match_country]) || "").upcase == vat.iso_country_code
+        end
         
         unless is_valid
           record.errors.add(attribute, :invalid_vat, 

data/lib/valvat/version.rb

@@ -1,3 +1,3 @@
 class Valvat
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/spec/valvat/active_model_spec.rb

@@ -20,30 +20,31 @@ class InvoiceAllowBlankOnAll < ModelBase
   validates :vat_number, :valvat => true, :allow_blank => true
 end
 
+class InvoiceCheckCountry < ModelBase  
+  validates :vat_number, :valvat => {:match_country => :country}
+  
+  def country
+    @attributes[:country]
+  end
+end
+
 describe Invoice do
   context "with valid vat number" do
-    before do
-      Valvat::Syntax.stub(:validate => true)
-    end
-    
     it "should be valid" do
-      Invoice.new(:vat_number => "DE123").should be_valid
+      Invoice.new(:vat_number => "DE259597697").should be_valid
     end
   end
   
   context "with invalid vat number" do
-    before do
-      Valvat::Syntax.stub(:validate => false)
-    end
+    let(:invoice) { Invoice.new(:vat_number => "DE259597697123") }
     
     it "should not be valid" do
-      Invoice.new(:vat_number => "DE123").should_not be_valid
+      invoice.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"])
+      invoice.valid?
+      invoice.errors[:vat_number].should eql(["is not a valid german vat number"])
     end
     
     context "with i18n translation in place" do
@@ -56,9 +57,8 @@ describe Invoice do
       after { I18n.reload! }
       
       it "should use translation" do
-        i = Invoice.new(:vat_number => "DE123")
-        i.valid?
-        i.errors[:vat_number].should eql(["is ugly."])
+        invoice.valid?
+        invoice.errors[:vat_number].should eql(["is ugly."])
       end
     end
     
@@ -72,15 +72,15 @@ describe Invoice do
       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"])
+        invoice = Invoice.new(:vat_number => "IE123")
+        invoice.valid?
+        invoice.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"])
+        invoice = Invoice.new(:vat_number => "XX123")
+        invoice.valid?
+        invoice.errors[:vat_number].should eql(["is not a european vat"])
       end
     end
   end
@@ -157,4 +157,29 @@ describe InvoiceAllowBlankOnAll do
       InvoiceAllowBlankOnAll.new(:vat_number => nil).should be_valid
     end
   end
+end
+
+describe InvoiceCheckCountry do
+  context "with blank vat number" do
+    it "should be not valid on blank country" do
+      InvoiceCheckCountry.new(:country => nil, :vat_number => "DE259597697").should_not be_valid
+      InvoiceCheckCountry.new(:country => "", :vat_number => "DE259597697").should_not be_valid
+    end
+    
+    it "should be not valid on wired country" do
+      InvoiceCheckCountry.new(:country => "XAXXX", :vat_number => "DE259597697").should_not be_valid
+      InvoiceCheckCountry.new(:country => "ZO", :vat_number => "DE259597697").should_not be_valid
+    end
+    
+    it "should be not valid on mismatching (eu) country" do
+      InvoiceCheckCountry.new(:country => "FR", :vat_number => "DE259597697").should_not be_valid
+      InvoiceCheckCountry.new(:country => "AT", :vat_number => "DE259597697").should_not be_valid
+      InvoiceCheckCountry.new(:country => "DE", :vat_number => "ATU65931334").should_not be_valid
+    end
+    
+    it "should be valid on matching country" do
+      InvoiceCheckCountry.new(:country => "DE", :vat_number => "DE259597697").should be_valid
+      InvoiceCheckCountry.new(:country => "AT", :vat_number => "ATU65931334").should be_valid
+    end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sebastian Munz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-10 00:00:00 +01:00
+date: 2011-01-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency