identificamex 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7582ffcdc522742b30de845539e2b75aa9f7207
-  data.tar.gz: 5a9c321686aa075703734e80f55fc84fc1c4e03a
+  metadata.gz: 65fa3e6fd8638d2aa972815f35ed94ba3df0424b
+  data.tar.gz: 71497ea86147ae06abeaf84624dc081557771612
 SHA512:
-  metadata.gz: bca3b17490e14c1572ec2d57ef673eb265632ffeae0171f80bf63f453523d1d608914a68042ba40e455ea6ecbd362f730f7cff50bc5e38930faa79bdcf1a7891
-  data.tar.gz: b2e09aa117afd8f48254b4afe182a4e516e833c73b8c1517336463059a8e4c5baae0224066706feb8db054b2fb7fa06817f0a4a9250548811b593d13fae99748
+  metadata.gz: 56f512d4a89955f1b52e70a561f54463815a705e257fd60401a2f91515fdb5a03ce71426c3a23bcfc5133b8f88cb9a41c28b561a5f14f9f170b3c32759dd9088
+  data.tar.gz: c9896b42a2261fd5bd3bfc3ed4a1913fe8f2fe91807ebe2227de77c59246995d026551d27aef551afc3ade2c9f324e1e9d702ba8de3e296e91a1691e7b846abf

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/README.md

