fix: improve error handling in EncodingValidator and update expected_convention in tests by konradmichalik · Pull Request #50 · move-elevator/composer-translation-validator

konradmichalik · 2025-07-28T11:09:55Z

Summary by CodeRabbit

Bug Fixes
- Improved error handling when validating files by providing clearer error messages if a file does not exist.
- Adjusted the reporting of expected naming conventions in validation results to display them as readable strings.
Tests
- Updated test cases to match the new error messages and the updated format of expected convention values.

…convention in tests

coderabbitai · 2025-07-28T11:10:03Z

Walkthrough

This change updates the EncodingValidator to check file existence before reading, logging an error and returning early if the file is missing. Additionally, KeyNamingConventionValidator now reports the expected convention as a string rather than an enum object. Associated tests are updated to match these behavioral changes.

Changes

Cohort / File(s)	Change Summary
EncodingValidator file existence handling `src/Validator/EncodingValidator.php`	Adds an early file existence check in `processFile`, logs error and returns empty array if missing.
KeyNamingConventionValidator convention reporting `src/Validator/KeyNamingConventionValidator.php`	Changes `expected_convention` in issue data from enum object to string value or 'custom pattern'.
EncodingValidator test update `tests/src/Validator/EncodingValidatorTest.php`	Updates test to expect new error message for missing file scenario.
KeyNamingConventionValidator test update `tests/src/Validator/KeyNamingConventionValidatorTest.php`	Updates test to assert `expected_convention` is a string, not an enum object.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant EncodingValidator
    participant Logger

    Caller->>EncodingValidator: processFile(filePath)
    EncodingValidator->>EncodingValidator: Check if file exists
    alt File does not exist
        EncodingValidator->>Logger: log("File does not exist: ...")
        EncodingValidator-->>Caller: return []
    else File exists
        EncodingValidator->>EncodingValidator: Read file contents
        EncodingValidator-->>Caller: Process and return results
    end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

feat: add EncodingValidator for file encoding and JSON syntax validation #33: Introduced the EncodingValidator class and its processFile method, which is directly modified here.
feat: enhance EncodingValidator with performance optimizations #34: Also modifies processFile in EncodingValidator, focusing on performance and JSON validation, indicating overlapping concerns.
feat: modernize KeyNamingConventionValidator with enum-based constants #48: Introduces the enum for key naming conventions and refactors KeyNamingConventionValidator, directly related to the change in how conventions are reported.

Poem

A file check here, a string there,
Validators now handle with care.
If a file is gone, we log and hop,
Convention as string—no enum swap!
Tests are tuned, all neat and tight,
This bunny’s code feels just right. 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93c6e74 and 7033aee.

📒 Files selected for processing (4)

src/Validator/EncodingValidator.php (1 hunks)
src/Validator/KeyNamingConventionValidator.php (1 hunks)
tests/src/Validator/EncodingValidatorTest.php (1 hunks)
tests/src/Validator/KeyNamingConventionValidatorTest.php (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/Validator/EncodingValidator.php (1)

tests/src/Validator/SchemaValidatorTest.php (2)

processFile (315-339)

processFile (278-295)

🔇 Additional comments (4)

src/Validator/EncodingValidator.php (1)

44-50: Excellent defensive programming improvement!

Adding the file existence check before attempting to read the file content is a solid defensive programming practice. This prevents potential issues with file_get_contents() and provides clearer error messaging when files are missing.

tests/src/Validator/EncodingValidatorTest.php (1)

332-332: Test correctly updated to match implementation change.

The test expectation has been properly updated to match the new error message format from the EncodingValidator implementation.

src/Validator/KeyNamingConventionValidator.php (1)

73-73: Good consistency improvement for error reporting.

Converting the enum to its string value ensures consistent data types in the issue details array. The fallback to 'custom pattern' provides appropriate handling when using custom patterns instead of predefined conventions.

tests/src/Validator/KeyNamingConventionValidatorTest.php (1)

591-592: Test properly updated with helpful documentation.

The test assertion has been correctly updated to expect a string value instead of an enum object, and the added comment provides valuable context about the change in behavior.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix-key-naming-enum

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

fix: improve error handling in EncodingValidator and update expected_…

7033aee

…convention in tests

konradmichalik merged commit 9986cf8 into main Jul 28, 2025
26 of 28 checks passed

konradmichalik deleted the fix-key-naming-enum branch July 28, 2025 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: improve error handling in EncodingValidator and update expected_convention in tests#50

fix: improve error handling in EncodingValidator and update expected_convention in tests#50
konradmichalik merged 1 commit intomainfrom
fix-key-naming-enum

konradmichalik commented Jul 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 28, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

konradmichalik commented Jul 28, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

konradmichalik commented Jul 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)