portuguese_validators 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb5e228a583342dcd6b0afdfe85cadc5508054f3
-  data.tar.gz: 398b47b5b3f861d5a94bb5d537c5fa7647247ba8
+  metadata.gz: dda9a0ba1218650749627b149ac72a33a2db99a6
+  data.tar.gz: cddc577ffa4606e7298f2b770082559ca77ca8c6
 SHA512:
-  metadata.gz: dcb090dc850e45d3259dede6dd878975526712d55773ac07c92062e8fa94500fcf213a6c291b634a6b40ad42d7717d982f20540d495a18ea730e942ce8179c95
-  data.tar.gz: d74ed5af267eea869f35efd8c3482f99a86453a00c3e13aab6d7b7f1f6bc823a220fc1d9f6eab9e627c98e2a1ca3b5f255e662eae79d4a65802912075f76304b
+  metadata.gz: 3741c81cce9cba804019218667329a609694220e37ef51731975eb01a8e2bbe5c4da775acbd225444c8e624803410c0d3f914ad1f77f007b55fed9452555d3f4
+  data.tar.gz: 40da33c44934c9a0cf6c8eaaa218d86c6ab69c04ec12f2a7e21e53eeac5abf808071ce965f6b5710925210ca08f1b77fccdd9d31f5e461911c7f328765a6ad74

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format s -c

data/.ruby-gemset

@@ -0,0 +1 @@
+portuguese_validators

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - '1.9.3'
+  - '2.0.0'
+  - jruby-19mode # JRuby in 1.9 mode
+
+script: bundle exec rspec

data/README.md

