curp_generator 1.0.0 → 1.1.0

checksums.yaml

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

data/lib/base.rb

@@ -0,0 +1,54 @@
+require 'curp'
+
+class CurpGenerator::Base
+  include CurpGenerator::Catalogs
+
+  InvalidCurpArgumentError = Class.new(StandardError)
+
+  def generate
+    raise NotImplementedError
+  end
+
+  private
+
+  def valid_params?
+    raise NotImplementedError
+  end
+
+  def error_message!
+    raise NotImplementedError
+  end
+
+  def parse_attribute(attribute)
+    return if blank_string?(attribute)
+
+    str = remove_special_chars(normalize(attribute))
+    remove_composed_names(str)
+  end
+
+  def blank_string?(value)
+    value.to_s.strip.empty?
+  end
+
+  def remove_special_chars(string)
+    string&.gsub(/[.'\d-]/, "")
+  end
+
+  def normalize(string)
+    string&.tr(
+      "ÀàÁáÄäÈèÉéËëÌìÍíÏïÒòÓóÖöÙùÚúÜüÑñ",
+      "AaAaAaEeEeEeIiIiIiOoOoOoUuUuUuXx"
+    )
+  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
+end

data/lib/birth_date.rb

@@ -0,0 +1,37 @@
+require 'base'
+
+class CurpGenerator::BirthDate < CurpGenerator::Base
+  def initialize(birth_date)
+    @birth_date = birth_date
+  end
+
+  def self.generate(birth_date)
+    new(birth_date).generate
+  end
+
+  def self.homoclave_digit(birth_date)
+    new(birth_date).homoclave_digit
+  end
+
+  def generate
+    invalid_params? ? error_message! : parsed_date
+  end
+
+  def homoclave_digit
+    @birth_date.year < 2000 ? '0' : 'A'
+  end
+
+  private
+
+  def invalid_params?
+    blank_string?(@birth_date) || !@birth_date.respond_to?(:strftime)
+  end
+
+  def error_message!
+    raise InvalidCurpArgumentError, 'Invalid date format'
+  end
+
+  def parsed_date
+    @birth_date.strftime("%y%m%d")
+  end
+end

data/lib/catalogs.rb

@@ -1,39 +1,103 @@
 module CurpGenerator::Catalogs
-  VALID_CHARACTERS = '0123456789ABCDEFGHIJKLMNÑOPQRSTUVWXYZ'.freeze
-
   STATES = {
-    'AGUASCALIENTES' => 'AS',
+    'AGUASCALIENTES'        => 'AS',
+    'AG'                    => 'AS',
+    'AGU'                   => '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'
+    'BC'                    => 'BC',
+    'BCN'                   => 'BC',
+    'BAJA CALIFORNIA SUR'   => 'BS',
+    'BS'                    => 'BS',
+    'BCS'                   => 'BS',
+    'CAMPECHE'              => 'CC',
+    'CM'                    => 'CC',
+    'CAM'                   => 'CC',
+    'CHIAPAS'               => 'CS',
+    'CS'                    => 'CS',
+    'CHP'                   => 'CS',
+    'CHIHUAHUA'             => 'CH',
+    'CH'                    => 'CH',
+    'CHH'                   => 'CH',
+    'COAHUILA'              => 'CL',
+    'CO'                    => 'CL',
+    'COA'                   => 'CL',
+    'COLIMA'                => 'CM',
+    'CL'                    => 'CM',
+    'COL'                   => 'CM',
+    'CIUDAD DE MEXICO'      => 'DF',
+    'DF'                    => 'DF',
+    'CMX'                   => 'DF',
+    'CDMX'                  => 'DF',
+    'DURANGO'               => 'DG',
+    'DG'                    => 'DG',
+    'DUR'                   => 'DG',
+    'GUANAJUATO'            => 'GT',
+    'GT'                    => 'GT',
+    'GUA'                   => 'GT',
+    'GUERRERO'              => 'GR',
+    'GR'                    => 'GR',
+    'GRO'                   => 'GR',
+    'HIDALGO'               => 'HG',
+    'HG'                    => 'HG',
+    'HID'                   => 'HG',
+    'JALISCO'               => 'JC',
+    'JA'                    => 'JC',
+    'JAL'                   => 'JC',
+    'MEXICO'                => 'MC',
+    'EM'                    => 'MC',
+    'MEX'                   => 'MC',
+    'ESTADO DE MEXICO'      => 'MC',
+    'MICHOACAN'             => 'MN',
+    'MI'                    => 'MN',
+    'MIC'                   => 'MN',
+    'MORELOS'               => 'MS',
+    'MO'                    => 'MS',
+    'MOR'                   => 'MS',
+    'NAYARIT'               => 'NT',
+    'NA'                    => 'NT',
+    'NAY'                   => 'NT',
+    'NUEVO LEON'            => 'NL',
+    'NL'                    => 'NL',
+    'NLE'                   => 'NL',
+    'OAXACA'                => 'OC',
+    'OA'                    => 'OC',
+    'OAX'                   => 'OC',
+    'PUEBLA'                => 'PL',
+    'PU'                    => 'PL',
+    'PUE'                   => 'PL',
+    'QUERETARO'             => 'QT',
+    'QT'                    => 'QT',
+    'QUE'                   => 'QT',
+    'QUINTANA ROO'          => 'QR',
+    'QR'                    => 'QR',
+    'ROO'                   => 'QR',
+    'SAN LUIS POTOSI'       => 'SP',
+    'SL'                    => 'SP',
+    'SLP'                   => 'SP',
+    'SINALOA'               => 'SL',
+    'SI'                    => 'SL',
+    'SIN'                   => 'SL',
+    'SONORA'                => 'SR',
+    'SO'                    => 'SR',
+    'SON'                   => 'SR',
+    'TABASCO'               => 'TC',
+    'TB'                    => 'TC',
+    'TAB'                   => 'TC',
+    'TAMAULIPAS'            => 'TS',
+    'TM'                    => 'TS',
+    'TAM'                   => 'TS',
+    'TLAXCALA'              => 'TL',
+    'TL'                    => 'TL',
+    'TLA'                   => 'TL',
+    'VERACRUZ'              => 'VZ',
+    'VE'                    => 'VZ',
+    'VER'                   => 'VZ',
+    'YUCATAN'               => 'YN',
+    'YU'                    => 'YN',
+    'YUC'                   => 'YN',
+    'ZACATECAS'             => 'ZS',
+    'ZA'                    => 'ZS',
+    'ZAC'                   => 'ZS'
   }.freeze
 
   FORBIDDEN_WORDS = {

data/lib/curp.rb

@@ -1,98 +1,68 @@
 require 'version'
 require 'catalogs'
-require 'element'
-require 'helpers'
+require 'name'
+require 'birth_date'
+require 'digit_verifier'
+require 'gender'
+require 'state'
 
 class CurpGenerator::Curp
   include CurpGenerator::Catalogs
-  include CurpGenerator::Helpers
 
-  MissingParamError = Class.new(StandardError)
+  InvalidArgumentError = 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)
+  def initialize(data={})
+    @first_name       = data[:first_name]
+    @second_name      = data[:second_name]
+    @first_last_name  = data[:first_last_name]
+    @second_last_name = data[:second_last_name]
+    @birth_date       = data[:birth_date]
+    @birth_state      = data[:birth_state]
+    @gender           = data[:gender]
   end
 
   def generate
-    validate_params
-
-    prefix = partial_curp
-    prefix + verifying_digit(prefix)
+    "#{partial_curp}#{verifier_digit}"
+  rescue => e
+    raise InvalidArgumentError, e
   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
+    @partial_curp ||= prefix_name +
+      parsed_date +
+      gender_character +
+      state_character +
+      sufix_name +
+      homoclave_digit
   end
 
-  def gender_character
-    @gender == 'male' ? 'H' : 'M'
-  end
-
-  def state_code
-    STATES.dig(@birth_state.upcase) || 'NE'
+  def verifier_digit
+    CurpGenerator::DigitVerifier.generate(partial_curp)
   end
 
-  def homoclave_digit
-    @birth_date.year < 2000 ? '0' : 'A'
+  def prefix_name
+    CurpGenerator::Name.prefix_name(@first_name, @second_name, @first_last_name, @second_last_name)
   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
+  def parsed_date
+    CurpGenerator::BirthDate.generate(@birth_date)
   end
 
-  def first_last_name_element
-    @first_last_name_element ||= CurpGenerator::Element.new(@first_last_name)
+  def gender_character
+    CurpGenerator::Gender.generate(@gender)
   end
 
-  def second_last_name_element
-    @second_last_name_element ||= CurpGenerator::Element.new(@second_last_name)
+  def state_character
+    CurpGenerator::State.generate(@birth_state)
   end
 
-  def first_name_element
-    @first_name_element ||= CurpGenerator::Element.new(validate_first_name)
+  def sufix_name
+    CurpGenerator::Name.sufix_name(@first_name, @second_name, @first_last_name, @second_last_name)
   end
 
-  def validate_first_name
-    name = parse_attribute(@first_name)
-    COMMON_NAMES.include?(name) ? @second_name : name
+  def homoclave_digit
+    CurpGenerator::BirthDate.homoclave_digit(@birth_date)
   end
 end

data/lib/digit_verifier.rb

@@ -0,0 +1,38 @@
+require 'base'
+
+class CurpGenerator::DigitVerifier < CurpGenerator::Base
+  VALID_CHARACTERS = '0123456789ABCDEFGHIJKLMNÑOPQRSTUVWXYZ'.freeze
+
+  def initialize(partial_curp)
+    @partial_curp = partial_curp
+  end
+
+  def self.generate(partial_curp)
+    new(partial_curp).generate
+  end
+
+  def generate
+    invalid_params? ? error_message! : verifying_digit
+  end
+
+  private
+
+  def invalid_params?
+    blank_string?(@partial_curp) || @partial_curp.size != 17
+  end
+
+  def error_message!
+    raise InvalidCurpArgumentError, 'Missing partial curp'
+  end
+
+  def verifying_digit
+    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
+end

data/lib/gender.rb

@@ -0,0 +1,47 @@
+require 'base'
+
+class CurpGenerator::Gender < CurpGenerator::Base
+  VALID_MALE_GENDERS = %w[
+    male
+    hombre
+    masculino
+    h
+  ].freeze
+
+  VALID_FEMALE_GENDERS = %w[
+    female
+    mujer
+    femenino
+    m
+  ].freeze
+
+  def initialize(gender)
+    @gender = gender.to_s.downcase
+  end
+
+  def self.generate(gender)
+    new(gender).generate
+  end
+
+  def generate
+    invalid_params? ? error_message! : parsed_gender
+  end
+
+  private
+
+  def invalid_params?
+    blank_string?(@gender) || invalid_gender?
+  end
+
+  def invalid_gender?
+    !VALID_MALE_GENDERS.include?(@gender) && !VALID_FEMALE_GENDERS.include?(@gender)
+  end
+
+  def error_message!
+    raise InvalidCurpArgumentError, "Available gender options are #{VALID_MALE_GENDERS + VALID_FEMALE_GENDERS}"
+  end
+
+  def parsed_gender
+    VALID_MALE_GENDERS.include?(@gender) ? 'H' : 'M'
+  end
+end

data/lib/name.rb

@@ -0,0 +1,101 @@
+require 'base'
+require 'catalogs'
+
+class CurpGenerator::Name < CurpGenerator::Base
+  include CurpGenerator::Catalogs
+
+  def initialize(first_name, second_name, first_last_name, second_last_name)
+    @first_name       = parse_attribute(first_name&.upcase)
+    @second_name      = parse_attribute(second_name&.upcase)
+    @first_last_name  = parse_attribute(first_last_name&.upcase)
+    @second_last_name = parse_attribute(second_last_name&.upcase)
+  end
+
+  def self.prefix_name(first_name, second_name, first_last_name, second_last_name)
+    new(first_name, second_name, first_last_name, second_last_name).prefix_name
+  end
+
+  def self.sufix_name(first_name, second_name, first_last_name, second_last_name)
+    new(first_name, second_name, first_last_name, second_last_name).sufix_name
+  end
+
+  def generate
+    error_message! if invalid_params?
+  end
+
+  def prefix_name
+    generate
+    FORBIDDEN_WORDS[prefix_consonants] || prefix_consonants
+  end
+
+  def sufix_name
+    generate
+    sufix_consonants
+  end
+
+  private
+
+  def invalid_params?
+    blank_string?(@first_name) || blank_string?(@first_last_name)
+  end
+
+  def error_message!
+    raise InvalidCurpArgumentError, 'Invalid name arguments'
+  end
+
+  def prefix_consonants
+    @prefix_consonants ||=
+      first_character(@first_last_name) +
+      next_vowel(@first_last_name) +
+      first_character(@second_last_name) +
+      first_character(valid_first_name)
+  end
+
+  def sufix_consonants
+    next_consonant(@first_last_name) +
+    next_consonant(@second_last_name) +
+    next_consonant(valid_first_name)
+  end
+
+  def valid_first_name
+    valid_second_name? ? @second_name : @first_name
+  end
+
+  def valid_second_name?
+    COMMON_NAMES.include?(@first_name) && !blank_string?(@second_name)
+  end
+
+  def first_character(str)
+    return 'X' if blank_string?(str)
+
+    str[0].upcase
+  end
+
+  def next_consonant(str)
+    return 'X' if blank_string?(str)
+
+    consonants = remove_vowels(str)
+    consonants.size.zero? ? 'X' : consonants[0].upcase
+  end
+
+  def next_vowel(str)
+    return 'X' if blank_string?(str)
+
+    vowels = remove_consonants(str)
+    vowels.size.zero? ? 'X' : vowels[0].upcase
+  end
+
+  def remove_vowels(str)
+    new_str = removing_first_char(str)
+    new_str.downcase.tr('aeiou', '')
+  end
+
+  def remove_consonants(str)
+    new_str = removing_first_char(str)
+    new_str.downcase.tr('^aeiou', '')
+  end
+
+  def removing_first_char(str)
+    str[1..]
+  end
+end

data/lib/state.rb

@@ -0,0 +1,31 @@
+require 'base'
+
+class CurpGenerator::State < CurpGenerator::Base
+  include CurpGenerator::Catalogs
+
+  def initialize(birth_state)
+    @birth_state = parse_attribute(birth_state&.upcase)
+  end
+
+  def self.generate(birth_state)
+    new(birth_state).generate
+  end
+
+  def generate
+    invalid_params? ? error_message! : parsed_state
+  end
+
+  private
+
+  def invalid_params?
+    blank_string?(@birth_state)
+  end
+
+  def error_message!
+    raise InvalidCurpArgumentError, 'Missing birth state argument'
+  end
+
+  def parsed_state
+    STATES[@birth_state.upcase] || 'NE'
+  end
+end

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curp_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Juan Carlos Estebes
@@ -17,12 +17,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/base.rb
+- lib/birth_date.rb
 - lib/catalogs.rb
 - lib/curp.rb
 - lib/curp_generator.rb
-- lib/element.rb
-- lib/helpers.rb
-- lib/string_format.rb
+- lib/digit_verifier.rb
+- lib/gender.rb
+- lib/name.rb
+- lib/state.rb
 - lib/version.rb
 homepage: https://github.com/yotepresto-com/curp-generator
 licenses:
@@ -46,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Generates a mexican CURP given the information of a person

data/lib/element.rb

@@ -1,45 +0,0 @@
-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

@@ -1,41 +0,0 @@
-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

@@ -1,43 +0,0 @@
-# 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