cpf_utils 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0d2d6965f5f52f0e68ff55f132eb61320ff2ba0
+  data.tar.gz: 86de60cc7567d557c4d2b046d6263d38cf5ae683
+SHA512:
+  metadata.gz: e29b9ae14c7b1bd6de47566e40b05f381be364cc2711f17c59967a7b8d3bd1c8f8fbf4a9b05536609d4304ac20b01c5eef072857b6c3bdb17b89f2290aff08fb
+  data.tar.gz: 05f06aaea9eb8c9b80c090407523b1a73b6d996c969687d8127d87ced37d5adb95670f008f646de65db77446a9b770bb3104a6057cf1e4d72377064e30c1626b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jackson Pires
+
+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,58 @@
+# CpfUtils
+
+CpfUtils é uma suite de funcionalidades para CPF.
+O CpfUtils é capaz de gerar CPF para testes no formado tradicional ou apenas numérico, testa se determinado número de CPF é válido, gera dígitos verificadores para determinado número candidato a CPF, dentre outras coisas.
+
+## Instalação
+
+Adicione essa linha na Gemfile da sua aplicação:
+
+    gem 'cpf_utils'
+
+E então execute:
+
+    $ bundle
+
+Ou instale você mesmo, conforme abaixo:
+
+    $ gem install cpf_utils
+
+## Uso
+
+O CpfUtils é muito fácil de usar, por exempo:
+
+    # Para gerar um número de CPF:
+    CpfUtils.cpf => # "45698394823"
+
+    # Para gerar um CPF formatado:
+    CpfUtils.cpf_formatted => # "456.983.948-23"
+
+    # Para verificar se um CPF é válido:
+    CpfUtils.valid_cpf?("47238051923") => # true
+    CpfUtils.valid_cpf?(47238051923) => # true
+    CpfUtils.valid_cpf?("472.380.519-23") => # true
+
+    # Outra forma de verificar se um CPF é válido:
+    "45698394823".valid_cpf? => # true
+    "456.983.948-23".valid_cpf? => # true
+
+    # Para verificar se uma máscara de CPF é válida:
+    "456.983.948-23".valid_cpf_mask? => # true
+    "456.983..948-23".valid_cpf_mask? => # false
+
+    # Para formatar um número válido de CPF:
+    "45698394823".to_cpf_format => # "456.983.948-23"
+
+    # Para gerar um número de CPF a partir de um número candidato:
+    "456983948".generate_cpf => # "45698394823"
+
+    # Para gerar um número de CPF formatado a partir de um número candidato:
+    "456983948".generate_cpf_formatted => # "456.983.948-23"
+
+## Contribuindo
+
+1. Faça um Fork
+2. Crie um branch para a nova funcionalidade (`git checkout -b my-new-feature`)
+3. Faça o commit de suas alterações  (`git commit -am 'Add some feature'`)
+4. Faça um push da sua nova funconalidade (`git push origin my-new-feature`)
+5. Submeta uma nova Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cpf_utils.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cpf_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cpf_utils"
+  spec.version       = CpfUtils::VERSION
+  spec.authors       = ["Jackson Pires"]
+  spec.email         = ["jackson.pires@gmail.com"]
+  spec.description   = %q{Uma suite de funcionalidades para o CPF.}
+  spec.summary       = %q{Gera CPF para testes no formado tradicional ou apenas
+                          numérico, testa se determinado número de CPF
+                          é válido, além muitas outras funcionalidades descritas
+                          na documentação.}
+  spec.homepage      = "https://github.com/jacksonpires/cpf_utils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/lib/cpf_utils/string.rb

