titulo_eleitoral 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTExOGMzYWRmN2M0ZmUzYmEwOWRjZTY0NmNkODVhNTZiMGFhMGIyZg==
+  data.tar.gz: !binary |-
+    Y2FjYjFlMzQ0N2NkNGFjOWM3YjU4MjY0NWQ5NGQ4NzRiMTFlODI1ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    YTg1NGQwOWM3YjVjZGM2MjJjNzJhNjA1ODk0NDU3YjMyMzczMWIxMzY0ODQ3
+    MmQ1MTFhMDc3NGY2YWRhYzBjYjMwM2E1NzgzMGZhOTEyZWVmMDMzYWFjY2Yz
+    ZDIyZmUwYWEyNTZjN2FhNTljMGE1ODQ2NzVjZmMzNDhiZmI5ZWI=
+  data.tar.gz: !binary |-
+    ZWZmNTc5M2Y3YTc4YzJlYTQ1NTZlZTU5ZTI5NTVjZDJjOGE4OWJkNzFiNzJl
+    MzA4NTQ2MDFmYjAzYmNkNmFlMjYyZWJkODYwNmU0ZWMzOGRkZTRiZTdjMTNm
+    Zjc5Y2I1ODA5YmU2MDg3ZWFjM2MxZWFlZjFkOTA1Zjg2MDZkYzg=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - eduardodeoh@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in titulo-eleitoral.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eduardo de O. Hernandes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# TituloEleitoral
+
+[![Build Status](https://travis-ci.org/eduardodeoh/titulo_eleitoral.svg?branch=master)](https://travis-ci.org/eduardodeoh/titulo_eleitoral) [![Coverage Status](https://coveralls.io/repos/eduardodeoh/titulo_eleitoral/badge.png?branch=master)](https://coveralls.io/r/eduardodeoh/titulo_eleitoral?branch=master) [![Gem Version](https://badge.fury.io/rb/titulo_eleitoral.svg)](http://badge.fury.io/rb/titulo_eleitoral)
+
+Esta gem permite validar o número de inscrição presente no título eleitoral, de acordo com o artigo 12 da resolução número 21.538 do TSE, de 14/10/2003.
+
+## Instalação
+
+Adicione essa linha no arquivo Gemfile da sua aplicação:
+
+    gem 'titulo_eleitoral'
+
+E etão execute:
+
+    $ bundle
+
+Ou instale você mesmo:
+
+    $ gem install titulo_eleitoral
+
+## Uso
+
+A utilização é bem simples:
+
+```ruby
+# Para verificar se o número de inscrição é válido:
+TituloEleitoral.valido?('324542010232')
+
+# Para verificar a UF do número de inscrição:
+TituloEleitoral.uf('324542010232')
+
+# Para retornar uma instância da classe TituloEleitoral::NumeroInscricao:
+TituloEleitoral.numero_inscricao('324542010232')
+```
+
+## Contribuindo
+
+1. Faça um Fork
+2. Crie um branch para a nova funcionalidade (`git checkout -b minha-nova-funcionalidade`)
+3. Faça o commit de suas alterações  (`git commit -am 'Adicionada nova funcionalidade'`)
+4. Faça um push da sua nova funconalidade (`git push origin minha-nova-funcionalidade`)
+5. Submeta uma nova Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/titulo_eleitoral'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/titulo_eleitoral.rb

@@ -0,0 +1,16 @@
+require 'titulo_eleitoral/version'
+require 'titulo_eleitoral/numero_inscricao'
+
+module TituloEleitoral
+  def self.valido?(numero)
+    numero_inscricao(numero).valido?
+  end
+
+  def self.numero_inscricao(numero)
+    NumeroInscricao.new(numero)
+  end
+
+  def self.uf(numero)
+    numero_inscricao(numero).uf
+  end
+end

data/lib/titulo_eleitoral/constantes.rb

@@ -0,0 +1,39 @@
+module TituloEleitoral
+  MULTIPLICADORES_DV1 = [2, 3, 4, 5, 6, 7, 8, 9]
+  MULTIPLICADORES_DV2 = [7, 8, 9]
+
+  UFS = {
+      '01' => 'SP',
+      '02' => 'MG',
+      '03' => 'RJ',
+      '04' => 'RS',
+      '05' => 'BA',
+      '06' => 'PR',
+      '07' => 'CE',
+      '08' => 'PE',
+      '09' => 'SC',
+      '10' => 'GO',
+      '11' => 'MA',
+      '12' => 'PB',
+      '13' => 'PA',
+      '14' => 'ES',
+      '15' => 'PI',
+      '16' => 'RN',
+      '17' => 'AL',
+      '18' => 'MT',
+      '19' => 'MS',
+      '20' => 'DF',
+      '21' => 'SE',
+      '22' => 'AM',
+      '23' => 'RO',
+      '24' => 'AC',
+      '25' => 'AP',
+      '26' => 'RR',
+      '27' => 'TO',
+      '28' => 'Exterior(ZZ)'
+  }
+
+  MODULO = 11
+
+  NUMERO_DIGITOS = 12
+end

data/lib/titulo_eleitoral/numero_inscricao.rb

@@ -0,0 +1,87 @@
+require 'titulo_eleitoral/constantes'
+
+module TituloEleitoral
+  class NumeroInscricao
+    attr_reader :numero, :numero_original, :dv1, :dv2
+
+    #http://www.tse.jus.br/legislacao/codigo-eleitoral/normas-editadas-pelo-tse/resolucao-nb0-21.538-de-14-de-outubro-de-2003-brasilia-2013-df
+    #http://www.exceldoseujeito.com.br/2008/12/19/validar-cpf-cnpj-e-titulo-de-eleitor-parte-ii/
+    def initialize(numero)
+      @numero_original = divide_em_array(numero)
+      @numero = normaliza_quantidade_digitos(numero_original)
+      @dv1 = primeiro_digito_verificador
+      @dv2 = segundo_digito_verificador
+    end
+
+    def valido?
+      return false if numero_original.size > NUMERO_DIGITOS
+      digitos_verificadores == digitos_verificadores_calculados
+    end
+
+    def uf
+      UFS[digitos_uf] if uf_valida?
+    end
+
+    private
+      def primeiro_digito_verificador
+        #Somar a multiplicação dos 8 primeiros digitos, respectivamente, por [2,3,4,5,6,7,8,9] e após calcular módulo 11 desta soma
+        digitos = numero.take(8).map(&:to_i)
+        calcula_digito_verificador(digitos, MULTIPLICADORES_DV1)
+      end
+
+      def segundo_digito_verificador
+        #Somar a multiplicação dos digitos 9, 10 e DV1, respectivamente, por [7,8,9] e após calcular módulo 11 desta soma
+        digitos = numero[8,2].map(&:to_i) << dv1
+        calcula_digito_verificador(digitos, MULTIPLICADORES_DV2)
+      end
+
+      def calcula_digito_verificador(digitos, multiplicadores)
+        soma_multiplicacao = digitos.zip(multiplicadores).inject(0) { |resultado,(digito, multiplicador)| resultado + (digito * multiplicador) }
+        resto_divisao = soma_multiplicacao % MODULO
+        verifica_resto(resto_divisao)
+      end
+
+      def divide_em_array(numero)
+        case
+          when numero.is_a?(String) && numero.match(/\d$/)
+            numero.split('')
+          when numero.is_a?(Fixnum)
+            numero.to_s.split('')
+          else
+            []
+        end
+      end
+
+      def normaliza_quantidade_digitos(numero)
+        (numero.join.size == NUMERO_DIGITOS) ? numero : numero.join.rjust(NUMERO_DIGITOS, "0").split('')
+      end
+
+      def digitos_uf
+        numero[8,2].join
+      end
+
+      def digitos_verificadores
+        numero[10,2].join
+      end
+
+      def uf_valida?
+        uf = digitos_uf.to_i
+        uf >= 1 && uf <=28
+      end
+
+      def digitos_verificadores_calculados
+        dv1.to_s + dv2.to_s
+      end
+
+      def verifica_resto(resto_divisao)
+        case resto_divisao
+          when 10
+            0
+          when 0 || 1
+            1
+          else
+            resto_divisao
+        end
+      end
+  end
+end

data/lib/titulo_eleitoral/version.rb

@@ -0,0 +1,3 @@
+module TituloEleitoral
+  VERSION = "0.0.1"
+end

data/test/numero_inscricao_test.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+require_relative 'test_helper'
+
+describe TituloEleitoral::NumeroInscricao do
+
+  describe 'dado um número de inscrição válido com 12 dígitos' do
+    before do
+      @valor = 316820550159
+      @numero = TituloEleitoral::NumeroInscricao.new(@valor)
+    end
+
+    it 'deve ser válido' do
+      @numero.valido?.must_equal true
+    end
+
+    it 'deve retornar DV1' do
+      @numero.dv1.must_equal 5
+    end
+
+    it 'deve retornar DV2' do
+      @numero.dv2.must_equal 9
+    end
+
+    it 'deve retornar número original como array de strings' do
+      @numero.numero_original.must_be_instance_of Array
+    end
+
+    it 'deve retornar número como array de strings sem preenchimento de zeros à esquerda' do
+      teste = @valor.to_s.split('')
+      @numero.numero.must_equal teste
+    end
+
+    it 'deve retornar a UF do título' do
+      @numero.uf.wont_be_nil
+    end
+  end
+
+  describe 'dada uma string válida com 12 dígitos' do
+    before do
+      @valor2 = '316820550159'
+      @numero2 = TituloEleitoral::NumeroInscricao.new(@valor2)
+    end
+
+    it 'deve ser válido' do
+      @numero2.valido?.must_equal true
+    end
+  end
+
+  describe 'dado um número com menos de 12 dígitos' do
+    before do
+      @valor3 = 67735700132
+      @numero3 = TituloEleitoral::NumeroInscricao.new(@valor3)
+    end
+
+    it 'deve retornar número como array de strings com preenchimento de zeros à esquerda' do
+      teste = @valor3.to_s.split('').unshift('0')
+      @numero3.numero.must_equal teste
+    end
+  end
+
+  describe 'dada uma string com mais de 12 dígitos' do
+    before do
+      @valor4 = '0677357001321'
+      @numero4 = TituloEleitoral::NumeroInscricao.new(@valor4)
+    end
+
+    it 'número de inscrição deve ser inválido' do
+      @numero4.valido?.must_equal false
+    end
+  end
+
+  describe 'dada uma string com dígitos e letras' do
+    before do
+      @valor5 = '6773570013AB'
+      @numero5 = TituloEleitoral::NumeroInscricao.new(@valor5)
+    end
+
+    it 'número inscrição deve ser inválido' do
+      @numero5.valido?.must_equal false
+    end
+
+    it 'número original deve ser uma array vazio' do
+      @numero5.numero_original.must_equal []
+    end
+
+    it 'número deve ser um array preenchido com zeros' do
+      @numero5.numero.must_equal Array.new(12,'0')
+    end
+  end
+
+  describe 'dada uma string válida de 12 dígitos e dígitos da UF menores que 01 ou maiores que 28' do
+    it 'dígitos da UF menor que 01 retorna nil' do
+      numero = TituloEleitoral::NumeroInscricao.new('067735700032')
+      numero.uf.must_be_nil
+    end
+
+    it 'dígitos da UF maior que 28 retorna nil' do
+      numero = TituloEleitoral::NumeroInscricao.new('067735702932')
+      numero.uf.must_be_nil
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'titulo_eleitoral'
+require 'minitest/autorun'
+require 'minitest/pride'

data/test/version_test.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+
+describe TituloEleitoral do
+
+  it "must be defined" do
+    TituloEleitoral::VERSION.wont_be_nil
+  end
+
+end

data/titulo_eleitoral.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'titulo_eleitoral/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'titulo_eleitoral'
+  spec.version       = TituloEleitoral::VERSION
+  spec.authors       = ['Eduardo de O. Hernandes']
+  spec.email         = ['eduardodeoh@gmail.com']
+  spec.summary       = %q{Validação do número de inscrição do título eleitoral.}
+  spec.description   = %q{Valida o número de inscrição do título eleitoral conforme resolução 21.538 (14/10/2003) do TSE, artigo 12.}
+  spec.homepage      = 'https://github.com/eduardodeoh/titulo_eleitoral'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: titulo_eleitoral
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eduardo de O. Hernandes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Valida o número de inscrição do título eleitoral conforme resolução 21.538
+  (14/10/2003) do TSE, artigo 12.
+email:
+- eduardodeoh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/titulo_eleitoral.rb
+- lib/titulo_eleitoral/constantes.rb
+- lib/titulo_eleitoral/numero_inscricao.rb
+- lib/titulo_eleitoral/version.rb
+- test/numero_inscricao_test.rb
+- test/test_helper.rb
+- test/version_test.rb
+- titulo_eleitoral.gemspec
+homepage: https://github.com/eduardodeoh/titulo_eleitoral
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Validação do número de inscrição do título eleitoral.
+test_files:
+- test/numero_inscricao_test.rb
+- test/test_helper.rb
+- test/version_test.rb