Skip to content

Update tests to use lines_vec macro#86

Merged
leynos merged 4 commits intomainfrom
codex/replace-idioms-in-integration-tests
Jul 17, 2025
Merged

Update tests to use lines_vec macro#86
leynos merged 4 commits intomainfrom
codex/replace-idioms-in-integration-tests

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 17, 2025

Summary

  • refactor test vectors to use lines_vec![] throughout
  • drop intermediate conversions with .to_string() and .into_iter().map()

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Refactor test code to use the lines_vec! macro for constructing Vec line vectors and remove redundant manual conversions

Enhancements:

  • Refactor test fixtures and examples to use the lines_vec![] macro instead of manual Vec construction
  • Remove unnecessary .to_string() calls and iterator mappings in tests

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 17, 2025

Reviewer's Guide

Refactor integration tests to leverage the lines_vec! macro for concise Vec initialization, eliminating manual conversions and standardizing macro syntax.

File-Level Changes

Change Details Files
Refactor test vector initialization to use lines_vec! macro
  • Replaced vec![] and lines_vec!(…) invocations with lines_vec![]
  • Switched macro delimiters from parentheses to square brackets
  • Removed redundant .to_string() and .into_iter().map(str::to_string) calls
  • Added trailing commas for consistent formatting
tests/integration.rs

Possibly linked issues


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 17, 2025

Summary by CodeRabbit

  • Refactor
    • Simplified and unified test code by using a macro for creating vectors of strings, improving readability and consistency across all test cases. No changes to test behaviour or outcomes.

Walkthrough

Update the test code in tests/integration.rs to use the lines_vec![] macro for constructing vectors of strings, replacing all explicit vec![] or vec!() usages. Apply this change uniformly across all test fixtures, inputs, outputs, and code snippets. No logic, control flow, or assertions are altered.

Changes

File(s) Change Summary
tests/integration.rs Replace all explicit vec![] or vec!() constructions with the lines_vec![] macro for string vectors.

Possibly related PRs

Poem

With brackets and macros, the tests now align,
lines_vec![] brings order, the syntax is fine.
No more mapping or collecting in sight,
Just crisp, tidy vectors—oh, what a delight!

📚✨


📜 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 70b2f31 and a0882b4.

📒 Files selected for processing (1)
  • tests/integration.rs (25 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 (6)
src/table.rs (1)
  • reflow_table (95-132)
src/process.rs (1)
  • process_stream (76-76)
src/html.rs (2)
  • lines (176-179)
  • convert_html_tables (299-342)
tests/common/mod.rs (1)
  • assert_wrapped_list_item (17-53)
src/lists.rs (5)
  • renumber_lists (67-118)
  • vec (126-129)
  • vec (130-133)
  • vec (139-142)
  • vec (143-146)
src/breaks.rs (3)
  • format_breaks (19-38)
  • vec (48-51)
  • vec (62-65)
✨ 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/replace-idioms-in-integration-tests

🪧 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 - here's some feedback:

  • Some of the doc comments still use lines_vec! with String::from(...) wrappers—remove those and pass bare string literals to lines_vec! to keep the examples correct and concise.
  • The trailing‐comma style in your lines_vec! invocations is inconsistent—either include a comma after every element list or omit it uniformly to match project formatting conventions.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Some of the doc comments still use `lines_vec!` with `String::from(...)` wrappers—remove those and pass bare string literals to `lines_vec!` to keep the examples correct and concise.
- The trailing‐comma style in your `lines_vec!` invocations is inconsistent—either include a comma after every element list or omit it uniformly to match project formatting conventions.

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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 171aae2 and 28309e5.

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🔇 Additional comments (1)
tests/integration.rs (1)

185-190: Macro migration looks sound

All converted test inputs/expectations now use lines_vec![]. No functional, stylistic, or ownership issues detected.

Also applies to: 352-359, 378-384, 642-645, 654-655, 666-670, 678-681, 689-691, 699-701, 708-712, 726-728, 736-738, 750-758, 769-769, 776-779, 783-786, 856-856, 883-892, 910-915, 918-922, 929-932, 938-941, 947-950, 969-997

Comment thread tests/integration.rs Outdated
Comment thread tests/integration.rs Outdated
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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2987d62 and 70b2f31.

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🔇 Additional comments (1)
tests/integration.rs (1)

1-945: Macro adoption looks solid

Replacing the ad-hoc vec![] constructions with lines_vec![] everywhere tightens the tests and removes boiler-plate. No functional issues spotted.

Comment thread tests/integration.rs
let lines = lines_vec!("| A | B | |", "| 1 | 2 | | 3 | 4 |",);
lines
}
fn broken_table() -> Vec<String> { return lines_vec!["| A | B | |", "| 1 | 2 | | 3 | 4 |"]; }
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.

🧹 Nitpick (assertive)

Drop the redundant return in single-expression fixtures

The coding guidelines forbid return in one-liner functions. Strip it to keep idiomatic Rust across all the affected fixtures.

-fn broken_table() -> Vec<String> { return lines_vec![/* … */]; }
+fn broken_table() -> Vec<String> { lines_vec![/* … */] }

Apply the same tweak to malformed_table, indented_table, html_table_empty, and html_table_unclosed.

Also applies to: 30-30, 44-44, 118-118, 121-121

🤖 Prompt for AI Agents
In tests/integration.rs at lines 23, 30, 44, 118, and 121, remove the redundant
`return` keyword from the single-expression functions broken_table,
malformed_table, indented_table, html_table_empty, and html_table_unclosed.
Change these functions to directly return the expression without using `return`
to comply with idiomatic Rust style guidelines.

Comment thread tests/integration.rs
Comment on lines +340 to 350
let input = lines_vec![
"# Title",
String::new(),
"Para text.".to_string(),
"Para text.",
String::new(),
"| a | b |".to_string(),
"| 1 | 22 |".to_string(),
"| a | b |",
"| 1 | 22 |",
String::new(),
"* bullet".to_string(),
"* bullet",
String::new(),
];
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.

🧹 Nitpick (assertive)

Use "" instead of String::new() for blank lines

Blank lines don’t need an owned String. Supplying "" avoids the extra heap allocation without changing semantics.

         "# Title",
-        String::new(),
+        "",
         "Para text.",
-        String::new(),
+        "",
         "| a | b |",
         "| 1 | 22 |",
-        String::new(),
+        "",
         "* bullet",
-        String::new(),
+        "",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
let input = lines_vec![
"# Title",
String::new(),
"Para text.".to_string(),
"Para text.",
String::new(),
"| a | b |".to_string(),
"| 1 | 22 |".to_string(),
"| a | b |",
"| 1 | 22 |",
String::new(),
"* bullet".to_string(),
"* bullet",
String::new(),
];
let input = lines_vec![
"# Title",
"",
"Para text.",
"",
"| a | b |",
"| 1 | 22 |",
"",
"* bullet",
"",
];
🤖 Prompt for AI Agents
In tests/integration.rs around lines 340 to 350, replace all instances of
String::new() used for blank lines with "" to avoid unnecessary heap allocations
while keeping the same semantics. This change improves efficiency by using
string slices instead of owned Strings for empty lines.

@leynos leynos merged commit 956a908 into main Jul 17, 2025
1 of 2 checks passed
@leynos leynos deleted the codex/replace-idioms-in-integration-tests branch July 17, 2025 11:22
leynos added a commit that referenced this pull request Jul 17, 2025
leynos added a commit that referenced this pull request Jul 17, 2025
* Handle formatted paragraph restarts (#86)

* Define shared formatting markers
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