@@ -0,0 +1,59 @@
+class String
+
+  # Verifica se uma máscara de CPF é válida:
+  #
+  # "456.983.948-23".valid_cpf_mask? => # true
+  # "456.983..948-23".valid_cpf_mask? => # false
+  def valid_cpf_mask?
+    without_mask = !!(self =~ /^[+-]?[0-9]{11}+$/)
+    with_mask = !!(self =~ /^[+-]?[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}+$/)
+    with_mask || without_mask
+  end
+
+  # Verifica se um CPF é válido:
+  #
+  # CpfUtils.valid_cpf?("47238051923") => # true
+  # CpfUtils.valid_cpf?(47238051923) => # tru
+  # CpfUtils.valid_cpf?("472.380.519-23") => # true
+  def valid_cpf?
+    if valid_cpf_mask?
+      original_cpf = self.gsub(/\.?-?/,"",)
+      tested_cpf = original_cpf[0..8]
+
+      tested_cpf << CpfUtils::Cpf.new(original_cpf[0..8]).first_digit.to_s
+      tested_cpf << CpfUtils::Cpf.new(tested_cpf[0..9]).second_digit.to_s
+
+      tested_cpf == original_cpf ? true : false
+    end
+  end
+
+  # Para formatar um número válido de CPF:
+  #
+  # "45698394823".to_cpf_format => # "456.983.948-23"
+  def to_cpf_format
+    if self.valid_cpf?
+      "#{self[0..2]}.#{self[3..5]}.#{self[6..8]}-#{self[9..11]}"
+    end
+  end
+
+  # Para gerar um número de CPF a partir de um número candidato:
+  #
+  # "456983948".generate_cpf => # "45698394823"
+  def generate_cpf
+    if !!(self =~ /^[+-]?[0-9]{9}+$/)
+      final_cpf = self
+
+      final_cpf << CpfUtils::Cpf.new(final_cpf[0..8]).first_digit.to_s
+      final_cpf << CpfUtils::Cpf.new(final_cpf[0..9]).second_digit.to_s
+
+      final_cpf
+    end
+  end
+
+  # Para gerar um número de CPF formatado a partir de um número candidato:
+  #
+  # "456983948".generate_cpf_formatted => # "456.983.948-23"
+  def generate_cpf_formatted
+    generate_cpf.to_cpf_format
+  end
+end

data/lib/cpf_utils/version.rb

@@ -0,0 +1,3 @@
+module CpfUtils
+  VERSION = "1.0.0"
+end

data/lib/cpf_utils.rb

@@ -0,0 +1,99 @@
+require "cpf_utils/version"
+require "cpf_utils/string"
+
+module CpfUtils
+
+
+  # Gera um número de CPF.
+  #
+  # Exemplo:
+  # CpfUtils.cpf => # "45698394823"
+  def self.cpf
+    Cpf.new(sample_numbers).generate_cpf
+  end
+
+  # Gera um número de CPF formatado.
+  #
+  # Exemplo:
+  # CpfUtils.cpf_formatted => # "456.983.948-23"
+  def self.cpf_formatted
+    Cpf.new(sample_numbers).generate_cpf.to_cpf_format
+  end
+
+  # Verifica se um CPF é válido.
+  #
+  # Exemplo:
+  # CpfUtils.valid_cpf?(45698394823) => # true
+  # CpfUtils.valid_cpf?("45698394823") => # true
+  # CpfUtils.valid_cpf?("456.983.948-23") => # true
+  def self.valid_cpf?(cpf_number)
+    cpf_number.to_s.valid_cpf?
+  end
+
+  # Sorteia nove números para compor o um novo CPF
+  def self.sample_numbers
+    [*0..9].sample(9)
+  end
+
+
+  class Cpf
+
+    # Acessor de leitura para os números
+    attr_reader :numbers
+
+    # Inicializador da classe
+    def initialize(numbers)
+      if numbers.is_a? String
+        numbers = numbers.split('')
+      elsif numbers.is_a? Fixnum
+        numbers = numbers.to_s.split('')
+      end
+
+      @numbers = numbers
+    end
+
+    # Gera o CPF propriamente dito
+    def generate_cpf
+      @numbers << first_digit
+      @numbers << second_digit
+      @numbers.join("")
+    end
+
+    # Gera o primeiro dígito verificador
+    def first_digit
+      if @numbers.size == 9
+        value = 0
+        multipliers = [10,9,8,7,6,5,4,3,2]
+
+        multipliers.each_with_index do |mult, index|
+          value += @numbers[index].to_i * mult
+        end
+
+        check_remainder(value % 11)
+      end
+    end
+
+    # Gera o segundo dígito verificador
+    def second_digit
+      if @numbers.size == 10
+        value = 0
+        multipliers = [11,10,9,8,7,6,5,4,3,2]
+
+        multipliers.each_with_index do |mult, index|
+          value += @numbers[index].to_i * mult
+        end
+
+        check_remainder(value % 11)
+      end
+    end
+
+    # Checa o resto da divisão
+    def check_remainder(remainder)
+      if remainder < 2
+        0
+      else
+        (11 - remainder)
+      end
+    end
+  end
+end

data/spec/cpf_util/string_spec.rb

