https://github.com/leocolman/simplecpfvalidator

🇧🇷 Validador simples para o documento CPF (Cadastro de Pessoa Física) | Simple Brazilian taxpayer document (CPF) validator
https://github.com/leocolman/simplecpfvalidator

brazil cpf cpf-validador cpf-validation cpf-validator document hacktoberfest kotlin validar-cpf zero-dependency

Last synced: about 1 month ago
JSON representation

🇧🇷 Validador simples para o documento CPF (Cadastro de Pessoa Física) | Simple Brazilian taxpayer document (CPF) validator

• Host: GitHub
• URL: https://github.com/leocolman/simplecpfvalidator
• Owner: LeoColman
• License: apache-2.0
• Created: 2019-10-14T17:33:08.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-01T02:05:45.000Z (about 2 months ago)
• Last Synced: 2024-11-01T03:17:32.314Z (about 2 months ago)
• Topics: brazil, cpf, cpf-validador, cpf-validation, cpf-validator, document, hacktoberfest, kotlin, validar-cpf, zero-dependency
• Language: Kotlin
• Homepage:
• Size: 354 KB
• Stars: 24
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Cpf Validator

![Build](https://github.com/LeoColman/SimpleCpfValidator/workflows/Build/badge.svg)

[![GitHub](https://img.shields.io/github/license/LeoColman/SimpleCpfValidator.svg)](https://github.com/LeoColman/SimpleCpfValidator/blob/master/LICENSE) [![Maven Central](https://img.shields.io/maven-central/v/br.com.colman.simplecpfvalidator/simple-cpf-validator.svg)](https://search.maven.org/search?q=g:br.com.colman.simplecpfvalidator)

[![Awesome Kotlin Badge](https://kotlin.link/awesome-kotlin.svg)](https://github.com/KotlinBy/awesome-kotlin/tree/readme#validation-back-)

[![Zero Dependencies Badge](https://img.shields.io/badge/Dependencies-0-brightgreen)](build.gradle.kts)

O conceito de validação de CPF existe desde a criação do próprio documento. No entanto, observa-se que a validação deste documento é replicada em várias aplicações, em classes idênticas, copiadas e coladas.

Com o objetivo de simplificar esse tipo de validação (seja em casos de teste ou em cenários de verificação de cadastro), a biblioteca **Simple CPF Validator** traz essa funcionalidade de uma vez, evitando assim boilerplate e possibilidade de erros no reuso de classe.

# Utilizando

Para utilizar é bem simples. Primeiro importe no seu Gradle:

`implementation("br.com.colman.simplecpfvalidator:simple-cpf-validator:{version}")`

E utilize a função em qualquer String de seu código:

`"12345678911".isCpf()`

Por padrão, os caracteres `.` e `-` são retirados da String (permitindo o formato `123.456.789-11`, por exemplo), mas isso pode ser modificado através do parâmetro `charactersToIgnore`:

`"123.456.789/11".isCpf(charactersToIgnore = listOf('.', '/'))`

## CPFs inválidos

Por definição, os CPFs `111.111.111-11`, `222.222.222-22`, `...`, `999.999.999-99` são inválidos, e seu retorno será `falso`.

O CPF `000.000.001-91` em teoria representa apenas pessoas sem CPF, no entanto este validador considerará que o CPF é válido.

## Contribuindo

Sinta-se livre para abrir um pull request ou uma issue para contribuir com este projeto.