refactor: apply rector rules #709

lotyp · 2024-04-28T08:56:17Z

Summary by CodeRabbit

Refactor
- Improved code robustness by making several properties across multiple classes read-only.
Tests
- Updated test annotations to modern PHP 8 attributes across various test classes, enhancing readability and maintaining modern coding standards.

vercel · 2024-04-28T08:56:23Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
laravel-cycle-orm-adapter	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 28, 2024 8:57am

coderabbitai · 2024-04-28T08:56:38Z

Walkthrough

The recent updates primarily involve the introduction of readonly properties in various PHP classes to ensure immutability, and a shift from PHPDoc test annotations to PHP 8 attributes (#[Test]) across multiple test classes. This modernizes the codebase, aligns with current best practices, and enhances code clarity and maintainability.

Changes

File Path	Change Summary
`src/Bridge/Telescope/TelescopeLogger.php`	Added `readonly` to `LoggerInterface $parentLogger`.
`tests/app/Entities/...`	Properties in `Footprint`, `Post`, and `UserId` classes made `readonly`.
`tests/src/Bridge/Laravel/...`	Replaced PHPDoc test annotations with PHP 8 attributes (`#[Test]`) in various test classes.

🐰✨
A rabbit hopped through the code,
Sprinkling readonly, a treasure trove!
#[Test] tags in files galore,
Cleaner tests, who could ask for more?
Hop, hop, hop, on soft green grass,
Our code now modern, first class! 🌟📜
✨🐰

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ca870ef and 8f6c630.

Files selected for processing (25)

src/Bridge/Telescope/TelescopeLogger.php (1 hunks)
tests/app/Entities/Footprint.php (1 hunks)
tests/app/Entities/Post.php (1 hunks)
tests/app/Entities/UserId.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/Database/ListCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/Database/TableCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/Migrations/InitCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/Migrations/MigrateCommandTest.php (3 hunks)
tests/src/Bridge/Laravel/Console/Commands/Migrations/ReplayCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/Migrations/RollbackCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/Migrations/StatusCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/ORM/MigrateCommandTest.php (5 hunks)
tests/src/Bridge/Laravel/Console/Commands/ORM/RenderCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/Console/Commands/ORM/SyncCommandTest.php (3 hunks)
tests/src/Bridge/Laravel/Console/Commands/ORM/UpdateCommandTest.php (1 hunks)
tests/src/Bridge/Laravel/LoggerFactoryTest.php (4 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterAnnotatedTest.php (6 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterAttributesTest.php (4 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterConfigsTest.php (5 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterDatabaseTest.php (3 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterMigrationsTest.php (5 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterORMTest.php (4 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterSchemaTest.php (6 hunks)
tests/src/Bridge/Laravel/Providers/Registrators/RegisterTokenizerTest.php (6 hunks)
tests/src/Testing/SoftDeletableTest.php (3 hunks)

Files skipped from review due to trivial changes (9)

tests/src/Bridge/Laravel/Console/Commands/Database/ListCommandTest.php
tests/src/Bridge/Laravel/Console/Commands/Migrations/MigrateCommandTest.php
tests/src/Bridge/Laravel/Console/Commands/Migrations/RollbackCommandTest.php
tests/src/Bridge/Laravel/Providers/Registrators/RegisterAnnotatedTest.php
tests/src/Bridge/Laravel/Providers/Registrators/RegisterAttributesTest.php
tests/src/Bridge/Laravel/Providers/Registrators/RegisterDatabaseTest.php
tests/src/Bridge/Laravel/Providers/Registrators/RegisterMigrationsTest.php
tests/src/Bridge/Laravel/Providers/Registrators/RegisterORMTest.php
tests/src/Bridge/Laravel/Providers/Registrators/RegisterTokenizerTest.php

Additional comments not posted (36)

tests/src/Bridge/Laravel/Console/Commands/ORM/UpdateCommandTest.php (2)

8-8: Import of PHPUnit\Framework\Attributes\Test correctly replaces the older @test annotation with the #[Test] attribute, aligning with modern PHP practices.

14-14: The #[Test] attribute is correctly applied to the it_runs_handle method, ensuring it's recognized as a test method by PHPUnit. This change enhances readability and aligns with PHP 8 attributes.

tests/src/Bridge/Laravel/Console/Commands/Migrations/InitCommandTest.php (2)

9-9: Import of PHPUnit\Framework\Attributes\Test correctly replaces the older @test annotation with the #[Test] attribute, aligning with modern PHP practices.

14-14: The #[Test] attribute is correctly applied to the it_runs_handle method, ensuring it's recognized as a test method by PHPUnit. This change enhances readability and aligns with PHP 8 attributes.

tests/app/Entities/UserId.php (1)

12-12: The readonly modifier has been correctly added to the $id property, ensuring immutability. This change prevents the property from being modified after initialization, which is crucial for entity identifiers.

tests/src/Bridge/Laravel/Console/Commands/Migrations/ReplayCommandTest.php (2)

9-9: Import of PHPUnit\Framework\Attributes\Test correctly replaces the older @test annotation with the #[Test] attribute, aligning with modern PHP practices.

14-14: The #[Test] attribute is correctly applied to the it_runs_handle method, ensuring it's recognized as a test method by PHPUnit. This change enhances readability and aligns with PHP 8 attributes.

tests/app/Entities/Post.php (2)

21-21: The readonly modifier has been correctly added to the $title property, ensuring immutability. This change prevents the property from being modified after initialization, which is crucial for maintaining data integrity.

24-24: The readonly modifier has been correctly added to the $description property, ensuring immutability. This change prevents the property from being modified after initialization, which is crucial for maintaining data integrity.

tests/src/Bridge/Laravel/Console/Commands/Migrations/StatusCommandTest.php (2)

10-10: Import of PHPUnit\Framework\Attributes\Test correctly replaces the older @test annotation with the #[Test] attribute, aligning with modern PHP practices.

15-15: The #[Test] attribute is correctly applied to the it_runs_handle method, ensuring it's recognized as a test method by PHPUnit. This change enhances readability and aligns with PHP 8 attributes.

tests/src/Testing/SoftDeletableTest.php (2)

9-10: Import of PHPUnit\Framework\Attributes\Test and Throwable correctly replaces the older @test annotation with the #[Test] attribute and prepares for exception handling, aligning with modern PHP practices.

33-33: The #[Test] attribute is correctly applied to the it_soft_deletes_post_entity method, ensuring it's recognized as a test method by PHPUnit. This change enhances readability and aligns with PHP 8 attributes.

tests/src/Bridge/Laravel/Console/Commands/Database/TableCommandTest.php (2)

10-10: Import of PHPUnit\Framework\Attributes\Test correctly replaces the older @test annotation with the #[Test] attribute, aligning with modern PHP practices.

15-15: The #[Test] attribute is correctly applied to the it_runs_handle method, ensuring it's recognized as a test method by PHPUnit. This change enhances readability and aligns with PHP 8 attributes.

tests/src/Bridge/Laravel/Console/Commands/ORM/RenderCommandTest.php (1)

14-14: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

src/Bridge/Telescope/TelescopeLogger.php (1)

13-13: The parentLogger property has been correctly marked as readonly. This enhances immutability and aligns with the PR objectives.

tests/src/Bridge/Laravel/Console/Commands/ORM/SyncCommandTest.php (3)

19-19: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

36-36: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

52-52: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

tests/app/Entities/Footprint.php (1)

18-22: Properties id, party, and realm have been correctly marked as readonly. This enhances immutability and aligns with the PR objectives.

tests/src/Bridge/Laravel/Providers/Registrators/RegisterConfigsTest.php (4)

19-19: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

38-38: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

57-57: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

78-78: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

tests/src/Bridge/Laravel/Console/Commands/ORM/MigrateCommandTest.php (4)

38-38: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

48-48: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

58-58: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

99-99: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

tests/src/Bridge/Laravel/LoggerFactoryTest.php (3)

38-38: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

64-64: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

89-89: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

tests/src/Bridge/Laravel/Providers/Registrators/RegisterSchemaTest.php (4)

25-25: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

44-44: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

62-62: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

83-83: Updated test annotation to PHP 8 attribute. This aligns with modern PHP practices and enhances readability.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

codecov-commenter · 2024-04-28T08:57:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.94%. Comparing base (ca870ef) to head (8f6c630).

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #709   +/-   ##
=========================================
  Coverage     75.94%   75.94%           
  Complexity      252      252           
=========================================
  Files            46       46           
  Lines           927      927           
=========================================
  Hits            704      704           
  Misses          223      223

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

tests/src/Bridge/Laravel/Console/Commands/ORM/RenderCommandTest.php (1)

Line range hint 24-24: TODO comment found. Please clarify or address this TODO to ensure that it does not get overlooked.

refactor: apply rector rules

8f6c630

github-actions bot added the type: maintenance For maintenance, refactor and testing (perf, chore, style, revert, refactor, test, build, ci) label Apr 28, 2024

vercel bot deployed to Preview April 28, 2024 08:57 View deployment

coderabbitai bot reviewed Apr 28, 2024

View reviewed changes

lotyp merged commit 90f651a into master Apr 28, 2024

lotyp deleted the feat/infra-dx branch April 28, 2024 09:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor: apply rector rules #709

refactor: apply rector rules #709

Uh oh!

lotyp commented Apr 28, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Apr 28, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 28, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov-commenter commented Apr 28, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

refactor: apply rector rules #709

refactor: apply rector rules #709

Uh oh!

Conversation

lotyp commented Apr 28, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Apr 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov-commenter commented Apr 28, 2024

Codecov Report

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lotyp commented Apr 28, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Apr 28, 2024 •

edited

Loading

coderabbitai bot commented Apr 28, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)