curp_generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a65ed003039b6871fef8ca8eca44a529706baf765010619457d8955d58ad032
+  data.tar.gz: 184facb4300807434ad265dd068b1924e2ad884c29333839564efa2e79be8d9c
+SHA512:
+  metadata.gz: a3d031d50701c6554cdc9f7c024e472157c27d58d1d8c42f4ccc60399b3a4b4b824ef144a26ebf9fa56eca25c4aae41d2120d98b0b5e8fd26fe6a93dcc8a3283
+  data.tar.gz: c6647a39d66e0445feb5f1e0ccaf8508387f075916ce560750490e986d412976e5a3367bf821a9ac8103e65f0fbb611dbde2a9bccd63b7a1b37390b08ee48e75

data/lib/catalogs.rb

@@ -0,0 +1,156 @@
+module CurpGenerator::Catalogs
+  VALID_CHARACTERS = '0123456789ABCDEFGHIJKLMNÑOPQRSTUVWXYZ'.freeze
+
+  STATES = {
+    'AGUASCALIENTES' => 'AS',
+    'BAJA CALIFORNIA NORTE' => 'BC',
+    'BAJA CALIFORNIA SUR' => 'BS',
+    'CAMPECHE' => 'CC',
+    'CHIAPAS' => 'CS',
+    'CHIHUAHUA' => 'CH',
+    'CIUDAD DE MEXICO' => 'DF',
+    'COAHUILA' => 'CL',
+    'COLIMA' => 'CM',
+    'DURANGO' => 'DG',
+    'GUANAJUATO' => 'GT',
+    'GUERRERO' => 'GR',
+    'HIDALGO' => 'HG',
+    'JALISCO' => 'JC',
+    'MEXICO' => 'MC',
+    'MICHOACAN' => 'MN',
+    'MORELOS' => 'MS',
+    'NAYARIT' => 'NT',
+    'NUEVO LEON' => 'NL',
+    'OAXACA' => 'OC',
+    'PUEBLA' => 'PL',
+    'QUERETARO' => 'QT',
+    'QUINTANA ROO' => 'QR',
+    'SAN LUIS POTOSI' => 'SP',
+    'SINALOA' => 'SL',
+    'SONORA' => 'SR',
+    'TABASCO' => 'TC',
+    'TAMAULIPAS' => 'TS',
+    'TLAXCALA' => 'TL',
+    'VERACRUZ' => 'VZ',
+    'YUCATAN' => 'YN',
+    'ZACATECAS' => 'ZS'
+  }.freeze
+
+  FORBIDDEN_WORDS = {
+    'BACA' => 'BXCA',
+    'LOCO' => 'LXCO',
+    'BAKA' => 'BXKA',
+    'BUEI' => 'BXEI',
+    'BUEY' => 'BXEY',
+    'CACA' => 'CXCA',
+    'CACO' => 'CXCO',
+    'CAGA' => 'CXGA',
+    'CAGO' => 'CXGO',
+    'CAKA' => 'CXKA',
+    'CAKO' => 'CXKO',
+    'COGE' => 'CXGE',
+    'COGI' => 'CXGI',
+    'COJA' => 'CXJA',
+    'COJE' => 'CXJE',
+    'COJI' => 'CXJI',
+    'COJO' => 'CXJO',
+    'COLA' => 'CXLA',
+    'CULO' => 'CXLO',
+    'FALO' => 'FXLO',
+    'FETO' => 'FXTO',
+    'GETA' => 'GXTA',
+    'GUEI' => 'GXEI',
+    'GUEY' => 'GXEY',
+    'JETA' => 'JXTA',
+    'JOTO' => 'JXTO',
+    'KACA' => 'KXCA',
+    'KACO' => 'KXCO',
+    'KAGA' => 'KXGA',
+    'KAGO' => 'KXGO',
+    'KAKA' => 'KXKA',
+    'KAKO' => 'KXKO',
+    'KOGE' => 'KXGE',
+    'KOGI' => 'KXGI',
+    'KOJA' => 'KXJA',
+    'KOJE' => 'KXJE',
+    'KOJI' => 'KXJI',
+    'KOJO' => 'KXJO',
+    'KOLA' => 'KXLA',
+    'KULO' => 'KXLO',
+    'LILO' => 'LXLO',
+    'LOKA' => 'LXKA',
+    'LOKO' => 'LXKO',
+    'MAME' => 'MXME',
+    'MAMO' => 'MXMO',
+    'MEAR' => 'MXAR',
+    'MEAS' => 'MXAS',
+    'MEON' => 'MXON',
+    'MIAR' => 'MXAR',
+    'MION' => 'MXON',
+    'MOCO' => 'MXCO',
+    'MOKO' => 'MXKO',
+    'MULA' => 'MXLA',
+    'MULO' => 'MXLO',
+    'NACA' => 'NXCA',
+    'NACO' => 'NXCO',
+    'PEDA' => 'PXDA',
+    'PEDO' => 'PXDO',
+    'PENE' => 'PXNE',
+    'PIPI' => 'PXPI',
+    'PITO' => 'PXTO',
+    'POPO' => 'PXPO',
+    'PUTA' => 'PXTA',
+    'PUTO' => 'PXTO',
+    'QULO' => 'QXLO',
+    'RATA' => 'RXTA',
+    'ROBA' => 'RXBA',
+    'ROBE' => 'RXBE',
+    'ROBO' => 'RXBO',
+    'RUIN' => 'RXIN',
+    'SENO' => 'SXNO',
+    'TETA' => 'TXTA',
+    'VACA' => 'VXCA',
+    'VAGA' => 'VXGA',
+    'VAGO' => 'VXGO',
+    'VAKA' => 'VXKA',
+    'VUEI' => 'VXEI',
+    'VUEY' => 'VXEY',
+    'WUEI' => 'WXEI',
+    'WUEY' => 'WXEY'
+  }.freeze
+
+  COMMON_NAMES = [
+    'MARIA DEL',
+    'MARIA DE LOS',
+    'MARIA',
+    'JOSE DE',
+    'JOSE',
+    'MA.',
+    'MA',
+    'M.',
+    'J.',
+    'J'
+  ].freeze
+
+  COMPOSED_NAMES = [
+    'DA ',
+    'DAS ',
+    'DE ',
+    'DEL ',
+    'DER ',
+    'DI ',
+    'DIE ',
+    'DD ',
+    'EL ',
+    'LA ',
+    'LOS ',
+    'LAS ',
+    'LE ',
+    'LES ',
+    'MAC ',
+    'MC ',
+    'VAN ',
+    'VON ',
+    'Y '
+  ].freeze
+end

