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.

Sign up for GitHub

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

Jump to bottom

Move GetoptsState definition to yash-builtin and store it in Env::any #445

Merged
merged 4 commits into from
Jan 16, 2025
Merged

Move GetoptsState definition to yash-builtin and store it in Env::any #445

merged 4 commits into from
Jan 16, 2025

Conversation

magicant
Copy link
Owner

@magicant magicant commented Jan 15, 2025 •
edited by coderabbitai bot
Loading

This pull request includes significant changes to the yash-builtin module, particularly focusing on the handling of arbitrary data within the environment and refactoring the getopts built-in. The most important changes include the introduction of a new DataSet type for storing arbitrary data, the removal of the getopts_state field, and the migration of related logic to use the new DataSet.

Closes #443

Introduction of DataSet for Arbitrary Data Storage:

  • yash-env/src/any.rs: Added a new module any that defines the DataSet struct, which allows for storing and managing arbitrary data within the environment.

Refactoring of getopts Built-in:

Updates to Environment Structure:

Changelog Updates:

  • yash-env/CHANGELOG.md: Documented the addition of the any field to the Env struct and the removal of the getopts_state field. [1] [2]

Test and Documentation Adjustments:

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a flexible data storage mechanism using DataSet for managing arbitrary data types in the shell environment
    • Enhanced argument parsing capabilities for built-in commands

  • Refactoring

    • Overhauled internal state management for the getopts built-in command
    • Replaced specific state tracking with a more generic data storage approach

  • Breaking Changes

    • Removed getopts_state field from the environment structure
    • Modified how command-line option states are tracked and managed
    • Removed the getopts module and its associated functionality

@magicant
Define DataSet in yash-env
876b35a
@magicant
Add any field to Env struct for storing anything
9c3a573
@magicant
Move GetoptsState definition to yash-builtin and store it in Env::any
4b5913e 
This commit moves the GetoptsState and Origin definitions from
yash-env to yash-builtin. The GetoptsState is stored in the Env::any
field, which is a DataSet. This change improves cohesion by keeping
the GetoptsState and Origin definitions inside the getopts module in the
yash-builtin crate.
@magicant magicant added enhancement New feature or request breaking change This enhancement is backward-incompatible labels Jan 15, 2025
@magicant magicant self-assigned this Jan 15, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 15, 2025 •
edited
Loading

Walkthrough

The pull request introduces a comprehensive refactoring of the getopts built-in state management across multiple files in the yash-env and yash-builtin crates. The primary change involves removing the getopts_state field from the Env struct and introducing a new DataSet type called any that allows storing arbitrary, type-erased data. The implementation moves the GetoptsState and Origin definitions from yash-env to yash-builtin, improving code organization and providing a more flexible approach to managing state within the shell environment.

Changes

File Change Summary
yash-builtin/src/getopts.rs Updated state management from getopts_state to any
yash-builtin/src/getopts/report.rs Modified state access to use env.any.get_mut::<GetoptsState>()
yash-builtin/src/getopts/verify.rs Added Origin enum and GetoptsState struct
yash-env/src/any.rs New module with DataSet for storing arbitrary data
yash-env/src/lib.rs Removed getopts_state, added any: DataSet
yash-env/src/builtin.rs Removed pub mod getopts;
yash-env/src/builtin/getopts.rs Deleted file, moved definitions to yash-builtin

Assessment against linked issues

Objective Addressed Explanation
Remove getopts_state from Env ✅
Add flexible data storage mechanism ✅ DataSet provides type-erased, cloneable storage
Improve code cohesion ✅ Moved state-related definitions to yash-builtin

Possibly related PRs

Poem

🐰 In the realm of shell's delight,
Where options dance and state takes flight,
We've boxed the data, set it free,
A flexible any for you and me!
Getopts now leaps with newfound might! 🚀

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b5913e and 941aa8f.

📒 Files selected for processing (1)
  • yash-env/CHANGELOG.md (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: windows
  • GitHub Check: msrv (macos-latest)
  • GitHub Check: extra
  • GitHub Check: msrv (ubuntu-latest)
  • GitHub Check: check
🔇 Additional comments (2)
yash-env/CHANGELOG.md (2)

13-15: LGTM! Clear documentation of the new any field and DataSet type.

The changelog effectively documents the addition of the new any field and DataSet type, which aligns with the PR objectives of introducing a new storage mechanism for arbitrary data.

35-38: LGTM! Comprehensive documentation of removed components.

The changelog correctly documents all the removed components, including:

  • The conversion implementation for errno::Errno
  • The getopts_state field
  • The GetoptsState struct and Origin enum from the builtin::getopts module

This aligns with both the PR objectives and the previous review feedback.

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
🪧 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.
    • 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 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 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 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. (Beta)
  • @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.

@magicant magicant merged commit 2b0fb8b into master Jan 16, 2025
8 checks passed
@magicant magicant deleted the any-data branch January 16, 2025 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@magicant magicant

Labels
breaking change This enhancement is backward-incompatible enhancement New feature or request
Projects
yash-rs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove getopts_state from Env and add AnySet instead
1 participant
@magicant