refactor: modernize codebase with PHP 8.1+ features by konradmichalik · Pull Request #49 · move-elevator/composer-translation-validator

konradmichalik · 2025-07-28T07:31:36Z

Summary by CodeRabbit

Refactor
- Improved internal handling of file path properties in parser classes to enhance immutability and consistency.
- Updated constructors in parser classes for cleaner and more robust property management.

No changes to user-facing features or functionality.

coderabbitai · 2025-07-28T07:31:44Z

Walkthrough

The changes update the immutability and property promotion patterns in parser classes. The base AbstractParser enforces readonly properties for $fileName and $filePath. The derived parser classes (JsonParser, PhpParser, XliffParser, YamlParser) remove property promotion from their constructors, passing $filePath as a regular parameter instead.

Changes

Cohort / File(s)	Change Summary
AbstractParser Immutability `src/Parser/AbstractParser.php`	Made `$fileName` and `$filePath` protected readonly properties; removed initial value from `$fileName`.
Parser Constructor Refactor `src/Parser/JsonParser.php`, `src/Parser/PhpParser.php`, `src/Parser/XliffParser.php`, `src/Parser/YamlParser.php`	Removed property promotion from constructors; `$filePath` is now a regular parameter, not a property.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A hop and a skip through parser code,
Readonly fields lighten the load.
No more promoted paths to see,
Just simple params—immutability!
With every file, the change is neat,
Parsers now feel extra sweet.
🐇✨

📜 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 6c30b0e and ce35141.

📒 Files selected for processing (5)

src/Parser/AbstractParser.php (1 hunks)
src/Parser/JsonParser.php (1 hunks)
src/Parser/PhpParser.php (1 hunks)
src/Parser/XliffParser.php (1 hunks)
src/Parser/YamlParser.php (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (5)

src/Parser/JsonParser.php (6)

src/Parser/AbstractParser.php (1)

__construct (33-52)

src/Parser/XliffParser.php (1)

__construct (39-55)

src/Parser/PhpParser.php (1)

__construct (34-43)

src/Parser/YamlParser.php (1)

__construct (35-44)

src/Parser/ParserInterface.php (1)

__construct (28-28)

tests/src/Parser/JsonParserTest.php (5)

JsonParserTest (31-290)

testConstructorThrowsExceptionIfFileDoesNotExist (95-100)

testConstructorThrowsExceptionOnEmptyJsonFile (157-165)

testConstructorThrowsExceptionIfJsonIsInvalid (143-148)

testConstructorThrowsExceptionIfFileHasInvalidExtension (133-141)

src/Parser/PhpParser.php (3)

src/Parser/AbstractParser.php (1)

__construct (33-52)

src/Parser/ParserInterface.php (2)

__construct (28-28)

ParserInterface (26-47)

tests/src/Parser/PhpParserTest.php (3)

testConstructorWithValidFile (39-46)

PhpParserTest (31-289)

testConstructorWithNonExistentFile (48-54)

src/Parser/XliffParser.php (5)

src/Parser/AbstractParser.php (1)

__construct (33-52)

src/Parser/PhpParser.php (1)

__construct (34-43)

src/Parser/YamlParser.php (1)

__construct (35-44)

src/Parser/ParserInterface.php (1)

__construct (28-28)

tests/src/Parser/XliffParserTest.php (1)

XliffParserTest (31-341)

src/Parser/YamlParser.php (6)

src/Parser/AbstractParser.php (1)

__construct (33-52)

src/Parser/XliffParser.php (1)

__construct (39-55)

src/Parser/PhpParser.php (1)

__construct (34-43)

src/Parser/JsonParser.php (1)

__construct (34-53)

src/Parser/ParserInterface.php (1)

__construct (28-28)

tests/src/Parser/YamlParserTest.php (1)

YamlParserTest (31-168)

src/Parser/AbstractParser.php (2)

tests/src/Parser/AbstractParserTest.php (5)

AbstractParserTest (40-148)

testConstructorWithUnreadableFile (82-97)

TestParser (32-38)

testConstructorWithValidFile (65-72)

testConstructorWithNonExistentFile (74-80)

src/Parser/ParserInterface.php (1)

__construct (28-28)

🔇 Additional comments (5)

src/Parser/AbstractParser.php (1)

31-33: Excellent use of PHP 8.1+ readonly properties!

The refactoring to protected readonly string for both $fileName and $filePath correctly enforces immutability after construction. The constructor property promotion for $filePath is properly implemented, and the manual assignment of $fileName in the constructor body is valid for readonly properties.

src/Parser/PhpParser.php (1)

34-34: LGTM! Constructor parameter simplification aligns with centralized property management.

Removing the protected modifier from $filePath is correct since AbstractParser now manages this property as protected readonly. The parent constructor call ensures proper initialization.

src/Parser/XliffParser.php (1)

39-39: Consistent refactoring approach maintained.

The removal of property promotion from $filePath follows the same pattern as other parser classes, correctly delegating property management to AbstractParser while preserving all existing functionality.

src/Parser/YamlParser.php (1)

35-35: Consistent implementation across parser hierarchy.

The constructor parameter change matches the refactoring pattern applied to all parser classes, properly removing property promotion while maintaining functionality through the parent constructor.

src/Parser/JsonParser.php (1)

34-34: Refactoring completed consistently across all parser classes.

The constructor parameter change completes the modernization effort, successfully centralizing property management in AbstractParser while maintaining all existing functionality. The readonly properties ensure immutability as intended.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch update/php81-modernization-features

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.

refactor: modernize codebase with PHP 8.1+ features

ce35141

konradmichalik merged commit 3200b17 into main Jul 28, 2025
28 checks passed

konradmichalik deleted the update/php81-modernization-features branch July 28, 2025 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: modernize codebase with PHP 8.1+ features#49

refactor: modernize codebase with PHP 8.1+ features#49
konradmichalik merged 1 commit intomainfrom
update/php81-modernization-features

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

Estimated code review effort

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`)