data/lib/curp.rb

@@ -0,0 +1,98 @@
+require 'version'
+require 'catalogs'
+require 'element'
+require 'helpers'
+
+class CurpGenerator::Curp
+  include CurpGenerator::Catalogs
+  include CurpGenerator::Helpers
+
+  MissingParamError = Class.new(StandardError)
+
+  PARAMS_TO_VALIDATE = %w(
+    first_last_name
+    first_name
+    birth_date
+    birth_state
+    gender
+  ).freeze
+
+  def initialize(data = {})
+    @first_name       = data.dig(:first_name)
+    @second_name      = data.dig(:second_name)
+    @first_last_name  = parse_attribute(data.dig(:first_last_name))
+    @second_last_name = parse_attribute(data.dig(:second_last_name)) || ''
+    @birth_date       = data.dig(:birth_date)
+    @birth_state      = parse_attribute(data.dig(:birth_state))
+    @gender           = data.dig(:gender)
+  end
+
+  def generate
+    validate_params
+
+    prefix = partial_curp
+    prefix + verifying_digit(prefix)
+  end
+
+  private
+
+  def validate_params
+    PARAMS_TO_VALIDATE.each do |param|
+      raise MissingParamError, "Missing #{param}" if blank_string?(instance_variable_get("@#{param}"))
+    end
+  end
+
+  def partial_curp
+    validate_first_four_curp_digits +
+    parse_date(@birth_date, "%y") +
+    parse_date(@birth_date, "%m") +
+    parse_date(@birth_date, "%d") +
+    gender_character +
+    state_code +
+    first_last_name_element.next_consonant +
+    second_last_name_element.next_consonant +
+    first_name_element.next_consonant +
+    homoclave_digit
+  end
+
+  def validate_first_four_curp_digits
+    FORBIDDEN_WORDS.dig(first_four_curp_digits) || first_four_curp_digits
+  end
+
+  def gender_character
+    @gender == 'male' ? 'H' : 'M'
+  end
+
+  def state_code
+    STATES.dig(@birth_state.upcase) || 'NE'
+  end
+
+  def homoclave_digit
+    @birth_date.year < 2000 ? '0' : 'A'
+  end
+
+  def first_four_curp_digits
+    @first_four_curp_digits ||=
+      first_last_name_element.first_character +
+      first_last_name_element.next_vowel +
+      second_last_name_element.first_character +
+      first_name_element.first_character
+  end
+
+  def first_last_name_element
+    @first_last_name_element ||= CurpGenerator::Element.new(@first_last_name)
+  end
+
+  def second_last_name_element
+    @second_last_name_element ||= CurpGenerator::Element.new(@second_last_name)
+  end
+
+  def first_name_element
+    @first_name_element ||= CurpGenerator::Element.new(validate_first_name)
+  end
+
+  def validate_first_name
+    name = parse_attribute(@first_name)
+    COMMON_NAMES.include?(name) ? @second_name : name
+  end
+end

data/lib/curp_generator.rb

@@ -0,0 +1 @@
+require 'curp'

data/lib/element.rb

@@ -0,0 +1,45 @@
+require 'helpers'
+require 'string_format'
+
+class CurpGenerator::Element
+  include CurpGenerator::Helpers
+
+  attr_accessor :name, :consonant_index, :vowel_index
+
+  def initialize(name)
+    @name = name
+    @consonant_index = 0
+    @vowel_index = 0
+  end
+
+  def first_character
+    return 'X' if blank_string?(name)
+
+    character = name[0].upcase
+    update_next_index_attribute(character)
+    character == 'Ñ' ? 'X' : character
+  end
+
+  def next_consonant
+    return 'X' if blank_string?(name)
+
+    consonants = CurpGenerator::StringFormat.new(name).remove_vowels.upcase
+    consonants.size < 2 ? consonants[0] : consonants[consonant_index]
+  end
+
+  def next_vowel
+    return 'X' if blank_string?(name)
+
+    consonants = CurpGenerator::StringFormat.new(name).remove_consonants.upcase
+    consonants.size < 2 ? 'X' : consonants[vowel_index]
+  end
+
+  private
+
+  def update_next_index_attribute(character)
+    new_consonant_value = CurpGenerator::StringFormat.new(character).consonant? ? 1 : 0
+    new_vowel_value = CurpGenerator::StringFormat.new(character).vowel? ? 1 : 0
+    self.consonant_index = new_consonant_value
+    self.vowel_index = new_vowel_value
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,41 @@
+require 'date'
+require 'catalogs'
+require 'string_format'
+
+module CurpGenerator::Helpers
+  include CurpGenerator::Catalogs
+
+  def verifying_digit(partial_curp)
+    length_sum = 0.0
+
+    partial_curp.split('').each_with_index do |character, index|
+      length_sum += VALID_CHARACTERS.index(character) * (18 - index)
+    end
+
+    last_digit = 10 - (length_sum % 10)
+    last_digit == 10 ? '0' : last_digit.to_i.to_s
+  end
+
+  def remove_composed_names(name)
+    name = name.upcase
+
+    COMPOSED_NAMES.each do |composed|
+      next unless name.include?(composed)
+      name = name.gsub(composed, '')
+    end
+    name
+  end
+
+  def parse_attribute(attribute)
+    return if blank_string?(attribute)
+    CurpGenerator::StringFormat.new(remove_composed_names(attribute)).str
+  end
+
+  def parse_date(date, format)
+    date.strftime(format)
+  end
+
+  def blank_string?(value)
+    value.to_s.strip.empty?
+  end
+end

data/lib/string_format.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class CurpGenerator::StringFormat
+
+  attr_accessor :str
+
+  def initialize(str)
+    @str = remove_special_chars(normalize(str.strip))
+  end
+
+  def remove_vowels
+    str.downcase.tr('aeiou', '')
+  end
+
+  def remove_consonants
+    str.downcase.tr('^aeiou', '')
+  end
+
+  def vowel?
+    %w(A E I O U).include?(str.upcase)
+  end
+
+  def consonant?
+    !vowel?
+  end
+
+  def first_vowel
+    str.downcase.match(/a|e|i|o|u/).to_s.upcase
+  end
+
+  private
+
+  def normalize(string)
+    string&.tr(
+      "ÀàÁáÄäÈèÉéËëÌìÍíÏïÒòÓóÖöÙùÚúÜüÑñ",
+      "AaAaAaEeEeEeIiIiIiOoOoOoUuUuUuNn"
+    )
+  end
+
+  def remove_special_chars(string)
+    string&.gsub(/[\.\'\d-]/, "")
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CurpGenerator
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: curp_generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juan Carlos Estebes
+- Manuel de la Torre
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/catalogs.rb
+- lib/curp.rb
+- lib/curp_generator.rb
+- lib/element.rb
+- lib/helpers.rb
+- lib/string_format.rb
+- lib/version.rb
+homepage: https://github.com/yotepresto-com/curp-generator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yotepresto-com/curp-generator
+  source_code_uri: https://github.com/yotepresto-com/curp-generator
+  changelog_uri: https://github.com/yotepresto-com/curp-generator/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Generates a mexican CURP given the information of a person
+test_files: []