Improve HTML table detection by leynos · Pull Request #18 · leynos/mdtablefix

leynos · 2025-06-14T01:34:56Z

Summary

recognize <table> tags with attributes or mixed casing
convert uppercase, mixed-case, and attributed tables
test additional HTML table scenarios
document that tag matching is case-insensitive

Testing

cargo fmt -- --check
cargo clippy -- -D warnings
cargo test
markdownlint "**/*.md" | head -n 20
nixie docs

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

Summary by Sourcery

Improve HTML table detection to handle case-insensitive tags and attributes, and add corresponding tests and documentation.

Enhancements:

Use case-insensitive regex patterns to detect <table> and </table> tags regardless of casing or attributes

Documentation:

Document that table tag matching is case-insensitive and supports attributes

Tests:

Add fixtures and tests for HTML tables with attributes, uppercase tags, and mixed-case tags

sourcery-ai · 2025-06-14T01:35:01Z

Reviewer's Guide

The PR enhances HTML table detection by replacing basic substring checks with case-insensitive regex patterns for <table> start/end tags (including attributes and mixed casing), updating push_html_line and process_stream to use these patterns, and adding integration tests and documentation for the new scenarios.

Sequence Diagram: HTML Table Start Detection in `process_stream`

sequenceDiagram
    participant C as Caller
    participant PS as process_stream
    participant TSR as TABLE_START_RE

    C->>PS: process_stream(lines)
    activate PS
    loop For each line in lines
        PS->>PS: current_line = ...
        PS->>PS: trimmed_line = current_line.trim_start()
        PS->>TSR: is_match(trimmed_line)
        activate TSR
        TSR-->>PS: bIsTableStartMatch
        deactivate TSR
        alt bIsTableStartMatch is true
            PS->>PS: Initiate HTML table processing logic
        else
            PS->>PS: Continue normal line processing
        end
    end
    PS-->>C: processed_lines
    deactivate PS

Class Diagram: `lib.rs` Module Changes

classDiagram
    class lib_rs {
        <<Rust Module>>
        +TABLE_START_RE: Regex
        +TABLE_END_RE: Regex
        +push_html_line(... C) // Modified
        +process_stream(... C) // Modified
    }

File-Level Changes

Change	Details	Files
Use case-insensitive regexes for table tag detection	Introduce TABLE_START_RE and TABLE_END_RE with `(?i)` flags Replace `<table` and `</table>` substring counts with regex `find_iter` and `is_match` calls in `push_html_line` Update `process_stream` to use TABLE_START_RE for detecting table starts	`src/lib.rs`
Add tests for tables with attributes and varied casing	Add fixtures for tables with attributes, uppercase, and mixed-case tags Add `rstest` test functions for each new fixture verifying markdown conversion	`tests/integration.rs`
Document updated tag-matching behavior	Append note in HTML table support docs about case-insensitive and attribute-aware detection	`docs/html-table-support.md`

Possibly linked issues

Update CLI docs and concurrency section #123: PR improves HTML table detection using regex for attributes, uppercase, mixed case.
#0: The PR implements case-insensitive regex matching for HTML table tags, directly fixing the issue's stated problem.

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

coderabbitai · 2025-06-14T01:35:03Z

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 38 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 7546636 and ef72489.

📒 Files selected for processing (3)

docs/html-table-support.md (1 hunks)
src/lib.rs (3 hunks)
tests/integration.rs (2 hunks)

✨ Finishing Touches

📝 Docstrings were successfully generated. (🔄 Check again to generate docstrings again)

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

sourcery-ai

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

codecov · 2025-06-14T01:38:31Z

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 78.03%. Comparing base (2c367ec) to head (ef72489).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
src/lib.rs	87.50%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #18      +/-   ##
==========================================
+ Coverage   74.37%   78.03%   +3.65%     
==========================================
  Files           2        2              
  Lines         160      264     +104     
==========================================
+ Hits          119      206      +87     
- Misses         41       58      +17

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@leynos

Docstrings generation was requested by @leynos. * #18 (comment) The following files were modified: * `src/lib.rs` * `tests/integration.rs`

coderabbitai · 2025-06-14T01:54:11Z

Note

Generated docstrings for this pull request at #19

Improve HTML table detection

ef72489

leynos added the codex label Jun 14, 2025 — with ChatGPT Codex Connector

sourcery-ai Bot reviewed Jun 14, 2025

View reviewed changes

coderabbitai Bot added a commit that referenced this pull request Jun 14, 2025

📝 Add docstrings to codex/improve-html-table-start-detection

df92a25

Docstrings generation was requested by @leynos. * #18 (comment) The following files were modified: * `src/lib.rs` * `tests/integration.rs`

coderabbitai Bot mentioned this pull request Jun 14, 2025

📝 Add docstrings to codex/improve-html-table-start-detection #19

Open

leynos merged commit f052182 into main Jun 14, 2025
5 checks passed

leynos deleted the codex/improve-html-table-start-detection branch June 14, 2025 01:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve HTML table detection#18

Improve HTML table detection#18
leynos merged 1 commit intomainfrom
codex/improve-html-table-start-detection

leynos commented Jun 14, 2025 •

edited by sourcery-ai Bot

Loading

Uh oh!

sourcery-ai Bot commented Jun 14, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

coderabbitai Bot commented Jun 14, 2025 •

edited

Loading

Rate limit exceeded

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sourcery-ai Bot left a comment

Uh oh!

codecov Bot commented Jun 14, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

leynos commented Jun 14, 2025 • edited by sourcery-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Summary by Sourcery

Uh oh!

sourcery-ai Bot commented Jun 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence Diagram: HTML Table Start Detection in process_stream

Class Diagram: lib.rs Module Changes

File-Level Changes

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

coderabbitai Bot commented Jun 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Jun 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai Bot commented Jun 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

leynos commented Jun 14, 2025 •

edited by sourcery-ai Bot

Loading

sourcery-ai Bot commented Jun 14, 2025 •

edited

Loading

Sequence Diagram: HTML Table Start Detection in `process_stream`

Class Diagram: `lib.rs` Module Changes

coderabbitai Bot commented Jun 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov Bot commented Jun 14, 2025 •

edited

Loading