valvat 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c35eea0081e4df97219ee215ea3321c8add02bc130c5b28488f1dca676765dc
-  data.tar.gz: 4ba7b89f223d26d1ac9d967944d6c2e0dbea74c3c6066f1d69d0e2f42ba204c8
+  metadata.gz: ddc578b98f0c869566769b5588b5768bbdcc5ba4901ab97227c7908502a7b5c9
+  data.tar.gz: f7bfc69d3cd2983bb3d306d0932ef6d436890850bc67f6c63e639d2c666dc1ac
 SHA512:
-  metadata.gz: ab9623bd1d680546ca7978751b6536b626d2d5cb9ae35240b5152d4e7c9512e99e025481bf0a844254e6ad14d3f1f320dbf54ab6901387e354b7682c45cb3c3c
-  data.tar.gz: 79a69d5d148b86282f609d66bf053a1b14d4bd86621d7277a5f17d1d1df6c6fd5c9731cff4eca8c8bb9dde9f1265eef7ea03c60d2d66876b0f255d97a9596a6b
+  metadata.gz: 910d4c387c6e82adeee3146b54e928b253fcd4aae6873ae438a575612b72a136459d50411c565ba47683b1b8f325f90771774add2b7110b1c4a6c4e880ba0999
+  data.tar.gz: a93a4d12a53fe3601525a153c6f2ae042259371f1775c05fb27ada151e91f3ff0325f794332797eb31ff502606dd31edee502d910866e8c76feeb6613cb3b95e

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+name: Specs
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - 'README.md'
+      - 'CHANGES.md'
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', 'jruby-head']
+        gemfile: [ 'standalone', 'activemodel-5', 'activemodel-6' ]
+        exclude:
+          - ruby-version: '3.0'
+            gemfile: 'activemodel-5'
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run specs
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -6,3 +6,4 @@ gemfiles/*.lock
 tmp
 .rbenv-*
 .ruby-version
+.ruby-gemset

data/.rubocop.yml

@@ -0,0 +1,15 @@
+require: rubocop-rspec
+AllCops:
+    NewCops: enable
+    TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Exclude:
+    - valvat.gemspec
+    - spec/**/*_spec.rb
+
+Style/Documentation:
+    Enabled: false
+
+RSpec/MultipleExpectations:
+    Enabled: false

data/CHANGES.md

@@ -1,7 +1,15 @@
 
 ### dev
 
