validates_spanish_documents 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7ad05e14e4f298b3e564a3434ede9bf53257269f43c8a099c5fcbd971bfb437
+  data.tar.gz: 5084889c94aeafe35b3a69014076337c24f02ab3cf7088abf42ccc133e8a92ad
+SHA512:
+  metadata.gz: 33c2b4d28b169f1ef275230ec3c6f19a91a65611fa1aa0ddfce2a4c679d71d5bd0be841b918334c47596ab02f4bcaef0e44339002cd12487f8841592e111c6bf
+  data.tar.gz: f3d5a77a08dd01f593799d3cad529bd14d4241e6d01f5b932c05acc00026116847eac107eba775258543a2d399f311078128b646ac2bbe98547e7f95ec24792e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rubocop-*

data/.gitlab-ci.yml

@@ -0,0 +1,31 @@
+image: nosolosoftware/testing:16.04
+
+cache:
+  paths:
+    - vendor/bundle
+
+stages:
+  - testing
+  - audit
+
+cache:
+  paths:
+    - vendor/bundle
+
+rspec:
+  stage: testing
+  before_script:
+    - mongod --smallfiles --fork --syslog --quiet
+    - bundle install --without production tools --jobs $(nproc)
+  script:
+    - bundle exec rspec
+
+rubocop:
+  stage: audit
+  allow_failure: true
+  before_script:
+    - gem install rubocop --no-ri --no-rdoc
+  script:
+    - rubocop -D lib/ spec/
+
+

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: https://gitlab.nosolosoftware.es/styleguides/rubocop/raw/master/cops.yml
+
+Naming/FileName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'mongoid'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rafael Jurado
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# ValidatesSpanishDocuments
+
+Common validations of spanish identification documents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'validates_spanish_documents'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validates_spanish_documents
+
+## Methods
+
+* **validate_dni(field_name, options)**: check if it is valid dni
+* **validate_nie(field_name, options)**: check if it is valid nie
+* **validate_cif(field_name, options)**: check if it is valid cif
+* **validate_nif(field_name, options)**: check if it is valid dni, nie or cif
+* **validate_person_nif(field_name, options)**: check if it is valid dni or nie
+
+## Options
+
+* **if**: name of boolean field or method to conditional validation
+
+## Example
+
+```ruby
+class Entity
+  include Mongoid::Document
+  include ValidatesSpanishDocuments
+
+  field :dni
+  field :nie
+  field :cif
+  field :nif
+  field :person_nif
+
+  validate_dni :dni
+  validate_nie :nie
+  validate_cif :cif
+  validate_nif :nif, if: :condition
+  validate_person_nif :person_nif
+
+  def condition
+    return true
+  end
+end
+```
+
+## Contributing
+
+1. Create a personal fork of the project
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/validates_spanish_documents.rb

