Skip to content

Fix escaped pipe handling#11

Merged
leynos merged 2 commits intomainfrom
codex/refactor-row-length-check-and-escape-handling
Jun 13, 2025
Merged

Fix escaped pipe handling#11
leynos merged 2 commits intomainfrom
codex/refactor-row-length-check-and-escape-handling

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 13, 2025

Summary

  • correctly treat escaped pipes as literals
  • extract helper for separator line formatting
  • simplify row-length consistency check
  • update test for new escaped pipe behaviour

Testing

  • cargo clippy -- -D warnings
  • cargo test

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

Summary by Sourcery

Fix escaped pipe handling in table reflow, refactor separator line formatting into a helper, simplify row-length consistency checks, and update tests for the new behavior

Bug Fixes:

  • Handle escaped pipes (\|) as literal characters in table cell splitting.

Enhancements:

  • Extract format_separator_cells helper to centralize separator row formatting.
  • Simplify row-length consistency check in reflow_table by comparing each row length to the first.

Tests:

  • Update integration test to expect correct spacing with escaped pipes in reflowed tables.

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of escaped pipe characters (\|) in Markdown tables, ensuring correct cell content and alignment.
  • Tests
    • Updated tests to reflect more accurate column alignment when escaped pipes are present in table data.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 13, 2025

Reviewer's Guide

This PR refines escaped pipe handling in split_cells to treat “|” as a literal character, introduces a format_separator_cells helper to centralize separator row formatting, simplifies the row-length consistency check in reflow_table, and updates the integration test to align with the new escaped-pipe behavior.

Sequence Diagram: reflow_table Interaction with format_separator_cells

sequenceDiagram
    participant R as "reflow_table()"
    participant F as "format_separator_cells()"
    R->>F: format_separator_cells(widths, sep_cells)
    F-->>R: sep_padded (formatted separator cells)
Loading

Updated Class Diagram for lib Module Functions

classDiagram
  class lib {
    +split_cells(line: &str) : Vec~String~
    +format_separator_cells(widths: &[usize], sep_cells: &[String]) : Vec~String~
    +reflow_table(lines: &[String]) : Vec~String~
  }
  %% split_cells: Logic for '\|' updated to treat as literal.
  %% format_separator_cells: New helper function extracted from reflow_table.
  %% reflow_table: Now calls format_separator_cells and has a simplified row-length consistency check.
Loading

File-Level Changes

Change Details Files
Treat escaped pipes as literals in split_cells
  • Detect “|” and consume the escape sequence
  • Append '
