Improve conditional readability with predicates

[leynos]

Summary

• refactor table cell parser to use next_is_pipe
• filter ignored HTML tags with is_ignored_tag
• detect <strong>/<b> tags via is_bold_tag
• clarify separator validation using should_use_second_row_as_separator

Testing

• make fmt
• make lint
• make test

---

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

Summary by Sourcery

Improve conditional readability by extracting and applying predicate helper functions across HTML parsing, cell splitting, and table separator detection

Enhancements:

• Introduce is_ignored_tag helper and replace inline checks in HTML text collection
• Extract is_bold_tag helper and simplify bold tag detection in contains_strong
• Add next_is_pipe predicate to clarify escape logic in split_cells
• Add should_use_second_row_as_separator helper to clarify separator validation in detect_separator

[sourcery-ai]

Reviewer's Guide

This PR refactors conditional checks into named predicate functions to improve readability and maintainability, replacing inline comparisons in HTML parsing, cell splitting, and separator detection logic with descriptive helpers.

File-Level Changes

Change	Details	Files
Extract ignored HTML tag check into a predicate	Add is_ignored_tag to centralize script/style/noscript/template/head checks Replace inline tag comparisons in collect_text with is_ignored_tag	src/html.rs
Encapsulate bold tag detection	Introduce is_bold_tag for / matching Update contains_strong guard to use is_bold_tag	src/html.rs
Encapsulate peek-pipe logic in cell splitting	Add next_is_pipe to check for upcoming '	' character Use next_is_pipe instead of inline peek comparison in split_cells
Clarify separator row selection logic	Create should_use_second_row_as_separator to combine validity and separator checks Replace inline sep_invalid && second_row_is_separator with the new predicate	src/reflow.rs

Possibly linked issues

• #0: The PR implements the issue's goal of improving readability by extracting conditional logic into predicate functions.

---

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]

Summary by CodeRabbit

• Refactor
  • Improved code readability and maintainability by consolidating repeated tag and condition checks into dedicated helper functions. No changes to user-facing functionality.

Walkthrough

Refactor inline conditional checks into dedicated helper functions across several modules. Move repeated tag comparisons in HTML parsing and markdown table logic into named functions, improving code organisation. No changes are made to the overall logic, control flow, or public interfaces, except for the addition of new private helpers.

Changes

File(s)	Change Summary
src/html.rs	Introduce is_ignored_tag and is_bold_tag helper functions; refactor tag checks in parsing.
src/lib.rs	Add private next_is_pipe helper; refactor escaped pipe detection in split_cells.
src/reflow.rs	Add should_use_second_row_as_separator helper; refactor separator condition logic.

Sequence Diagram(s)

sequenceDiagram
    participant Parser as HTML/Markdown Parser
    participant Helper as Helper Functions

    Parser->>Helper: is_ignored_tag(tag)
    Helper-->>Parser: true/false

    Parser->>Helper: is_bold_tag(tag)
    Helper-->>Parser: true/false

    Parser->>Helper: next_is_pipe(iterator)
    Helper-->>Parser: true/false

    Parser->>Helper: should_use_second_row_as_separator(sep_invalid, rows)
    Helper-->>Parser: true/false

Loading

Possibly related PRs

• Refactor conditionals into predicates #51: Refactors inline tag checks into helpers in src/html.rs, directly aligning with this PR's approach.
• Fix escaped pipe handling #11: Adjusts escaped pipe handling in split_cells, related to the new next_is_pipe helper.
• Add docstrings for HTML utilities #22: Adds documentation to HTML utility functions in src/html.rs, related by focus on HTML utilities.

Poem

Refactor the checks, let helpers arise,
No more inline clutter before our eyes.
Pipes and tags now neatly contained,
Logic untouched, but clarity gained.
With functions for aid and code now refined,
Onward the codebase, elegantly aligned!
🛠️✨

---

📜 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 4126af8 and 25c5d54.

📒 Files selected for processing (3)

• src/html.rs (3 hunks)
• src/lib.rs (2 hunks)
• src/reflow.rs (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

🔇 Additional comments (8)

src/reflow.rs (2)

132-135: Excellent refactoring that improves conditional readability.

The extraction of the compound boolean condition into a named predicate function makes the intent clearer in detect_separator. The function correctly preserves the original logic whilst adhering to the coding guidelines about moving conditionals into predicate functions.

---

117-117: Clean usage of the new predicate function.

The function call is much more readable than the previous inline condition and clearly expresses the intent of when to use the second row as separator.

src/lib.rs (2)

34-36: Well-implemented predicate function for pipe detection.

The extraction of the peek check into a named function improves the readability of the escape logic in split_cells. The function correctly handles the mutable reference to the peekable iterator and follows the guideline of not using return in single-line functions.

---

52-52: Clear usage of the pipe detection predicate.

The function call makes the escape logic more readable and self-documenting compared to the previous inline peek check.

src/html.rs (4)

32-38: Excellent consolidation of ignored tag checks.

The extraction of multiple case-insensitive tag comparisons into a dedicated function significantly improves code organisation and readability. The function correctly preserves all the previous tag checks (script, style, noscript, template, head) and maintains the case-insensitive comparison logic.

---

106-108: Clean implementation of bold tag detection.

The consolidation of bold tag checks into a single predicate function improves readability whilst correctly preserving the case-insensitive comparison logic for both strong and b tags.

---

58-58: Improved readability with the ignored tag predicate.

The function call makes the filtering logic in collect_text much clearer and easier to understand than the previous inline comparisons.

---

112-116: Clean refactoring of bold tag detection logic.

The usage of is_bold_tag in the pattern matching makes the intent clearer and consolidates the tag checking logic effectively.

✨ 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/refactor-conditional-expressions-into-predicates

---

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

[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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[leynos]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[leynos]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.