cpf_utils 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0d2d6965f5f52f0e68ff55f132eb61320ff2ba0
-  data.tar.gz: 86de60cc7567d557c4d2b046d6263d38cf5ae683
+  metadata.gz: 3f2114e18fd7ac1dfe9813aaa6644341560b925e
+  data.tar.gz: dd4b5fcaf9228aef7c7ec39d5d236324e9c8b91d
 SHA512:
-  metadata.gz: e29b9ae14c7b1bd6de47566e40b05f381be364cc2711f17c59967a7b8d3bd1c8f8fbf4a9b05536609d4304ac20b01c5eef072857b6c3bdb17b89f2290aff08fb
-  data.tar.gz: 05f06aaea9eb8c9b80c090407523b1a73b6d996c969687d8127d87ced37d5adb95670f008f646de65db77446a9b770bb3104a6057cf1e4d72377064e30c1626b
+  metadata.gz: 7b1974ca3f4d387c40f8bb948b993aeaf695f550359ba91ec4529deecb2e4e8c1940b7ef7668b2bba960ee461ee8bb0fe617a7ece279eb66f52df9ddbd9458fc
+  data.tar.gz: b91138132f481c28794c60375ee1499f81340a1ec28b513b3e43d1b2d8953a0a23003256efe7ea76bbc16e70c33c2a4107259a21813dcd2a887f51dda8a013cd

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: "bundle exec rspec spec"

data/README.md

@@ -1,4 +1,7 @@
 # CpfUtils
