Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As suggested by sourcery.ai #30

Merged
merged 1 commit into from
Nov 24, 2024
Merged

Conversation

ziriuz84
Copy link
Owner

@ziriuz84 ziriuz84 commented Nov 24, 2024

Summary by Sourcery

Improve error handling and refactor settings update functions for better code clarity and reliability.

Enhancements:

  • Refactor the set_lang function to return a Result type for better error handling.
  • Refactor the set_settings function to update fields directly and write to the config file using serde.

Copy link
Contributor

sourcery-ai bot commented Nov 24, 2024

Reviewer's Guide by Sourcery

This PR improves error handling in the settings management code by replacing unwrap() calls with proper error propagation using the Result type. The changes also simplify the settings update logic by using direct serialization instead of manual field-by-field updates.

Sequence diagram for set_lang method

sequenceDiagram
    participant User
    participant Settings
    participant FileSystem
    User->>Settings: set_lang(lang)
    Settings->>FileSystem: modify_field_in_file("lang", lang)
    FileSystem-->>Settings: Result
    Settings-->>User: Result
Loading

Sequence diagram for set_settings method

sequenceDiagram
    participant User
    participant Settings
    participant FileSystem
    User->>Settings: set_settings(settings)
    Settings->>FileSystem: Write config.toml
    FileSystem-->>Settings: Result
    Settings-->>User: Result
Loading

Updated class diagram for Settings

classDiagram
    class Settings {
        +set_lang(lang: String) Result<(), Box<dyn std::error::Error>>
        +set_settings(settings: Settings) Result<(), Box<dyn std::error::Error>>
    }
    note for Settings "Improved error handling and simplified settings update logic"
Loading

File-Level Changes

Change Details Files
Improved error handling in language setting functionality
  • Changed set_lang method to return Result instead of unwrapping
  • Updated language_menu to handle potential errors from set_lang
src/settings.rs
src/settings_tui.rs
Simplified settings update mechanism
  • Replaced manual field-by-field update logic with direct struct assignment
  • Implemented direct TOML serialization for config file updates
  • Added proper error handling for config file operations
src/settings.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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@ziriuz84 ziriuz84 merged commit 10c2d4b into main Nov 24, 2024
2 checks passed
@ziriuz84 ziriuz84 deleted the 26-adds-sunrises-sunsets-and-twilights branch November 24, 2024 09:18
Copy link
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 @ziriuz84 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant