Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upcase body before searching to find lowercase tracking numbers #85

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

cgunther
Copy link
Contributor

@cgunther cgunther commented Aug 20, 2024

The regexps define the search pattern in terms of uppercase characters, so when the source data you're searching contains lowercase tracking numbers, they don't match.

By upcasing the body before searching, it's more likely to match the search patterns.

This also matches that initializing a new TrackingNumber object upcases the number for its internal value.

Inspired by:
jkeen/tracking_number_data#102

Meant as an interim solution until it's decided whether the source regexps should be case-sensitive or not.

Summary by CodeRabbit

  • New Features

    • Enhanced tracking number detection by allowing case-insensitive search, improving user experience when entering tracking numbers in various formats.
  • Tests

    • Added a test case to verify the functionality of case-insensitive tracking number recognition, ensuring reliability and accuracy in diverse input scenarios.

The regexps define the search pattern in terms of uppercase characters,
so when the source data you're searching contains lowercase tracking
numbers, they don't match.

By upcasing the body before searching, it's more likely to match the
search patterns.

This also matches that initializing a new `TrackingNumber` object
upcases the number for its internal value.

Inspired by:
jkeen/tracking_number_data#102

Meant as an interim solution until it's decided whether the source
regexps should be case-sensitive or not.
Copy link

coderabbitai bot commented Aug 20, 2024

Walkthrough

The recent changes enhance the TrackingNumber class's scan method to handle case insensitivity by converting input strings to uppercase before regex processing. Additionally, a new test case ensures that the search method correctly identifies lowercase tracking numbers, improving overall robustness. These modifications collectively enhance the functionality and test coverage, ensuring the tracking number detection remains accurate regardless of casing.

Changes

Files Change Summary
lib/tracking_number/base.rb Modified the scan method to convert the input string to uppercase for case-insensitive pattern matching of tracking numbers.
test/tracking_number_test.rb Added a test case for the search method to validate its performance with mixed-case tracking numbers, ensuring correct identification and enhancing test coverage.

Poem

In fields of code where bunnies hop,
A case-insensitive change makes us stop!
Tracking numbers in any light,
Will be found, oh what a sight!
With tests that dance and always cheer,
Robust and ready, we have no fear! 🐇✨


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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f04ea42 and 950e068.

Files selected for processing (2)
  • lib/tracking_number/base.rb (1 hunks)
  • test/tracking_number_test.rb (2 hunks)
Additional comments not posted (2)
test/tracking_number_test.rb (1)

44-47: New test case for lowercase tracking numbers is effective.

The addition of this test case ensures that the TrackingNumber.search method correctly handles lowercase tracking numbers, enhancing test coverage and robustness.

lib/tracking_number/base.rb (1)

27-27: Modification to handle case insensitivity is well-implemented.

Converting the body to uppercase before regex processing ensures that the scan method can handle tracking numbers in any case, improving robustness.

@jkeen jkeen merged commit e07c754 into jkeen:main Aug 20, 2024
5 checks passed
@jkeen
Copy link
Owner

jkeen commented Aug 20, 2024

@cgunther Thanks! A new version is getting cut and released right now 🤖

github-actions bot pushed a commit that referenced this pull request Aug 20, 2024
## [2.0.1](v2.0.0...v2.0.1) (2024-08-20)

### Bug Fixes

* upcase body before searching to find lowercase tracking numbers ([#85](#85)) ([e07c754](e07c754))
Copy link

🎉 This PR is included in version 2.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@cgunther cgunther deleted the upcase-search branch August 21, 2024 19:21
@cgunther
Copy link
Contributor Author

Thanks for the quick merge/release.

For anyone else who stumbles on this, if your goal was to take a string like "hello 1z879E930346834440 bye" and replace the tracking number with a link, TrackingNumber.search will now match on that tracking number, however the TrackingNumber::UPS object you get will have a tracking_number of 1Z879E930346834440 (upcase), due to being upcased, and even the original_number will be upcased, since the search string is upcased first. That means when you go to do the substitution, make sure it's case-insensitive, since the tracking number you'll be looking for might now be in a different case than your original string (upcase vs original).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants