Changes related to Meilisearch v1.15.0

[meili-bot]

Related to this issue: meilisearch/integration-guides#316

This PR:

• gathers the changes related to the next Meilisearch release (v1.15.0) so that this package is ready when the official release is out.
• should pass the tests against the latest pre-release of Meilisearch.
• might eventually contain test failures until the Meilisearch v1.15.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v1.15.0) is out.

This PR is auto-generated for the pre-release week purpose.

Summary by CodeRabbit

• New Features

  • Added a new code sample demonstrating how to enable the disableOnNumbers option in typo tolerance settings for an index.

• Documentation

  • Updated documentation to reflect the new disableOnNumbers option in typo tolerance settings.

• Tests

  • Extended test coverage to include the disableOnNumbers setting in typo tolerance configurations and assertions.

[coderabbitai]

Walkthrough

A new typo tolerance setting, disableOnNumbers, was introduced and integrated into the codebase. Documentation, code samples, and test cases were updated to include this setting in the typo tolerance configuration arrays. No changes were made to method implementations or control flow, only to type signatures, documentation, and test expectations.

Changes

File(s)	Change Summary
.code-samples.meilisearch.yaml	Added code sample typo_tolerance_guide_5 demonstrating disableOnNumbers usage in typo tolerance.
src/Endpoints/Delegates/HandlesSettings.php	Updated PHPDoc for getTypoTolerance() and updateTypoTolerance() to include disableOnNumbers.
tests/Endpoints/IndexTest.php	Extended assertion in testIndexGetSettings to expect disableOnNumbers in typo tolerance output.
tests/Settings/SettingsTest.php	Added disableOnNumbers to DEFAULT_TYPO_TOLERANCE and test case arrays.
tests/Settings/TypoToleranceTest.php	Added disableOnNumbers to default and updated typo tolerance arrays in tests.

Poem

A hop, a skip, a number too,
Now typos know just what to do.
With settings neat and tests in tow,
Our code can handle numbers so!
🐇✨

---

📜 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 e58c568 and 368495c.

📒 Files selected for processing (5)

• .code-samples.meilisearch.yaml (1 hunks)
• src/Endpoints/Delegates/HandlesSettings.php (2 hunks)
• tests/Endpoints/IndexTest.php (1 hunks)
• tests/Settings/SettingsTest.php (2 hunks)
• tests/Settings/TypoToleranceTest.php (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: integration-tests-against-rc (PHP )
• GitHub Check: integration-tests-against-rc (PHP )
• GitHub Check: integration-tests-against-rc (PHP )
• GitHub Check: integration-tests-against-rc (PHP )
• GitHub Check: integration-tests-against-rc (PHP )

🔇 Additional comments (5)

src/Endpoints/Delegates/HandlesSettings.php (1)

286-287: Clean documentation update for new typo tolerance feature.

The PHPDoc annotations correctly document the new disableOnNumbers boolean property in both getter and setter methods. The type annotations are consistent and maintain backwards compatibility.

Also applies to: 301-302

.code-samples.meilisearch.yaml (1)

420-423: Good addition of documentation example.

The new code sample clearly demonstrates how to use the disableOnNumbers setting, providing helpful documentation for users of the new feature.

tests/Endpoints/IndexTest.php (1)

50-50: Correct test assertion update.

The test properly expects the new disableOnNumbers property with the appropriate default value of false, ensuring the test remains valid with the new feature.

tests/Settings/SettingsTest.php (1)

28-28: Consistent updates to test constants and data.

The changes properly extend the default typo tolerance settings to include disableOnNumbers with the correct default value, maintaining consistency across test constants and test data.

Also applies to: 127-127

tests/Settings/TypoToleranceTest.php (1)

22-22: Comprehensive test coverage for new feature.

The changes provide good test coverage by including the new property in both the default settings constant and testing its update functionality with a different value. This ensures both default behavior and update operations are properly tested.

Also applies to: 48-48

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.