fnando / cpf_cnpj Goto Github PK

🇧🇷 Validate, generate and format CPF/CNPJ numbers. Include command-line tools.

License: MIT License

Ruby 100.00%

gem cnpj cpf

cpf_cnpj's Introduction

CPF/CNPJ

This gem does some CPF/CNPJ magic. It allows you to create, validate and format CPF/CNPJ, even through the command-line.

Just making my life easier when filling these damn numbers on internet bankings and government sites.

For ActiveModel/ActiveRecord validations, please check https://github.com/fnando/validators.

Installation

Add this line to your application's Gemfile:

gem "cpf_cnpj"

And then execute:

$ bundle

Or install it yourself as:

$ gem install cpf_cnpj

Usage

Ruby API

This library has the same API for both CNPJ/CPF, so only one of them is documented below.

require "cpf_cnpj"

CPF.valid?(number)    # Check if a CPF is valid
CPF.generate          # Generate a random CPF number
CPF.generate(true)    # Generate a formatted number

cpf = CPF.new(number)
cpf.formatted         # Return formatted CPF (xxx.xxx.xxx-xx)
cpf.stripped          # Return stripped CPF (xxxxxxxxxxx)
cpf.valid?            # Check if CPF is valid

Strict Validation

By default, validations will strip any characters that aren't numbers. This means that 532#####820------857\n96 is considered a valid number. To perform a strict validation use strict: true.

CPF.valid?(number, strict: true)

Command-line

This library gives you two binaries: cpf and cnpj.

$ cpf --check 532.820.857-96
$ $?
0

$ cpf --check 53282085796
$ $?
0

$ cpf --format 53282085796
532.820.857-96

$ cpf --strip 532.820.857-96
53282085796

$ cpf --generate
417.524.931-17

$ cpf --generate --strip
76001454809

$ echo 76001454809 | cpf -f
760.014.548-09

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am "Added some feature")
Push to the branch (git push origin my-new-feature)
Create new Pull Request

cpf_cnpj's People

Contributors

Stargazers

Watchers

Forkers

acblmoncao infoslack esmerino wesleyskap rhrfonseca brodock palpiteros leonardoro hifenhur sislam2 gpcarmo beautydate lucassch edmaarcosta voiski blumpa jansilva lucasmazza aelkz powerticmkt maritiberio guilhermedallanol dougmpx viniciusoyama quadrogiz jacobrodrigues vitortiba soares-marcio hugopassos tranqueiracorp haroldofurtado mersonff mathxbs01 donads carlosdanielpohlod souzanato guistoff081 gabriel-franzoni-pier andersonbr-oss tarikboschi

cpf_cnpj's Issues

Still working with Ruby 2.6.3?

Let me know if is still working, I couldn't use it with ActiveRecord (using validators).

Not generate unique when use generate

In my model, I create unique index for CPF/CNPJ, and when I use CPF/CNPJ.generate in RSpec, not generate unique CPF/CPNJ and give validation error in Factory.

CPF must return false if parameter of "valid?" method contains letters

@fnando

CPF.valid? 'Luisa Maria', strict: true
#=> true

This code above returns "true", but the correct return value is "false". This because any CPF with letters is not a valid CPF.

Define: strict - Validation function returning nil and allowing WRONG values

Using version 0.5.0.

Drop Travis CI to Github Actions

More details: #18

Valid CPF returning nil in validation

This is a valid cpf number 01234567890 but when I call the CPF.valid? function I have this behavior:

wrong blacklisted CPF

Apparently 01234567890 are VALID CPF from a real woman (SEBASTIANA)

Does it work on 1.8.7 version?

Olá,

Instalei a gem no meu projeto ruby de versão 1.8.7, mas a validação de CPF parece não estar funcionando, pois sempre retorna FALSE, independente do CPF ser válido ou não.
Devido a versão do ruby (1.8.7), eu tive que refatorar a classe CPF substituindo o symbol :strict por uma variável strict, caso contrário dava erro na gem.
Não sei se foi por essa causa, a validação sempre retorna erro. Sabe de alguma versão da gem compatível com o ruby 1.8.7 que eu poderia instalar?

Obrigado,

Guilherme

Loading development environment (Rails 5.2.1)
2.5.3 :001 > require "cpf_cnpj"
 => false 
2.5.3 :002 > CPF.valid?(06244668090)
Traceback (most recent call last):
SyntaxError ((irb):2: Invalid octal digit)
CPF.valid?(06244668090)
           ^~~~~~~~