act_as_cnpj_cpf 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73824fe9acab5c7cc094a1b4dba942eeadf69f94
-  data.tar.gz: 65d424c466ff2cec600bc6efd57a329cfab1bed8
+  metadata.gz: 755a81eeb5ddc1753442ee13a84bbed78719f2a7
+  data.tar.gz: 48393237613d80ac092c06b4a8f6a049ef503315
 SHA512:
-  metadata.gz: 05919b168466a32e5994136c3bad1920f3fafcc4af7eef72c8cde5d5ebd58641c26336fbfb0bb1fa59ec76fc7f55f1a7a01898db56ed24c5776fcc4e1de0ccba
-  data.tar.gz: 6b8072c4e3538b575bfd5e0386e2f7c450f649fe5c67cd2d152d159bd409d55dfc685aa3cff5d8abbd9beb7c4d2a3afc2d5b9d6d003b7aed44ae03299beb32e5
+  metadata.gz: f5dde6be0219911bdb656bd7855986a594a4aa67f8928b10c88d312fb698a1d01f5706e5ffba45cecb0c2da2bcf21a2e18f1b0c4693c79a6071746041368d3a5
+  data.tar.gz: 5388314a83a54ad87a4fe4bd5853020016192c51d4bd8b493160e1a8dd2bda9a6147fd721eec6cd0ffe4e027304ec2a7b83e0e5779a48c473fb75061a8e811ef

data/README.md