@@ -1,7 +1,14 @@
+[![Build Status](https://travis-ci.org/LogicalBricks/identificamex.png)](https://travis-ci.org/LogicalBricks/identificamex)
+
+
 # Identificamex
 
-Gema con validadores para los formatos de la Clave Única de Registro de Población (CURP) y el Registro Federal de Contribuyentes (RFC) utilizados en México.
-Los validadores se integran con el mecanismo que implementa ActiveModel para el resto de validadores de Rails.
+Gema con validadores para los formatos de la Clave Única de Registro de
+Población (CURP) y el Registro Federal de Contribuyentes (RFC) utilizados en
+México.
+
+Los validadores se integran con el mecanismo que implementa ActiveModel
+para el resto de validadores de Rails.
 
 ## Instalación
 
@@ -21,14 +28,49 @@ O instálala por ti mismo de esta manera:
 
 Agrega las validaciones de formato a los campos correspondientes.
 
-
 ```ruby
-class Employee < ActiveRecor::Base
+class Employee < ActiveRecord::Base
   validates :curp, presence: true, curp_format: true
-  validates :rfc, rfc_format: true, allow_blank: true
+  validates :rfc, rfc_format: { force_homoclave: true }, allow_blank: true
 end
 ```
 
+### valid_rfc?
+
+En el caso del RFC, es posible verificar no sólo el formato sino también el
+contenido. Para esto, se debe utilizar el método `valid_rfc?`. Este método se
+encuentra en el módulo `Identificamex::Methods` y no se agrega
+automáticamente a la base de ActiveRecord o ActiveModel, por lo que es
+necesario agregarlo manualmente.
+
+```ruby
+class Employee < ActiveRecord::Base
+
+  include Identificamex::Methods
+
+  def un_metodo
+    valid_rfc? 'BAFJ701213SBA', nombre: 'Juan',
+                                primer_apellido: 'Barrios',
+                                segundo_apellido: 'Fernández',
+                                fecha_nacimiento: Date.new(1970, 12, 13)
+
+    valid_rfc? 'APB830305QS6', razon_social: 'U.S. Ruber Mexicana, S.A.',
+                               fecha_creacion: Date.new(1983, 03, 05)
+  end
+end
+```
+
+NOTA: _Esta versión todavía no valida correctamente el RFC de personas
+morales que incluyan números o caracteres especiales en su razón social.
+Por ejemplo: 'Cyber @ SA de CV', 'Cooperativa 5 de mayo SC',
+'Estudio Siglo XXI SA'. Es una funcionalidad que se piensa incluir
+posteriormente, al igual que la generación de la CURP_
+
+El método `valid_rfc?` es auxiliar y ha funcionado con los casos que he
+probado, pero no hay garantía que funcione en todos los casos, así que debe
+usarse con precaución. Si detectas algún caso en el que no funciona, agrega
+un _issue_ para corregirlo.
+
 ## Contribución
 
 1. Haz un fork de este repositorio

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'lib/identificamex'
-  t.test_files = FileList['test/identificamex/*_test.rb']
+  t.test_files = FileList['test/identificamex/**/*_test.rb']
 end
 
 task :default => :test

data/lib/identificamex.rb

@@ -2,7 +2,32 @@ require 'active_model'
 require_relative "identificamex/version"
 require_relative "curp_format_validator"
 require_relative "rfc_format_validator"
+require_relative "identificamex/rfc/rfc_generator"
 
 module Identificamex
-  # Your code goes here...
+  module Methods
+
+    # Valida si un RFC está correctamente formado. Recibe como parámetros el
+    # RFC a comparar y la razón social y fecha de creación (en caso de ser
+    # persona moral) o el nombre, primer apellido, segundo apellido y fecha
+    # de nacimiento (en caso de ser persona física).
+    #
+    # Ejemplos:
+    #
+    #     params = { razon_social: 'Sonora Industrial Azucarera, S. de R.L',
+    #                fecha_creacion:  Date.new(1983, 03, 05) }
+    #     valid_rfc? 'SIA8303054L5', params
+    #     # => true
+    #
+    #     params = { nombre: 'Juan',
+    #                primer_apellido:  'Barrios',
+    #                segundo_apellido: 'Fernández',
+    #                fecha_nacimiento:  Date.new(1970, 12, 13) }
+    #     valid_rfc? 'BAFJ701213SBA', params
+    #     # => true
+    #
+    def valid_rfc?(rfc, options)
+      ::Identificamex::Rfc::RfcGenerator.new(options).rfc == rfc
+    end
+  end
 end

data/lib/identificamex/nombre/mayusculas.rb

@@ -0,0 +1,35 @@
+module Identificamex
+  module Nombre
+
+    module Mayusculas
+      def mayusculas(str)
+        return if str.nil?
+        str
+        .gsub(/[ÁÉÍÓÚÜáéíóúü]/, hash_vocales)
+        .upcase
+        .gsub(/ñ/, 'Ñ')
+        .gsub(/,/, '')
+        .gsub(/'/, '')
+        .gsub(/\./, ' ')
+        .squeeze(' ')
+        .strip
+      end
+
+      def hash_vocales
+        @hash_vocales ||= {'á' => 'a',
+                           'é' => 'e',
+                           'í' => 'i',
+                           'ó' => 'o',
+                           'ú' => 'u',
+                           'ü' => 'u',
+                           'Á' => 'A',
+                           'É' => 'E',
+                           'Í' => 'I',
+                           'Ó' => 'O',
+                           'Ú' => 'U',
+                           'Ü' => 'U'}
+      end
+    end
+
+  end
+end

data/lib/identificamex/nombre/nombre_completo.rb

@@ -0,0 +1,96 @@
+require_relative 'normalizador_nombre'
+require_relative 'normalizador_apellido'
+require_relative 'palabra_inconveniente'
+
+module Identificamex
+  module Nombre
+    class NombreCompleto
+      include Mayusculas
+
+      def initialize(params)
+        @nombre                        = mayusculas(params[:nombre])
+        @primer_apellido               = mayusculas(params[:primer_apellido])
+        @segundo_apellido              = mayusculas(params[:segundo_apellido])
+        @nombre_simplificado           = normalizar_nombre(@nombre)
+        @primer_apellido_simplificado  = normalizar_apellido(@primer_apellido)
+        @segundo_apellido_simplificado = normalizar_apellido(@segundo_apellido)
+      end
+
+      def siglas
+        @siglas ||= PalabraInconveniente.convertir(extraer_siglas)
+      end
+
+      def to_s
+        "#{@primer_apellido} #{@segundo_apellido} #{@nombre}"
+      end
+
+      #=====================
+      private
+      #=====================
+
+      def normalizar_nombre(nombre)
+        NormalizadorNombre.new(nombre).normalizar if nombre
+      end
+
+      def normalizar_apellido(apellido)
+        NormalizadorApellido.new(apellido).normalizar if apellido
+      end
+
+      def extraer_siglas
+        if siglas_apellidos_completa?
+          siglas_apellidos + primera_letra_nombre
+        else
+          siglas_apellidos + primeras_dos_letras_nombre
+        end
+      end
+
+      def siglas_apellidos
+        @siglas_apellidos ||= generar_siglas_apellidos
+      end
+
+      def siglas_apellidos_completa?
+        siglas_apellidos.length == 3
+      end
+
+      def generar_siglas_apellidos
+        return @segundo_apellido_simplificado[0, 2] if sin_primer_apellido?
+        return @primer_apellido_simplificado[0, 2] if sin_segundo_apellido?
+        primera_letra_primer_apellido +
+          primera_vocal_interna_primer_apellido.to_s +
+          primera_letra_segundo_apellido
+      end
+
+      def sin_primer_apellido?
+        @primer_apellido_simplificado.nil?
+      end
+
+      def sin_segundo_apellido?
+        @segundo_apellido_simplificado.nil?
+      end
+
+      def primera_letra_primer_apellido
+        @primer_apellido_simplificado[0] if @primer_apellido_simplificado.present?
+      end
+
+      def primera_vocal_interna_primer_apellido
+        return unless @primer_apellido_simplificado.present?
+        apellido = @primer_apellido_simplificado[1..-1]
+        posicion_primera_vocal = apellido =~ /[AEIOU]/
+        apellido[posicion_primera_vocal] if posicion_primera_vocal
+      end
+
+      def primera_letra_segundo_apellido
+        @segundo_apellido_simplificado[0] if @segundo_apellido_simplificado.present?
+      end
+
+      def primera_letra_nombre
+        @nombre_simplificado[0] if @nombre_simplificado.present?
+      end
+
+      def primeras_dos_letras_nombre
+        @nombre_simplificado[0, 2] if @nombre_simplificado.present?
+      end
+
+    end
+  end
+end

data/lib/identificamex/nombre/normalizador_apellido.rb

@@ -0,0 +1,30 @@
+require_relative 'normalizador_cadena'
+
+module Identificamex
+  module Nombre
+
+    # Clase que hereda de `NormalizadorCadena` y define los nombres a ignorar
+    # como `%w[DE LA DEL LOS]` que son los únicos que se ignoran para los
+    # apellidos.
+    #
+    # Ejemplo:
+    #
+    #     NormalizadorApellido.new('De la Rosa').normalizar
+    #     # => ROSA
+    #
+    #     NormalizadorApellido.new('Del Toro').normalizar
+    #     # => TORO
+    #
+    #     NormalizadorApellido.new('Pérez').normalizar
+    #     # => PEREZ
+    class NormalizadorApellido < NormalizadorCadena
+
+      private
+
+      def nombres_ignorados
+        %w[DE LA DEL LOS Y]
+      end
+
+    end
+  end
+end

data/lib/identificamex/nombre/normalizador_cadena.rb

@@ -0,0 +1,47 @@
+require_relative 'mayusculas'
+
+module Identificamex
+  module Nombre
+
+    # Clase base para normalizar las cadenas de nombres y apellidos. La clase
+    # se encarga de convertir a mayúsculas las cadenas y recorre los nombres para
+    # descartar los nombres ignorados.
+    #
+    # Los nombres ignorados deben ser provistos por las clases que hereden.
+    class NormalizadorCadena
+
+      include Mayusculas
+
+      def initialize(nombre)
+        @nombre = mayusculas(nombre)
+      end
+
+      def normalizar
+        nombre_aceptado || primer_nombre
+      end
+
+      private
+
+      def nombre_aceptado
+        nombres.find{|nombre| no_ignorado?(nombre) } if nombres.count > 1
+      end
+
+      def no_ignorado?(nombre)
+        !nombres_ignorados.member?(nombre)
+      end
+
+      def primer_nombre
+        nombres.first
+      end
+
+      def nombres_ignorados
+        raise NotImplementedError
+      end
+
+      def nombres
+        @nombres ||= @nombre.split
+      end
+
+    end
+  end
+end

data/lib/identificamex/nombre/normalizador_nombre.rb

@@ -0,0 +1,42 @@
+require_relative 'normalizador_cadena'
+
+module Identificamex
+  module Nombre
+
+    # Clase que hereda de `NormalizadorCadena` y define los nombres a ignorar
+    # como `%w[JOSE MARIA DE LA DEL LOS]` que son los que se ignoran para los
+    # nombres.
+    #
+    # Ejemplo:
+    #
+    #     NormalizadorNombre.new('María del Carmen').normalizar
+    #     # => CARMEN
+    #
+    #     NormalizadorNombre.new('José Mario').normalizar
+    #     # => MARIO
+    #
+    #     NormalizadorNombre.new('María de los Ángeles').normalizar
+    #     # => ANGELES
+    #
+    #     NormalizadorNombre.new('José de Jesús').normalizar
+    #     # => JESUS
+    #
+    #     NormalizadorNombre.new('María').normalizar
+    #     # => MARIA
+    #
+    #     NormalizadorNombre.new('José Mario').normalizar
+    #     # => MARIO
+    #
+    #     NormalizadorNombre.new('José').normalizar
+    #     # => JOSE
+    class NormalizadorNombre < NormalizadorCadena
+
+      private
+
+      def nombres_ignorados
+        %w[JOSE MARIA DE LA DEL LOS]
+      end
+
+    end
+  end
+end

data/lib/identificamex/nombre/palabra_inconveniente.rb

@@ -0,0 +1,55 @@
+module Identificamex
+  module Nombre
+
+    class PalabraInconveniente
+      def self.convertir(palabra)
+        hash_palabras[palabra] || palabra
+      end
+
+      def self.hash_palabras
+        @hash_palabras ||= {
+          'BUEI' => 'BUEX',
+          'BUEY' => 'BUEX',
+          'CACA' => 'CACX',
+          'CACO' => 'CACX',
+          'CAGA' => 'CAGX',
+          'CAGO' => 'CAGX',
+          'CAKA' => 'CAKX',
+          'COGE' => 'COGX',
+          'COJA' => 'COJX',
+          'COJE' => 'COJX',
+          'COJI' => 'COJX',
+          'COJO' => 'COJX',
+          'CULO' => 'CULX',
+          'FETO' => 'FETX',
+          'GUEY' => 'GUEX',
+          'JOTO' => 'JOTX',
+          'KACA' => 'KACX',
+          'KACO' => 'KACX',
+          'KAGA' => 'KAGX',
+          'KAGO' => 'KAGX',
+          'KOGE' => 'KOGX',
+          'KOJO' => 'KOJX',
+          'KAKA' => 'KAKX',
+          'KULO' => 'KULX',
+          'MAME' => 'MAMX',
+          'MAMO' => 'MAMX',
+          'MEAR' => 'MEAX',
+          'MEON' => 'MEOX',
+          'MION' => 'MIOX',
+          'MOCO' => 'MOCX',
+          'MULA' => 'MULX',
+          'PEDA' => 'PEDX',
+          'PEDO' => 'PEDX',
+          'PENE' => 'PENX',
+          'PUTA' => 'PUTX',
+          'PUTO' => 'PUTX',
+          'QULO' => 'QULX',
+          'RATA' => 'RATX',
+          'RUIN' => 'RUIX'
+        }
+      end
+    end
+
+  end
+end