refact: use cfg_if to control feature related code

[Kilerd]

Summary by CodeRabbit

• New Features

  • Introduced a new dependency for improved conditional compilation capabilities, enhancing future development flexibility.

• Improvements

  • Streamlined the logic for handling plugin execution, improving code readability and maintainability without altering existing functionality.
  • Refined the timezone detection logic to enhance clarity while maintaining the same operational behavior.

[coderabbitai]

Walkthrough

The recent changes to the zhang-core project streamline code handling and enhance conditional compilation capabilities. Notably, a new dependency (cfg-if) was added to facilitate clearer management of feature flags, particularly in the handle_plugin_execution and detect_timezone functions. These updates improve code readability and maintainability without altering existing functionalities, ultimately leading to a more organized codebase.

Changes

File	Change Summary
zhang-core/Cargo.toml	Added cfg-if = "1.0.0" to manage conditional compilation more flexibly.
zhang-core/src/ledger.rs, zhang-core/src/options.rs	Streamlined conditional logic using cfg_if! macro, enhancing readability and maintainability in handling feature flags.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Ledger
    participant Plugin
    participant Timezone

    User->>Ledger: Request plugin execution
    Ledger->>Ledger: Check plugins feature
    alt Plugins enabled
        Ledger->>Ledger: Check plugin_runtime feature
        alt Plugin runtime enabled
            Ledger->>Plugin: Execute registered plugins
            Plugin->>Ledger: Return processed directives
        else Plugin runtime not enabled
            Ledger->>User: Return unprocessed directives
        end
    else Plugins not enabled
        Ledger->>User: Return unprocessed directives
    end

Loading

sequenceDiagram
    participant User
    participant Timezone

    User->>Timezone: Request timezone detection
    alt iana-time-zone feature enabled
        Timezone->>Timezone: Retrieve system timezone
        Timezone->>User: Return timezone or warning
    else iana-time-zone feature not enabled
        Timezone->>User: Return default timezone
    end

Loading

Poem

🐇 In the code where features dance,
A little rabbit took a chance.
With cfg-if now in tow,
The logic flows, oh what a show!
A hop, a skip, clarity shines bright,
In zhang-core, all feels just right! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[Kilerd]

@coderabbitai review

[coderabbitai]

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4644c52 and 2ccdff3.

Files ignored due to path filters (1)

• Cargo.lock is excluded by !**/*.lock

Files selected for processing (3)

• zhang-core/Cargo.toml (1 hunks)
• zhang-core/src/ledger.rs (3 hunks)
• zhang-core/src/options.rs (2 hunks)

Additional comments not posted (5)

zhang-core/Cargo.toml (1)

43-43: Dependency Addition: cfg-if

The addition of the cfg-if dependency is appropriate for managing conditional compilation more effectively. Ensure that this dependency is necessary and utilized in the codebase.

zhang-core/src/options.rs (2)

5-5: Dependency Import: cfg_if

The import of cfg_if is necessary for the refactoring performed in this file.

---

43-60: Refactor: Use cfg_if for Conditional Compilation

The use of cfg_if macro improves the readability and maintainability of the detect_timezone function by consolidating conditional compilation logic into a single structure. This change does not alter the functionality but enhances code clarity.

zhang-core/src/ledger.rs (2)

8-8: Dependency Import: cfg_if

The import of cfg_if is necessary for the refactoring performed in this file.

---

Line range hint 328-353:
Refactor: Use cfg_if for Conditional Compilation

The use of cfg_if macro improves the readability and maintainability of the handle_plugin_execution method by consolidating conditional compilation logic into a single structure. This change does not alter the functionality but enhances code clarity.