Add a database class for MySQL/MariaDB +semver: minor

guibranco commented 1 week ago

Closes #

📑 Description

✅ Checks

[x] My pull request adheres to the code style of this project
[x] My code requires changes to the documentation
[x] I have updated the documentation as required
[ ] All the tests have passed

☢️ Does this introduce a breaking change?

[x] Yes
[ ] No

ℹ Additional Information

Summary by CodeRabbit

Release Notes

New Features
- Introduced a Database class for managing database connections and operations.
- Added a DatabaseOptions class for configuring database connection settings.
- Implemented a custom DatabaseException for handling database-related errors.
Documentation
- Updated user guide to include new sections for the Database class and its usage.
- Enhanced README with a new "Testing" section detailing PHPUnit configurations.
Tests
- Added integration tests for the Database class.
- Introduced unit tests for DatabaseException and DatabaseOptions.
Chores
- Updated CI workflows to include Docker setup and additional PHP extensions for testing.

coderabbitai[bot] commented 1 week ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This pull request introduces several modifications across multiple GitHub Actions workflow files, primarily adding a new step for running Docker containers and updating the required PHP extensions for PHPUnit tests. The changes include a shift from automatic triggers to manual execution for several workflows, the introduction of a new Database class, and updates to documentation files to reflect these changes. Additionally, new test classes are added to ensure the functionality of the newly introduced classes, while existing tests are reorganized into a more structured namespace.

Changes

File	Change Summary
`.github/workflows/build.yml`	Added step `Docker compose up` and updated `php_extensions` to include `curl`, `pdo`, `pdo_mysql`.
`.github/workflows/ci.yml`	Added step `Docker compose up` and updated `phpunit` step to include new PHP extensions.
`.github/workflows/codacy.yml`	Changed trigger to `workflow_dispatch`, added `Docker compose up` step, and updated `php_extensions`.
`.github/workflows/code-climate.yml`	Changed trigger to `workflow_dispatch`, added `Docker compose up` step, and updated `php_extensions`.
`.github/workflows/codecov.yml`	Changed trigger to `workflow_dispatch`, added `Docker compose up` step, and updated `php_extensions`.
`.github/workflows/deep-source.yml`	Changed trigger to `workflow_dispatch`, added `Docker compose up` step, and updated `php_extensions`.
`.github/workflows/sonar-cloud.yml`	Changed trigger to `workflow_dispatch`, added `Docker compose up` step, and updated `php_extensions`.
`.vscode/settings.json`	Updated `cSpell.words` to include `Codacy`, `Codecov`, and `Packagist`.
`README.md`	Updated logo and added a new section on testing with PHPUnit.
`docs/changelog.md`	Added entry for version 0.14 documenting the new `Database` class.
`docs/user-guide/basic-usage.md`	Updated to include usage of the new `Database` class.
`docs/user-guide/color.md`	Corrected typographical errors and reformatted sections.
`docs/user-guide/database.md`	New documentation for the `Database` class.
`docker-compose.yml`	Introduced a new file defining a MySQL service with health checks.
`src/Database/Database.php`	Added `Database` class for database operations using PDO.
`src/Database/DatabaseException.php`	Added custom `DatabaseException` class for handling database errors.
`src/Database/DatabaseOptions.php`	Added `DatabaseOptions` class for managing database connection options.
`src/Database/IDatabase.php`	Introduced `IDatabase` interface defining database operation methods.
`tests/Integration/DatabaseTest.php`	New test class for testing `Database` functionality.
`tests/Unit/DatabaseExceptionTest.php`	New test class for validating `DatabaseException`.
`tests/Unit/DatabaseOptionsTest.php`	New test class for verifying `DatabaseOptions` functionality.
Various test files	Updated namespaces to categorize tests into `Unit` and `Integration`.

Possibly related PRs

246: The changes in the main PR regarding the addition of PHP extensions and Docker steps in the workflow are related to the modifications in the CI workflow for testing environments, as both PRs involve updates to the testing setup and requirements for PHP extensions.

Suggested labels

size/L, ♻️ code quality, 🧑‍💻 tech-debit, 🕓 medium effort

Suggested reviewers

gstraccini

Poem

In the garden where the code does bloom,
New classes sprout, dispelling gloom.
With Docker's might, we build and test,
In every change, we strive for the best.
So hop along, let’s code with glee,
For every line, a victory! 🐇✨

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 , please review it.` - `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 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 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 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 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

