update docs, minor corrections

Author: geekcom

README.md

@@ -1,63 +1,170 @@
-# Validator Docs - Brasil
+# LaraValidator Docs - Brasil
 _Validação de documentos do Brasil usando Laravel 5.*_
 
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/geekcom/validator-docs/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/geekcom/validator-docs/?branch=master)
 [![Total Downloads](https://poser.pugx.org/geekcom/validator-docs/downloads)](https://packagist.org/packages/geekcom/validator-docs)
 [![License](https://poser.pugx.org/geekcom/validator-docs/license)](https://packagist.org/packages/geekcom/validator-docs)
 
-Biblioteca Laravel para validação de CPF, CNPJ, CPF/CNPJ (quando salvos no mesmo atributo), CNH e Título de Eleitor.
+Biblioteca Laravel para validação de CPF, CNPJ, CPF/CNPJ (quando salvos no mesmo atributo), CNH, PIS/PASEP/NIT/NIS e Título de Eleitor.
 
-# Instalação
+## Instalação
 
-No arquivo `composer.json`, adicione:
+No arquivo `composer.json`, adicione validator-docs como dependência do seu projeto:
 
 ```
 "require": {
     "geekcom/validator-docs" : "1.*"
  },
 ```
 
-Ou rode o comando:
+Depois execute:
+
+```
+composer install
+```
+
+Ou simplesmente execute o comando:
 
 ```
 composer require geekcom/validator-docs
 ```
 
-Após a instalação, adicione no arquivo `config/app.php` no array `providers` a seguinte linha:
+Após a instalação, adicione ao arquivo `config/app.php` ao array `providers` a seguinte linha:
 
 ```php
 geekcom\ValidatorDocs\ValidatorProvider::class
 ```
 
-Para utilizar a validação agora, basta fazer o procedimento padrão do `Laravel`, confira na documentação especifica para a sua versão,
-a diferença é que agora, você terá os seguintes métodos de validação:
+----------------------------------------------------------------------------------------------------------------------------
+
+## Como usar - Validações disponíveis
+
+Agora, você terá os métodos de validação validator docs Brasil disponíveis.
+
+* **cpf** - Verifica se um CPF é valido.
+
+```php
+$this->validate($request, [
+    'cpf' => 'required|cpf',
+]);
+```
+
+* **cnpj** - Verifica se um CNPJ é valido.
+
+```php
+$this->validate($request, [
+    'cnpj' => 'required|cnpj',
+]);
+```
+
+* **cnh** - Verifica se uma CNH (Carteira Nacional de Habilitação) é válida.
+
+```php
+$this->validate($request, [
+    'cnh' => 'required|cnh',
+]);
+```
+
+* **titulo_eleitor** - Verifica se um Título de Eleitor é válido.
+
+```php
+$this->validate($request, [
+    'titulo_eleitor' => 'required|titulo_eleitor',
+]);
+```
+
+* **cpf_cnpj** - Verifica se um CPF ou CNPJ é válido.
+
+```php
+$this->validate($request, [
+    'cpf_cnpj' => 'required|cpf_cnpj',
+]);
+```
+
+* **nis** - Verifica se um PIS/PASEP/NIT/NIS é válido.
+
+```php
+$this->validate($request, [
+    'nis' => 'required|nis',
+]);
+```
+
+* **formato_cnpj** - Verifica se o formato de um CNPJ é válida. ( 99.999.999/9999-99 )
+
+```php
+$this->validate($request, [
+    'formato_cnpj' => 'required|formato_cnpj',
+]);
+```
+
+* **formato_cpf** - Verifica se o formato de um CPF é válido. ( 999.999.999-99 )
+
+```php
+$this->validate($request, [
+    'formato_cpf' => 'required|formato_cpf',
+]);
+```
 
-* **cnh** - Verifica se uma CNH é valida. Para testar, basta utilizar o site http://4devs.com.br/gerador_de_cnh
-* **titulo_eleitor** - Verifica se um Título de Eleitor é valido. Para testar, basta utilizar o site http://4devs.com.br/gerador_de_titulo_de_eleitor
-* **cnpj** - Verifica se o CNPJ é valido. Para testar, basta utilizar o site http://www.geradorcnpj.com/
-* **cpf** - Verifica se o CPF é valido. Para testar, basta utilizar o site http://geradordecpf.org
-* **cpf_cnpj** - Verifica se é um CPF ou CNPJ valido. Para testar, basta utilizar um dos sites acima
-* **nis** - Verifica se o PIS/PASEP/NIT/NIS é valido. Para testar, basta utilizar o site https://www.4devs.com.br/gerador_de_pis_pasep
-* **formato_cnpj** - Verifica se a mascara do CNPJ é válida. ( 99.999.999/9999-99 )
-* **formato_cpf** - Verifica se a mascara do CPF é válida. ( 999.999.999-99 )
-* **formato_cpf_cnpj** - Verifica se a mascara do CPF ou CNPJ é válida. ( 999.999.999-99 ) ou ( 99.999.999/9999-99 )
-* **formato_nis** - Verifica se a mascara do PIS/PASEP/NIT/NIS é válida. ( 999.99999-99.9 )
+* **formato_cpf_cnpj** - Verifica se o formato de um CPF ou um CNPJ é válido. ( 999.999.999-99 ) ou ( 99.999.999/9999-99 )
 
+```php
+$this->validate($request, [
+    'formato_cpf_cnpj' => 'required|formato_cpf_cnpj',
+]);
+```
 
-Então, podemos realizar um simples teste onde dizemos que o campo CPF será obrigatório e usamos a biblioteca para validar:
+* **formato_nis** - Verifica se o formato de um PIS/PASEP/NIT/NIS é válido. ( 999.99999-99.9 )
 
 ```php
 $this->validate($request, [
-          'cpf' => 'required|cpf',
-      ]);
+    'formato_nis' => 'required|formato_nis',
+]);
 ```
+----------------------------------------------------------------------------------------------------------------------------
 
-No exemplo abaixo, fazemos um teste onde validamos a formatação e a validade de um CPF ou CNPJ, para os casos onde a informação deva ser salva em um mesmo atributo:
+##Combinando validação e formato
+
+No exemplo abaixo, fazemos um teste onde verificamos a formatação e a validade de um CPF ou CNPJ, para os casos onde a informação deva ser salva em um mesmo atributo:
 
 ```php
 $this->validate($request, [
-          'cpf_or_cnpj' => 'formato_cpf_cnpj|cpf_cnpj',
-      ]);
+    'cpf_or_cnpj' => 'formato_cpf_cnpj|cpf_cnpj',
+]);
 ```
 
+----------------------------------------------------------------------------------------------------------------------------
+
+##Exemplo de uso em um controller
+
+Método de validação de exemplo em um controller com todas as possibilidades de validação
+
+```php
+public function store(Request $request)
+{
+    $data = $request->all();
+
+    $this->validate($request, [
+        'cpf' => 'required|cpf',
+        'cnpj' => 'required|cnpj',
+        'cnh' => 'required|cnh',
+        'titulo_eleitor' => 'required|titulo_eleitor',
+        'nis' => 'required|nis',
+    ]);
+
+    dd($data);
+}
+```
+
+----------------------------------------------------------------------------------------------------------------------------
+
+##Geradores de documentos para testes
+
+* **CNH** - http://4devs.com.br/gerador_de_cnh
+* **TÍTULO ELEITORAL** - http://4devs.com.br/gerador_de_titulo_de_eleitor
+* **CNPJ** - http://www.geradorcnpj.com/
+* **CPF** - http://geradordecpf.org
+* **NIS** - https://www.4devs.com.br/gerador_de_pis_pasep
+
 Fique a vontade para contribuir fazendo um fork.
+
+Caso tenha alguma dúvida ou encontre algm bug, abra uma [issue](https://github.com/geekcom/validator-docs/issues) ou pesquise por issues antigas.

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "geekcom/validator-docs",
-  "description": "Biblioteca para validação de Título de Eleitor, CPF, CNPJ e CNH",
+  "description": "Biblioteca para validação de Título de Eleitor, CPF, CNPJ, NIS e CNH",
   "license": "MIT",
   "authors": [
     {

src/validator-docs/Validator.php

@@ -43,7 +43,7 @@ protected function validateFormatoCpfCnpj($attribute, $value)
     {
         return $this->validateFormatoCpf($attribute, $value) || $this->validateFormatoCnpj($attribute, $value);
     }
-    
+
     /**
      * Valida o formato do PIS/PASEP/NIS/NIT
      * @param string $attribute
@@ -70,20 +70,19 @@ protected function validateCpf($attribute, $value)
             return false;
         }
 
-        for ($s = 10, $n = 0, $i = 0; $s >= 2; $n += $c[$i++] * $s--) ;
+        for ($s = 10, $n = 0, $i = 0; $s >= 2; $n += $c[$i++] * $s--);
 
         if ($c[9] != ((($n %= 11) < 2) ? 0 : 11 - $n)) {
             return false;
         }
 
-        for ($s = 11, $n = 0, $i = 0; $s >= 2; $n += $c[$i++] * $s--) ;
+        for ($s = 11, $n = 0, $i = 0; $s >= 2; $n += $c[$i++] * $s--);
 
         if ($c[10] != ((($n %= 11) < 2) ? 0 : 11 - $n)) {
             return false;
         }
 
         return true;
-
     }
 
     /**
@@ -102,20 +101,19 @@ protected function validateCnpj($attribute, $value)
 
         $b = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2];
 
-        for ($i = 0, $n = 0; $i < 12; $n += $c[$i] * $b[++$i]) ;
+        for ($i = 0, $n = 0; $i < 12; $n += $c[$i] * $b[++$i]);
 
         if ($c[12] != ((($n %= 11) < 2) ? 0 : 11 - $n)) {
             return false;
         }
 
-        for ($i = 0, $n = 0; $i <= 12; $n += $c[$i] * $b[$i++]) ;
+        for ($i = 0, $n = 0; $i <= 12; $n += $c[$i] * $b[$i++]);
 
         if ($c[13] != ((($n %= 11) < 2) ? 0 : 11 - $n)) {
             return false;
         }
 
         return true;
-
     }
 
     /**
@@ -172,7 +170,7 @@ protected function validateCnh($attribute, $value)
         }
 
         return $ret;
-    }   
+    }
 
     /**
      * Valida Titulo de Eleitor
@@ -188,9 +186,9 @@ protected function validateTituloEleitor($attribute, $value)
 
         $uf = substr($input, -4, 2);
 
-        if (((strlen($input) < 5) || (strlen($input) > 13)) || 
-        (str_repeat($input[1], strlen($input)) == $input) || 
-        ($uf < 1 || $uf > 28)) {
+        if (((strlen($input) < 5) || (strlen($input) > 13)) ||
+            (str_repeat($input[1], strlen($input)) == $input) ||
+            ($uf < 1 || $uf > 28)) {
             return false;
         }
 
@@ -199,11 +197,11 @@ protected function validateTituloEleitor($attribute, $value)
 
         $sequencia = substr($input, 0, -4);
 
-        for ($i = 0; $i < 2; $i++) { 
+        for ($i = 0; $i < 2; $i++) {
             $fator = 9;
             $soma = 0;
 
-            for ($j = (strlen($sequencia) - 1); $j > -1; $j--) { 
+            for ($j = (strlen($sequencia) - 1); $j > -1; $j--) {
                 $soma += $sequencia[$j] * $fator;
 
                 if ($fator == $base) {
@@ -220,7 +218,7 @@ protected function validateTituloEleitor($attribute, $value)
             } elseif ($digito == 10) {
                 $digito = 0;
             }
-            
+
             if ($dv[$i] != $digito) {
                 return false;
             }
@@ -232,10 +230,10 @@ protected function validateTituloEleitor($attribute, $value)
                     break;
             }
         }
-        
+
         return true;
     }
-    
+
     /**
      * Valida PIS/PASEP/NIS/NIT
      * @param string $attribute