(Added) Add Rector for Code Quality Enhancement

[MarjovanLier]

User description

Summary

This Merge Request (MR) introduces Rector, a tool for automated code quality enhancements, into the project. Rector is a PHP tool that applies rules to refactor and improve the codebase, ensuring adherence to coding standards and best practices.

Context and Background

Maintaining a high code quality standard is crucial for a software project's long-term maintainability and stability. Manually enforcing coding standards and refactoring code can be time-consuming and error-prone. Rector automates this process, allowing developers to focus on core functionality while ensuring a consistent, high-quality codebase.

Problem Description

Enforcing coding standards and applying code quality improvements across the project without an automated tool like Rector can be tedious and error-prone. This can lead to consistency in the codebase and make it easier to maintain and extend over time.

Solution Description

Rector is introduced as a development dependency in the project's composer.json file. A new configuration file, rector.php, is added to define the rules and sets of rules Rector should apply to the codebase. These rules cover various aspects of code quality, including coding style, dead code elimination, early return optimization, PHP version compatibility, type declaration, naming conventions, and more.

A new script command, test:rector is added to the composer.json file, allowing developers to run Rector in dry-run mode to preview the changes before applying them.

The GitHub Actions workflow in .github/workflows/php.yml is updated to include a new step that runs Rector after the Psalm static analysis tool has been completed successfully.

List of Changes

• Added:
  • rector.php: Configuration file for Rector, specifying the rules and sets of rules to apply.
  • composer.json: Rector added as a development dependency, and a new test:rector script command added.
  • .github/workflows/php.yml: A new step was added to run Rector in the GitHub Actions workflow.
  • localTest.sh: Command added to require Rector as a development dependency.

---

Type

enhancement, documentation

---

Description

• Introduced Rector to the project for automated code quality enhancements, including configuration and rule definitions in rector.php.
• Updated localTest.sh to include Rector as a development dependency for PHP 8.1.
• Enabled Rector in the GitHub Actions workflow to run after Psalm analysis, ensuring code quality checks are automated.
• Added Rector as a development dependency in composer.json and included a new script command test:rector for running Rector in dry-run mode.

---

Changes walkthrough

	Relevant files
Enhancement	rector.php Introduce Rector Configuration for Automated Code Quality Enhancements rector.php Introduced Rector configuration with a variety of rules for code quality improvements. Configured paths for source and test directories to be analyzed by Rector. Defined PHP version compatibility and imported necessary namespaces. Excluded specific rules from being applied by Rector. +71/-0    php.yml Enable Rector in GitHub Actions Workflow for Code Quality Checks .github/workflows/php.yml Enabled a step in the GitHub Actions workflow to run Rector after Psalm analysis. +5/-5
Configuration changes	localTest.sh Update Local Testing Script to Include Rector Dependency  localTest.sh Updated the script to include Rector as a development dependency for PHP 8.1. +1/-2
Dependencies	composer.json Add Rector Dependency and Script Command in composer.json composer.json Added Rector as a development dependency. Included a new script command test:rector to run Rector in dry-run mode. +5/-1

---

✨ PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

Summary by CodeRabbit

• Chores
  • Updated GitHub workflow for better code quality checks.
  • Modified dependency management to include Rector for automated code enhancements.
• New Features
  • Introduced Rector for automated code refactoring, focusing on code quality, style improvements, and PHP version compatibility.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The project has integrated Rector, a tool for automated PHP code refactoring. This includes adjustments in the workflow to focus on code quality enhancements, adding Rector as a dependency, and modifying scripts to employ Rector for code quality improvements. A configuration file for Rector has also been introduced, specifying rules for refactoring, code quality, coding style, and PHP version compatibility. ## Changes | Files | Change Summary | |----------------------------|----------------------------------------------------------------------------------------------------| | `.github/workflows/php.yml`| Corrected indentation and disabled Rector-related steps. | | `composer.json` | Added `rector/rector` as a dependency and included it in test scripts for automated code quality. | | `localTest.sh` | Updated Composer script to use `rector/rector` instead of `vimeo/psalm` and `psalm/plugin-phpunit`.| | `rector.php` | Created a Rector configuration file specifying rules for code refactoring and quality improvements.|

---

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 .` - `Generate unit-tests 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 tests 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 tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

[sweep-ai[bot]]

Apply Sweep Rules to your PR?

• [ ] Apply: All new business logic should have corresponding unit tests.
• [ ] Apply: Refactor large functions to be more modular.
• [ ] Apply: Add docstrings to all functions and file headers.