deepsource-io[bot] commented 1 week ago

Here's the code health analysis summary for commits eb9073a..7ec1dfe. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Link
Test coverage	✅ Success	View Check ↗
SQL	✅ Success	View Check ↗
Secrets	✅ Success	View Check ↗
PHP	✅ Success	View Check ↗
Docker	✅ Success	View Check ↗

Code Coverage Report

Metric	Aggregate	Php
Branch Coverage	100%	100%
Composite Coverage	90.5% (down 0.3% from `main`)	90.5% (down 0.3% from `main`)
Line Coverage	90.5% (down 0.3% from `main`)	90.5% (down 0.3% from `main`)

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

guibranco commented 1 week ago

@gstraccini rerun failed workflows

gstraccini[bot] commented 1 week ago

Rerunning 7 failed workflows on the commit 75b5fc066e20c8b4613c79731b59545c9ba268c1! :repeat:

gstraccini[bot] commented 1 week ago

Rerunning the following workflows:

gitguardian[bot] commented 1 week ago

⚠️ GitGuardian has uncovered 6 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [14276095](https://dashboard.gitguardian.com/workspace/7014/incidents/14276095?occurrence=169062493) | Triggered | Generic Password | 0fe2f103c986a306b050c532f1bbea58ac548d31 | .github/workflows/build.yml | [View secret](https://github.com/guibranco/pancake/commit/0fe2f103c986a306b050c532f1bbea58ac548d31#diff-5c3fa597431eda03ac3339ae6bf7f05e1a50d6fc7333679ec38e21b337cb6721R19) | | [14276095](https://dashboard.gitguardian.com/workspace/7014/incidents/14276095?occurrence=169063760) | Triggered | Generic Password | 751dc2c5bc87ad08699e3da375dcd1cf8f73f428 | .github/workflows/build.yml | [View secret](https://github.com/guibranco/pancake/commit/751dc2c5bc87ad08699e3da375dcd1cf8f73f428#diff-5c3fa597431eda03ac3339ae6bf7f05e1a50d6fc7333679ec38e21b337cb6721R19) | | [14276095](https://dashboard.gitguardian.com/workspace/7014/incidents/14276095?occurrence=169063761) | Triggered | Generic Password | 751dc2c5bc87ad08699e3da375dcd1cf8f73f428 | .github/workflows/build.yml | [View secret](https://github.com/guibranco/pancake/commit/751dc2c5bc87ad08699e3da375dcd1cf8f73f428#diff-5c3fa597431eda03ac3339ae6bf7f05e1a50d6fc7333679ec38e21b337cb6721L19) | | [14276095](https://dashboard.gitguardian.com/workspace/7014/incidents/14276095?occurrence=169063835) | Triggered | Generic Password | a396cf056070627aec951b3529daa3a2a98358b9 | .github/workflows/build.yml | [View secret](https://github.com/guibranco/pancake/commit/a396cf056070627aec951b3529daa3a2a98358b9#diff-5c3fa597431eda03ac3339ae6bf7f05e1a50d6fc7333679ec38e21b337cb6721L19) | | [14276204](https://dashboard.gitguardian.com/workspace/7014/incidents/14276204?occurrence=169064152) | Triggered | Generic Password | 9e2b57340e3aa5eabc80670332d0db061b66dd29 | docker-compose.yml | [View secret](https://github.com/guibranco/pancake/commit/9e2b57340e3aa5eabc80670332d0db061b66dd29#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3R15) | | [14276204](https://dashboard.gitguardian.com/workspace/7014/incidents/14276204?occurrence=169064409) | Triggered | Generic Password | 3ec26fc2864a8e525ac35713045bd9181cd125cc | docker-compose.yml | [View secret](https://github.com/guibranco/pancake/commit/3ec26fc2864a8e525ac35713045bd9181cd125cc#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3L15) |

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/generics/generic_password#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

codacy-production[bot] commented 1 week ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
:white_check_mark: +90.53% (target: -1.00%)	:white_check_mark: 89.77%

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (eb9073a1e7ff836dadd77c9016d07106e1bacf09) | 0 | 0 | 0.00% | | | Head commit (7ec1dfe16c5e920d549e900d12a2835a2504c069) | 433 (+433) | 392 (+392) | 90.53% (**+90.53%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#250) | 88 | 79 | **89.77%** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`