https://github.com/concretesolutions/canarinho
Utilitários Android para padrões Brasileiros
https://github.com/concretesolutions/canarinho
android brazilian-standards validation
Last synced: 10 months ago
JSON representation
Utilitários Android para padrões Brasileiros
- Host: GitHub
- URL: https://github.com/concretesolutions/canarinho
- Owner: concretesolutions
- License: apache-2.0
- Created: 2015-06-26T02:09:21.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-04-11T20:37:11.000Z (about 4 years ago)
- Last Synced: 2025-04-07T22:22:18.709Z (about 1 year ago)
- Topics: android, brazilian-standards, validation
- Language: Java
- Homepage:
- Size: 417 KB
- Stars: 178
- Watchers: 13
- Forks: 41
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Android Canarinho
Esta biblioteca é um conjunto de utilitários para trabalhar com padrões brasileiros no Android.
Inspirado em: https://github.com/caelum/caelum-stella.
O foco aqui é o Android. Portanto, não é compatível com aplicações Java puras.
Entre os padrões implementados temos:
- Formatador e validador de CPF
- Formatador e validador de CNPJ
- Formatador e validador de boleto bancário (e linha digitável)
- Formatador e validador de CEP
- Formatador de telefone
- [Formatador de valores financeiros](#formatador-de-valor-financeiro-no-padrão-real) (vírgula para milhares e ponto para decimais com duas casas)
Estes são utilizados para implementar `TextWatcher`s que formatam e validam a digitação do usuário.
## Exemplo de uso:
### Validar um CPF
```java
if (Validador.CPF.ehValido(cpf))
Toast.makeText(context, "Válido!", Toast.LENGTH_SHORT).show();
else
Toast.makeText(context, "Inválido!", Toast.LENGTH_SHORT).show();
```
### Formatar um CPF
```java
String cpfFormatado = Formatador.CPF.formata(usuario.getCpf());
```
### Formatar um EditText para CPF sem validação
```java
cpfEditText.addTextChangedListener(new MascaraNumericaTextWatcher("###.###.###-##"));
```
### Formatar um EditText para CPF com validação
```java
cpfEditText.addTextChangedListener(new MascaraNumericaTextWatcher.Builder()
.paraMascara("###.###.###-##")
.comCallbackDeValidacao(new SampleEventoDeValidacao(context))
.comValidador(Validador.CPF)
.build());
```
## Formatador de valor financeiro no padrão Real
Para deixar um usuário digitar valores monetários no padrão Real, basta adicionar um `ValorMonetarioWatcher` e alguns atributos ao `EditText`
```java
// Padrão sem símbolo de Real
editText.addTextChangedListener(new ValorMonetarioWatcher());
editText.append("1234567890");
assertThat(editText.getText().toString(), is("12.345.678,90"));
// Customizado com símbolo e mantendo zeros ao apagar em lote
editText.addTextChangedListener(new ValorMonetarioWatcher.Builder()
.comSimboloReal()
.comMantemZerosAoLimpar()
.build());
editText.append("1234567890");
assertThat(editText.getText().toString(), is("R$ 12.345.678,90"));
editText.getText().clear();
assertThat(editText.getText().toString(), is("R$ 0,00"));
```
Exemplo de declaração no layout:
```xml
```
## Callback de validação
Os `TextWatcher`s possuem a possibilidade de avisar o usuário conforme ele está digitando sobre algum erro de campo.
Para isso, usamos um `EventoDeValidacao` que possui os seguintes callbacks:
- `void invalido(String valorAtual, String mensagem)`: chamado quando o valor está inválido
- `void parcialmenteValido(String valorAtual)`: chamado quando o valor ainda não está completo e também não está inválido
- `void totalmenteValido(String valorAtual)`: chamado quando o valor está completo e válido
Um exemplo de implementação:
```java
public class SampleEventoDeValidacao implements EventoDeValidacao {
private final TextInputLayout textInputLayout;
public SampleEventoDeValidacao(TextInputLayout textInputLayout) {
this.textInputLayout = textInputLayout;
}
@Override
public void invalido(String valorAtual, String mensagem) {
textInputLayout.setError(mensagem);
}
@Override
public void parcialmenteValido(String valorAtual) {
textInputLayout.setErrorEnabled(false);
textInputLayout.setError(null);
}
@Override
public void totalmenteValido(String valorAtual) {
new AlertDialog.Builder(textInputLayout.getContext())
.setTitle("Campo válido!")
.setMessage(valorAtual)
.show();
}
}
```
Veja exemplos de implementação no sample.
## Changelog
Ver [CHANGELOG.md](CHANGELOG.md)
## Arquitetura
- `Formatador`: Formata, desformata e verifica se um valor está formatado e se pode ser formatado. Opera com valores completos.
- `Validador`: Valida de duas formas: absoluta (true ou false) e atualizando um objeto de validação (`ResultadoParcial`).
- Watchers: implementações de `TextWatcher`s para formatação e validação contínua (conforme a digitação do usuário).
Para exemplos, verifique os testes na pasta sample.
## Gradle
`allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}`
`implementation 'br.com.concrete:canarinho:{latest version}'`
## ATENÇÃO
Este projeto é desenvolvido de boa vontade e com o intuito de ajudar. No entanto, todo o desenvolvimento é feito SEM GARANTIAS.
## LICENÇA
Este projeto é disponibilizado sob a licença Apache vesão 2.0. Ver declaração no arquivo LICENSE.txt