Skip to content

Replace unreachable unwrap with expect#71

Merged
leynos merged 3 commits intomainfrom
codex/replace-unreachable-with-expect-in-kind_to_raw
Jul 16, 2025
Merged

Replace unreachable unwrap with expect#71
leynos merged 3 commits intomainfrom
codex/replace-unreachable-with-expect-in-kind_to_raw

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 15, 2025

Summary

  • replace unwrap_or_else call with expect in kind_to_raw
  • note why the expect is acceptable using a Clippy #[expect] attribute

Testing

  • make lint
  • make test

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

Summary by Sourcery

Simplify error handling in the kind_to_raw implementation by switching to expect for unreachable branches and suppress the Clippy expect_used lint with an explicit attribute

Enhancements:

  • Replace unwrap_or_else with expect in kind_to_raw to simplify unreachable error handling
  • Add a Clippy #[expect(clippy::expect_used, reason = "all SyntaxKind variants map to u16")] attribute to justify the use of expect

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 15, 2025

Reviewer's Guide

Refactor kind_to_raw to use expect for unreachable cases and annotate it with a Clippy attribute to suppress the expect_used lint.

Class diagram for updated DdlogLanguage implementation

classDiagram
    class DdlogLanguage {
        +SyntaxKind raw_kind_to_kind(RowanSyntaxKind raw)
        +RowanSyntaxKind kind_to_raw(SyntaxKind kind)
    }

    class SyntaxKind {
        +u16 to_u16()
        +from_u16(u16)
        N_ERROR
    }

    class RowanSyntaxKind {
        +u16 0
    }

    DdlogLanguage --> SyntaxKind : uses
    DdlogLanguage --> RowanSyntaxKind : returns
    SyntaxKind <.. RowanSyntaxKind : conversion
Loading

File-Level Changes

Change Details Files
Simplify kind_to_raw by replacing unwrap_or_else with expect
  • Removed multi-line to_u16().unwrap_or_else(
Suppress Clippy lint for expect usage
  • Added #[expect(clippy::expect_used, reason = "all SyntaxKind variants map to u16")] above kind_to_raw
src/language.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 15, 2025

Summary by CodeRabbit

  • Refactor
    • Simplified internal logic for converting syntax kinds, improving code clarity and maintainability. No changes to user-facing features or behaviour.

Summary by CodeRabbit

  • Refactor
    • Simplified the kind_to_raw function in DdlogLanguage by removing ToPrimitive dependency and replacing unwrap_or_else with a direct cast from SyntaxKind to u16. Relied on #[repr(u16)] for safe casting. No changes to kind_from_raw.

Walkthrough

Simplify the kind_to_raw method in the DdlogLanguage implementation by removing the ToPrimitive trait usage and replacing the conversion with a direct cast from SyntaxKind to u16. Remove error handling code that was previously guarding against invalid casts.

Changes

File(s) Change Summary
src/language.rs Remove ToPrimitive import, simplify kind_to_raw by replacing to_u16().unwrap_or_else with a direct as u16 cast, remove unreachable panic.

Possibly related PRs

  • Add SyntaxKind and language wrapper #6: Simplifies kind_to_raw conversion in DdlogLanguage by removing ToPrimitive usage, closely related to SyntaxKind enum handling and DdlogLanguage wrapper.

Poem

🎭 In casts so bold, the code now flies,
No unwraps lurking with surprise.
From traits once called, we now depart,
A cleaner, safer kind to chart.
SyntaxKind stands proud and true,
A simpler path for me and you! 🚀✨


📜 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 191baeb and 3777c2d.

📒 Files selected for processing (1)
  • src/language.rs (2 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/language.rs (2)

10-10: Import removal aligns with implementation change.

The removal of ToPrimitive from the import statement is correct since the function no longer uses the to_u16() method.


185-188: Direct cast implementation is optimal and safe.

The direct cast approach eliminates unnecessary runtime overhead compared to the previous fallible conversion through ToPrimitive::to_u16(). The #[repr(u16)] attribute on SyntaxKind guarantees that all variants are valid u16 values, making the cast safe and the comment accurate.

This implementation follows the coding guidelines better than using expect() by avoiding the need for error handling entirely.

✨ 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-unreachable-with-expect-in-kind_to_raw

🪧 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/language.rs:187` </location>
<code_context>
-            kind.to_u16()
-                .unwrap_or_else(|| unreachable!("all SyntaxKind variants map to u16")),
-        )
+        RowanSyntaxKind(kind.to_u16().expect("all SyntaxKind variants map to u16"))
     }
 }
</code_context>

<issue_to_address>
Direct use of expect improves clarity, but may obscure the source of panics.

Consider adding the specific SyntaxKind value to the expect message to aid debugging if a panic occurs.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        RowanSyntaxKind(kind.to_u16().expect("all SyntaxKind variants map to u16"))
=======
        RowanSyntaxKind(
            kind.to_u16().expect(&format!(
                "all SyntaxKind variants map to u16; failed for SyntaxKind::{:?}",
                kind
            ))
        )
>>>>>>> REPLACE

</suggested_fix>

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/language.rs Outdated
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0e8a127 and 191baeb.

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

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

Comment thread src/language.rs Outdated
@leynos leynos merged commit 6f6a60d into main Jul 16, 2025
2 checks passed
@leynos leynos deleted the codex/replace-unreachable-with-expect-in-kind_to_raw branch July 16, 2025 19:03
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