[v2][cnpj-dv] Upgrade to latest API and add support to alphanumeric CNPJ format

packages/cnpj-dv/CHANGELOG.md

@@ -1,5 +1,11 @@
 # lacus/cnpj-dv
 
+## 1.1.0
+
+### New Features
+
+- a90dd0a89b18a19bbb8ad72200d65df01c465fdb Created **`getName()`** to all package-specific errors and exceptions. Now `CnpjCheckDigitsException`, `CnpjCheckDigitsTypeError` and all their subclasses can return their class names without namespaces. This change is an API alignment across all **BR Utils** initiatives.
+
 ## 1.0.0
 
 ### 🚀 Stable Version Released!

packages/cnpj-dv/README.pt.md

@@ -57,7 +57,7 @@ A classe `CnpjCheckDigits` aceita múltiplos formatos de entrada:
 
 **String:** dígitos e/ou letras crus, ou CNPJ formatado (ex.: `91.415.732/0007-93`, `MG.KGM.J9X/0001-68`). Caracteres não alfanuméricos são removidos; letras minúsculas viram maiúsculas.
 
-**Array de strings:** cada elemento deve ser string; os valores são concatenados e interpretados como uma única string (ex.: `['9','1','4',…]`, `['9141','5732','0007']`, `['MG','KGM','J9X','0001']`). Elementos que não são string não são permitidos.
+**Array de strings:** cada elemento deve ser string; os valores são concatenados e interpretados como uma única string (ex.: `['9','1','4',…]`, `['9141','5732','0007']`, `['MG','KGM','J9X','0001']`). Elementos que não são strings não são permitidos.
 
 ### Erros e exceções
 

packages/cnpj-dv/src/CnpjCheckDigits.php

@@ -35,7 +35,6 @@ class CnpjCheckDigits
     /** Maximum number of characters accepted as input for the CNPJ check digits calculation. */
     public const CNPJ_MAX_LENGTH = CNPJ_MAX_LENGTH;
 
-
     /** @var list<string> */
     private array $cnpjChars;
     private ?int $cachedFirstDigit = null;

packages/cnpj-dv/src/Exceptions/CnpjCheckDigitsException.php

@@ -5,6 +5,7 @@
 namespace Lacus\BrUtils\Cnpj\Exceptions;
 
 use Exception;
+use ReflectionClass;
 
 /**
  * Base exception for all `cnpj-dv` rules-related errors.
@@ -16,4 +17,18 @@
  */
 abstract class CnpjCheckDigitsException extends Exception
 {
+    public function __construct(string $message)
+    {
+        parent::__construct($message);
+    }
+
+    /**
+     * Get the short class name of the exception instance.
+     */
+    public function getName(): string
+    {
+        $thisReflection = new ReflectionClass($this);
+
+        return $thisReflection->getShortName();
+    }
 }

packages/cnpj-dv/src/Exceptions/CnpjCheckDigitsTypeError.php

@@ -4,7 +4,7 @@
 
 namespace Lacus\BrUtils\Cnpj\Exceptions;
 
-use Throwable;
+use ReflectionClass;
 use TypeError;
 
 /**
@@ -24,12 +24,20 @@ public function __construct(
         string $actualType,
         string $expectedType,
         string $message,
-        int $code = 0,
-        ?Throwable $previous = null,
     ) {
-        parent::__construct($message, $code, $previous);
+        parent::__construct($message);
         $this->actualInput = $actualInput;
         $this->actualType = $actualType;
         $this->expectedType = $expectedType;
     }
+
+    /**
+     * Get the short class name of the error instance.
+     */
+    public function getName(): string
+    {
+        $thisReflection = new ReflectionClass($this);
+
+        return $thisReflection->getShortName();
+    }
 }

packages/cnpj-dv/tests/Specs/Exceptions.spec.php

@@ -4,67 +4,60 @@
 
 namespace Lacus\BrUtils\Cnpj\Tests\Specs;
 
+use Exception;
 use Lacus\BrUtils\Cnpj\Exceptions\CnpjCheckDigitsException;
 use Lacus\BrUtils\Cnpj\Exceptions\CnpjCheckDigitsInputInvalidException;
 use Lacus\BrUtils\Cnpj\Exceptions\CnpjCheckDigitsInputLengthException;
 use Lacus\BrUtils\Cnpj\Exceptions\CnpjCheckDigitsInputTypeError;
 use Lacus\BrUtils\Cnpj\Exceptions\CnpjCheckDigitsTypeError;
 use TypeError;
 
