[v3][cpf-dv] Create cpf-dv package for CPF check digit calculation#36
Merged
juliolmuller merged 16 commits intomainfrom Mar 21, 2026
Merged
[v3][cpf-dv] Create cpf-dv package for CPF check digit calculation#36juliolmuller merged 16 commits intomainfrom
v3][cpf-dv] Create cpf-dv package for CPF check digit calculation#36juliolmuller merged 16 commits intomainfrom
Conversation
📝 WalkthroughWalkthroughAdds a new PHP package Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment Tip CodeRabbit can scan for known vulnerabilities in your dependencies using OSV Scanner.OSV Scanner will automatically detect and report security vulnerabilities in your project's dependencies. No additional configuration is required. |
Closed
6 tasks
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/cpf-dv/README.pt.md`:
- Around line 1-5: Add a top-level H1 heading to the README before the existing
image to satisfy markdownlint MD041 and improve navigability; update the
README.pt.md by inserting an H1 (e.g., "# cpf-dv para PHP" or similar Portuguese
title) at the top so the file begins with a heading rather than an image.
In `@packages/cpf-dv/src/cpf-dv.php`:
- Around line 11-17: Remove the duplicated namespace constants CPF_MIN_LENGTH
and CPF_MAX_LENGTH and update any code in this file to reference the canonical
class constants on CpfCheckDigits (use CpfCheckDigits::CPF_MIN_LENGTH and
CpfCheckDigits::CPF_MAX_LENGTH) so the values can’t drift; locate the constants
defined in this file and all usages and replace them with references to the
CpfCheckDigits class constants.
In `@packages/cpf-dv/src/CpfCheckDigits.php`:
- Around line 163-166: The thrown CpfCheckDigitsInputTypeError inside the
foreach over $cpfArray currently passes 'string' as the expected type but should
indicate an array of strings; update the error construction in the loop (where
foreach ($cpfArray as $item) triggers throw new
CpfCheckDigitsInputTypeError($cpfArray, 'string')) to pass 'string[]' instead so
the error accurately reflects that array members must be strings.
In `@packages/cpf-dv/src/Exceptions/CpfCheckDigitsInputInvalidException.php`:
- Around line 22-24: Align the indentation for the ternary assignment to match
the project's 4-space style: update the lines that set $fmtActual (the ternary
using is_string($actualInput) ? "\"{$actualInput}\"" : json_encode($actualInput,
JSON_THROW_ON_ERROR);) so the continuation line(s) use 4-space indentation
instead of 2-space, ensuring the formatting of the $fmtActual assignment in
CpfCheckDigitsInputInvalidException is consistent with the rest of the file.
In `@packages/cpf-dv/src/Exceptions/CpfCheckDigitsInputLengthException.php`:
- Around line 29-31: The indentation in CpfCheckDigitsInputLengthException
around the $fmtActual assignment is inconsistent; update the block in the
CpfCheckDigitsInputLengthException class (the ternary assignment that sets
$fmtActual using is_string($actualInput) ? "\"{$actualInput}\"" :
json_encode(...)) to match the project's 4-space indentation style used in
CpfCheckDigitsInputInvalidException so the lines align consistently with
surrounding code.
In `@packages/cpf-dv/tests/Mocks/CpfCheckDigitsWithCalculateSpy.php`:
- Around line 13-16: Remove the no-op constructor from the
CpfCheckDigitsWithCalculateSpy class: the __construct(mixed $cpfInput) method
only calls parent::__construct($cpfInput) and adds no behavior, so delete this
constructor so the spy inherits the parent's constructor directly; update any
instantiation calls if they rely on type hints (they shouldn't) and run the
tests to ensure no regressions.
In `@packages/cpf-dv/tests/Pest.php`:
- Line 13: The Pest bootstrap uses the wrong constant when building the specs
path: in the uses(TestCase::class)->in(__DIR__ . PATH_SEPARATOR . 'Specs') call
replace PATH_SEPARATOR with DIRECTORY_SEPARATOR so the filesystem path is
constructed correctly (uses(TestCase::class)->in(__DIR__ . DIRECTORY_SEPARATOR .
'Specs')), ensuring Pest can discover specs across platforms.
In `@packages/cpf-dv/tests/Specs/CpfCheckDigits.spec.php`:
- Around line 324-342: Add a spec that asserts CpfCheckDigits->__get throws when
an unknown magic property is accessed: create a new it() under the existing
"edge cases" describe block which instantiates new CpfCheckDigits('123456789')
and then wraps an access like $cpfCheckDigits->nonexistentProperty in a closure
and expects that invoking the closure throws an exception (matching whatever
exception type CpfCheckDigits::__get currently throws); reference the
CpfCheckDigits class and its __get method in the test so the behavior is
explicitly covered.
In `@packages/utils/README.md`:
- Around line 12-14: The README's test status table still lists a "PHP 8.1"
column as Passing, but the CI matrix key php-versions no longer includes 8.1;
update to keep them consistent by either removing the PHP 8.1 column from the
test status table in the README or re-adding "8.1" to the php-versions matrix in
the CI workflow (adjust the test badges/row entries accordingly so the table
accurately reflects the CI matrix).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: ea8f4376-e84a-4019-a49d-c6a191b1e3ec
📒 Files selected for processing (21)
.github/workflows/ci.ymlpackages/cpf-dv/CHANGELOG.mdpackages/cpf-dv/LICENSEpackages/cpf-dv/README.mdpackages/cpf-dv/README.pt.mdpackages/cpf-dv/composer.jsonpackages/cpf-dv/phpunit.xmlpackages/cpf-dv/src/CpfCheckDigits.phppackages/cpf-dv/src/Exceptions/CpfCheckDigitsException.phppackages/cpf-dv/src/Exceptions/CpfCheckDigitsInputInvalidException.phppackages/cpf-dv/src/Exceptions/CpfCheckDigitsInputLengthException.phppackages/cpf-dv/src/Exceptions/CpfCheckDigitsInputTypeError.phppackages/cpf-dv/src/Exceptions/CpfCheckDigitsTypeError.phppackages/cpf-dv/src/cpf-dv.phppackages/cpf-dv/tests/Mocks/CpfCheckDigitsWithCalculateSpy.phppackages/cpf-dv/tests/Pest.phppackages/cpf-dv/tests/Specs/CpfCheckDigits.spec.phppackages/cpf-dv/tests/Specs/Exceptions.spec.phppackages/cpf-dv/tests/Specs/Package.spec.phppackages/utils/README.mdphpstan.neon
packages/cpf-dv/src/Exceptions/CpfCheckDigitsInputInvalidException.php
Outdated
Show resolved
Hide resolved
packages/cpf-dv/src/Exceptions/CpfCheckDigitsInputLengthException.php
Outdated
Show resolved
Hide resolved
Fix as per @coderabbitai review comment at #36 (comment).
Fix as per @coderabbitai review comment at #36 (comment).
Fix as per @coderabbitai review comment at #36 (comment).
Fix as per @coderabbitai review comment at #36 (comment).
Fix as per @coderabbitai review comment at #36 (comment).
There was a problem hiding this comment.
♻️ Duplicate comments (1)
packages/cpf-dv/src/CpfCheckDigits.php (1)
163-166:⚠️ Potential issue | 🟡 MinorUse
string[]as expected type for invalid array members.On Line 165, this branch is validating array elements, so reporting expected type as
string[]is more accurate thanstring or string[].Proposed fix
- throw new CpfCheckDigitsInputTypeError($cpfArray, 'string or string[]'); + throw new CpfCheckDigitsInputTypeError($cpfArray, 'string[]');🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/cpf-dv/src/CpfCheckDigits.php` around lines 163 - 166, The error message passed to CpfCheckDigitsInputTypeError inside the foreach validation loop is incorrect: update the expected-type string argument from 'string or string[]' to 'string[]' where CpfCheckDigitsInputTypeError($cpfArray, 'string or string[]') is thrown in the foreach ($cpfArray as $item) block so the reported expected type reflects that array members must be strings.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@packages/cpf-dv/src/CpfCheckDigits.php`:
- Around line 163-166: The error message passed to CpfCheckDigitsInputTypeError
inside the foreach validation loop is incorrect: update the expected-type string
argument from 'string or string[]' to 'string[]' where
CpfCheckDigitsInputTypeError($cpfArray, 'string or string[]') is thrown in the
foreach ($cpfArray as $item) block so the reported expected type reflects that
array members must be strings.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 811a4237-5a99-4ebf-b125-1c87beab1ab8
📒 Files selected for processing (5)
packages/cpf-dv/src/CpfCheckDigits.phppackages/cpf-dv/src/Exceptions/CpfCheckDigitsInputInvalidException.phppackages/cpf-dv/src/Exceptions/CpfCheckDigitsInputLengthException.phppackages/cpf-dv/tests/Mocks/CpfCheckDigitsWithCalculateSpy.phppackages/cpf-dv/tests/Pest.php
juliolmuller
added a commit
that referenced
this pull request
Mar 21, 2026
Fix as per @coderabbitai review comment at #36 (comment).
juliolmuller
added a commit
that referenced
this pull request
Mar 21, 2026
Fix as per @coderabbitai review comment at #36 (comment).
juliolmuller
added a commit
that referenced
this pull request
Mar 21, 2026
Fix as per @coderabbitai review comment at #36 (comment).
juliolmuller
added a commit
that referenced
this pull request
Mar 21, 2026
Fix as per @coderabbitai review comment at #36 (comment).
juliolmuller
added a commit
that referenced
this pull request
Mar 21, 2026
Fix as per @coderabbitai review comment at #36 (comment).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Documentation
Tests
Chores