Apply contribution guidelines to "Cpf" rule

Co-Authored-By: Henrique Moody <henriquemoody@gmail.com>

library/Exceptions/CpfException.php

@@ -13,8 +13,16 @@ declare(strict_types=1);
 
 namespace Respect\Validation\Exceptions;
 
-class CpfException extends ValidationException
+/**
+ * @author Henrique Moody <henriquemoody@gmail.com>
+ * @author Jair Henrique <jair.henrique@gmail.com>
+ * @author Wiliam Espindola <oi@williamespindola.com.br>
+ */
+final class CpfException extends ValidationException
 {
+    /**
+     * {@inheritdoc}
+     */
     public static $defaultTemplates = [
         self::MODE_DEFAULT => [
             self::STANDARD => '{{name}} must be a valid CPF number',

library/Rules/Cpf.php

@@ -13,8 +13,25 @@ declare(strict_types=1);
 
 namespace Respect\Validation\Rules;
 
-class Cpf extends AbstractRule
+use function mb_strlen;
+use function preg_match;
+use function preg_replace;
+
+/**
+ * Validates whether the input is a CPF (Brazilian Natural Persons Register) number.
+ *
+ * @author Alexandre Gomes Gaigalas <alexandre@gaigalas.net>
+ * @author Henrique Moody <henriquemoody@gmail.com>
+ * @author Jair Henrique <jair.henrique@gmail.com>
+ * @author Jayson Reis <jayson.reis@sabbre.com.br>
+ * @author Jean Pimentel <jeanfap@gmail.com>
+ * @author William Espindola <oi@williamespindola.com.br>
+ */
+final class Cpf extends AbstractRule
 {
+    /**
+     * {@inheritdoc}
+     */
     public function validate($input): bool
     {
         // Code ported from jsfromhell.com

tests/integration/rules/cpf.phpt

@@ -0,0 +1,37 @@
+--FILE--
+<?php
+require 'vendor/autoload.php';
+
+use Respect\Validation\Exceptions\CpfException;
+use Respect\Validation\Exceptions\NestedValidationException;
+use Respect\Validation\Validator as v;
+
+try {
+    v::cpf()->check('this thing');
+} catch (CpfException $exception) {
+    echo $exception->getMessage().PHP_EOL;
+}
+
+try {
+    v::not(v::cpf())->check('276.865.775-11');
+} catch (CpfException $exception) {
+    echo $exception->getMessage().PHP_EOL;
+}
+
+try {
+    v::cpf()->assert('your mother');
+} catch (NestedValidationException $exception) {
+    echo $exception->getFullMessage().PHP_EOL;
+}
+
+try {
+    v::not(v::cpf())->assert('61836182848');
+} catch (NestedValidationException $exception) {
+    echo $exception->getFullMessage().PHP_EOL;
+}
+?>
+--EXPECTF--
+"this thing" must be a valid CPF number
+"276.865.775-11" must not be a valid CPF number
+- "your mother" must be a valid CPF number
+- "61836182848" must not be a valid CPF number

tests/integration/rules/cpf_1.phpt

@@ -1,11 +0,0 @@
---FILE--
-<?php
-
-require 'vendor/autoload.php';
-
-use Respect\Validation\Validator as v;
-
-v::cpf()->check('68786265440');
-v::cpf()->assert('485.764.121-60');
-?>
---EXPECTF--

tests/integration/rules/cpf_2.phpt

@@ -1,17 +0,0 @@
---FILE--
-<?php
-
-require 'vendor/autoload.php';
-
-use Respect\Validation\Exceptions\CpfException;
-use Respect\Validation\Validator as v;
-
-try {
-    v::cpf()->check('this thing');
-} catch (CpfException $e) {
-    echo $e->getMessage();
-}
-
-?>
---EXPECTF--
-"this thing" must be a valid CPF number

tests/integration/rules/cpf_3.phpt

@@ -1,16 +0,0 @@
---FILE--
-<?php
-
-require 'vendor/autoload.php';
-
-use Respect\Validation\Exceptions\AllOfException;
-use Respect\Validation\Validator as v;
-
-try {
-    v::cpf()->assert('your mother');
-} catch (AllOfException $e) {
-    echo $e->getFullMessage();
-}
-?>
---EXPECTF--
-- "your mother" must be a valid CPF number

tests/integration/rules/cpf_4.phpt

@@ -1,16 +0,0 @@
---FILE--
-<?php
-
-require 'vendor/autoload.php';
-
-use Respect\Validation\Exceptions\CpfException;
-use Respect\Validation\Validator as v;
-
-try {
-    v::not(v::cpf())->check('276.865.775-11');
-} catch (CpfException $e) {
-    echo $e->getMessage();
-}
-?>
---EXPECTF--
-"276.865.775-11" must not be a valid CPF number

tests/integration/rules/cpf_5.phpt

@@ -1,16 +0,0 @@
---FILE--
-<?php
-
-require 'vendor/autoload.php';
-
-use Respect\Validation\Exceptions\AllOfException;
-use Respect\Validation\Validator as v;
-
-try {
-    v::not(v::cpf())->assert('368.928.062-10');
-} catch (AllOfException $e) {
-    echo $e->getFullMessage().PHP_EOL;
-}
-?>
---EXPECTF--
-- "368.928.062-10" must not be a valid CPF number

tests/unit/Rules/CpfTest.php

@@ -13,123 +13,68 @@ declare(strict_types=1);
 
 namespace Respect\Validation\Rules;
 
-use PHPUnit\Framework\TestCase;
+use Respect\Validation\Test\RuleTestCase;
 
 /**
- * @group  rule
+ * @group rule
+ *
  * @covers \Respect\Validation\Rules\Cpf
- * @covers \Respect\Validation\Exceptions\CpfException
+ *
+ * @author Alexandre Gomes Gaigalas <alexandre@gaigalas.net>
+ * @author Gabriel Caruso <carusogabriel34@gmail.com>
+ * @author Henrique Moody <henriquemoody@gmail.com>
+ * @author Jair Henrique <jair.henrique@gmail.com>
+ * @author Jean Pimentel <jeanfap@gmail.com>
+ * @author William Espindola <oi@williamespindola.com.br>
  */
-class CpfTest extends TestCase
+final class CpfTest extends RuleTestCase
 {
-    protected $cpfValidator;
-
-    protected function setUp(): void
-    {
-        $this->cpfValidator = new Cpf();
-    }
-
     /**
-     * @doesNotPerformAssertions
-     *
-     * @dataProvider providerValidFormattedCpf
+     * {@inheritdoc}
      */
-    public function testFormattedCpfsShouldValidate($input): void
+    public function providerForValidInput(): array
     {
-        $this->cpfValidator->assert($input);
-    }
+        $rule = new Cpf();
 
-    /**
-     * @doesNotPerformAssertions
-     *
-     * @dataProvider providerValidUnformattedCpf
-     */
-    public function testUnformattedCpfsShouldValidates($input): void
-    {
-        $this->cpfValidator->assert($input);
-    }
-
-    /**
-     * @dataProvider providerInvalidFormattedCpf
-     * @expectedException \Respect\Validation\Exceptions\CpfException
-     */
-    public function testInvalidCpfShouldFailWhenFormatted($input): void
-    {
-        $this->cpfValidator->assert($input);
-    }
-
-    /**
-     * @dataProvider providerInvalidUnformattedCpf
-     * @expectedException \Respect\Validation\Exceptions\CpfException
-     */
-    public function testInvalidCpfShouldFailWhenNotFormatted($input): void
-    {
-        $this->cpfValidator->assert($input);
-    }
-
-    /**
-     * @dataProvider providerInvalidFormattedAndUnformattedCpfLength
-     * @expectedException \Respect\Validation\Exceptions\CpfException
-     */
-    public function testCpfsWithIncorrectLengthShouldFail($input): void
-    {
-        $this->cpfValidator->assert($input);
-    }
-
-    public function providerValidFormattedCpf()
-    {
         return [
-            ['342.444.198-88'],
-            ['342.444.198.88'],
-            ['350.45261819'],
-            ['693-319-118-40'],
-            ['3.6.8.8.9.2.5.5.4.8.8'],
+            [$rule, '342.444.198-88'],
+            [$rule, '342.444.198.88'],
+            [$rule, '350.45261819'],
+            [$rule, '693-319-118-40'],
+            [$rule, '3.6.8.8.9.2.5.5.4.8.8'],
+            [$rule, '11598647644'],
+            [$rule, '86734718697'],
+            [$rule, '86223423284'],
+            [$rule, '24845408333'],
+            [$rule, '95574461102'],
         ];
     }
 
-    public function providerValidUnformattedCpf()
+    /**
+     * {@inheritdoc}
+     */
+    public function providerForInvalidInput(): array
     {
-        return [
-            ['11598647644'],
-            ['86734718697'],
-            ['86223423284'],
-            ['24845408333'],
-            ['95574461102'],
-        ];
-    }
+        $rule = new Cpf();
 
-    public function providerInvalidFormattedCpf()
-    {
         return [
-            [''],
-            ['000.000.000-00'],
-            ['111.222.444-05'],
-            ['999999999.99'],
-            ['8.8.8.8.8.8.8.8.8.8.8'],
-            ['693-319-110-40'],
-            ['698.111-111.00'],
-        ];
-    }
-
-    public function providerInvalidUnformattedCpf()
-    {
-        return [
-            ['11111111111'],
-            ['22222222222'],
-            ['12345678900'],
-            ['99299929384'],
-            ['84434895894'],
-            ['44242340000'],
-        ];
-    }
-
-    public function providerInvalidFormattedAndUnformattedCpfLength()
-    {
-        return [
-            ['1'],
-            ['22'],
-            ['123'],
-            ['992999999999929384'],
+            [$rule, ''],
+            [$rule, '000.000.000-00'],
+            [$rule, '111.222.444-05'],
+            [$rule, '999999999.99'],
+            [$rule, '8.8.8.8.8.8.8.8.8.8.8'],
+            [$rule, '693-319-110-40'],
+            [$rule, '698.111-111.00'],
+            [$rule, '11111111111'],
+            [$rule, '22222222222'],
+            [$rule, '12345678900'],
+            [$rule, '99299929384'],
+            [$rule, '84434895894'],
+            [$rule, '44242340000'],
+            [$rule, '1'],
+            [$rule, '22'],
+            [$rule, '123'],
+            [$rule, '992999999999929384'],
         ];
     }
 }