@@ -0,0 +1,24 @@
+require "cpf_utils"
+
+describe String do
+  it "#valid_cpf_mask?" do
+    expect("123.456.789-12".valid_cpf_mask?).to be_true
+    expect("12345678912".valid_cpf_mask?).to be_true
+  end
+
+  it "#valid_cpf_mask? - be false" do
+    expect("123..456.789-12".valid_cpf_mask?).to be_false
+    expect("123.456.789--12".valid_cpf_mask?).to be_false
+    expect("123.456.789-1E".valid_cpf_mask?).to be_false
+  end
+
+  it "#valid_cpf?" do
+    cpf = CpfUtils.cpf
+    expect(cpf.valid_cpf?).to be_true
+  end
+
+  it "#to_cpf_format?" do
+    cpf = CpfUtils.cpf
+    expect(cpf.to_cpf_format).to match(/^[+-]?[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}+$/)
+  end
+end

data/spec/cpf_util_spec.rb

@@ -0,0 +1,89 @@
+require "cpf_utils"
+
+describe CpfUtils do
+  context 'CpfUtils' do
+    it ".cpf" do
+      valid_cpf = CpfUtils.cpf
+      expect(valid_cpf).to be_a_kind_of(String)
+      expect(valid_cpf.length).to eql(11)
+    end
+
+    it ".cpf_formatted" do
+      valid_cpf = CpfUtils.cpf_formatted
+      expect(valid_cpf).to match(/^[+-]?[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}+$/)
+    end
+
+    it ".valid_cpf?" do
+      valid_cpf = CpfUtils.cpf
+      expect(CpfUtils.valid_cpf? valid_cpf).to be_true
+    end
+
+    it ".valid_cpf? - be false" do
+      invalid_cpf = "123.456.789-12"
+      expect(CpfUtils.valid_cpf? invalid_cpf).to be_false
+    end
+
+    it ".sample_numbers" do
+      numbers = CpfUtils.sample_numbers
+      expect(numbers.size).to eql(9)
+      expect(numbers).to be_a_kind_of(Array)
+    end
+  end
+
+  context 'CpfUtils::Cpf' do
+    it "#initialize - Text" do
+      cpf = CpfUtils::Cpf.new("123456789")
+      expect(cpf.numbers).to be_a_kind_of(Array)
+      expect(cpf.numbers.size).to eql(9)
+    end
+
+    it "#initialize - Fixnum" do
+      cpf = CpfUtils::Cpf.new(123456789)
+      expect(cpf.numbers).to be_a_kind_of(Array)
+      expect(cpf.numbers.size).to eql(9)
+    end
+
+    it "#initialize - Array" do
+      cpf = CpfUtils::Cpf.new([1, 2, 3, 4, 5, 6, 7, 8, 9])
+      expect(cpf.numbers).to be_a_kind_of(Array)
+      expect(cpf.numbers.size).to eql(9)
+    end
+
+    it "#generate_cpf" do
+      cpf = CpfUtils::Cpf.new("123456789")
+      complete_cpf = cpf.generate_cpf
+      expect(complete_cpf.size).to eql(11)
+    end
+
+    it "#first_digit" do
+      cpf = CpfUtils::Cpf.new("123412345")
+      first_digit = cpf.first_digit
+      expect(first_digit).to eql(2)
+    end
+
+    it "#first_digit - false" do
+      cpf = CpfUtils::Cpf.new("123")
+      first_digit = cpf.first_digit
+      expect(first_digit).to be_false
+    end
+
+    it "#second_digit" do
+      cpf = CpfUtils::Cpf.new("1234567891")
+      second_digit = cpf.second_digit
+      expect(second_digit).to eql(7)
+    end
+
+    it "#second_digit - false" do
+      cpf = CpfUtils::Cpf.new("123")
+      second_digit = cpf.second_digit
+      expect(second_digit).to be_false
+    end
+
+    it "#check_remainder" do
+      cpf = CpfUtils::Cpf.new("1234567891")
+      expect(cpf.check_remainder(0)).to eql(0)
+      expect(cpf.check_remainder(1)).to eql(0)
+      expect(cpf.check_remainder(2)).to eql(9)
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: cpf_utils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jackson Pires
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Uma suite de funcionalidades para o CPF.
+email:
+- jackson.pires@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cpf_utils.gemspec
+- lib/cpf_utils.rb
+- lib/cpf_utils/string.rb
+- lib/cpf_utils/version.rb
+- spec/cpf_util/string_spec.rb
+- spec/cpf_util_spec.rb
+homepage: https://github.com/jacksonpires/cpf_utils
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Gera CPF para testes no formado tradicional ou apenas numérico, testa se
+  determinado número de CPF é válido, além muitas outras funcionalidades descritas
+  na documentação.
+test_files:
+- spec/cpf_util/string_spec.rb
+- spec/cpf_util_spec.rb