faker_spanish_documents 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2544e5f94aed1c398cabbd6e7ce101a9aa6fc6a5b41cfdfe12fb0fd173ed7147
+  data.tar.gz: ab82a168780f59505d15d0bd097820104b57e348545327467e5d045c17108d3b
+SHA512:
+  metadata.gz: 39891aba45bdd57587d44a53955893bd5113a72580c6b15c4741219c1f10494e6ef73e1d498fe4cc51120363526b76b826bee96300cd20518951a91afce0b35e
+  data.tar.gz: 7319379e3bac40943b7981dc5390a1dc792948f06f7bf73fdcfa51ff3cec3bb044108018abe0ced0dc1ab3765cd76888f1bef2b369da013e15c871a894f8961f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    faker_spanish_documents (0.1.0)
+      faker (~> 2.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.3)
+    faker (2.18.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker_spanish_documents!
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,25 @@
+# Faker::SpanishDocuments
+
+Gem to generate fake spanish documents as DNI, CIF or NIE. It's based on the well-known gem [Faker](https://github.com/stympy/faker).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faker_spanish_documents'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faker_spanish_documents
+
+## Usage
+
+Its use is pretty easy, it exposes three method one for each type of document.
+```ruby
+Faker::SpanishDocuments.dni
+Faker::SpanishDocuments.cif
+Faker::SpanishDocuments.nie

data/faker_spanish_documents.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'faker_spanish_documents'
+  s.version     = '0.1.0'
+  s.description = 'A simple faker to generate spanish documents as DNI, NIE or CIF'
+  s.summary     = 'Generate valid DNI, NIE or CIF numbers'
+  s.authors     = ['F. Padillo']
+  s.email       = 'fpadillo@nosolosoftware.es'
+  s.homepage    = 'https://github.com/nosolosoftware/faker_spanish'
+  s.license     = 'MIT'
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.add_dependency 'faker', '~> 2.18'
+end

data/lib/faker_spanish_documents.rb

@@ -0,0 +1,69 @@
+require 'faker'
+require 'faker_spanish_documents/version'
+
+module Faker
+  class SpanishDocuments
+    NIF_LETTERS = 'TRWAGMYFPDXBNJZSQVHLCKE'.freeze
+    NIE_LETTERS = %w[X Y Z].freeze
+    CIF_LETTERS = %w[A B C D E F G H J N P Q R S U V W].freeze
+    CIF_LETTERS_NUMBER = 'PQSW'.freeze
+    CIF_CONTROL_LETTERS = 'JABCDEFGHI'.freeze
+
+    class << self
+      def dni
+        number = Faker::Number.number(digits: 8).to_i
+        "#{number}#{nif_letter(number)}"
+      end
+
+      def nie(letter=nil)
+        first_letter = letter && NIE_LETTERS.include?(letter) ? letter : NIE_LETTERS.sample
+        first_number = NIE_LETTERS.find_index { |e| e == first_letter }
+        number_part = Faker::Number.number(digits: 7)
+        number_for_calculation = "#{first_number}#{number_part}".to_i
+
+        "#{first_letter}#{number_part}#{nif_letter(number_for_calculation)}"
+      end
+
+      def cif(letter=nil)
+        first_letter = letter && CIF_LETTERS.include?(letter) ? letter : CIF_LETTERS.sample
+        province_code = Faker::Number.number(digits: 2)
+        random_number = Faker::Number.number(digits: 5)
+        number = "#{province_code}#{random_number}"
+
+        control_code = cif_control_code(number, first_letter)
+
+        "#{first_letter}#{number}#{control_code}"
+      end
+
+      private
+
+      def cif_control_code(number, first_letter)
+        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
+        control = decimal != 0 ? 10 - decimal : decimal
+
+        if CIF_LETTERS_NUMBER.include?(first_letter) || number.start_with?('00')
+          # Control code will be a letter
+          CIF_CONTROL_LETTERS[control]
+        else
+          # Control code will be a number
+          control
+        end
+      end
+
+      def nif_letter(number)
+        NIF_LETTERS[number % NIF_LETTERS.length]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: faker_spanish_documents
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- F. Padillo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+description: A simple faker to generate spanish documents as DNI, NIE or CIF
+email: fpadillo@nosolosoftware.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- faker_spanish_documents.gemspec
+- lib/faker_spanish_documents.rb
+- lib/faker_spanish_documents/version.rb
+homepage: https://github.com/nosolosoftware/faker_spanish
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate valid DNI, NIE or CIF numbers
+test_files: []