Fix fence specifier indentation

[leynos]

Summary

• fix indentation handling in attach_orphan_specifiers
• add regression test for indent preservation

Testing

• make fmt
• make lint
• make test

---

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

Summary by Sourcery

Fix indentation handling when attaching orphan specifiers in fenced code blocks and add a regression test to ensure indent preservation

Bug Fixes:

• Use trim_end instead of trim to preserve leading indentation when attaching specifiers

Tests:

• Add a regression test to verify that orphan specifiers retain indentation when attached

[sourcery-ai]

Reviewer's Guide

Updates attach_orphan_specifiers to preserve leading indentation by switching from trim() to trim_end(), and adds a regression test to ensure indent is maintained on fence specifiers.

Class diagram for attach_orphan_specifiers indentation fix

classDiagram
    class fences {
        +attach_orphan_specifiers(lines: &[String]) -> Vec<String>
    }
    fences : attach_orphan_specifiers
    %% Note: The method now uses trim_end() instead of trim() to preserve leading indentation.

Loading

File-Level Changes

Change	Details	Files
Preserve leading indentation when attaching orphan specifiers	Replace trim() with trim_end() to avoid stripping leading spaces Retain original indent when matching fence specifiers	src/fences.rs
Add regression test for indent preservation in fences	Introduce attaches_orphan_specifier_preserves_indent test Assert that output fences preserve initial spaces	tests/fences.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

• 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

• Bug Fixes

  • Improved detection of code fences with indentation, ensuring that leading whitespace is preserved and correctly handled.

• Tests

  • Added tests to verify that code fences with spaces, tabs, or mixed indentation retain their original formatting when attaching language specifiers.

Walkthrough

Update the attach_orphan_specifiers function in src/fences.rs by removing the trimming of each input line before regex matching, preserving leading indentation. Add three new tests in tests/fences.rs to ensure indentation is preserved when attaching orphan specifiers with spaces, tabs, and mixed indentation.

Changes

File(s)	Change Summary
src/fences.rs	Remove trim() on lines before regex matching in attach_orphan_specifiers to preserve leading whitespace.
tests/fences.rs	Add three tests (attaches_orphan_specifier_preserves_indent, _preserves_tab_indent, _mixed_indent) verifying indentation preservation for orphan specifier attachment.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Runner
    participant Fences as attach_orphan_specifiers
    Test->>Fences: Provide indented lines with orphan specifier
    Fences->>Fences: Match lines with regex without trimming leading whitespace
    Fences->>Test: Return lines with preserved indentation and attached specifier

Loading

Estimated code review effort

2 (~20 minutes)

Possibly related issues

• Refactor attach_orphan_specifiers to use state machine with Peekable iterator #103: Both focus on attach_orphan_specifiers; this PR changes trimming behaviour, the issue proposes refactoring iteration.
• Refactor attach_orphan_specifiers to use state machine with Peekable iterator #102: Related by targeting attach_orphan_specifiers function; this PR changes matching logic, the issue restructures control flow.
• Refactor attach_orphan_specifiers function to reduce complexity #109: Both address attach_orphan_specifiers function; this PR alters matching, the issue targets complexity reduction.

Possibly related PRs

• Implement builder defaults and expand fence tests #110: Both modify attach_orphan_specifiers; this PR changes trimming, the other refactors control flow.
• Fix orphaned fence specifiers #116: Both affect attach_orphan_specifiers but focus on different logic aspects.
• Add fences option #100: This PR builds on the initial implementation of attach_orphan_specifiers introduced in that PR.

Poem

Preserve the space, don’t trim the start,
Let code blocks keep their indented art.
Specifiers join, with whitespace intact—
Fences align, the formatting exact.
A tidy change, a test to defend,
Indentation and order, right to the end!
🐇✨

---

📜 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 101a440 and 68c10f8.

📒 Files selected for processing (2)

• src/fences.rs (1 hunks)
• tests/fences.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.rs: Comments must use en-GB-oxendict spelling and grammar.
Function documentation must include clear examples.
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.
Place function attributes after doc comments.
Do not use return in single-line functions.
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.
Clippy warnings MUST be disallowed.
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.
Use predicate functions for conditional criteria with more than two branches.
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.
Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Use functions and composition. Avoid repetition by extracting reusable logic. Prefer generators or comprehensions, and declarative code to imperative repetition when readable.
Small, meaningful functions. Functions must be small, clear in purpose, single responsibility, and obey command/query segregation.
Name things precisely. Use clear, descriptive variable and function names. For booleans, prefer names with is, has, or should.
Structure log...

Files:

• src/fences.rs
• tests/fences.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/fences.rs
• tests/fences.rs

🧬 Code Graph Analysis (1)

tests/fences.rs (1)

src/fences.rs (2)

• attach_orphan_specifiers (69-109)
• compress_fences (30-47)

⏰ Context from checks skipped due to timeout of 240000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build-test

🔇 Additional comments (4)

src/fences.rs (1)

73-73: Approve the indentation preservation fix.

The removal of .trim() correctly preserves leading indentation when matching fence lines. The FENCE_RE regex already captures indentation in group 1 ((\s*)), so this change allows proper detection of indented fences whilst maintaining their original formatting.

tests/fences.rs (3)

163-168: Excellent test coverage for space indentation preservation.

This test properly validates that two-space indentation is preserved when attaching orphan specifiers. The test structure is clear and follows established patterns in the file.

---

170-175: Good coverage for tab indentation scenarios.

This test ensures tab-based indentation is handled correctly, complementing the space indentation test. The use of \t escape sequences in the test data is appropriate and clear.

---

177-182: Thorough edge case testing with mixed indentation.

This test covers the important edge case of mixed space-tab indentation, ensuring the fix works correctly across different indentation styles that developers might encounter in practice.

✨ 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/add-test-for-fence-indentation-retention

---

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

[sourcery-ai]

Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.

• Consider capturing and reusing the leading whitespace prefix directly in the regex or parsing logic instead of relying on trim_end and re-adding indentation, to make indent handling more explicit and maintainable.
• It would be good to add regression tests for tab-based or mixed-whitespace indentation to verify that indent preservation works in all common scenarios.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Consider capturing and reusing the leading whitespace prefix directly in the regex or parsing logic instead of relying on trim_end and re-adding indentation, to make indent handling more explicit and maintainable.
- It would be good to add regression tests for tab-based or mixed-whitespace indentation to verify that indent preservation works in all common scenarios.

---

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