Refactor CNPJ validation: optimize storage and remove Reflection

[juliolmuller]

Summary by CodeRabbit

• Refactor
  • Optimized CNPJ parsing, validation, check-digit generation and caching with measured benchmark improvements (no public API change)
• Exceptions
  • Simplified exception name reporting to return short class names without namespace prefixes
• Tests
  • Tests rewritten for clearer case titles and consistent iteration/assertion style
• Documentation
  • Changelog updated with the above changes and performance notes

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 44a91e7b-62bd-4cd8-b045-6305878f6acd

📥 Commits

Reviewing files that changed from the base of the PR and between d53acbc and 96020d0.

📒 Files selected for processing (1)

• packages/cnpj-dv/CHANGELOG.md

---

📝 Walkthrough

Walkthrough

Refactored CNPJ validation internals from array to string storage, removed Reflection usage from exception name extraction, updated tests to foreach-based cases, and documented the changes in the package changelog. No public API changes.

Changes

CNPJ-DV Performance and API Alignment Refactor

Layer / File(s)	Summary
Exception naming without Reflection packages/cnpj-dv/src/Exceptions/CnpjCheckDigitsException.php, packages/cnpj-dv/src/Exceptions/CnpjCheckDigitsTypeError.php	Both exception classes now derive short class names from static::class using strrpos/substr instead of constructing ReflectionClass instances.
CnpjCheckDigits internal refactor: array to string packages/cnpj-dv/src/CnpjCheckDigits.php	Internal representation changed from character-array ($cnpjChars) to normalized 12-character string ($cnpjBase). Parsing now returns strings; validation and digit generation use string operations (str_split, str_starts_with, substr, str_repeat). Caching and public behavior unchanged.
CnpjCheckDigits test restructuring packages/cnpj-dv/tests/Specs/CnpjCheckDigits.spec.php	Tests converted from Pest with() datasets to explicit foreach loops with per-case it() blocks and closure-based expect(...)->toThrow() assertions; assertions preserved.
Test description formatting packages/cnpj-dv/tests/Specs/Exceptions.spec.php, packages/cnpj-dv/tests/Specs/Package.spec.php	Human-readable test descriptions updated to wrap class/constant identifiers in backticks; no change to assertions.
Version 1.1.0 changelog documentation packages/cnpj-dv/CHANGELOG.md	Changelog entry documents exception naming change and the performance refactor for CnpjCheckDigits, and explicitly states no public API change.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~65 minutes

Possibly related PRs

• LacusSolutions/br-utils-php#38: Directly modifies the same exception classes' getName() implementations in packages/cnpj-dv.
• LacusSolutions/br-utils-php#37: Earlier refactor touching the same CnpjCheckDigits and exception classes.

Poem

🐰 A string now hops where arrays once played,
Reflection trimmed, light-footed the trade.
Tests loop in chorus, each case named bright,
Changelog whispers: API kept tight.
A little rabbit cheers the refactor's flight!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title Check	✅ Passed	Title check skipped as CodeRabbit has written the PR title.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch perf/cnpj-dv

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/cnpj-dv/CHANGELOG.md`:
- Line 11: Update the CHANGELOG entry to reflect the actual shipped
implementation: remove or reword claims about a `private const WEIGHTS` lookup
table and `??=` memoization since `calculate()` still uses the factor-rolling
logic (the `factor === 9 ? 2 : factor + 1` style) and `getBoth()`/`getCnpj()`
still use explicit `if ($cache === null)` cache checks; mention the true
optimizations present (e.g., string-based internal representation, C-level
primitives, parseStringInput/parseArrayInput behavior) rather than the absent
WEIGHTS constant and null-coalescing assignment.

In `@packages/cnpj-dv/src/CnpjCheckDigits.php`:
- Around line 185-199: Update the parseArrayInput() PHPDoc to reflect that the
function can receive arrays with non-string elements so static analysis sees the
is_string check as reachable: change the `@param` annotation from list<string> to
list<mixed> (or array<mixed> / array<int,mixed>) above parseArrayInput(),
leaving the runtime guard and CnpjCheckDigitsInputTypeError throw intact; this
aligns the docblock with the actual contract of parseArrayInput() and removes
PHPStan false positives for the is_string($item) branch.

In `@packages/cnpj-dv/tests/Specs/CnpjCheckDigits.spec.php`:
- Around line 227-230: The test declares a local $invalid as (object) [...] but
annotates it with "@var mixed", causing a PHPStan conflict; edit the spec inside
the it('throws `CnpjCheckDigitsInputTypeError` for object input', ...) block and
either remove the "@var mixed" doc comment entirely or change it to a more
specific type like "@var stdClass $invalid" so the annotation matches the actual
object literal and PHPStan warning is resolved.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c933d0d7-33f7-46fc-8ded-9b4443c4c5c2

📥 Commits

Reviewing files that changed from the base of the PR and between 18d1513 and d2039c0.

📒 Files selected for processing (7)

• packages/cnpj-dv/CHANGELOG.md
• packages/cnpj-dv/src/CnpjCheckDigits.php
• packages/cnpj-dv/src/Exceptions/CnpjCheckDigitsException.php
• packages/cnpj-dv/src/Exceptions/CnpjCheckDigitsTypeError.php
• packages/cnpj-dv/tests/Specs/CnpjCheckDigits.spec.php
• packages/cnpj-dv/tests/Specs/Exceptions.spec.php
• packages/cnpj-dv/tests/Specs/Package.spec.php

[juliolmuller]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[juliolmuller]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/cnpj-dv/CHANGELOG.md`:
- Line 11: The changelog paragraph is dense and must be converted into a clear,
bulleted entry and use Conventional Comments format (e.g., a "docs:" or "chore:"
prefix); split the single paragraph into bullets that call out the internal
representation change ($cnpjBase / CnpjCheckDigits), validator optimizations
(use of strlen, str_starts_with, substr, str_repeat), parsing improvements
(parseStringInput, parseArrayInput), retained BC behavior in calculate (array
$cnpjSequence and factor-rolling logic), caching behavior (getBoth, getCnpj with
explicit if ($cache === null) checks), and benchmark results, and ensure the
entry begins with the appropriate Conventional Comment tag.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3bdd0561-a44e-4fdb-a7a5-969ce829e445

📥 Commits

Reviewing files that changed from the base of the PR and between d2039c0 and d53acbc.

📒 Files selected for processing (1)

• packages/cnpj-dv/CHANGELOG.md

[juliolmuller]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.