helsinque / cpf_cnpj Goto Github PK

Atualmente, sempre que o phpunit é rodado o codeCoverage é gerado, fazendo com que os testes demorem em momentos desnecessários.

• Remover o coverage por padrão

Para gerar um coverage, basta executar ./vendor/bin/phpunit --coverage-html ~/path/to/index.html

• Soltar uma exceção caso não tenha o indíce definido, informando que o indice "tal" é necessário para a requisição

Escrever em ingles e utilizar o padrão https://gist.github.com/PurpleBooth/109311bb0361f32d87a2
Adicionar um exemplo de cada validador

Será que ele realmente é um validator? me parece que ele possui uma responsabilidade maior de retornar os dados a partir de um CPF/CNPJ, não me parece que ele deveria ser tratado como validator.

Atualmente quando precisamos validar um CPF/CNPJ usamos o seguinte código
$validate = new Validate();
$return= $validate->validate("Cnpj", $document);

Para a bipbop, sugiro uma mudança
$validate = new Validate();
$return= $validate->getInfo("Cnpj", $document);

Com essa mudança, não faz muito sentido o Validate() buscar a Info, com isso podemos mudar o nome new Validate para outra coisa, e utilizar esse mesmo nome no Repositório. Este nome seria o nome oficial da biblioteca.

• Criar ValidateErrorException, com um método que retorna o array de erros getErrors()
• Setar os erros caso sejam retornados
• Somente rodar try{}catch{} na classe src/Validators/Validator
• Programar os validadores para soltar uma exceção com o erro

Nesse caso pode ocorrer conflitos com os namespaces gerado pela aplicação que for consumir o Validator.
Recomenda-se sempre utilizar um único namespace, no nosso caso "Helsinque"

• Deixar todos validadores sobre o mesmo namespace (Pasta) chamada "Types"
• Remover o termo Validator do nome dos arquivos
• Deixar como público somente o método "validate"

Para tornar claro para o desenvolvedor quais campos serão retornados da chamada de API do BipBop e unificar o retorno em uma Entidade