Skip to content

Refactor lexer helpers#73

Merged
leynos merged 1 commit intomainfrom
codex/extract-parser-lexer_helpers-module
Jul 16, 2025
Merged

Refactor lexer helpers#73
leynos merged 1 commit intomainfrom
codex/extract-parser-lexer_helpers-module

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 16, 2025

Summary

  • extract lexer helper utilities into their own module
  • update parser and AST utilities to use the new module
  • add focused unit tests for the helpers

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Extract and centralize lexer helper utilities into a new parser/lexer_helpers module, update the parser module to use these shared helpers, and add focused unit tests for all helper functions.

Enhancements:

  • Move token_display, token_dispatch macro, and token parsers (inline_ws, ident, atom, balanced_block, balanced_block_nonempty) into a dedicated parser/lexer_helpers module
  • Update src/parser/mod.rs to import and use the new lexer_helpers module, removing duplicated helper definitions

Tests:

  • Add unit tests for token_display mappings, token_dispatch macro behavior, and parser combinators inline_ws, ident, atom, balanced_block, and balanced_block_nonempty

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 16, 2025

Reviewer's Guide

This PR refactors various inline lexer helper functions and the token dispatch macro into a dedicated lexer_helpers module, updates parser imports to use the centralized helpers, and adds targeted unit tests to ensure correct behavior.

File-Level Changes

Change Details Files
Extract lexer helper utilities into a new module
  • Moved token_display, token_dispatch!, inline_ws, ident, atom, balanced_block (and variations) definitions into src/parser/lexer_helpers.rs
  • Adjusted function visibility to pub(super) and applied #[macro_use] for the dispatch macro
  • Removed the original helper definitions from src/parser/mod.rs
src/parser/mod.rs
src/parser/lexer_helpers.rs
Update parser code to import and use centralized helpers
  • Added use lexer_helpers::{atom, balanced_block, balanced_block_nonempty, ident, inline_ws} to parser/mod.rs
  • Replaced local helper calls with the imported versions
src/parser/mod.rs
Add focused unit tests for the new helpers
  • Created tests for token_display covering various punctuation and non-punctuation tokens
  • Validated token_dispatch! invokes correct handlers
  • Ensured inline_ws, ident, atom, balanced_block, and balanced_block_nonempty behave as expected
src/parser/lexer_helpers.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 16, 2025

Summary by CodeRabbit

  • New Features

    • Introduced a set of token parsing utilities, including helpers for whitespace, identifiers, atoms, and balanced blocks, improving parsing capabilities and diagnostics.
  • Refactor

    • Moved parser helper functions and macros into a dedicated module for better organisation and maintainability. No changes to user-facing behaviour.

Walkthrough

Refactor the parser helpers by moving token parsing utilities, macros, and balanced block parsers from mod.rs into a new lexer_helpers module. Update import paths and references throughout the parser codebase to use the new module, ensuring all functionality remains unchanged but is now modularised.

Changes

File(s) Change Summary
src/parser/lexer_helpers.rs Add new module containing token display, dispatch macro, whitespace, identifier, atom, and balanced block parsing helpers.
src/parser/mod.rs Remove helper functions and macro; import them from lexer_helpers instead.
src/parser/ast/parse_utils.rs Update import path for balanced_block to source from lexer_helpers.

Sequence Diagram(s)

sequenceDiagram
    participant Parser
    participant LexerHelpers

    Parser->>LexerHelpers: Call atom(), ident(), inline_ws(), balanced_block()
    LexerHelpers-->>Parser: Return parsed tokens or errors
Loading

Possibly related PRs

  • Implement function parser #40: Introduces the original balanced_block parsers and uses them for function parsing; this PR reorganises and relocates those same parsing functions.

Poem

In the parser’s realm, helpers once sprawled,
Now in lexer_helpers, they’re neatly installed.
Macros and functions, all in their place,
Bringing the codebase a tidier face.
Balanced blocks, whitespace, and tokens galore—
Refactored and ready to parse evermore!


📜 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 6f6a60d and d89de61.

📒 Files selected for processing (3)
  • src/parser/ast/parse_utils.rs (1 hunks)
  • src/parser/lexer_helpers.rs (1 hunks)
  • src/parser/mod.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🧬 Code Graph Analysis (2)
src/parser/ast/parse_utils.rs (1)
src/parser/lexer_helpers.rs (1)
  • balanced_block (187-192)
src/parser/mod.rs (1)
src/parser/lexer_helpers.rs (5)
  • atom (125-142)
  • balanced_block (187-192)
  • balanced_block_nonempty (195-200)
  • ident (111-115)
  • inline_ws (98-101)
🔇 Additional comments (8)
src/parser/ast/parse_utils.rs (1)

11-11: Import path correctly updated for new module structure.

The import path has been properly updated to reflect the relocation of balanced_block to the new lexer_helpers module, maintaining functionality whilst improving modularity.

src/parser/mod.rs (1)

15-17: Excellent modularisation of lexer helper functions.

The extraction of lexer helper functions into a dedicated module improves code organisation and follows the coding guidelines for grouping related functionality together. The #[macro_use] directive and selective imports maintain clean module boundaries.

