Skip to content

Introduce common AstNode trait#77

Merged
leynos merged 2 commits intomainfrom
codex/add-private-trait-astnode-to-parser
Jul 17, 2025
Merged

Introduce common AstNode trait#77
leynos merged 2 commits intomainfrom
codex/add-private-trait-astnode-to-parser

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 16, 2025

Summary

  • define an internal AstNode trait for AST wrappers
  • implement AstNode for all statement types
  • update tests to import the trait

Testing

  • make lint
  • make test

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

Summary by Sourcery

Unify AST wrapper types under a common AstNode trait and update codebase and tests to use this trait for accessing syntax nodes.

New Features:

  • Introduce an internal AstNode trait for AST wrapper types.

Enhancements:

  • Implement the AstNode trait for all statement wrapper types to provide a unified interface.

Tests:

  • Update tests to import and use the new AstNode trait.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 16, 2025

Reviewer's Guide

This pull request introduces a new internal AstNode trait for AST wrapper types, implements this trait for all major statement types, and updates tests to import the trait, thereby unifying access to the underlying syntax node across the AST.

Class diagram for introduction of AstNode trait and its implementations

classDiagram
    class AstNode {
        +syntax() SyntaxNode<DdlogLanguage>
    }
    class Import {
        +syntax: SyntaxNode<DdlogLanguage>
        +syntax() SyntaxNode<DdlogLanguage>
    }
    class TypeDef {
        +syntax: SyntaxNode<DdlogLanguage>
        +syntax() SyntaxNode<DdlogLanguage>
    }
    class Relation {
        +syntax: SyntaxNode<DdlogLanguage>
        +syntax() SyntaxNode<DdlogLanguage>
    }
    class Index {
        +syntax: SyntaxNode<DdlogLanguage>
        +syntax() SyntaxNode<DdlogLanguage>
    }
    class Rule {
        +syntax: SyntaxNode<DdlogLanguage>
        +syntax() SyntaxNode<DdlogLanguage>
    }
    class Function {
        +syntax: SyntaxNode<DdlogLanguage>
        +syntax() SyntaxNode<DdlogLanguage>
    }
    class Transformer {
        +syntax: SyntaxNode<DdlogLanguage>
        +syntax() SyntaxNode<DdlogLanguage>
    }
    Import ..|> AstNode
    TypeDef ..|> AstNode
    Relation ..|> AstNode
    Index ..|> AstNode
    Rule ..|> AstNode
    Function ..|> AstNode
    Transformer ..|> AstNode
Loading

File-Level Changes

Change Details Files
Introduce internal AstNode trait for AST wrappers.
  • Define AstNode trait with a syntax() method for accessing the underlying syntax node.
  • Mark the trait as internal and hidden from documentation.
src/parser/mod.rs
Implement AstNode trait for all major statement types.
  • Remove individual syntax() methods from Import, TypeDef, Relation, Index, Rule, Function, and Transformer.
  • Implement AstNode for each of these types, providing a unified syntax() method.
src/parser/mod.rs
Update tests to import the new AstNode trait.
  • Add use statement for AstNode trait in test modules to enable trait method usage.
src/parser/ast/parse_utils.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

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 6 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 608bb07 and 2ab9a28.

📒 Files selected for processing (2)
  • .markdownlint-cli2.jsonc (1 hunks)
  • src/parser/mod.rs (8 hunks)

Summary by CodeRabbit

  • Refactor
    • Unified access to syntax nodes across AST wrapper types through a new internal trait, streamlining the interface for underlying syntax retrieval.
  • Chores
    • Updated test imports to support the new trait-based interface.

Walkthrough

Refactor the AST node wrappers by introducing a new internal AstNode trait with a syntax() accessor. Remove the individual syntax() methods from the AST structs and implement the AstNode trait for each. Update test modules to import and use the new trait where needed.

Changes

File(s) Change Summary
src/parser/mod.rs Add internal AstNode trait with syntax() method; remove individual syntax() methods from AST structs; implement AstNode for each relevant struct.
src/parser/ast/parse_utils.rs Add use crate::parser::ast::AstNode; import inside tests module.
tests/parser.rs Add use of AstNode trait from ddlint::ast for test code.

Poem

In the land where syntax nodes roam,
A trait unites them, calls them home.
No more lone methods, all now aligned,
With AstNode’s touch, their paths entwined.
Imports refreshed, the tests are bright—
Refactor complete, all code in flight!
🌳✨

✨ 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-private-trait-astnode-to-parser

🪧 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

@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: 2

♻️ Duplicate comments (6)
src/parser/mod.rs (6)

685-689: Duplicate of the macro refactor request above.


941-945: Duplicate of the macro refactor request above.


1068-1072: Duplicate of the macro refactor request above.


1166-1170: Duplicate of the macro refactor request above.


1278-1282: Duplicate of the macro refactor request above.


1342-1346: Duplicate of the macro refactor request above.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c960a35 and 608bb07.

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🔇 Additional comments (2)
src/parser/ast/parse_utils.rs (1)

664-665: Import trait conditionally

AstNode is only needed inside tests. Wrap the import with #[cfg(test)] to avoid an unused-import lint in release builds:

-    use crate::parser::ast::AstNode;
+    #[cfg(test)]
+    use crate::parser::ast::AstNode;
tests/parser.rs (1)

7-10: Keep import list alphabetically sorted

Add AstNode in lexical order to maintain readability:

-    ast::{AstNode, Import, TypeDef},
+    ast::{AstNode, Import, TypeDef},

(If an import-ordering lint is active this prevents churn.)

Likely an incorrect or invalid review comment.

Comment thread src/parser/mod.rs Outdated
Comment thread src/parser/mod.rs Outdated
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/parser/mod.rs:394` </location>
<code_context>
+    /// Internal trait implemented by all AST wrappers.
+    #[doc(hidden)]
+    pub trait AstNode {
+        /// Access the underlying syntax node.
+        fn syntax(&self) -> &SyntaxNode<DdlogLanguage>;
+    }
</code_context>

<issue_to_address>
Removing #[must_use] may reduce helpful compiler warnings.

Consider retaining #[must_use] on the trait method or trait definition to help prevent accidental discarding of return values.
</issue_to_address>

### Comment 2
<location> `src/parser/mod.rs:635` </location>
<code_context>
         }
     }

+    impl AstNode for Import {
+        fn syntax(&self) -> &SyntaxNode<DdlogLanguage> {
+            &self.syntax
</code_context>

<issue_to_address>
Consider using a macro to implement the AstNode trait for all AST wrappers to eliminate repetitive code.

You can reduce boilerplate and complexity by using a macro to implement the `AstNode` trait for each AST wrapper, instead of repeating identical impl blocks. This keeps the trait-based abstraction (in case you need it for generic code), but avoids repetitive code.

Example:

```rust
macro_rules! impl_ast_node {
    ($($ty:ty),*) => {
        $(
            impl AstNode for $ty {
                fn syntax(&self) -> &SyntaxNode<DdlogLanguage> {
                    &self.syntax
                }
            }
        )*
    };
}

impl_ast_node!(Import, TypeDef, Relation, Index, Rule, Function, Transformer);
```

Actionable steps:
1. Add the macro above near your trait definition.
2. Remove the individual `impl AstNode for ...` blocks.
3. Add a single call to `impl_ast_node!` with all relevant types.

This will keep your code DRY and easier to maintain, while preserving all current functionality.
</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/mod.rs
Comment thread src/parser/mod.rs Outdated
@leynos leynos merged commit 80b863a into main Jul 17, 2025
2 checks passed
@leynos leynos deleted the codex/add-private-trait-astnode-to-parser branch July 17, 2025 23:36
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