+[![Gem Version](https://badge.fury.io/rb/cpf_utils.png)](http://badge.fury.io/rb/cpf_utils)
+[![Build status](https://secure.travis-ci.org/jacksonpires/cpf_utils.png)](https://secure.travis-ci.org/jacksonpires/cpf_utils)
+[![Code Climate](https://codeclimate.com/github/jacksonpires/cpf_utils.png)](https://codeclimate.com/github/jacksonpires/cpf_utils)
 
 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.

data/lib/cpf_utils/cpf.rb

@@ -0,0 +1,62 @@
+module CpfUtils
+  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/lib/cpf_utils/string.rb

@@ -56,4 +56,19 @@ class String
   def generate_cpf_formatted
     generate_cpf.to_cpf_format
   end
+
+  # Apelido 'mascara_de_cpf_valida' para o método valid_cpf_mask
+  alias_method :mascara_de_cpf_valida?, :valid_cpf_mask?
+
+  # Apelido 'cpf_valido?' para o método valid_cpf?
+  alias_method :cpf_valido?, :valid_cpf?
+
+  # Apelido 'para_formato_cpf' para o método to_cpf_format
+  alias_method :para_formato_cpf, :to_cpf_format
+
+  # Apelido 'gerar_cpf' para o método generate_cpf
+  alias_method :gerar_cpf, :generate_cpf
+
+  # Apelido 'gerar_cpf_formatado' para o método generate_cpf_formatted
+  alias_method :gerar_cpf_formatado, :generate_cpf_formatted
 end

data/lib/cpf_utils/version.rb

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

data/lib/cpf_utils.rb

@@ -1,9 +1,9 @@
 require "cpf_utils/version"
 require "cpf_utils/string"
+require "cpf_utils/cpf"
 
 module CpfUtils
 
-
   # Gera um número de CPF.
   #
   # Exemplo:
@@ -20,6 +20,14 @@ module CpfUtils
     Cpf.new(sample_numbers).generate_cpf.to_cpf_format
   end
 
+  # Gera um número de CPF formatado.
+  #
+  # Exemplo:
+  # CpfUtils.cpf_formatado => # "456.983.948-23"
+  def self.cpf_formatado
+    self.cpf_formatted
+  end
+
   # Verifica se um CPF é válido.
   #
   # Exemplo:
@@ -30,70 +38,20 @@ module CpfUtils
     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)
+  # Verifica se um CPF é válido.
+  #
+  # Exemplo:
+  # CpfUtils.cpf_valido?(45698394823) => # true
+  # CpfUtils.cpf_valido?("45698394823") => # true
+  # CpfUtils.cpf_valido?("456.983.948-23") => # true
+  def self.cpf_valido?(cpf_number)
+    self.valid_cpf?(cpf_number)
   end
 
+  private
 
-  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
+  # Sorteia nove números para compor o um novo CPF
+  def self.sample_numbers
+    [*0..9].sample(9)
   end
 end

data/spec/{cpf_util_spec.rb → cpf_utils/cpf.rb}

@@ -1,36 +1,9 @@
-require "cpf_utils"
+require "spec_helper"
 
 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)

data/spec/cpf_utils/string_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+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 "#mascara_de_cpf_valida?" do
+    expect("123.456.789-12".mascara_de_cpf_valida?).to be_true
+    expect("12345678912".mascara_de_cpf_valida?).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 "#mascara_de_cpf_valida? - be false" do
+    expect("123..456.789-12".mascara_de_cpf_valida?).to be_false
+    expect("123.456.789--12".mascara_de_cpf_valida?).to be_false
+    expect("123.456.789-1E".mascara_de_cpf_valida?).to be_false
+  end
+
+  it "#valid_cpf?" do
+    cpf = CpfUtils.cpf
+    expect(cpf.valid_cpf?).to be_true
+  end
+
+  it "#cpf_valido?" do
+    cpf = CpfUtils.cpf
+    expect(cpf.cpf_valido?).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
+
+  it "#para_formato_cpf?" do
+    cpf = CpfUtils.cpf
+    expect(cpf.para_formato_cpf).to match(/^[+-]?[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}+$/)
+  end
+
+  it "#generate_cpf" do
+    valid_cpf = CpfUtils.cpf
+    final_cpf = valid_cpf[0..8].generate_cpf
+
+    expect(final_cpf).to be_a_kind_of(String)
+    expect(final_cpf.length).to eql(11)
+  end
+
+  it "#gerar_cpf" do
+    valid_cpf = CpfUtils.cpf
+    final_cpf = valid_cpf[0..8].gerar_cpf
+
+    expect(final_cpf).to be_a_kind_of(String)
+    expect(final_cpf.length).to eql(11)
+  end
+
+  it "#gerar_cpf_formatado" do
+    valid_cpf = CpfUtils.cpf
+    final_cpf = valid_cpf[0..8].gerar_cpf_formatado
+
+    expect(final_cpf).to match(/^[+-]?[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}+$/)
+  end
+
+  it "#generate_cpf_formatted" do
+    valid_cpf = CpfUtils.cpf
+    final_cpf = valid_cpf[0..8].generate_cpf_formatted
+
+    expect(final_cpf).to match(/^[+-]?[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}+$/)
+  end
+end

data/spec/cpf_utils_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe 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 ".cpf_formatado" do
+    valid_cpf = CpfUtils.cpf_formatado
+    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 ".cpf_valido?" do
+    cpf_valido = CpfUtils.cpf
+    expect(CpfUtils.cpf_valido? cpf_valido).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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "cpf_utils"
+require_relative "../lib/cpf_utils/cpf"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpf_utils
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jackson Pires
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,16 +61,20 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cpf_utils.gemspec
 - lib/cpf_utils.rb
+- lib/cpf_utils/cpf.rb
 - lib/cpf_utils/string.rb
 - lib/cpf_utils/version.rb
-- spec/cpf_util/string_spec.rb
-- spec/cpf_util_spec.rb
+- spec/cpf_utils/cpf.rb
+- spec/cpf_utils/string_spec.rb
+- spec/cpf_utils_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jacksonpires/cpf_utils
 licenses:
 - MIT
@@ -98,5 +102,7 @@ summary: Gera CPF para testes no formado tradicional ou apenas numérico, testa
   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
+- spec/cpf_utils/cpf.rb
+- spec/cpf_utils/string_spec.rb
+- spec/cpf_utils_spec.rb
+- spec/spec_helper.rb

data/spec/cpf_util/string_spec.rb

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