Skip to content

Add test for wrapping angle bracket URLs#96

Merged
leynos merged 2 commits intomainfrom
codex/add-test-for-angle-bracket-url-wrapping
Jul 18, 2025
Merged

Add test for wrapping angle bracket URLs#96
leynos merged 2 commits intomainfrom
codex/add-test-for-angle-bracket-url-wrapping

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 18, 2025

Summary

  • add regression test ensuring angle-bracket URLs are wrapped on one line

Testing

  • make fmt
  • make lint
  • make test
  • make markdownlint
  • make nixie

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

Summary by Sourcery

Tests:

  • Add test_wrap_angle_bracket_url integration test to verify that angle-bracket URLs in footnotes wrap correctly

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 18, 2025

Reviewer's Guide

Introduce a regression test to verify that URLs enclosed in angle brackets are wrapped to a new line correctly by the formatter.

File-Level Changes

Change Details Files
Add integration test for wrapping angle-bracket URLs
  • Define input vector with a footnote containing an angle-bracket URL
  • Specify expected output where the URL is moved to the next indented line
  • Call process_stream on the input and assert the output matches expected
tests/integration.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 18, 2025

Summary by CodeRabbit

  • Tests
    • Added a new test to verify correct wrapping of footnotes containing URLs enclosed in angle brackets.

Walkthrough

Add a new integration test to verify that the process_stream function correctly wraps a footnote line containing a URL enclosed in angle brackets. The test checks that the URL is moved to a new indented line beneath the footnote text, ensuring the expected wrapped format is produced.

Changes

File(s) Change Summary
tests/integration.rs Add integration test test_wrap_angle_bracket_url for footnote URL wrapping

Sequence Diagram(s)

sequenceDiagram
    participant Test as test_wrap_angle_bracket_url
    participant Processor as process_stream
    Test->>Processor: Provide footnote line with angle bracket URL
    Processor-->>Test: Return wrapped output with URL on new indented line
    Test->>Test: Assert output matches expected format
Loading

Possibly related PRs

Poem

In angle brackets, a URL lay,
The footnote’s end, now tucked away.
Wrapped and indented, neat and clear,
Integration tests bring cheer!
Markdown’s order, once askew—
Now aligned, and passing too.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0334f10 and a282122.

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🧬 Code Graph Analysis (1)
tests/integration.rs (1)
src/process.rs (1)
  • process_stream (76-76)
🔇 Additional comments (1)
tests/integration.rs (1)

681-693: Test implementation looks correct.

The test properly verifies that angle-bracketed URLs in footnotes are wrapped to a new indented line. The input setup, expected output, and assertion logic all follow the established patterns in this test file.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/add-test-for-angle-bracket-url-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.

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 a6ec333 and 0334f10.

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🧬 Code Graph Analysis (1)
tests/integration.rs (1)
src/process.rs (1)
  • process_stream (76-76)
🔇 Additional comments (2)
tests/integration.rs (2)

687-688: Test logic is correct and follows established patterns.

The test correctly uses process_stream and assert_eq! to verify the wrapping behaviour, consistent with other wrapping tests in the file.


679-686: Confirm expected indentation alignment. The wrapped URL line uses 6 spaces, matching the 6-character footnote prefix “[ˇ^5]: ”. No changes required.

Comment thread tests/integration.rs
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@leynos leynos merged commit f94af97 into main Jul 18, 2025
2 checks passed
@leynos leynos deleted the codex/add-test-for-angle-bracket-url-wrapping branch July 18, 2025 13:43
This was referenced Jul 18, 2025
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