' directly to the current cell instead of splitting
  • Remove previous logic that pushed and cleared the cell on escape
  • Extract format_separator_cells helper
    • Create format_separator_cells(widths, sep_cells) to generate aligned dash strings with optional leading/trailing ':'
    • Replace inline separator formatting in reflow_table with a call to the new helper
    src/lib.rs
    Simplify row-length consistency check in reflow_table
    • Use first row’s length and any mismatch detection instead of building a HashSet
    • Restructure nested if-let for early return on inconsistent row lengths
    src/lib.rs
    Update integration test for escaped pipe behavior
    • Adjust expected table spacing in test_reflow_handles_escaped_pipes to reflect literal '
    ' inclusion

    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 Jun 13, 2025

    Warning

    Rate limit exceeded

    @leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 46 seconds before requesting another review.

    ⌛ How to resolve this issue?

    After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

    We recommend that you space out your commits to avoid hitting the rate limit.

    🚦 How do rate limits work?

    CodeRabbit enforces hourly rate limits for each developer per organization.

    Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

    Please see our FAQ for further information.

    📥 Commits

    Reviewing files that changed from the base of the PR and between b576f90 and b6f7b72.

    📒 Files selected for processing (2)
    • src/lib.rs (4 hunks)
    • tests/integration.rs (1 hunks)

    Walkthrough

    The changes revise the handling of escaped pipe characters in the Markdown table parser, ensuring they are included in cell content rather than splitting cells. A new helper function for formatting separator rows is introduced, and row length consistency checks are simplified. Corresponding test expectations are updated for improved column alignment.

    Changes

    File(s) Change Summary
    src/lib.rs Fixed escaped pipe (|) handling in split_cells; added format_separator_cells helper; simplified row length checks in reflow_table.
    tests/integration.rs Updated expected output in test_reflow_handles_escaped_pipes to reflect improved column alignment.

    Sequence Diagram(s)

    sequenceDiagram
        participant User
        participant reflow_table
        participant split_cells
        participant format_separator_cells
    
        User->>reflow_table: Call with Markdown table
        reflow_table->>split_cells: Split each row into cells (handles escaped pipes)
        reflow_table->>format_separator_cells: Format separator row cells for alignment
        reflow_table-->>User: Return reflowed table with correct alignment
    
    Loading

    Possibly related PRs

    Poem

    A table reflows, neat and wide,
    Escaped pipes now tucked inside.
    Separator lines, aligned with care,
    Helper functions trim the glare.
    Tests updated, columns bright—
    Markdown tables set just right!
    🐇✨

    ✨ Finishing Touches
    • 📝 Generate Docstrings

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

    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

    🧹 Nitpick comments (2)
    src/lib.rs (2)

    38-41: Escaped-pipe handling looks correct but silently drops the backslash

    The new branch correctly converts \| to a literal |, but the backslash itself is discarded.
    That’s fine for escaped pipes, yet it will also eat the backslash if the input was \\| (intended to render “|”). Consider pushing the backslash when two consecutive backslashes are encountered so that double escapes survive a single pass.
    Not critical for the announced PR scope, just a corner-case to keep in mind.


    157-163: Simplified consistency check is fine but still O(n²)-ish

    Replacing the HashSet with a first-row comparison is clearer; however the any scan is still executed for every call. Minor, but you could early-exit on the first mismatch:

    -if cleaned.iter().any(|row| row.len() != first_len) {
    +if cleaned[1..].iter().any(|row| row.len() != first_len) {

    Avoids one needless comparison.

    📜 Review details

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

    📥 Commits

    Reviewing files that changed from the base of the PR and between edaaf61 and b576f90.

    📒 Files selected for processing (2)
    • src/lib.rs (4 hunks)
    • tests/integration.rs (1 hunks)
    ⏰ Context from checks skipped due to timeout of 90000ms (2)
    • GitHub Check: build-test
    • GitHub Check: coverage
    🔇 Additional comments (1)
    tests/integration.rs (1)

    97-99: Test expectation conceals a double-split bug

    The expected line | a | b | 1 | implies three cells, yet the source line has only two real cells ("a | b" and "1").
    The extra split after a and before b would re-introduce the very bug this PR is fixing. Please verify the golden output with reflow_table; if two cells are returned, adjust the expectation to | a | b |1 | (or whatever spacing emerges).

    Comment thread src/lib.rs
    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!

    Prompt for AI Agents
    Please address the comments from this code review:
    ## Individual Comments
    
    ### Comment 1
    <location> `tests/integration.rs:96` </location>
    <code_context>
    
     #[rstest]
     fn test_reflow_handles_escaped_pipes(escaped_pipe_table: Vec<String>) {
    -    let expected = vec!["| X | Y |", "| a | b | 1 |", "| 2 | 3 |"];
    +    let expected = vec!["| X     | Y |", "| a | b | 1 |", "| 2     | 3 |"];
    </code_context>
    
    <issue_to_address>
    Consider clarifying the expected output structure and fixture interaction for this test.
    
    A brief comment in the test explaining the fixture's structure and its effect on the output, especially regarding row-length consistency, would make the test easier to understand and maintain.
    </issue_to_address>

    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.

    Comment thread tests/integration.rs
    @leynos leynos merged commit 2c367ec into main Jun 13, 2025
    3 checks passed
    @leynos leynos deleted the codex/refactor-row-length-check-and-escape-handling branch June 13, 2025 22:36
    @codecov
    Copy link
    Copy Markdown

    codecov Bot commented Jun 13, 2025

    Welcome to Codecov 🎉

    Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

    Thanks for integrating Codecov - We've got you covered ☂️

    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