Use Composer autoloader

vaurdan commented 1 month ago

Description

This PR implements the Composer autoload into the wp-parsely plugin, to avoid manually requiring all the necessary classes.

A few notes:

The tests have been reorganized to comply with the PSR-4 specification.
The main codebase is not PSR-4 compliant, but it is handled by classmap (see Composer documentation here). Since this requires an authoritive classmap to be generated each time we add a new class, I have created a gen-autoload composer command to take care of it.
Utils have been moved to its own class with static methods, so it can be autoloaded instead of manually requiring it.

Motivation and context

Improve the quality, readability and maintenance of the plugin's codebase

How has this been tested?

Tested locally, and validated that the unit tests are working; and also validated that there are no issues on the plugin inside WordPress.

Summary by CodeRabbit

New Features
- Enhanced deployment workflow for the WordPress plugin, optimizing the autoloading process for improved performance.
- Introduction of a Utils class that consolidates various utility functions for better organization and maintainability.
Bug Fixes
- Improved reliability of end-to-end tests by ensuring Composer autoload files are up to date.
Refactor
- Refactored utility function calls across multiple classes to use the new Utils class, promoting better code organization.
- Removed unused references to the get_asset_info function, streamlining the code structure.
- Shifted to Composer for dependency management, simplifying the loading process for the Parsely plugin.
Chores
- Namespace updates across numerous test files to better reflect the organization and structure of tests.

coderabbitai[bot] commented 1 month ago

Walkthrough

## Walkthrough The recent changes enhance the efficiency and maintainability of the WordPress plugin by introducing a new `Utils` class for utility function calls, optimizing Composer autoloading, and updating deployment and testing workflows. These modifications promote better organization of code, reducing direct function references and encapsulating functionality, which streamlines the development process and improves performance during deployment and testing. ## Changes | File(s) | Change Summary | |--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | `.github/workflows/deploy.yml`, `.github/workflows/e2e-tests.yml` | Added `composer dump-autoload --classmap-authoritative` to improve autoloading efficiency in deployment and testing workflows. | | `composer.json` | Restructured autoload configuration, removed `"files"` section, added `"gen-autoload"` script, and updated memory limit for static analysis. | | `src/...` | Refactored utility function calls to utilize the new `Utils` class across various files, enhancing code organization and maintainability. | | `tests/...` | Updated namespaces for several test classes to reflect a new organizational structure, transitioning from `ContentHelper` to `Integration\ContentHelper` and similar adjustments for other tests. | | `wp-parsely.php` | Removed `require_once` statements for individual class files, relying on Composer's autoloading, and added type hints for variable annotations. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Dev as Developer participant CI as Continuous Integration participant WP as WordPress Plugin Dev->>CI: Push changes CI->>WP: Run deployment workflow WP->>WP: composer dump-autoload --classmap-authoritative WP->>WP: Build and deploy CI->>WP: Run end-to-end tests WP-->>CI: Test results ```

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

acicovic commented 1 month ago

Do we want to refactor the plugin to also adhere to the PSR-4 spec?

That's an interesting question. Generally, I'd say that the more structured a project is, and the more well-known standards it follows, it's generally easier to work with for external contributors. In our case, this might not translate to any real advantages though, and classmap seems pretty standard.

A couple of questions:

Do you think that the current change could be characterized as a breaking change?
Do you think that switching to PSR-4 would be a breaking change?

vaurdan commented 1 month ago

Do you think that the current change could be characterized as a breaking change?

Currently, as it is, not really. I have only changed the tests to be PSR-4 compliant, all the remaining code base currently has the same structure and filenames.

Do you think that switching to PSR-4 would be a breaking change?

I don't think it's a breaking change. Although we would need to change a bunch of file names, all the existing hooks would still function exactly as before, and the same for all the functionalities. The only way I can think of where it could be a breaking change is, if for some reason, someone would be requiring a file directly from the plugin. And I don't think this is something that anybody does, and definitely not something that we support.

acicovic commented 2 weeks ago

@vaurdan, just a FYI that I've pushed a commit that removes a couple of unneeded use declarations below one of your own removals.

Parsely / wp-parsely