Skip to content

Use io rewrite helpers#133

Merged
leynos merged 1 commit intomainfrom
codex/replace-handle_file-with-io-functions
Jul 29, 2025
Merged

Use io rewrite helpers#133
leynos merged 1 commit intomainfrom
codex/replace-handle_file-with-io-functions

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 29, 2025

Summary

  • replace inline file handling with io::rewrite and rewrite_no_wrap

Testing

  • make lint
  • make test

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

Summary by Sourcery

Use the mdtablefix rewrite helpers to simplify file I/O in handle_file, delegating in-place updates to rewrite and rewrite_no_wrap and preserving manual processing for non-in-place mode.

Enhancements:

  • Replace manual file read/write in handle_file with mdtablefix::rewrite and rewrite_no_wrap for in-place formatting
  • Relocate manual file reading and line processing to the non-in-place branch to retain existing behavior

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 29, 2025

Reviewer's Guide

Replaces inline file reading and writing with mdtablefix rewrite helpers for in-place updates, adds wrap mode branching, and moves manual content processing to the non-in-place path.

Class diagram for updated file handling in handle_file

classDiagram
    class handle_file {
        +Option<String> handle_file(path: &Path, in_place: bool, opts: FormatOpts)
    }
    class mdtablefix {
        +rewrite(path: &Path)
        +rewrite_no_wrap(path: &Path)
    }
    handle_file ..> mdtablefix : uses
Loading

File-Level Changes

Change Details Files
Swap manual file I/O for in-place rewrite helpers
  • Remove manual fs::write of formatted output
  • Insert conditional calls to mdtablefix::rewrite and rewrite_no_wrap
  • Add wrap flag check to choose appropriate rewrite helper
src/main.rs
Relocate content reading and processing to non in-place branch
  • Remove initial fs::read_to_string and direct process_lines invocation
  • Move content read, lines generation, and process_lines.join into the else block
  • Return processed content only in non-in-place path
src/main.rs

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

Summary by CodeRabbit

  • Refactor
    • Improved file processing logic for in-place operations, enhancing how files are rewritten based on user options. No changes to user-facing functionality.

Walkthrough

Delegate in-place file rewriting within the handle_file function in src/main.rs to the mdtablefix::rewrite or mdtablefix::rewrite_no_wrap functions, based on the opts.wrap flag. Preserve the original behaviour for non-in-place operations and retain consistent error context messages.

Changes

Cohort / File(s) Change Summary
Main logic delegation
src/main.rs
Refactor handle_file to use mdtablefix::rewrite or mdtablefix::rewrite_no_wrap for in-place file edits. Preserve previous logic for non-in-place operations. Error context messages remain unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant handle_file
    participant mdtablefix

    User->>handle_file: Call with (path, in_place, opts)
    alt in_place == true
        alt opts.wrap == true
            handle_file->>mdtablefix: rewrite(path)
        else opts.wrap == false
            handle_file->>mdtablefix: rewrite_no_wrap(path)
        end
        mdtablefix-->>handle_file: Result
        handle_file-->>User: None (in-place edit)
    else in_place == false
        handle_file->>FileSystem: Read file
        handle_file->>process_lines: Process lines
        process_lines-->>handle_file: Fixed content
        handle_file-->>User: Some(fixed content)
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

Rewrite with care, in-place or not,
Let mdtablefix handle the lot!
No more manual read and write,
Delegation makes the code more tight.
Tables fixed with a single call—
Markdown harmony for one and all!
📝✨


📜 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 35b50b8 and 4609bcd.

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

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.rs: Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.
Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.
Place function attributes after doc comments.
Do not use return in single-line functions.
Use predicate functions for conditional criteria with more than two branches.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Prefer .expect() over .unwrap().
Use concat!() to combine long string literals rather than escaping newlines with a backslash.
Prefer semantic error enums: Derive std::error::Error (via the thiserror crate) for any condition the caller might inspect, retry, or map to an HTTP status.
Use an opaque error only at the app boundary: Use eyre::Report for human-readable logs; these should not be exposed in public APIs.
Never export the opaque type from a library: Convert to domain enums at API boundaries, and to eyre only in the main main() entrypoint or top-level async task.

Files:

  • src/main.rs

⚙️ CodeRabbit Configuration File

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

  • Adhere to single responsibility and CQRS

  • Place function attributes after doc comments.

  • Do not use return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless absolutely necessary.

  • Every module must begin with a //! doc comment that explains the module's purpose and utility.

  • Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar

  • Lints must not be silenced except as a last resort.

    • #[allow] is forbidden.
    • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
    • No lint groups, no blanket or file-wide suppression.
    • Include FIXME: with link if a fix is expected.
  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for mocks/stubs.

  • Prefer .expect() over .unwrap()

  • Ensure that any API or behavioural changes are reflected in the documentation in docs/

  • Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

  • Files must not exceed 400 lines in length

    • Large modules must be decomposed
    • Long match statements or dispatch tables should be decomposed by domain and collocated with targets
    • Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.

Files:

  • src/main.rs
🧬 Code Graph Analysis (1)
src/main.rs (1)
src/io.rs (2)
  • rewrite (33-33)
  • rewrite_no_wrap (39-41)
🔇 Additional comments (2)
src/main.rs (2)

83-88: Excellent refactoring to use dedicated rewrite helpers.

The delegation to mdtablefix::rewrite and mdtablefix::rewrite_no_wrap based on the opts.wrap flag is well-implemented. The error handling with .with_context() maintains consistency with the existing error reporting pattern, and the conditional logic correctly maps the wrap option to the appropriate rewrite function.


91-94: Clean preservation of non-in-place behaviour.

The else branch correctly maintains the original file reading and processing logic for non-in-place operations. The use of fs::read_to_string with appropriate error context and the subsequent line processing maintains backward compatibility whilst allowing the new rewrite helpers to handle in-place operations.

✨ 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-handle_file-with-io-functions

🪧 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 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 and found some issues that need to be addressed.

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/main.rs:83` </location>
<code_context>
     if in_place {
-        fs::write(path, format!("{fixed}\n"))
-            .with_context(|| format!("writing {}", path.display()))?;
+        if opts.wrap {
+            mdtablefix::rewrite(path).with_context(|| format!("writing {}", path.display()))?;
+        } else {
</code_context>

<issue_to_address>
The module is missing a `//!` comment at the top as required by the review instructions.

Please add a `//!` doc comment at the very top of the file to describe the module's purpose, as per the project guidelines.
</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 src/main.rs
@leynos leynos merged commit 7ba89d9 into main Jul 29, 2025
2 of 3 checks passed
@leynos leynos deleted the codex/replace-handle_file-with-io-functions branch July 29, 2025 16:57
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