@@ -1,6 +1,8 @@
+[![Build Status](https://travis-ci.org/rikas/portuguese_validators.svg?branch=master)](https://travis-ci.org/rikas/portuguese_validators) [![Dependency Status](https://gemnasium.com/rikas/portuguese_validators.svg)](https://gemnasium.com/rikas/portuguese_validators)
+
 # PortugueseValidators
 
-This is a simple gem to validate NIB, NIF and BI numbers.
+This is a simple gem to validate NIB, NIF, BI and phone numbers.
 
 ## Installation
 
@@ -24,15 +26,14 @@ $ gem install portuguese_validators
 
 ## Usage
 
-You will have to include `PortugueseValidators` and then just add the validators to your model:
+Just add the custom validators to your models and you're ready to go!
 
 ```ruby
 class MyModel < ActiveRecord::Base
-  include PortugueseValidators
-
-  validates :nif_field, nif: true
-  validates :nib_field, nib: true
-  validates :bi_field, bi: true
+  validates :nif, portuguese_nif: true
+  validates :nib, portuguese_nib: true
+  validates :bi, portuguese_bi: true
+  validates :phone, portuguese_phone: true
 end
 ```
 
@@ -40,9 +41,7 @@ Note that these validators are just like the ones that Rails provide you so you
 
 ```ruby
 class MyModel < ActiveRecord::Base
-  include PortugueseValidators
-
-  validates :bi_field, bi: { message: 'é um número errado' }, if: :user_pt?
+  validates :bi, portuguese_bi: { message: 'é inválido' }, if: :user_pt?
 end
 ```
 

data/lib/portuguese_validators/{bi_validator.rb → bi.rb}

@@ -4,26 +4,30 @@ module PortugueseValidators
   # A Portuguese BI number is comprised by eight digits. Between that number and the "issue" box,
   # the card also has a small box with a single digit. That's the control digit. In order to
   # validate a Portuguese BI you have to give the full number (including the control digit).
-  class BiValidator
-    def validate_each(record, attribute, value)
+  class PortugueseBiValidator < ActiveModel::EachValidator
+    BLACKLIST = %w(000000000)
+
+    def validate_each(record, attribute, value) # :nodoc:
       unless is_valid?(value)
         record.errors[attribute] << (options[:message] || 'is not a valid BI')
       end
     end
 
+    # Returns true if the number is a valid BI or false otherwise.
     def is_valid?(number)
-      looks_like_bi?(number.to_s) && is_valid_bi?(number.to_s)
+      return false unless number
+
+      number = number.to_s
+      looks_like_bi?(number) && valid_bi?(number)
     end
 
     private
 
-    def is_valid_bi?(number)
+    def valid_bi?(number)
       control = number.split('').map { |digit| digit.to_i }
 
       sum = 0
-      9.downto(2) do |num|
-        sum += num * control.shift
-      end
+      9.downto(2) { |num| sum += num * control.shift }
 
       expected = 11 - sum % 11;
       expected = 0 if expected > 9 # when the value is greater than 9 then we assume 0
@@ -32,7 +36,8 @@ module PortugueseValidators
     end
 
     def looks_like_bi?(number)
-      return false unless number
+      return false if !number || BLACKLIST.include?(number)
+
       number.match(/^\d{9}$/) ? true : false
     end
   end

data/lib/portuguese_validators/{nib_validator.rb → nib.rb}

@@ -2,7 +2,7 @@ module PortugueseValidators
   # Validates Portuguese bank numbers (NIB).
   #
   # The number is always composed by 21 where the last two form the control number.
-  class NibValidator < ActiveModel::EachValidator
+  class PortugueseNibValidator < ActiveModel::EachValidator
     def validate_each(record, attribute, value)
       unless is_valid?(value)
         record.errors[attribute] << (options[:message] || 'is not a valid NIB')
@@ -10,13 +10,15 @@ module PortugueseValidators
     end
 
     def is_valid?(number)
+      return false unless number
+
       number = sprintf("%021o", number) if number.kind_of?(Integer)
-      looks_like_nib?(number) && is_valid_nib?(number)
+      looks_like_nib?(number) && valid_nib?(number)
     end
 
     private
 
-    def is_valid_nib?(number)
+    def valid_nib?(number)
       nib = number.slice(0..18).split('').map { |digit| digit.to_i }
       control = number.slice(19..20).to_i
 

data/lib/portuguese_validators/{nif_validator.rb → nif.rb}

@@ -3,7 +3,7 @@ module PortugueseValidators
   #
   # The portuguese NIF is composed by 9 digits and it must start with 1, 2, 5, 6, 7, 8 or 9. The
   # last digit is the control digit.
-  class NifValidator < ActiveModel::EachValidator
+  class PortugueseNifValidator < ActiveModel::EachValidator
     def validate_each(record, attribute, value)
       unless is_valid?(value)
         record.errors[attribute] << (options[:message] || 'is not a valid NIF')
@@ -11,13 +11,15 @@ module PortugueseValidators
     end
 
     def is_valid?(number)
+      return false unless number
+
       nif = number.to_s
-      looks_like_nif?(nif) && is_valid_nif?(nif)
+      looks_like_nif?(nif) && valid_nif?(nif)
     end
 
     private
 
-    def is_valid_nif?(number)
+    def valid_nif?(number)
       control = number.split('').map { |digit| digit.to_i }
 
       sum = 0
@@ -31,8 +33,6 @@ module PortugueseValidators
       expected == control.last
     end
 
-    # Checks if at least the given number has the correct number of digits and starts with a valid
-    # digit.
     def looks_like_nif?(number)
       return false unless number
       number.match(/^\d{9}$/) && number.match(/^[1256789]/) ? true : false

data/lib/portuguese_validators/phone.rb

@@ -0,0 +1,37 @@
+module PortugueseValidators
+  # Validates Portuguese Phone numbers.
+  #
+  # The portuguese phone numbers can start by 00351 or +351 and are composed by 9 digits.
+  # The number must start with one of the values in VALID_PREFIXES
+  class PortuguesePhoneValidator < ActiveModel::EachValidator
+    VALID_PREFIXES = %w(91 92 93 96 21 226 231 232 233 234 235 236 238 239 241 242 243 244 245 249
+      251 252 253 254 255 256 258 259 261 262 263 265 266 268 269 271 272 273 274 275 276 277 278
+      279 281 281 282 283 284 285 286 289 291 292 295 296)
+
+    COUNTRY_PREFIXES = %w(00351 +351)
+
+    def validate_each(record, attribute, value)
+      return if value.blank?
+
+      number = value.gsub(" ", "")
+      record.errors.add(attribute, options[:message] || :invalid) unless is_valid?(number)
+    end
+
+    def is_valid?(number)
+      looks_like_phone_number?(number.to_s) && valid_phone_number?(number.to_s)
+    end
+
+    private
+
+    def valid_phone_number?(number)
+      COUNTRY_PREFIXES.each { |pref| number.gsub!(pref, '') if number.start_with?(pref) }
+      VALID_PREFIXES.each { |pref| return true if number.start_with?(pref) }
+      false
+    end
+
+    def looks_like_phone_number?(number)
+      number.match(/^((00|\+)(\d{3}))?\d{9}$/) ? true : false
+    end
+  end
+
+end

data/lib/portuguese_validators/version.rb

@@ -1,3 +1,3 @@
 module PortugueseValidators
-  VERSION = '0.0.1'
+  VERSION = '0.1.1'
 end

data/lib/portuguese_validators.rb

@@ -1,9 +1,19 @@
 require 'active_model/validator'
 
+require 'portuguese_validators/bi'
+require 'portuguese_validators/nif'
+require 'portuguese_validators/nib'
+require 'portuguese_validators/phone'
 require 'portuguese_validators/version'
-require 'portuguese_validators/nif_validator'
-require 'portuguese_validators/nib_validator'
-require 'portuguese_validators/bi_validator'
 
+# PortugueseValidators offer a set of Rails validators that you can use as normal ActiveRecord
+# validators.
 module PortugueseValidators
 end
+
+# Open ActiveModel Validations to include PortugueseValidators and avoid the manual inclusion.
+module ActiveModel
+  module Validations
+    include PortugueseValidators
+  end
+end

data/portuguese_validators.gemspec

@@ -1,6 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'portuguese_validators/version'
 
 Gem::Specification.new do |spec|
@@ -8,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = PortugueseValidators::VERSION
   spec.authors       = ['Ricardo Otero']
   spec.email         = ['oterosantos@gmail.com']
-  spec.summary       = 'Validators for portuguese related numbers like NIB, NIF and BI.'
+  spec.summary       = 'Validators for portuguese NIB, NIF, BI and phone.'
   spec.description   = spec.summary
   spec.homepage      = 'http://github.com/rikas/portuguese_validators/fork'
   spec.license       = 'MIT'
@@ -20,6 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
 
-  spec.add_dependency 'activemodel'
+  spec.add_dependency 'activemodel', '~> 4.1.4'
 end

data/spec/bi_validator_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe PortugueseBiValidator do
+  before(:all) {
+    class User < TestModel
+      validates :bi, portuguese_bi: true
+    end
+  }
+
+  after(:all) { Object.send(:remove_const, :User) }
+
+  describe 'validation' do
+    it 'returns false if the number is empty' do
+      expect(User.new(bi: '')).to be_invalid
+    end
+
+    it 'returns false if the number is not defined' do
+      expect(User.new(bi: nil)).to be_invalid
+    end
+
+    context 'given valid BI numbers' do
+      %w(117052337 134307607 178756830 101812418).each do |bi|
+        it "returns true for `#{bi}'" do
+          expect(User.new(bi: bi)).to be_valid
+        end
+      end
+    end
+
+    context 'given blacklisted BI numbers' do
+      %w(000000000).each do |bi|
+        it "returns false for `#{bi}'" do
+          expect(User.new(bi: bi)).to be_invalid
+        end
+      end
+    end
+
+    context 'given invalid BI numbers' do
+      %w(-3 117051343 138473133 7873 kjas 017051349 117051348).each do |bi|
+        it "returns false for `#{bi}'" do
+          expect(User.new(bi: bi)).to be_invalid
+        end
+      end
+    end
+  end
+end

data/spec/nib_validator_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe PortugueseNibValidator do
+  before(:all) {
+    class User < TestModel
+      validates :nib, portuguese_nib: true
+    end
+  }
+
+  after(:all) { Object.send(:remove_const, :User) }
+
+  describe 'validation' do
+    it 'returns false if the number is empty' do
+      expect(User.new(nib: '')).to be_invalid
+    end
+
+    it 'returns false if the number is not defined' do
+      expect(User.new(nib: nil)).to be_invalid
+    end
+
+    context 'given invalid NIB numbers' do
+      %w(1 -39 three 0 823792873 004609950003132833098).each do |nib|
+        it "returns false for `#{nib}'" do
+          expect(User.new(nib: nib)).to be_invalid
+        end
+      end
+    end
+
+    context 'given valid NIB numbers' do
+      %w(003509950003132833098 001800031700953102078 003600339910037234245).each do |nib|
+        it "returns true for `#{nib}'" do
+          expect(User.new(nib: nib)).to be_valid
+        end
+      end
+    end
+  end
+end

data/spec/nif_validator_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe PortugueseNifValidator do
+  before(:all) {
+    class User < TestModel
+      validates :nif, portuguese_nif: true
+    end
+  }
+
+  after(:all) { Object.send(:remove_const, :User) }
+
+  describe 'validation' do
+    it 'returns false if the number is empty' do
+      expect(User.new(nif: '')).to be_invalid
+    end
+
+    it 'returns false if the number is not defined' do
+      expect(User.new(nif: nil)).to be_invalid
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_model'
+
+require 'portuguese_validators'
+
+RSpec.configure do |config|
+  include PortugueseValidators
+
+  config.order = 'random'
+end
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portuguese_validators
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,20 +39,62 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Validators for portuguese related numbers like NIB, NIF and BI.
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+description: Validators for portuguese NIB, NIF, BI and phone.
 email:
 - oterosantos@gmail.com
 executables: []
@@ -60,16 +102,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/portuguese_validators.rb
-- lib/portuguese_validators/bi_validator.rb
-- lib/portuguese_validators/nib_validator.rb
-- lib/portuguese_validators/nif_validator.rb
+- lib/portuguese_validators/bi.rb
+- lib/portuguese_validators/nib.rb
+- lib/portuguese_validators/nif.rb
+- lib/portuguese_validators/phone.rb
 - lib/portuguese_validators/version.rb
 - portuguese_validators.gemspec
+- spec/bi_validator_spec.rb
+- spec/nib_validator_spec.rb
+- spec/nif_validator_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/rikas/portuguese_validators/fork
 licenses:
 - MIT
@@ -93,5 +144,9 @@ rubyforge_project:
 rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
-summary: Validators for portuguese related numbers like NIB, NIF and BI.
-test_files: []
+summary: Validators for portuguese NIB, NIF, BI and phone.
+test_files:
+- spec/bi_validator_spec.rb
+- spec/nib_validator_spec.rb
+- spec/nif_validator_spec.rb
+- spec/spec_helper.rb