magicant / yash-rs

Reimplementation of yash, an extended POSIX shell
65 stars 3 forks source link

Replace OFlag & Mode with nix-independent type #389

Closed magicant closed 3 months ago

magicant commented 3 months ago

This is part of #353.

The fcntl_setfl and fcntl_getfl functions are removed in favor of the new functions get_and_set_nonblocking and ofd_access. We cannot support the fcntl_setfl function because its return value may need to contain platform-specific flags that cannot be represented in a portable type.

The Mode type is replaced with a new homebrew type.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates in the yash project enhance file handling by replacing outdated flag-based approaches with structured, type-safe enumerations for file access permissions. This transition improves code clarity and maintainability while introducing robust error handling. The reorganization of file system operations results in a more efficient and user-friendly shell environment, fostering better interactions with file descriptors.

Changes

Files Change Summary
yash-builtin/src/exec.rs Updated file permission handling using Mode for clarity; replaced bitwise operations with explicit method calls.
yash-builtin/src/source/semantics.rs Switched from OFlag to OfdAccess and OpenFlag in open_file, enhancing type safety and clarity in file access modes.
yash-cli/src/startup/init_file.rs Refactored file opening logic to use OpenFlag and OfdAccess, improving file access clarity and functionality.
yash-cli/src/startup/input.rs Changed input handling to non-blocking mode; updated file opening with new type-safe flags.
yash-env/CHANGELOG.md Documented changes in the system module, introduced new types, methods, and structural changes for improved usability.
yash-env/src/input/fd_reader.rs Refactored open method to accept OfdAccess and OpenFlag, enhancing file opening granularity.
yash-env/src/system.rs Enhanced file system functionality with new methods; updated open to use structured flags for better access management.
yash-env/src/system/file_system.rs Added DEFAULT_DIRECTORY_MODE; refactored permission management to use structured types for clarity.
yash-semantics/src/command/item.rs Updated nullify_stdin to use OfdAccess, improving clarity in file descriptor handling.
yash-semantics/src/redir.rs Refactored file opening methods to utilize new access types (OfdAccess, OpenFlag), enhancing validation and error handling in file operations.
yash-env/src/system/real/open_flag.rs Added methods to OfdAccess and OpenFlag enums for better mapping to real system flags, improving interoperability with underlying file operations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Shell
    participant System

    User->>Shell: Request file operation
    activate Shell
    Shell->>System: Open file with OfdAccess
    activate System
    System-->>Shell: Return file descriptor
    deactivate System
    Shell-->>User: Confirm operation success
    deactivate Shell

🐇 In the meadow where bunnies play,
New changes hop in, brightening the day!
With clearer paths and flags so neat,
File handling's now a joyful feat!
So let us celebrate with a cheerful cheer,
For a better shell is finally here! 🌼✨


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.