@@ -0,0 +1,250 @@
+require 'validates_spanish_documents/version'
+
+##
+# Add common valiations methods
+#
+module ValidatesSpanishDocuments
+  LETTERS_DNI = %w[T R W A G M Y F P D X B N J Z S Q V H L C K E].freeze
+  REGEX_DNI = /^(\d{8})\-?(#{LETTERS_DNI.join('|')})$/
+
+  LETTERS_NIE = %w[X Y Z].freeze
+  REGEX_NIE = /^(#{LETTERS_NIE.join('|')})\-?(\d{7})(#{LETTERS_DNI.join('|')})$/
+
+  LETTERS_CIF = %w[A B C D E F G H J N P Q R S U V W].freeze
+  LETTERS_CIF_NUMBER = %w[P Q S W].freeze
+  LETTERS_CIF_CONTROL = %w[J A B C D E F G H I].freeze
+  REGEX_CIF = /^(#{LETTERS_CIF.join('|')})\-?(\d{7})\-?(\d|#{LETTERS_CIF_CONTROL.join('|')})$/
+
+  # rubocop:disable Metrics/ModuleLength
+  module InstanceMethods
+    private
+
+    # Check validate nif
+    def nif_valid?(field_name)
+      if send(field_name).match?(REGEX_DNI)
+        dni_valid?(field_name)
+      elsif send(field_name).match?(REGEX_NIE)
+        nie_valid?(field_name)
+      else
+        cif_valid?(field_name)
+      end
+    end
+
+    # Check validate PERSON NIF
+    def person_nif_valid?(field_name)
+      if send(field_name).match?(REGEX_DNI)
+        dni_valid?(field_name)
+      else
+        nie_valid?(field_name)
+      end
+    end
+
+    # Check validate DNI
+    def dni_valid?(field_name)
+      if send(field_name) =~ REGEX_DNI
+        number = Regexp.last_match(1).to_i
+        position = number % 23
+        control_code = Regexp.last_match(2)
+
+        return true if control_code == LETTERS_DNI[position]
+      end
+
+      false
+    end
+
+    # Check validate NIE
+    def nie_valid?(field_name)
+      if send(field_name) =~ REGEX_NIE
+        number_first = LETTERS_NIE.index(Regexp.last_match(1))
+        number = (number_first.to_s + Regexp.last_match(2)).to_i
+        position = number % 23
+        control_code = Regexp.last_match(3)
+
+        return true if control_code == LETTERS_DNI[position]
+      end
+
+      false
+    end
+
+    # Check validate CIF
+    def cif_valid?(field_name)
+      if send(field_name) =~ REGEX_CIF
+        number = Regexp.last_match(2)
+        first_letter = Regexp.last_match(1)
+        province_code = number[0..1]
+        actual_control = Regexp.last_match(3)
+
+        total = number
+                .split('')
+                .each_with_index
+                .inject(0) do |acc, (element, index)|
+          acc + if index.even?
+                  (element.to_i * 2).digits.inject(:+)
+                else
+                  element.to_i
+                end
+        end
+
+        decimal = total.digits.first
+        expected_control = decimal != 0 ? 10 - decimal : decimal
+
+        # Control code must be a letter
+        return LETTERS_CIF_CONTROL[expected_control] if LETTERS_CIF_NUMBER.include?(first_letter) ||
+                                                        province_code == '00'
+
+        # Control code will be a number or a letter
+        return [expected_control.to_s,
+                LETTERS_CIF_CONTROL[expected_control]].include?(actual_control)
+      end
+
+      false
+    end
+
+    # Validate NIF method
+    def validate_nss_nif(field_name)
+      unless nif_valid?(field_name)
+        errors.add field_name, :invalid
+        false
+      end
+
+      true
+    end
+
+    # Validate NIF method
+    def validate_nss_person_nif(field_name)
+      unless person_nif_valid?(field_name)
+        errors.add field_name, :invalid
+        false
+      end
+
+      true
+    end
+
+    # Validate DNI method
+    def validate_nss_dni(field_name)
+      unless dni_valid?(field_name)
+        errors.add field_name, :invalid
+        false
+      end
+
+      true
+    end
+
+    # Validate NIE method
+    def validate_nss_nie(field_name)
+      unless nie_valid?(field_name)
+        errors.add field_name, :invalid
+        false
+      end
+
+      true
+    end
+
+    # Validate CIF method
+    # https://es.wikipedia.org/wiki/C%C3%B3digo_de_identificaci%C3%B3n_fiscal
+    def validate_nss_cif(field_name)
+      unless cif_valid?(field_name)
+        errors.add field_name, :invalid
+        false
+      end
+
+      true
+    end
+
+    # Call all validations
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def nss_validators
+      self.class.nss_validations.each do |item|
+        next if send(item[:field_name]).blank? || (item[:if] && !check_if(item[:if]))
+
+        case item[:validation]
+        when :nif then send(:validate_nss_nif, item[:field_name])
+        when :dni then send(:validate_nss_dni, item[:field_name])
+        when :cif then send(:validate_nss_cif, item[:field_name])
+        when :nie then send(:validate_nss_nie, item[:field_name])
+        when :person_nif then send(:validate_nss_person_nif, item[:field_name])
+        end
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def check_if(condition)
+      return send(condition) if condition.class == String || condition.class == Symbol
+      return condition.call if condition.class == Proc
+
+      true
+    end
+
+    class << self
+      # Call nss validators
+      def included(base)
+        base.send(:validate, :nss_validators)
+      end
+    end
+  end
+
+  module ClassMethods
+    ##
+    # Add NIF validation to field
+    #
+    def validate_nif(field_name, options={})
+      add_nss_validation({field_name: field_name, validation: :nif}.merge(options))
+    end
+
+    ##
+    # Add DNI validation to field
+    #
+    def validate_dni(field_name, options={})
+      add_nss_validation({field_name: field_name, validation: :dni}.merge(options))
+    end
+
+    ##
+    # Add NIE validation to field
+    #
+    def validate_nie(field_name, options={})
+      add_nss_validation({field_name: field_name, validation: :nie}.merge(options))
+    end
+
+    ##
+    # Add CIF validation to field
+    #
+    def validate_cif(field_name, options={})
+      add_nss_validation({field_name: field_name, validation: :cif}.merge(options))
+    end
+
+    ##
+    # Add DNI/NIE validation to field
+    #
+    def validate_person_nif(field_name, options={})
+      add_nss_validation({field_name: field_name, validation: :person_nif}.merge(options))
+    end
+
+    ##
+    # Add validation
+    #
+    def add_nss_validation(options)
+      @nss_validations ||= []
+      @nss_validations.push(options)
+    end
+
+    ##
+    # Return nss validations
+    #
+    def nss_validations
+      if superclass.methods.include? :nss_validations
+        superclass.nss_validations + (@nss_validations || [])
+      else
+        @nss_validations || []
+      end
+    end
+  end
+
+  ##
+  # Adds class methods
+  #
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.include(InstanceMethods)
+  end
+end
+# rubocop:enable Metrics/ModuleLength

data/lib/validates_spanish_documents/version.rb

@@ -0,0 +1,3 @@
+module ValidatesSpanishDocuments
+  VERSION = '1.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'mongoid'
+require 'validates_spanish_documents'

data/spec/validations_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+RSpec.shared_context "validations" do
+  let(:valid_dni) { '29032146M' }
+  let(:valid_nie) { 'Y5284410J' }
+  let(:valid_cif) { 'R8693558B' }
+  let(:valid_cif_number) { 'A89464903' }
+  let(:invalid_cif_valid_control_invalid_letter) { 'X52168135' }
+  let(:invalid_dni) { valid_dni + 'X' }
+  let(:invalid_nie) { valid_dni + 'X' }
+  let(:invalid_cif) { valid_dni + 'X' }
+
+  describe 'validation' do
+    describe 'dni' do
+      it 'with valid' do
+        expect(Entity.new(dni: valid_dni).valid?).to be_truthy
+      end
+
+      it 'with multiple valid' do
+        entity = Entity.new(dni: "#{valid_dni} #{valid_dni}")
+        expect(entity.valid?).to be_falsey
+        expect(entity.errors[:dni]).not_to be_empty
+      end
+
+      it 'with invalid letter' do
+        entity = Entity.new(dni: '29032146X')
+        expect(entity.valid?).to be_falsey
+        expect(entity.errors[:dni]).not_to be_empty
+      end
+
+      it 'with invalid' do
+        expect(Entity.new(dni: invalid_dni).valid?).to be_falsey
+      end
+    end
+
+    describe 'nie' do
+      it 'with valid' do
+        expect(Entity.new(nie: valid_nie).valid?).to be_truthy
+      end
+
+      it 'with multiple valid' do
+        entity = Entity.new(nie: "#{valid_nie} #{valid_nie}")
+        expect(entity.valid?).to be_falsey
+        expect(entity.errors[:nie]).not_to be_empty
+      end
+
+      it 'with invalid letter' do
+        entity = Entity.new(nie: 'X0709831Q')
+        expect(entity.valid?).to be_falsey
+        expect(entity.errors[:nie]).not_to be_empty
+      end
+
+      it 'with invalid' do
+        expect(Entity.new(nie: invalid_nie).valid?).to be_falsey
+      end
+    end
+
+    describe 'cif' do
+      context 'when is valid' do
+        it 'has control code a letter' do
+          expect(Entity.new(cif: valid_cif).valid?).to be_truthy
+        end
+
+        it 'has control code a number' do
+          expect(Entity.new(cif: valid_cif_number).valid?).to be_truthy
+        end
+      end
+
+      context 'when is invalid' do
+        it 'with valid control_code but invalid first_letter' do
+          entity = Entity.new(cif: invalid_cif_valid_control_invalid_letter)
+          expect(entity.valid?).to be_falsey
+          expect(entity.errors[:cif]).not_to be_empty
+        end
+
+        it 'with multiple valid' do
+          entity = Entity.new(cif: "#{valid_cif} #{valid_cif}")
+          expect(entity.valid?).to be_falsey
+          expect(entity.errors[:cif]).not_to be_empty
+        end
+
+        it 'with invalid letter' do
+          # invalid last number
+          entity = Entity.new(cif: 'E93339490')
+          expect(entity.valid?).to be_falsey
+          expect(entity.errors[:cif]).not_to be_empty
+        end
+
+        it 'with invalid' do
+          expect(Entity.new(cif: invalid_cif).valid?).to be_falsey
+        end
+      end
+    end
+
+    it 'validate person_nif' do
+      expect(Entity.new(person_nif: valid_dni).valid?).to be_truthy
+      expect(Entity.new(person_nif: valid_nie).valid?).to be_truthy
+      expect(Entity.new(person_nif: valid_cif).valid?).to be_falsey
+      expect(Entity.new(person_nif: invalid_dni).valid?).to be_falsey
+      expect(Entity.new(person_nif: invalid_nie).valid?).to be_falsey
+    end
+
+    it 'validate nif' do
+      expect(Entity.new(nif: valid_dni).valid?).to be_truthy
+      expect(Entity.new(nif: valid_nie).valid?).to be_truthy
+      expect(Entity.new(nif: valid_cif).valid?).to be_truthy
+      expect(Entity.new(nif: invalid_dni).valid?).to be_falsey
+      expect(Entity.new(nif: invalid_nie).valid?).to be_falsey
+      expect(Entity.new(nif: invalid_cif).valid?).to be_falsey
+    end
+  end
+
+  describe 'functinality' do
+    it 'allow heritage' do
+      class MyEntity < Entity
+      end
+
+      # invalid dni letter (last)
+      entity = MyEntity.new(dni: '29032146X')
+      expect(entity.valid?).to be_falsey
+      expect(entity.errors[:dni]).not_to be_empty
+    end
+  end
+end
+
+describe ValidatesSpanishDocuments do
+  context 'when use with Mongoid' do
+    class Entity
+      include Mongoid::Document
+      include ValidatesSpanishDocuments
+
+      field :dni
+      field :nie
+      field :cif
+      field :nif
+      field :person_nif
+
+      validate_dni :dni, if: -> { true }
+      validate_nie :nie
+      validate_cif :cif
+      validate_nif :nif
+      validate_person_nif :person_nif
+    end
+
+    include_context 'validations'
+  end
+
+  context 'when use with ActiveModel::Validations' do
+    class Entity
+      include ActiveModel::Validations
+      include ValidatesSpanishDocuments
+
+      validate_dni :dni, if: 'condition'
+      validate_nie :nie
+      validate_cif :cif
+      validate_nif :nif
+      validate_person_nif :person_nif
+
+      attr_reader :dni, :nie, :cif, :nif, :person_nif
+
+      def initialize(params)
+        @dni = params[:dni]
+        @nie = params[:nie]
+        @cif = params[:cif]
+        @nif = params[:nif]
+        @person_nif = params[:person_nif]
+      end
+
+      def condition
+        true
+      end
+    end
+
+    include_context 'validations'
+  end
+end

data/validates_spanish_documents.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validates_spanish_documents'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'validates_spanish_documents'
+  spec.version       = ValidatesSpanishDocuments::VERSION
+  spec.authors       = ['Rafael Jurado']
+  spec.email         = ['rjurado@nosolosoftware.es']
+  spec.summary       = 'Common validations.'
+  spec.description   = 'Add common validations.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: validates_spanish_documents
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Rafael Jurado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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'
+description: Add common validations.
+email:
+- rjurado@nosolosoftware.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/validates_spanish_documents.rb
+- lib/validates_spanish_documents/version.rb
+- spec/spec_helper.rb
+- spec/validations_spec.rb
+- validates_spanish_documents.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Common validations.
+test_files:
+- spec/spec_helper.rb
+- spec/validations_spec.rb