id_ecuador 0.0.1.alpha → 0.0.1.beta

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## v0.0.1.alpha
+
+*Versión inicial*
+
+* La clase **IdEcuador::Id** valida cédulas, RUCs
+
+## v0.0.1.beta
+
+* Agregado `IdEcuador.new` como alias de `IdEcuador::Id.new`
+* Verificando que cuando un modelo en rails utiliza el validador, no se vuelva a instanciar otro validador a menos que la identificación (atributo) del mismo cambie.
+* Agregado `factory_girl` para testing
+* Tests refactored

data/README.md

@@ -1,8 +1,12 @@
 # IdEcuador
-[![Build Status](https://travis-ci.org/macool/id_ecuador.png?branch=master)](https://travis-ci.org/macool/id_ecuador)
 
 Gema para validar la cédula o ruc de Ecuador
 
+## Status
+
+[![Build Status](https://travis-ci.org/macool/id_ecuador.png?branch=master)](https://travis-ci.org/macool/id_ecuador)
+[![Gem Version](https://badge.fury.io/rb/id_ecuador.png)](http://badge.fury.io/rb/id_ecuador)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,44 +23,58 @@ Or install it yourself as:
 
 ## Usage
 
-  ```ruby
-  cedula = IdEcuador::Id.new "1104680135"
-  cedula.valid?           # => true
-  cedula.tipo_id          # => "Cédula Persona natural"
-  cedula.codigo_provincia # => 11
+```ruby
+require "id_ecuador"
+
+cedula = IdEcuador::Id.new "1104680135"
+cedula.valid?           # => true
+cedula.tipo_id          # => "Cédula Persona natural"
+cedula.codigo_provincia # => 11
 
-  cedula_invalida = IdEcuador::Id.new "1105680134"
-  cedula_invalida.errors # => ["ID inválida"]
-  ```
+cedula_invalida = IdEcuador::Id.new "1105680134"
+cedula_invalida.errors # => ["ID inválida"]
+```
 
 No validar automáticamente:
-  ```ruby
-  cedula = IdEcuador::Id.new "1104680135", auto_validate: false
-  cedula.validate!.valid?
-  ```
+
+```ruby
+cedula = IdEcuador::Id.new "1104680135", auto_validate: false
+cedula.validate!.valid?
+```
 
 ## Rails
 
-  ```ruby
-  class User < ActiveRecord::Base
-    validates_id :identificacion
-  end
-  ```
+```ruby
+class User < ActiveRecord::Base
+  validates_id :identificacion
+end
+```
 
 Con opciones:
-  ```ruby
-  class User < ActiveRecord::Base
-    validates_id :identificacion, allow_blank: false, message: "Cédula inválida", only: [:cedula, :ruc]
-  end
-  ```
+
+```ruby
+class User < ActiveRecord::Base
+  validates_id :identificacion, allow_blank: false, message: "Cédula inválida", only: [:cedula, :ruc]
+end
+```
 
 Ejemplo API Rails:
-  ```ruby
-  user = User.new identificacion: "110468135001"
-  user.identificacion_id_validator.class # => IdEcuador::Id
-  user.identificacion_tipo_id            # => "RUC Persona natural"
-  user.identificacion_codigo_provincia   # => 11
-  ```
+
+```ruby
+user = User.new identificacion: "110468135001"
+user.identificacion_id_validator.class # => IdEcuador::Id
+user.identificacion_tipo_id            # => "RUC Persona natural"
+user.identificacion_codigo_provincia   # => 11
+```
+
+## Documentación
+
+[rubydoc](http://rubydoc.info/github/macool/id_ecuador/master/frames)
+
+## TODO
+
+- [ ] Documentar
+- [ ] Escribir la documentación en un solo idioma
 
 ## Contributing
 

data/id_ecuador.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "supermodel"
+  spec.add_development_dependency "factory_girl"
 
 end

data/lib/id_ecuador.rb

@@ -3,6 +3,23 @@ require "id_ecuador/id"
 require "id_ecuador/model_additions"
 require "id_ecuador/railtie" if defined? Rails
 
+# Este módulo debe servir como <em>namespace</em>
+#
+# @author macool <a@macool.me>
+#
+# Contiene:
+# Clases:
+# * <tt>Id</tt>
+#
+# Módulos:
+# * <tt>ModelAdditions</tt>
+# * <tt>Railtie</tt>
 module IdEcuador
-  # Your code goes here...
+
+  # Alias al método #new de la clase IdEcuador::Id
+  # @example Instanciar ID
+  #   IdEcuador.new("1104680135").class #=> IdEcuador::Id
+  def self.new(*args)
+    IdEcuador::Id.new(*args)
+  end
 end

data/lib/id_ecuador/id.rb

@@ -1,10 +1,30 @@
 # encoding: utf-8
 
 module IdEcuador
+  # Clase que va a analizar la cédula. Recibe un id y unas opciones
+  # @attr_reader [Array] errors Los errores que tiene el ID. Array vacío si es un ID válido
+  #
+  # @attr_reader [String] tipo_id El tipo de identificación. Puede ser:
+  #   - "Cédula Persona natural"
+  #   - "RUC Persona natural"
+  #   - "Sociedad pública"
+  #   - "Sociedad privada o extranjera"
+  #
+  # @attr_reader [Fixnum] codigo_provincia El código de la provincia del ID ingresado
+  #
+  # @attr_reader [Symbol] tipo_id_sym El tipo de identificación en símbolo. Puede ser:
+  #   - :ruc
+  #   - :cedula
+  #   - :sociedad_publica
+  #   - :sociedad_privada
+  #
   class Id
     
     attr_reader :errors, :tipo_id, :codigo_provincia, :tipo_id_sym
     
+    # @param [String] id El ID que se va a analizar
+    # @param [Hash] options Las opciones
+    # @option options [Boolean] :auto_validate Validar automáticamente el ID al instanciar. <tt>true</tt> por defecto
     def initialize(id="", options={})
       @id = id.to_s
       @errors = []
@@ -15,15 +35,21 @@ module IdEcuador
       @options = defaults.merge options
       validate! if @options[:auto_validate]
     end
+
+    # @return [Boolean] Si es un ID válido o no
     def valid?
       validate! unless already_validated
       @errors.empty?
     end
+
+    # @return [self] Método que valida
     def validate!
       @already_validated = true
       validate_length and evaluate_province_code and evaluate_third_digit
       self
     end
+
+    # @return [Boolean] Si el ID ya ha sido validado
     def already_validated
       !!@already_validated
     end

data/lib/id_ecuador/model_additions.rb

@@ -1,20 +1,32 @@
 # encoding: utf-8
 
 module IdEcuador
+  # Módulo que agrega funcionalidad a los modelos de Rails
+  # Permite llamar a <tt>validates_id</tt> dentro de un modelo de Rails
   module ModelAdditions
+
+    # @param [Symbol] attribute Atributo que va a validar IdEcuador::Id
+    # @param [Hash] options Opciones para la validación
+    # @option options [Boolean] :allow_blank Poner (o no) errores si el atributo es nulo
+    # @option options [String] :message Mensaje de error que se va a poner en el atributo
+    # @option options [Array] :only Tipos de ID que se va a permitir: <tt>[:cedula, :ruc, :sociedad_publica, :sociedad_privada]</tt>
     def validates_id(attribute, options={})
-      # options for only: [:cedula, :ruc, :sociedad_publica, :sociedad_privada]
+
+      # parse options:
       defaults = {
         allow_blank: true,
         message: nil,
         only: []
       }
+      # options for :only: [:cedula, :ruc, :sociedad_publica, :sociedad_privada]
       options = defaults.merge options
 
-      # to array if not:
+      # transform options[:only] to array if it's not:
       unless options[:only].class == Array
         options[:only] = [options[:only]]
       end
+
+
       # poner métodos:
 
       # getter del atributo que siempre retorna una instancia de IdEcuador::Id y se encarga de hacer cache basado en el valor del atributo
@@ -38,15 +50,19 @@ module IdEcuador
         end
       EVAL
 
+      # método de validación
       validate do
+        # Agregar error si <tt>allow_blank</tt> es <tt>false</tt> y <tt>attribute</tt> está en blanco
         if not options[:allow_blank] and send(:"#{attribute}").blank?
           errors.add attribute.to_sym, (options[:message] or "No puede quedar en blanco")
         else
           # normal validations:
           if not send(:"#{attribute}").blank? and not send(:"#{attribute}_id_validator").valid?
             if options[:message]
+              # poner <tt>options[:message]</tt> si algo está mal
               errors.add attribute.to_sym, options[:message]
             else
+              # poner los mensajes por defecto si no hay un <tt>options[:message]</tt>
               send(:"#{attribute}_id_validator").errors.each do |error|
                 errors.add attribute.to_sym, error
               end
@@ -55,6 +71,7 @@ module IdEcuador
           # for options:
           unless options[:only].empty?
             unless options[:only].include?(send(:"#{attribute}_id_validator").tipo_id_sym)
+              # si está especificado <tt>options[:only]</tt>, validar que el tipo de ID esté permitido
               errors.add attribute.to_sym, (options[:message] or "Tipo de identificación no permitido")
             end
           end

data/lib/id_ecuador/railtie.rb

@@ -1,4 +1,5 @@
 module IdEcuador
+  # extend <tt>IdEcuador::ModelAdditions</tt> module into Rails' <tt>ActiveRecord::Base</tt>
   class Railtie < Rails::Railtie
     intializer 'id_ecuador.model_additions' do
       ActiveSupport.on_load :active_record do

data/lib/id_ecuador/version.rb

@@ -1,3 +1,3 @@
 module IdEcuador
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.0.1.beta"
 end

data/spec/factories.rb

@@ -0,0 +1,17 @@
+require "factory_girl"
+
+CEDULA_VALIDA = "1104680135"
+CEDULA_INVALIDA = "1104680134"
+RUC_VALIDO = "1104680135001"
+
+FactoryGirl.define do
+  factory :user do
+    identificacion CEDULA_VALIDA
+  end
+  factory :user_invalid, class: "User" do
+    identificacion CEDULA_INVALIDA
+  end
+  factory :user_ruc, class: "User" do
+    identificacion RUC_VALIDO
+  end
+end

data/spec/id_ecuador/id_spec.rb

@@ -5,12 +5,12 @@ describe IdEcuador::Id do
   
   describe "interfaz de la clase" do
     it "debe llamar automáticamente al método validate!" do
-      id = IdEcuador::Id.new("1104680135")
+      id = IdEcuador::Id.new CEDULA_VALIDA
       id.send(:already_validated).should be_true
     end
     it "no debe llamar automáticamente al método validate!" do
       IdEcuador::Id.any_instance.stub(:validate!)
-      id = IdEcuador::Id.new("1104680135", validate: false)
+      id = IdEcuador::Id.new CEDULA_VALIDA, validate: false
       id.send(:already_validated).should be_false
     end
   end
@@ -27,11 +27,11 @@ describe IdEcuador::Id do
         id.errors.should include(@error)
       end
       it "no debería incluir problemas de longitud con 10 caracteres" do
-        id = IdEcuador::Id.new "1104680135"
+        id = IdEcuador::Id.new CEDULA_VALIDA
         id.errors.should_not include(@error)
       end
       it "no debería incluir problemas de longitud con 13 caracteres" do
-        id = IdEcuador::Id.new "1104680135001"
+        id = IdEcuador::Id.new RUC_VALIDO
         id.errors.should_not include(@error)
       end
       it "debería fallar con longitud mayor a 13 caracteres" do
@@ -47,7 +47,7 @@ describe IdEcuador::Id do
         id.errors.should include("Código de provincia incorrecto")
       end
       it "debería decir que el código de la provincia es 11" do
-        id = IdEcuador::Id.new "1104680135"
+        id = IdEcuador::Id.new CEDULA_VALIDA
         id.codigo_provincia.should eq(11)
       end
     end
@@ -74,11 +74,11 @@ describe IdEcuador::Id do
       #   6    -> sociedades públicas
       #   0..5 -> personas naturales
       it "debería decir que es una persona natural" do
-        id = IdEcuador::Id.new "1104680135"
+        id = IdEcuador::Id.new CEDULA_VALIDA
         id.tipo_id.should eq("Cédula Persona natural")
       end
       it "debería decir que es el RUC de una persona natural" do
-        id = IdEcuador::Id.new "1104680135001"
+        id = IdEcuador::Id.new RUC_VALIDO
         id.tipo_id.should eq("RUC Persona natural")
       end
       it "debería decir que es una sociedad pública" do
@@ -93,10 +93,10 @@ describe IdEcuador::Id do
   
     describe "probar con algunas cédulas" do
       it "debería decir que esta cédula es válida" do
-        IdEcuador::Id.new("1104680135").valid?.should be_true
+        IdEcuador::Id.new(CEDULA_VALIDA).valid?.should be_true
       end
       it "debería decir que esta cédula es inválida" do
-        IdEcuador::Id.new("1104680134").valid?.should be_false
+        IdEcuador::Id.new(CEDULA_INVALIDA).valid?.should be_false
       end
       it "debería decir que estas cédulas son válidas" do
         ["1104077209",

data/spec/id_ecuador/model_additions_spec.rb

@@ -16,12 +16,32 @@ describe IdEcuador::ModelAdditions do
       user.save.should be_true
     end
 
+    describe "cache on #attribute_id_validator" do
+      it "debería decir que el id del objeto que retorna el método es el mismo mientras la identificación no cambie" do
+        user = FactoryGirl.build :user
+        id = user.identificacion_id_validator.object_id
+        user.identificacion_id_validator.object_id.should eq(id)
+      end
+      it "no debería expirar el caché si se reasigna el mismo ID" do
+        user = FactoryGirl.build :user
+        id = user.identificacion_id_validator.object_id
+        user.identificacion = FactoryGirl.attributes_for(:user)[:identificacion]
+        user.identificacion_id_validator.object_id.should eq(id)
+      end
+      it "debería expirar el caché si se reasigna otro ID" do
+        user = FactoryGirl.build :user
+        id = user.identificacion_id_validator.object_id
+        user.identificacion = FactoryGirl.attributes_for(:user_invalid)[:identificacion]
+        user.identificacion_id_validator.object_id.should_not eq(id)
+      end
+    end
+
     describe "valida el ID de un usuario antes de guardarlo a la base de datos" do
       it "debería decir que es válido" do
-        User.new(identificacion: "1104680135").valid?.should be_true
+        FactoryGirl.build(:user).valid?.should be_true
       end
       it "debería decir que es inválido" do
-        user = User.new(identificacion: "1104680134")
+        user = FactoryGirl.build(:user_invalid)
         user.save.should be_false
         user.errors[:identificacion].should include("ID inválida")
       end
@@ -52,12 +72,12 @@ describe IdEcuador::ModelAdditions do
 
     describe "debe agregar métodos al atributo" do
       it "debe agregar método `identificacion_tipo_id`" do
-        user = User.new(identificacion: "1104680135")
+        user = FactoryGirl.build(:user)
         user.respond_to?(:identificacion_tipo_id).should be_true
         user.identificacion_tipo_id.should eq("Cédula Persona natural")
       end
       it "debe agregar método `identificacion_codigo_provincia`" do
-        user = User.new(identificacion: "1104680135")
+        user = FactoryGirl.build(:user)
         user.respond_to?(:identificacion_codigo_provincia).should be_true
         user.identificacion_codigo_provincia.should eq(11)
       end
@@ -77,6 +97,7 @@ describe IdEcuador::ModelAdditions do
         user.errors[:identificacion].should include("No puede quedar en blanco")
       end
     end
+
     describe "specify message" do
       class UserWithOptionsMessage < SuperModel::Base
         extend IdEcuador::ModelAdditions
@@ -89,7 +110,7 @@ describe IdEcuador::ModelAdditions do
         user.errors[:identificacion].should eq(["Not valid!"])
       end
       it "debería mostrar 'Not valid!' como error con cédula" do
-        user = UserWithOptionsMessage.new identificacion: "1104680134"
+        user = UserWithOptionsMessage.new FactoryGirl.attributes_for(:user_invalid)
         user.valid?.should be_false
         user.errors[:identificacion].should eq(["Not valid!"])
       end
@@ -102,11 +123,11 @@ describe IdEcuador::ModelAdditions do
         end
 
         it "debería decir que es válido" do
-          user = UserWithOptionsOnlyCedula.new identificacion: "1104680135"
+          user = UserWithOptionsOnlyCedula.new FactoryGirl.attributes_for(:user)
           user.valid?.should be_true
         end
         it "debería decir que es inválido" do
-          user = UserWithOptionsOnlyCedula.new identificacion: "1104680135001"
+          user = UserWithOptionsOnlyCedula.new FactoryGirl.attributes_for(:user_ruc)
           user.valid?.should be_false
           user.errors[:identificacion].should include("Tipo de identificación no permitido")
         end
@@ -117,11 +138,11 @@ describe IdEcuador::ModelAdditions do
           validates_id :identificacion, only: :ruc
         end
         it "debería decir que es válido" do
-          user = UserWithOptionsOnlyRUC.new identificacion: "1104680135001"
+          user = UserWithOptionsOnlyRUC.new FactoryGirl.attributes_for(:user_ruc)
           user.valid?.should be_true
         end
         it "debería decir que es inválido" do
-          user = UserWithOptionsOnlyRUC.new identificacion: "1104680135"
+          user = UserWithOptionsOnlyRUC.new FactoryGirl.attributes_for(:user)
           user.valid?.should be_false
           user.errors[:identificacion].should include("Tipo de identificación no permitido")
         end

data/spec/id_ecuador_spec.rb

@@ -2,5 +2,8 @@
 require "spec_helper"
 
 describe IdEcuador do
-
+  it "should alias IdEcuador#new to IdEcuador::Id#new" do
+    id = IdEcuador.new CEDULA_VALIDA
+    id.class.should eq(IdEcuador::Id)
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 # encoding: utf-8
 require "id_ecuador"
 require "supermodel"
+require "factories"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: id_ecuador
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.1.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Validate Ecuador's CI and RUC
 email:
 - a@macool.me
@@ -84,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,6 +111,7 @@ files:
 - lib/id_ecuador/model_additions.rb
 - lib/id_ecuador/railtie.rb
 - lib/id_ecuador/version.rb
+- spec/factories.rb
 - spec/id_ecuador/id_spec.rb
 - spec/id_ecuador/model_additions_spec.rb
 - spec/id_ecuador_spec.rb
@@ -124,6 +142,7 @@ signing_key:
 specification_version: 3
 summary: Gem to validate Ecuador's CI and RUC
 test_files:
+- spec/factories.rb
 - spec/id_ecuador/id_spec.rb
 - spec/id_ecuador/model_additions_spec.rb
 - spec/id_ecuador_spec.rb