Skip to content

Refactor conditionals into predicates#51

Merged
leynos merged 2 commits intomainfrom
codex/refactor-conditional-expressions-with-predicates
Jun 16, 2025
Merged

Refactor conditionals into predicates#51
leynos merged 2 commits intomainfrom
codex/refactor-conditional-expressions-with-predicates

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 16, 2025

Summary

  • move complex if let logic into small predicate helpers
  • add tests and docs for new helpers

Testing

  • cargo clippy -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test

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

Summary by Sourcery

Refactor conditional checks into dedicated predicate functions to simplify HTML and markdown table handling

Enhancements:

  • Extract common element and table-cell detection into is_element and is_table_cell helpers
  • Introduce sep_index_within and rows_mismatched predicates for separator indexing and row consistency checks
  • Replace inline conditional logic in HTML parsing and table reflow with the new predicate helpers

Documentation:

  • Add doc comments for all new predicate helpers

Tests:

  • Add unit tests for is_element, is_table_cell, sep_index_within, and rows_mismatched functions

Summary by CodeRabbit

  • Refactor
    • Improved internal logic for HTML element detection and table processing, resulting in cleaner and more maintainable code.
  • Tests
    • Added new unit tests to verify correct behaviour of HTML element detection and table row consistency checks.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 16, 2025

Reviewer's Guide

Refactors complex inline conditionals in html.rs and lib.rs into reusable predicate helpers with accompanying doc comments and unit tests to improve code clarity and maintainability.

Class diagram for new predicate helpers in html.rs

classDiagram
    class Handle
    class NodeData
    class html_helpers {
        +is_element(handle: &Handle, tag: &str) bool
        +is_table_cell(handle: &Handle) bool
    }
    Handle --> NodeData
    html_helpers ..> Handle
    html_helpers ..> NodeData
Loading

Class diagram for new predicate helpers in lib.rs

classDiagram
    class lib_helpers {
        +sep_index_within(idx: Option<usize>, len: usize) Option<usize>
        +rows_mismatched(rows: &[Vec<String>], split_within_line: bool) bool
    }
    lib_helpers ..> Vec
    lib_helpers ..> Option
Loading

File-Level Changes

Change Details Files
Extracted HTML predicate helpers for element and table cell detection
  • Added is_element and is_table_cell functions with doc comments
  • Replaced inline if-let checks in collect_tables, collect_rows, and table_node_to_markdown
  • Added unit tests validating element and table cell detection
src/html.rs
Refactored table reflow conditional logic into helper functions
  • Introduced sep_index_within and rows_mismatched predicates with doc comments
  • Replaced inline sep_row_idx and mismatch checking in reflow_table with these helpers
  • Added unit tests for sep_index_within and rows_mismatched
src/lib.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 Jun 16, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update introduces helper functions to centralise HTML tag checks in the DOM, replacing inline logic in table parsing routines. It also adds utility functions for bounds-checking and row consistency in table reflow logic. New unit tests are included for all helper functions to verify correctness.

Changes

File(s) Change Summary
src/html.rs Added is_element and is_table_cell helper functions; refactored table routines to use them; added unit tests for these helpers.
src/lib.rs Added sep_index_within and rows_mismatched helper functions; refactored reflow_table to use them; added unit tests for these helpers.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant HTMLHelper
    participant TableLogic

    Caller->>HTMLHelper: is_element(handle, tag)
    HTMLHelper-->>Caller: bool

    Caller->>HTMLHelper: is_table_cell(handle)
    HTMLHelper-->>Caller: bool

    Caller->>TableLogic: sep_index_within(idx, len)
    TableLogic-->>Caller: Option<usize>

    Caller->>TableLogic: rows_mismatched(rows, split_within_line)
    TableLogic-->>Caller: bool
Loading

Possibly related PRs

  • Refactor HTML table handling #20: Adds helper functions to simplify tag checks within the existing HTML table handling code in src/html.rs, directly building on and refining the HTML table processing logic.
  • Add HTML table conversion support #13: Adds helper functions to simplify HTML element tag checks within the existing HTML table parsing and conversion code, directly relating to the same HTML table processing logic in src/html.rs.