@@ -1,6 +1,158 @@
+# act_as_cnpj_cpf
+
 [![Build Status](https://travis-ci.org/josuelima/act_as_cnpj_cpf.svg?branch=master)](https://travis-ci.org/josuelima/act_as_cnpj_cpf)
 [![Code Climate](https://codeclimate.com/github/josuelima/act_as_cnpj_cpf/badges/gpa.svg)](https://codeclimate.com/github/josuelima/act_as_cnpj_cpf)
 [![Test Coverage](https://codeclimate.com/github/josuelima/act_as_cnpj_cpf/badges/coverage.svg)](https://codeclimate.com/github/josuelima/act_as_cnpj_cpf)
 
-Under construction.
-More info soon..
+** Rubygem to format and validate CNPJ (Brazilian company registration number) and CPF (Brazilian citizens registration number). You can use it solo or as an ActiveRecord plugin. **
+
+act_as_cnpj_cpf é uma Rubygem para validar e formatar CNPJ e CPF.
+
+## Funcionalidades
+
+* Valida CPF e CNPJ com ou sem formatação
+* Integração com ActiveRecord
+* Formata número para o padrão do CNPJ ou CPF (xx.xxx.xxx/xxxx-xx e xxx.xxx.xxx-xx)
+* Possibilidade de utilizar um atributo como CNPJ ou CPF ao mesmo tempo
+* Permite persistir cpf ou cnpj inválido (caso seja especificado com permite_invalido: true)
+
+Este projeto foi inicialmente desenvolvido como uma extensão da gem [brcpfcnpj](https://github.com/tapajos/brazilian-rails/tree/master/brcpfcnpj) e em seguida totalmente re-escrito por se tratar de uma proposta diferente. Além das novas funcionalidades, diferentemente do brcpfcnpj, este projeto utiliza o número sem formatação como padrão para salvar no banco de dados e exibir (podendo ser exibido formatado com .formatado)
+
+## Instalação
+
+```bash
+$ gem install act_as_cnpj_cpf
+```
+
+ou adicione act_as_cnpj_cpf ao seu Gemfile e em seguida `bundle install`:
+
+```ruby
+gem 'act_as_cnpj_cpf'
+```
+
+## Uso
+
+### ActiveRecord
+
+CPF Válido
+
+```ruby
+class Pessoa < ActiveRecord::Base
+  # :cpf é um atributo no seu model Pessoa
+  usar_como_cpf :cpf
+end
+
+fulano = Pessoa.new(cpf: '67392957864')
+# ou
+fulano = Pessoa.new(cpf: '673.929.578-64')
+
+fulano.cpf # retorna numero sem formatação 67392957864
+fulano.cpf.formatado # retorna 673.929.578-64
+fulano.cpf.valido? # validação do CPF, retorna true
+fulano.valid? # validação do objeto pessoa, retorna true
+fulano.save # retorna true e salva sem formatação no cpf
+```
+
+CPF Inválido
+
+```ruby
+fulano = Pessoa.new(cpf: '111111')
+fulano.cpf # retorna 111111
+fulano.cpf.valido? # validação do CPF, retorna false
+fulano.cpf.formatado # retorna 111111
+fulano.valid? # validação do objeto pessoa, retorna false
+fulano.save # retorna false e adiciona mensagem de erro ao model (fulano.errors)
+```
+
+CNPJ Válido
+
+```ruby
+class Empresa < ActiveRecord::Base
+  # :cnpj é um atributo no seu model Empresa
+  usar_como_cnpj :cnpj
+end
+
+company = Empresa.new(cnpj: '54609346436407')
+# ou
+company = Empresa.new(cnpj: '54.609.346/4364-07')
+
+company.cnpj # retorna numero sem formatação 54609346436407
+company.cnpj.formatado # retorna 54.609.346/4364-07
+company.cnpj.valido? # validação do CNPJ, retorna true
+company.save # retorna true e salva sem formatação no cnpj
+```
+
+CNPJ Inválido
+
+```ruby
+company = Empresa.new(cnpj: '1111111111111')
+company.cnpj # retorna 1111111111111
+company.cnpj.valido? # validação do CNPJ, retorna false
+company.cnpj.formatado # retorna 1111111111111
+company.save # retorna false e adiciona mensagem de erro ao model (company.errors)
+```
+
+### CNPJ e CPF no mesmo atributo
+
+Podem existir situações onde você precise utilizar o mesmo campo ora como CNPJ ora como CPF, para isto basta utilizar `usar_como_cnpj_ou_cpf`:
+
+```ruby
+class Cliente < ActiveRecord::Base
+  # :codigo é um atributo no seu model Cliente
+  usar_como_cnpj_ou_cpf :codigo
+end
+
+# para cnpj com ou sem formatação
+cliente = Cliente.new(codigo: '54609346436407')
+# ou para cpf com ou sem formatação
+cliente = Cliente.new(codigo: '67392957864')
+
+cliente.codigo # retorna o cpf ou cnpj informado sem formatação
+cliente.codigo.formatado # retorna o cpf ou cnpj informado devidamente formatado
+cliente.codigo.valido? # retorna true caso seja um cnpj ou cpf válido
+cliente.save # retorna true e salva sem formatação caso seja um cnpj ou cpf válido
+cliente.eh_cpf? # retorna true se o conteudo do codigo for um CPF
+cliente.eh_cnpj? # retorna true se o conteudo do codigo for um CNPJ
+```
+A validação é feita de acordo com o tamanho do valor informado (após remover os caracteres especiais). Se == 11 tenta validar como CPF caso contrario tenta validar como CNPJ.
+
+### Persistir mesmo com CNPJ ou CPF Inválido
+
+Caso o CNPJ ou CPF não sejam válidos o objeto não será salvo no banco de dados e uma mensagem de erro anexada ao objeto. Porém, podem existir casos onde você precise persistir CPF ou CNPJ inválidos para analises futuras. Para isso, utilize o atributo `permite_invalido: true`.
+
+```ruby
+class Pessoa < ActiveRecord::Base
+  usar_como_cpf :cpf, permite_invalido: true
+end
+
+class Empresa < ActiveRecord::Base
+  usar_como_cnpj :cnpj, permite_invalido: true
+end
+
+class Cliente < ActiveRecord::Base
+  usar_como_cnpj_ou_cpf :codigo, permite_invalido: true
+end
+```
+
+### Sem ActiveRecord
+
+Para utilizar isoladamente basta apenas criar uma nova instancia da class Cpf, Cnpj ou CnpjOuCpf
+
+```ruby
+codigo = ActAsCnpjCpf::Cnpj.new( cnpj )
+codigo = ActAsCnpjCpf::Cpf.new( cpf )
+codigo = ActAsCnpjCpf::CnpjOuCpf.new( cnpj_ou_cpf )
+
+# api
+codigo.valido?   # true ou false
+codigo.numero    # cpf ou cnpj sem formatação
+codigo.formatado # cpf ou cnpj formatado
+```
+
+## Contribuindo
+
+1. Fork it ( http://github.com/josuelima/act_as_cnpj_cpf/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/act_as_cnpj_cpf/cnpj_cpf_active_record.rb

@@ -7,17 +7,17 @@ module ActAsCnpjCpf
 
     module ClassMethods
       %w(cnpj cpf cnpj_ou_cpf).each do |method|
-        define_method("usar_como_#{method}") do |field, options = {}| 
+        define_method("usar_como_#{method}") do |field, options = {}|
           init(field, options, "ActAsCnpjCpf::#{method.split('_').map(&:capitalize).join}")
         end
       end
 
       def init(field, options, klass)
         add_composed_class(field, klass)
-        module_eval(create_validation(field.to_s, options, klass))
+        module_eval(create_validation(field.to_s, options))
       end
 
-      # Adiciona reader e writer 
+      # Adiciona reader e writer
       # http://api.rubyonrails.org/classes/ActiveRecord/Aggregations/ClassMethods.html
       def add_composed_class(name, klass)
         options = {class_name: klass, mapping: [name.to_s, 'numero'], allow_nil: true}
@@ -26,7 +26,7 @@ module ActAsCnpjCpf
       end
 
       # cria validacao para o model
-      def create_validation(field, options, klass)
+      def create_validation(field, options)
         <<-CODE
           validate :#{field}_vazio?, :#{field}_valido?
 

data/lib/act_as_cnpj_cpf/cnpj_ou_cpf.rb

@@ -16,5 +16,13 @@ module ActAsCnpjCpf
       klass     = numero.to_s.gsub(/[^0-9]/, '').length == 11 ? Cpf : Cnpj
       @instance = klass.new(numero)
     end
+
+    def eh_cpf?
+      @instance.is_a?(Cpf)
+    end
+
+    def eh_cnpj?
+      @instance.is_a?(Cnpj)
+    end
   end
 end

data/lib/act_as_cnpj_cpf/version.rb

@@ -1,3 +1,3 @@
 module ActAsCnpjCpf
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/lib/cnpj_ou_cpf_spec.rb

@@ -12,5 +12,19 @@ module ActAsCnpjCpf
 
     it_behaves_like 'objeto valido'
     it_behaves_like 'objeto invalido'
+
+    context '#eh_cpf? e #eh_cnpj?' do
+      it 'deveria identificar como cpf' do
+        cpf = model.new(codigo: Faker::CPF.numeric)
+        expect(cpf.eh_cpf?).to  be true
+        expect(cpf.eh_cnpj?).to be false
+      end
+
+      it 'deveria identificar como cnpj' do
+        cnpj = model.new(codigo: Faker::CNPJ.numeric)
+        expect(cnpj.eh_cnpj?).to be true
+        expect(cnpj.eh_cpf?).to  be false
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_as_cnpj_cpf
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Josué Lima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport