Skip to content

Add hyphenated word wrap test#74

Merged
leynos merged 2 commits intomainfrom
1zyqr8-codex/add-test-for-hyphenated-words-wrapping
Jul 16, 2025
Merged

Add hyphenated word wrap test#74
leynos merged 2 commits intomainfrom
1zyqr8-codex/add-test-for-hyphenated-words-wrapping

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 16, 2025

Summary

  • add a regression test covering hyphenated words when wrapping
  • remove redundant assertion checking for stray space after hyphen
  • avoid compile issues by building the input string with concat!

Testing

  • make fmt
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_6875fac6b5608322a057d88ff845287f

Summary by Sourcery

Add a regression test to ensure wrap_text does not insert spaces in hyphenated words when wrapping.

Enhancements:

  • Construct the long input string using concat! macro to avoid compile issues with string literals

Tests:

  • Add wrap_text_does_not_insert_spaces_in_hyphenated_words test covering hyphenated word wrap behavior

Chores:

  • Remove redundant assertion that checked for stray spaces after hyphens

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 16, 2025

Reviewer's Guide

Introduces a regression test ensuring wrap_text handles hyphenated words without inserting spaces (built via concat!), and removes an obsolete stray-space assertion.

File-Level Changes

Change Details Files
Add regression test for hyphenated word wrapping
  • Created new test function to validate no spaces are inserted in hyphenated words
  • Built the test input string using concat! to avoid compile issues
  • Asserted expected wrapped output lines
src/lib.rs
Remove redundant stray-space assertion
  • Deleted unnecessary assertion that checked for a space after hyphens
src/lib.rs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 16, 2025

Summary by CodeRabbit

  • Tests
    • Added a new test to ensure that hyphenated words are not split with added spaces when wrapping text.

Summary by CodeRabbit

  • Tests
    • Added a new test to ensure hyphenated words are not split with spaces when wrapping text.

Walkthrough

Add a new test to the suite for the wrap_text function, specifically verifying that it does not insert spaces inside hyphenated words during wrapping. The test checks the output when a long line containing a hyphenated word is wrapped, ensuring correct behaviour at the wrap boundary.

Changes

File(s) Change Summary
src/lib.rs Add test wrap_text_does_not_insert_spaces_in_hyphenated_words to verify correct wrapping logic

Possibly related PRs

Poem

Wrap the words, but mind the dash,
No sneaky spaces in a hyphenated flash!
With tests in place, the code stands tall,
Hyphens unbroken, we answer the call.
📝✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 1zyqr8-codex/add-test-for-hyphenated-words-wrapping

🪧 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 auto-generate unit tests to generate unit tests for 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.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos leynos merged commit e91b0b1 into main Jul 16, 2025
1 of 2 checks passed
@leynos leynos deleted the 1zyqr8-codex/add-test-for-hyphenated-words-wrapping branch July 16, 2025 15:15
Copy link
Copy Markdown
Contributor

@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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b2aac87 and 2ca6306.

📒 Files selected for processing (1)
  • src/lib.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

Comment thread src/lib.rs
Comment on lines +762 to +782
#[test]
fn wrap_text_does_not_insert_spaces_in_hyphenated_words() {
let input = vec![
concat!(
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tincidunt ",
"elit-sed fermentum congue. Vivamus dictum nulla sed consectetur ",
"volutpat."
)
.to_string(),
];
let wrapped = wrap_text(&input, 80);
assert_eq!(
wrapped,
vec![
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tincidunt"
.to_string(),
"elit-sed fermentum congue. Vivamus dictum nulla sed consectetur volutpat."
.to_string(),
]
);
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Deduplicate hyphen-wrap tests via #[rstest] parameterisation

The new test exercises exactly the same invariant as wrap_text_preserves_hyphenated_words, only with a different input string and wrap width. The coding guidelines mandate replacing duplicated tests with #[rstest(...)] parameterised cases. Merge both checks into a single fixture that varies:

  • the input string
  • the wrap width
  • the expected vector

This removes repetition while preserving coverage and keeps the test module concise.

Example skeleton:

-#[test]
-fn wrap_text_preserves_hyphenated_words() { … }
-
-#[test]
-fn wrap_text_does_not_insert_spaces_in_hyphenated_words() { … }
+#[rstest(
+    (input, width, expected),
+    case(
+        "A word that is very-long-word indeed",
+        20,
+        vec![
+            "A word that is",
+            "very-long-word",
+            "indeed"
+        ]
+    ),
+    case(
+        concat!(
+            "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tincidunt ",
+            "elit-sed fermentum congue. Vivamus dictum nulla sed consectetur volutpat."
+        ),
+        80,
+        vec![
+            "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tincidunt",
+            "elit-sed fermentum congue. Vivamus dictum nulla sed consectetur volutpat."
+        ]
+    )
+)]
+fn wrap_text_preserves_hyphenated_words(input: &str, width: usize, expected: Vec<&str>) {
+    let wrapped = wrap_text(&[input.to_string()], width);
+    assert_eq!(
+        wrapped,
+        expected.into_iter().map(str::to_string).collect::<Vec<_>>()
+    );
+}

Enforce cargo fmt and cargo clippy after refactor to keep the build clean.

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents
In src/lib.rs around lines 762 to 782, the test
wrap_text_does_not_insert_spaces_in_hyphenated_words duplicates the logic of
wrap_text_preserves_hyphenated_words with different inputs. Refactor by merging
both tests into a single parameterized test using #[rstest] that takes input
string, wrap width, and expected output vector as parameters. This will remove
duplication while maintaining test coverage. After refactoring, run cargo fmt
and cargo clippy to ensure code style and linting compliance.

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.

1 participant