src/parser/lexer_helpers.rs (6)

1-10: Excellent module documentation and structure.

The module-level documentation clearly explains the purpose and utility of the lexer helpers, adhering to the coding guidelines requirement for //! doc comments. The imports are minimal and focused.


12-41: Well-documented token display function with clear examples.

The token_display function provides proper documentation with examples and handles the mapping of punctuation tokens to their printable representations. The function signature and implementation are straightforward and correct.


43-84: Robust token dispatch macro with comprehensive documentation.

The token_dispatch! macro is well-documented with clear examples and follows good macro design patterns. The implementation correctly handles token stream iteration and handler dispatch with appropriate fallback behaviour.


86-142: Clean parser combinators with proper documentation.

The inline_ws, ident, and atom parser functions are well-designed combinators that follow chumsky patterns correctly. Each function includes appropriate documentation and examples, and the implementations are concise and focused.


144-200: Sophisticated balanced block parser with proper error handling.

The balanced block parser implementation correctly handles nested delimiters and provides appropriate error messages. The use of Cell for mutable state within the parser is a good solution for this use case, and the functions provide clear variants for different minimum requirements.


202-300: Comprehensive unit test coverage.

The test suite covers all major functionality including token display, dispatch behaviour, whitespace handling, identifier parsing, atom parsing, and balanced block parsing with various edge cases. The tests use rstest parameterisation effectively and follow good testing practices.

✨ 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/extract-parser-lexer_helpers-module

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

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

### Comment 1
<location> `src/parser/lexer_helpers.rs:72` </location>
<code_context>
+///     SyntaxKind::K_EXTERN => handle_kw,
+/// });
+/// ```
+macro_rules! token_dispatch {
+    ( $ctx:ident, {
+        $( $kind:path => $handler:ident ),* $(,)?
</code_context>

<issue_to_address>
Consider replacing the macro-based token dispatch and manual stateful block parsing with simpler, more idiomatic methods and recursive combinators.

```markdown
Two spots stand out as adding disproportionate complexity: 

1) the `token_dispatch!` macro  
2) the `balanced_block_with_min` + `Cell` state machine  

Both can be simplified without losing any functionality.

---

### 1) Remove `token_dispatch!`, add a `dispatch` method on `TokenStream`

Instead of a macro, put the loop into a small method:

```rust
// in parser/token_stream.rs
impl<'a> TokenStream<'a> {
    /// Drive a user‐supplied closure over every peeked token;
    /// the closure must advance the stream itself.
    pub fn dispatch<F>(&mut self, mut f: F)
    where
        F: FnMut(&mut Self, SyntaxKind, Span),
    {
        while let Some(&(kind, ref span_ref)) = self.peek() {
            let span = span_ref.clone();
            f(self, kind, span);
        }
    }
}
```

Call‐site change:

```rust
// before:
// token_dispatch!(st, {
//     SyntaxKind::T_LPAREN => lp,
//     SyntaxKind::T_RPAREN => rp,
// });

// after:
st.stream.dispatch(|stream, kind, span| {
    match kind {
        SyntaxKind::T_LPAREN => lp(&mut st, span),
        SyntaxKind::T_RPAREN => rp(&mut st, span),
        _                  => stream.advance(),
    }
});
```

---

### 2) Replace `balanced_block_with_min` + `Cell` with a recursive combinator

Drop the manual `Cell`-based depth counter and use `chumsky::recursive`:

```rust
use chumsky::recursive;

// flat, no Cell needed:
pub(super) fn balanced_block(
    open: SyntaxKind,
    close: SyntaxKind,
) -> impl Parser<SyntaxKind, (), Error = Simple<SyntaxKind>> + Clone {
    recursive(|block| {
        just(open)
            .padded_by(inline_ws().repeated())
            .ignore_then(
                // either a nested block or any other token
                block
                    .or(filter(|k: &SyntaxKind| *k != open && *k != close).ignored())
                    .padded_by(inline_ws().repeated())
                    .repeated(),
            )
            .then_ignore(just(close))
            .ignored()
    })
}

// If you need “nonempty”, just wrap the inner `.repeated()` in `.at_least(1)`:
pub(super) fn balanced_block_nonempty(
    open: SyntaxKind,
    close: SyntaxKind,
) -> impl Parser<SyntaxKind, (), Error = Simple<SyntaxKind>> + Clone {
    recursive(|block| {
        just(open)
            .padded_by(inline_ws().repeated())
            .ignore_then(
                block
                    .or(filter(|k: &SyntaxKind| *k != open && *k != close).ignored())
                    .padded_by(inline_ws().repeated())
                    .repeated()
                    .at_least(1),
            )
            .then_ignore(just(close))
            .ignored()
    })
}
```

This eliminates the `filter_map` with internal mutable `Cell` and yields a much flatter, easier‐to‐read parser.
</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/parser/lexer_helpers.rs
@leynos leynos merged commit f6878e0 into main Jul 16, 2025
2 checks passed
@leynos leynos deleted the codex/extract-parser-lexer_helpers-module branch July 16, 2025 21:11
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