-final class TestCnpjCheckDigitsTypeError extends CnpjCheckDigitsTypeError
-{
-    public function __construct()
+describe('CnpjCheckDigitsTypeError', function () {
+    final class TestTypeError extends CnpjCheckDigitsTypeError
     {
-        parent::__construct(123, 'number', 'string', 'some error');
     }
-}
-
-final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
-{
-}
 
-describe('CnpjCheckDigitsTypeError', function () {
     describe('when instantiated through a subclass', function () {
         it('is an instance of TypeError', function () {
-            $error = new TestCnpjCheckDigitsTypeError();
+            $error = new TestTypeError(123, 'number', 'string', 'some error');
 
             expect($error)->toBeInstanceOf(TypeError::class);
         });
 
         it('is an instance of CnpjCheckDigitsTypeError', function () {
-            $error = new TestCnpjCheckDigitsTypeError();
+            $error = new TestTypeError(123, 'number', 'string', 'some error');
 
             expect($error)->toBeInstanceOf(CnpjCheckDigitsTypeError::class);
         });
 
-        it('has the correct class name', function () {
-            $error = new TestCnpjCheckDigitsTypeError();
-
-            expect($error::class)->toBe(TestCnpjCheckDigitsTypeError::class);
-        });
-
         it('sets the `actualInput` property', function () {
-            $error = new TestCnpjCheckDigitsTypeError();
+            $error = new TestTypeError(123, 'number', 'string', 'some error');
 
             expect($error->actualInput)->toBe(123);
         });
 
         it('sets the `actualType` property', function () {
-            $error = new TestCnpjCheckDigitsTypeError();
+            $error = new TestTypeError(123, 'number', 'string', 'some error');
 
             expect($error->actualType)->toBe('number');
         });
 
         it('sets the `expectedType` property', function () {
-            $error = new TestCnpjCheckDigitsTypeError();
+            $error = new TestTypeError(123, 'number', 'string', 'some error');
 
             expect($error->expectedType)->toBe('string');
         });
 
-        it('has a `message` property', function () {
-            $error = new TestCnpjCheckDigitsTypeError();
+        it('has the correct message', function () {
+            $exception = new TestTypeError(123, 'number', 'string', 'some error');
 
-            expect($error->getMessage())->toBe('some error');
+            expect($exception->getMessage())->toBe('some error');
+        });
+
+        it('has the correct name', function () {
+            $exception = new TestTypeError(123, 'number', 'string', 'some error');
+
+            expect($exception->getName())->toBe('TestTypeError');
         });
     });
 });
@@ -83,17 +76,10 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
             expect($error)->toBeInstanceOf(CnpjCheckDigitsTypeError::class);
         });
 
-        it('has the correct class name', function () {
-            $error = new CnpjCheckDigitsInputTypeError(123, 'string');
-
-            expect($error::class)->toBe(CnpjCheckDigitsInputTypeError::class);
-        });
-
         it('sets the `actualInput` property', function () {
-            $input = 123;
-            $error = new CnpjCheckDigitsInputTypeError($input, 'string');
+            $error = new CnpjCheckDigitsInputTypeError(123, 'string');
 
-            expect($error->actualInput)->toBe($input);
+            expect($error->actualInput)->toBe(123);
         });
 
         it('sets the `actualType` property', function () {
@@ -108,43 +94,56 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
             expect($error->expectedType)->toBe('string or string[]');
         });
 
-        it('generates a message describing the error', function () {
+        it('has the correct message', function () {
             $actualInput = 123;
             $actualType = 'integer number';
             $expectedType = 'string[]';
             $actualMessage = "CNPJ input must be of type {$expectedType}. Got {$actualType}.";
 
-            $error = new CnpjCheckDigitsInputTypeError($actualInput, $expectedType);
+            $error = new CnpjCheckDigitsInputTypeError(
+                $actualInput,
+                $expectedType,
+            );
 
             expect($error->getMessage())->toBe($actualMessage);
         });
+
+        it('has the correct name', function () {
+            $error = new CnpjCheckDigitsInputTypeError(123, 'string');
+
+            expect($error->getName())->toBe('CnpjCheckDigitsInputTypeError');
+        });
     });
 });
 
 describe('CnpjCheckDigitsException', function () {
+    final class TestException extends CnpjCheckDigitsException
+    {
+    }
+
     describe('when instantiated through a subclass', function () {
         it('is an instance of Exception', function () {
-            $exception = new TestCnpjCheckDigitsException('some error');
+            $exception = new TestException('some error');
 
-            expect($exception)->toBeInstanceOf(\Exception::class);
+            expect($exception)->toBeInstanceOf(Exception::class);
         });
 
         it('is an instance of CnpjCheckDigitsException', function () {
-            $exception = new TestCnpjCheckDigitsException('some error');
+            $exception = new TestException('some error');
 
             expect($exception)->toBeInstanceOf(CnpjCheckDigitsException::class);
         });
 
-        it('has the correct class name', function () {
-            $exception = new TestCnpjCheckDigitsException('some error');
+        it('has the correct message', function () {
+            $exception = new TestException('some exception');
 
-            expect($exception::class)->toBe(TestCnpjCheckDigitsException::class);
+            expect($exception->getMessage())->toBe('some exception');
         });
 
-        it('has a `message` property', function () {
-            $exception = new TestCnpjCheckDigitsException('some error');
+        it('has the correct name', function () {
+            $exception = new TestException('some error');
 
-            expect($exception->getMessage())->toBe('some error');
+            expect($exception->getName())->toBe('TestException');
         });
     });
 });
@@ -154,7 +153,7 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
         it('is an instance of Exception', function () {
             $exception = new CnpjCheckDigitsInputLengthException('1.2.3.4.5', '12345', 12, 14);
 
-            expect($exception)->toBeInstanceOf(\Exception::class);
+            expect($exception)->toBeInstanceOf(Exception::class);
         });
 
         it('is an instance of CnpjCheckDigitsException', function () {
@@ -163,12 +162,6 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
             expect($exception)->toBeInstanceOf(CnpjCheckDigitsException::class);
         });
 
-        it('has the correct class name', function () {
-            $exception = new CnpjCheckDigitsInputLengthException('1.2.3.4.5', '12345', 12, 14);
-
-            expect($exception::class)->toBe(CnpjCheckDigitsInputLengthException::class);
-        });
-
         it('sets the `actualInput` property', function () {
             $exception = new CnpjCheckDigitsInputLengthException('1.2.3.4.5', '12345', 12, 14);
 
@@ -193,7 +186,7 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
             expect($exception->maxExpectedLength)->toBe(14);
         });
 
-        it('generates a message describing the exception', function () {
+        it('has the correct message', function () {
             $actualInput = '1.2.3.4.5';
             $evaluatedInput = '12345';
             $minExpectedLength = 12;
@@ -209,6 +202,12 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
 
             expect($exception->getMessage())->toBe($actualMessage);
         });
+
+        it('has the correct name', function () {
+            $exception = new CnpjCheckDigitsInputLengthException('1.2.3.4.5', '12345', 12, 14);
+
+            expect($exception->getName())->toBe('CnpjCheckDigitsInputLengthException');
+        });
     });
 });
 
@@ -217,7 +216,7 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
         it('is an instance of Exception', function () {
             $exception = new CnpjCheckDigitsInputInvalidException('1.2.3.4.5', 'repeated digits');
 
-            expect($exception)->toBeInstanceOf(\Exception::class);
+            expect($exception)->toBeInstanceOf(Exception::class);
         });
 
         it('is an instance of CnpjCheckDigitsException', function () {
@@ -226,12 +225,6 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
             expect($exception)->toBeInstanceOf(CnpjCheckDigitsException::class);
         });
 
-        it('has the correct class name', function () {
-            $exception = new CnpjCheckDigitsInputInvalidException('1.2.3.4.5', 'repeated digits');
-
-            expect($exception::class)->toBe(CnpjCheckDigitsInputInvalidException::class);
-        });
-
         it('sets the `actualInput` property', function () {
             $exception = new CnpjCheckDigitsInputInvalidException('1.2.3.4.5', 'repeated digits');
 
@@ -244,14 +237,23 @@ final class TestCnpjCheckDigitsException extends CnpjCheckDigitsException
             expect($exception->reason)->toBe('repeated digits');
         });
 
-        it('generates a message describing the exception', function () {
+        it('has the correct message', function () {
             $actualInput = '1.2.3.4.5';
             $reason = 'repeated digits';
             $actualMessage = 'CNPJ input "'.$actualInput.'" is invalid. '.$reason;
 
-            $exception = new CnpjCheckDigitsInputInvalidException($actualInput, $reason);
+            $exception = new CnpjCheckDigitsInputInvalidException(
+                $actualInput,
+                $reason,
+            );
 
             expect($exception->getMessage())->toBe($actualMessage);
         });
+
+        it('has the correct name', function () {
+            $exception = new CnpjCheckDigitsInputInvalidException('1.2.3.4.5', 'repeated digits');
+
+            expect($exception->getName())->toBe('CnpjCheckDigitsInputInvalidException');
+        });
     });
 });