Add ~^ and ~$ support to the match helper.

[remilapeyre]

Got some code for us? Awesome 🎊!

Please take a minute to explain the change you're making:

• Why are you making it?
• What does it do?
• Why is this something Ghost users or developers need?

Please check your PR against these items:

• I've read and followed the Contributor Guide
• I've explained my change
• I've written an automated test to prove my change works

We appreciate your contribution! 🙏

[coderabbitai]

Walkthrough

The changes introduce two new string comparison operators, ~^ and ~$, to the handleMatch function in the matching helper. The ~^ operator checks if a string starts with a specified substring, while ~$ checks if a string ends with a specified substring. These operators validate that both operands are strings before performing their respective checks. Corresponding unit tests were added to verify the correct behavior of these operators, including cases with non-string values, empty strings, SafeString instances, and nested properties. No changes were made to the signatures of exported or public functions.

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 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 2f98686 and b434793.

📒 Files selected for processing (2)

• ghost/core/core/frontend/helpers/match.js (1 hunks)
• ghost/core/test/unit/frontend/helpers/match.test.js (1 hunks)

🔇 Additional comments (3)

ghost/core/core/frontend/helpers/match.js (1)

60-65: Implementation of string matching operators looks good!

The newly added ~^ and ~$ operators are well-implemented with proper type checking using _.isString() before performing the string operations. The code follows the existing pattern in the switch statement and handles edge cases appropriately by returning false for non-string values.

ghost/core/test/unit/frontend/helpers/match.test.js (2)

249-279: Comprehensive test coverage for the startsWith operator.

The tests cover a good range of scenarios including empty strings, regular strings, SafeString instances, and nested properties. The explicit testing of non-string values ensures the operator behaves correctly in all edge cases.

---

281-311: Comprehensive test coverage for the endsWith operator.

Similar to the startsWith tests, these tests thoroughly verify the behavior of the endsWith operator across various scenarios. I particularly appreciate the consistent structure between both test sections and the careful coverage of edge cases.

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

[ErisDS]

Oooooh! I've been wanting to do this for ages - props for copying the syntax from NQL!

[remilapeyre]

Oooooh! I've been wanting to do this for ages - props for copying the syntax from NQL!

Oh, that's great :) The initial code comes from #18411