This is an automated message generated by Sweep AI.

[sonarcloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[codiumai-pr-agent-pro[bot]]

PR Description updated to latest commit (https://github.com/MarjovanLier/XhprofTrace/commit/2a9f0c643c97ad889d0bae728e2a7930bbe514d4)

• [x] Copy walkthrough table to "Files Changed" Tab <!-- /describe --copy_walkthrough_to_diffview_tab -->

[codiumai-pr-agent-pro[bot]]

Changelog updates:

2024-03-05

Added

• Introduced Rector for automated code quality enhancements, including a new rector.php configuration file, Rector as a dev dependency in composer.json, and integration into the project's testing scripts and GitHub workflow.

to commit the new content to the CHANGELOG.md file, please type: '/update_changelog --pr_update_changelog.push_changelog_changes=true'

[codiumai-pr-agent-pro[bot]]

PR Code Suggestions

Category	Suggestions
Maintainability	Add a comment explaining the reason for skipping a specific rector rule. ___ **Consider adding a comment explaining why FlipTypeControlToUseExclusiveTypeRector is being skipped. This will help maintainers understand the decision and assess if it needs to be revisited in the future.** [rector.php [66-70]](https://github.com/MarjovanLier/XhprofTrace/pull/26/files#diff-d933a2ad57daa43419b483d3f1ddedaec7aa44933007fead9f9437390f596f4aR66-R70) ```diff +// Skipping FlipTypeControlToUseExclusiveTypeRector due to specific project requirements. $rectorConfig->skip( [ FlipTypeControlToUseExclusiveTypeRector::class, ] ); ```
	Group related rules or add comments to categorize them for better readability. ___ **To improve the maintainability and readability of the configuration, consider grouping related rules together or adding comments to categorize them. This will make it easier for developers to navigate and understand the configuration's structure.** [rector.php [32-42]](https://github.com/MarjovanLier/XhprofTrace/pull/26/files#diff-d933a2ad57daa43419b483d3f1ddedaec7aa44933007fead9f9437390f596f4aR32-R42) ```diff +// Property rules $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class); -$rectorConfig->rule(RenameForeachValueVariableToMatchExprVariableRector::class); ... +// Coding style rules $rectorConfig->rule(SeparateMultiUseImportsRector::class); $rectorConfig->rule(SplitDoubleAssignRector::class); ```
Best practice	Ensure the script fails on any command error by setting pipefail. ___ **To ensure that the script fails immediately if any command within the pipeline fails, consider adding set -o pipefail at the beginning of the script. This is especially important for CI/CD pipelines to catch errors early.** [localTest.sh [23-26]](https://github.com/MarjovanLier/XhprofTrace/pull/26/files#diff-ee3cef051df5421a0c1f313c0666b6c8c80b8ec26be919fdfe65992736b6091aR23-R26) ```diff +set -o pipefail rm -f composer.lock && \ $DOCKER_CMD composer install && \ $DOCKER_CMD composer update --with-all-dependencies && \ $DOCKER_CMD composer require --dev --with-all-dependencies "rector/rector":">=1.0.2" ```
	Add a step to check Rector command output for unapplied fixes or errors. ___ **It's a good practice to add a step for checking the output of the Rector command for any unapplied fixes or errors. This can be done by analyzing the exit code or the command output, ensuring that any necessary code quality improvements are not missed.** [.github/workflows/php.yml [127-130]](https://github.com/MarjovanLier/XhprofTrace/pull/26/files#diff-a73bb6555480a5ee79ae276a3f5d71a08fa316e09a4a8da7b643cf1e92c97df9R127-R130) ```diff - name: Run rector for code quality id: rector if: steps.psalm.outcome == 'success' run: composer test:rector + continue-on-error: true +- name: Check rector output + if: steps.rector.outcome == 'failure' + run: echo "Rector found issues that need to be addressed." ```
	Lock rector/rector dependency to a specific minor version for stability. ___ **It's recommended to lock the version of rector/rector to a specific minor version instead of using >=1.0.2. This prevents automatic updates to newer versions that might introduce breaking changes or require manual intervention for compatibility.** [composer.json [64]](https://github.com/MarjovanLier/XhprofTrace/pull/26/files#diff-d2ab9925cad7eac58e0ff4cc0d251a937ecf49e4b6bf57f8b95aab76648a9d34R64-R64) ```diff -"rector/rector": ">=1.0.2", +"rector/rector": "^1.0.2", ```

[codiumai-pr-agent-pro[bot]]

Auto-approved PR