-[full changelog](http://github.com/yolk/valvat/compare/v1.0.1...master)
+[full changelog](http://github.com/yolk/valvat/compare/v1.1.0...master)
+
+### 1.1.0 / 2021-01-15
+
+[full changelog](http://github.com/yolk/valvat/compare/v1.0.1...v1.1.0)
+
+* Added support for Northern Ireland XI prefixed VAT numbers (by [Avatar Ignacy Kasperowicz](https://github.com/kspe))
+* ActiveModel: Return specific error message if VIES is down and fail_if_down is set to true (by [Arkadiy Zabazhanov](https://github.com/pyromaniac))
+* Removed support for EOL rubies (all before 2.5) and ActiveModel before 5.0
 
 ### 1.0.1 / 2020-12-06
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in valvat.gemspec

data/Guardfile

@@ -1,5 +1,7 @@
-guard :rspec, cmd: "bundle exec rspec --color" do
-  watch(/^spec\/(.*)_spec.rb/)
-  watch(/^lib\/(.*)\.rb/)          { |m| "spec/#{m[1]}_spec.rb" }
-  watch(/^spec\/spec_helper.rb/)   { "spec" }
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec --color' do
+  watch(%r{^spec/(.*)_spec.rb})
+  watch(%r{^lib/(.*)\.rb})          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper.rb})   { 'spec' }
 end

data/README.md

@@ -1,7 +1,7 @@
 valvat
 ===========
 
-[![Gem Version](https://badge.fury.io/rb/valvat.svg)](http://badge.fury.io/rb/valvat) [![Build Status](https://travis-ci.org/yolk/valvat.svg)](https://travis-ci.org/yolk/valvat) [![Code Climate](https://codeclimate.com/github/yolk/valvat.svg)](https://codeclimate.com/github/yolk/valvat)
+[![rubygems](https://badgen.net/rubygems/v/valvat)](https://rubygems.org/gems/valvat) [![Specs](https://github.com/yolk/valvat/workflows/Specs/badge.svg)](https://github.com/yolk/valvat/actions?query=workflow%3ASpecs)
 
 Validates european vat numbers. Standalone or as a ActiveModel validator.
 
@@ -9,6 +9,8 @@ Validates european vat numbers. Standalone or as a ActiveModel validator.
 
 Valvat supports validating VAT-IDs from the UK by syntax & checksum for now. Validation against the VIES web service will probably stop working (and return `false`) in 2021.
 
+Northern Ireland received its own VAT number prefix - XI which is supported by VIES web service so any XI-prefixed VAT numbers should be validated as any EU VAT number.
+
 ## Features
 
 * Simple syntax verification
@@ -18,7 +20,7 @@ Valvat supports validating VAT-IDs from the UK by syntax & checksum for now. Val
 * I18n locales for language specific error messages in English, German, French, Spanish, Italian, Portuguese, Polish, Swedish, Dutch, Danish, Czech, Slovakian, Hungarian, Bulgarian, Romanian, Latvian, Catalan, Norwegian, and Finnish.
 * *Experimental* checksum verification
 
-valvat is tested and works with ruby MRI 1.9.3/2.0/2.1/2.2/2.3/2.4/2.5/2.6/2.7, jruby (including 1.9 mode) and ActiveModel 3/4/5/6
+valvat is tested and works with ruby MRI 2.5/2.6/2.7/3.0, jruby-head and ActiveModel 5/6. If you need support for ruby down to 1.9.3 and ActiveModel 3 and 4 use [v1.0.1](https://github.com/yolk/valvat/tree/v1.0.1).
 
 ## Installation
 
@@ -26,7 +28,7 @@ Add it to your Gemfile:
 
     gem 'valvat'
 
-To use less memory (~3.5 mb vs. ~0.5 mb) and load only the local verification functionality – and not the remote lookup with VIES – add it like this instead:
+To use less memory (~0.5 mb vs. ~3.5 mb) and load only the local verification functionality – and not the remote lookup with VIES – add it like this instead:
 
     gem 'valvat', require: 'valvat/local'
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
@@ -5,4 +7,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/gemfiles/activemodel-5

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem "activemodel", "~> 5.2.0"
+gem "activemodel", "~> 5.0"
 
 gem 'rack'
 

data/gemfiles/activemodel-6

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem "activemodel", "~> 6.0.0"
+gem "activemodel", "~> 6.0"
 
 gem 'rack'
 

data/lib/active_model/validations/valvat_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'valvat/syntax'
 require 'valvat/lookup'
@@ -6,16 +8,7 @@ module ActiveModel
   module Validations
     class ValvatValidator < EachValidator
       def initialize(options)
-        if options[:lookup]
-          options[:lookup] = if options[:lookup] == :fail_if_down
-            {fail_if_down: true}
-          elsif options[:lookup].is_a?(Hash)
-            options[:lookup]
-          else
-            {}
-          end
-        end
-
+        normalize_options(options)
         super
       end
 
@@ -23,44 +16,84 @@ module ActiveModel
         vat = Valvat(value)
         iso_country_code = vat.iso_country_code
 
-        if country_does_not_match?(record, iso_country_code)
-          iso_country_code = iso_country_code_of(record)
-        elsif vat.valid? && valid_checksum?(vat) && vat_exists?(vat)
-          return
-        end
+        is_valid = if country_does_not_match?(record, iso_country_code)
+                     iso_country_code = iso_country_code_of(record)
+                     false
+                   else
+                     vat_valid?(vat)
+                   end
 
-        iso_country_code = "eu" if iso_country_code.blank?
-        record.errors.add(attribute, :invalid_vat,
-          message: options[:message],
-          country_adjective: I18n.t(
-            :"valvat.country_adjectives.#{iso_country_code.downcase}",
-            default: [:"valvat.country_adjectives.eu", "european"]
-          )
-        )
+        iso_country_code = 'eu' if iso_country_code.blank?
+
+        add_error(is_valid, record, attribute, iso_country_code)
       end
 
       private
 
+      def vat_valid?(vat)
+        vat.valid? && valid_checksum?(vat) && vat_exists?(vat)
+      end
+
+      def valid_checksum?(vat)
+        return true unless options[:checksum]
+
+        vat.valid_checksum?
+      end
+
+      def vat_exists?(vat)
+        return true unless options[:lookup]
+
+        exists = vat.exists?(options[:lookup])
+
+        return true if exists.nil? && !options[:lookup][:fail_if_down]
+
+        exists
+      end
+
       def country_does_not_match?(record, iso_country_code)
         return false unless options[:match_country]
+
         iso_country_code_of(record) != iso_country_code
       end
 
       def iso_country_code_of(record)
-        (record.send(options[:match_country]) || "").upcase
+        (record.send(options[:match_country]) || '').upcase
       end
 
-      def valid_checksum?(vat)
-        return true unless options[:checksum]
-        vat.valid_checksum?
+      def add_error(is_valid, record, attribute, iso_country_code)
+        case is_valid
+        when false
+          add_invalid_vat_error(record, attribute, iso_country_code)
+        when nil
+          add_vies_down_error(record, attribute)
+        end
       end
 
-      def vat_exists?(vat)
-        return true unless options[:lookup]
+      def add_invalid_vat_error(record, attribute, iso_country_code)
+        record.errors.add(attribute, :invalid_vat,
+                          message: options[:message],
+                          country_adjective: I18n.t(
+                            :"valvat.country_adjectives.#{iso_country_code.downcase}",
+                            default: [:"valvat.country_adjectives.eu", 'european']
+                          ))
+      end
+
+      def add_vies_down_error(record, attribute)
+        record.errors.add(attribute, :vies_down,
+                          message: options[:vies_down_message])
+      end
+
+      def normalize_options(options)
+        return unless options[:lookup]
 
-        is_valid = vat.exists?(options[:lookup])
-        return is_valid unless is_valid.nil?
-        !options[:lookup][:fail_if_down]
+        options[:lookup] = case options[:lookup]
+                           when :fail_if_down
+                             { fail_if_down: true }
+                           when Hash
+                             options[:lookup]
+                           else
+                             {}
+                           end
       end
     end
   end

data/lib/valvat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'valvat/error'
 require 'valvat/local'
 require 'valvat/lookup'
@@ -7,8 +9,8 @@ require 'valvat/lookup/fault'
 require 'active_model/validations/valvat_validator' if defined?(ActiveModel)
 
 class Valvat
-  def exists?(options={})
+  def exists?(options = {})
     Valvat::Lookup.validate(self, options)
   end
-  alias_method :exist?, :exists?
+  alias exist? exists?
 end

data/lib/valvat/checksum.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
-    ALGORITHMS = {}
+    ALGORITHMS = {} # rubocop:disable Style/MutableConstant
 
     def self.validate(vat)
       vat = Valvat(vat)
@@ -11,11 +13,12 @@ class Valvat
     class Base
       def self.inherited(klass)
         ALGORITHMS[klass.name.split(/::/).last] = klass
+        super
       end
 
       attr_reader :vat
 
-      def self.check_digit_length(len=nil)
+      def self.check_digit_length(len = nil)
         @check_digit_length = len if len
         @check_digit_length || 1
       end
@@ -39,37 +42,35 @@ class Valvat
       end
 
       def figures_str
-        str_wo_country[0..-(self.class.check_digit_length+1)]
+        str_wo_country[0..-(self.class.check_digit_length + 1)]
       end
 
       def figures
-        figures_str.split("").map(&:to_i)
+        figures_str.split('').map(&:to_i)
       end
 
       def str_wo_country
         vat.to_s_wo_country
       end
 
-      def sum_figures_by
-        figures.reverse.each_with_index.map do |fig, i|
-          yield(fig, i)
-        end.inject(:+)
+      def sum_figures_by(&block)
+        figures.reverse.each_with_index.map(&block).inject(:+)
       end
 
       def sum_of_squares(num)
-        num.to_s.split("").map(&:to_i).inject(:+)
+        num.to_s.split('').map(&:to_i).inject(:+)
       end
 
-      def sum_of_figures_for_at_es_it_se(reverse_ints=false)
+      def sum_of_figures_for_at_es_it_se(reverse_ints: false)
         ints = reverse_ints ? [2, 1] : [1, 2]
         sum_figures_by do |fig, i|
-          sum_of_squares(fig*(i.modulo(2) == 0 ? ints[0] : ints[1]))
+          sum_of_squares(fig * (i.modulo(2).zero? ? ints[0] : ints[1]))
         end
       end
 
       def sum_of_figues_for_pt_si
         11 - sum_figures_by do |fig, i|
-          fig*(i+2)
+          fig * (i + 2)
         end.modulo(11)
       end
     end
@@ -79,4 +80,4 @@ end
 Dir[File.join(File.dirname(__FILE__), 'checksum', '*.rb')].each do |path|
   # On Ruby 2.1.0 ActiveSupport goes mad if you pass it paths with .rb at the end
   require path.gsub(/\.rb$/, '')
-end
+end

data/lib/valvat/checksum/at.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class AT < Base
@@ -11,4 +13,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/be.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class BE < Base
@@ -8,4 +10,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/bg.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class BG < Base
@@ -9,6 +11,7 @@ class Valvat
         local_person_chk = check_digit_local_natural_person
 
         return local_person_chk if given_check_digit == local_person_chk
+
         check_digit_foreign_natural_person
       end
 
@@ -19,43 +22,40 @@ class Valvat
         end.inject(:+).modulo(11)
 
         return chk if chk < 10
-        return 0
+
+        0
       end
 
       def check_digit_foreign_natural_person
         weight = [21, 19, 17, 13, 11, 9, 7, 3, 1]
 
-        chk = figures.map do |fig|
+        figures.map do |fig|
           fig * weight.shift
         end.inject(:+).modulo(10)
-
-        chk
       end
 
       def check_digit_legal_person
-        prod = 0
-        figures.each_with_index do |fig, index|
-          prod += (index + 1) * fig.to_i
-        end
-
-        chk = prod % 11
+        chk = build_prod % 11
 
         if chk == 10
-          prod = 0
-          figures.each_with_index do |fig, index|
-            prod += (index + 3) * fig.to_i
-          end
-
-          chk = prod % 11
+          chk = build_prod(3) % 11
           chk = 0 if chk == 10
         end
 
         chk
       end
 
+      def build_prod(add = 1)
+        prod = 0
+        figures.each_with_index do |fig, index|
+          prod += (index + add) * fig.to_i
+        end
+        prod
+      end
+
       def natural_person?
         vat.to_s_wo_country.length == 10
       end
     end
   end
-end
+end