Poem

In the warren of code, helpers now dwell,
Checking tags and rows, ensuring all is well.
With tests that hop and bounds that stay,
Table logic’s clearer, in every way.
🐇✨
“A tidy table, a happy hare!”
— Signed, your code-rabbit, with care.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch codex/refactor-conditional-expressions-with-predicates
  • Post Copyable Unit Tests in Comment

🪧 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

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Code Health Improved (1 files improve in Code Health)

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

View Improvements
File Code Health Impact Categories Improved
html.rs 7.33 → 7.79 Code Duplication, Complex Method, Overall Code Complexity
lib.rs no change Overall Code Complexity, String Heavy Function Arguments

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

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

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

102-104: Prefer early‐return clarity over terse combinator usage

idx.filter(|&i| i < len) is neat but hides intent. A short match or matches!(idx, Some(i) if i < len) spells out why None may be produced, which aids future maintainers skimming the code.

-fn sep_index_within(idx: Option<usize>, len: usize) -> Option<usize> { idx.filter(|&i| i < len) }
+fn sep_index_within(idx: Option<usize>, len: usize) -> Option<usize> {
+    matches!(idx, Some(i) if i < len).then_some(idx?).flatten()
+}

105-116: Slice indexing could be clearer & cheaper

The rows[1..] slice is safe but visually scary because of potential “empty-slice” panics readers might recall. Iterating with rows.iter().skip(1) avoids that concern and prevents re-allocation of the sub-slice.

-    rows[1..]
-        .iter()
+    rows.iter().skip(1)
         .any(|row| row.len() != first_len && !row.iter().all(|c| SEP_RE.is_match(c)))
src/html.rs (2)

72-80: Tag comparison should remain case-insensitive

html5ever lower-cases HTML tags, but using eq_ignore_ascii_case costs nothing and maintains parity with the rest of the file (e.g. contains_strong). It prevents surprises if the helper is ever reused with XML or non-canonicalised input.

-fn is_element(handle: &Handle, tag: &str) -> bool {
-    if let NodeData::Element { name, .. } = &handle.data {
-        name.local.as_ref() == tag
+fn is_element(handle: &Handle, tag: &str) -> bool {
+    if let NodeData::Element { name, .. } = &handle.data {
+        name.local.as_ref().eq_ignore_ascii_case(tag)
     } else {
         false
     }
 }

81-89: Reuse is_element to cut duplication & stay consistent

is_table_cell re-implements tag checks and is currently case-sensitive. Leveraging is_element keeps behaviour uniform and the intent crystal-clear.

-fn is_table_cell(handle: &Handle) -> bool {
-    if let NodeData::Element { name, .. } = &handle.data {
-        let tag = name.local.as_ref();
-        tag == "td" || tag == "th"
-    } else {
-        false
-    }
+fn is_table_cell(handle: &Handle) -> bool {
+    is_element(handle, "td") || is_element(handle, "th")
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4fa9f52 and ce9fbfc.

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

168-174: Good encapsulation of bounds & mismatch checks

Replacing the inline conditions with sep_index_within and rows_mismatched trims cognitive load and keeps reflow_table readable. Nice refactor.


523-557: Solid unit-test coverage for new helpers

The added tests cover in-bounds, out-of-bounds and None cases for sep_index_within, as well as all logical branches for rows_mismatched. This guards against future regressions.

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

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Code Health Improved (1 files improve in Code Health)

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

View Improvements
File Code Health Impact Categories Improved
html.rs 7.33 → 7.79 Code Duplication, Complex Method, Overall Code Complexity
lib.rs no change Overall Code Complexity, String Heavy Function Arguments

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

@leynos leynos merged commit 28204ad into main Jun 16, 2025
3 checks passed
@leynos leynos deleted the codex/refactor-conditional-expressions-with-predicates branch June 16, 2025 15:04
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