search

satoren / y_ex

Yjs port for Elixir
MIT License
58 stars 2 forks source link

feat: shared types can be compared on Elixir #58

Closed satoren closed 2 months ago

satoren commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve the removal of the unwrap_tuple function from the Yex.Nif.Util module and the simplification of return handling in various modules, including Yex.Array, Yex.Map, Yex.Text, Yex.XmlElement, and Yex.XmlFragment. New functions for XML manipulation were introduced, and resource management was refactored in the Rust components, transitioning from resource wrappers to shared types.

Changes

Files Change Summary
lib/nif.ex, lib/shared_type/array.ex, lib/shared_type/map.ex, lib/shared_type/text.ex, lib/shared_type/xml_element.ex, lib/shared_type/xml_fragment.ex Removed unwrap_tuple function and simplified return handling by eliminating calls to unwrap_tuple and unwrap_ok_tuple. Introduced new functions for XML manipulation.
native/yex/Cargo.toml Added dependencies: flexbuffers and serde.
native/yex/src/array.rs, native/yex/src/map.rs, native/yex/src/text.rs, native/yex/src/xml.rs Refactored resource management by replacing resource wrappers with shared types (NifSharedType).
native/yex/src/lib.rs Introduced a new shared_type module for better organization.
native/yex/src/shared_type.rs Defined NifSharedType<T> for managing shared types in Rustler NIF context.
test/shared_type/array_test.exs, test/shared_type/map_test.exs, test/shared_type/text_test.exs, test/shared_type/xml_element_test.exs, test/shared_type/xml_fragment_test.exs Added new test cases to enhance coverage for array, map, text, and XML functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Yex.Array
    participant Yex.Map
    participant Yex.Text
    participant Yex.XmlElement
    participant Yex.XmlFragment

    Client->>Yex.Array: Call array_delete_range()
    Yex.Array-->>Client: Return result directly

    Client->>Yex.Map: Call set()
    Yex.Map-->>Client: Return result directly

    Client->>Yex.Text: Call delete()
    Yex.Text-->>Client: Return result directly

    Client->>Yex.XmlElement: Call insert_after()
    Yex.XmlElement-->>Client: Return :ok or :error

    Client->>Yex.XmlFragment: Call insert_after()
    Yex.XmlFragment-->>Client: Return :ok or :error

🐰 "In the garden, changes bloom,
With functions new, there's more room.
No more tuples to unwrap,
Just direct calls, a simpler map.
Hopping through code, I cheer with glee,
For cleaner paths, oh joy for me!" 🐇

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 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 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](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.
coveralls commented 2 months ago

Coverage Status

coverage: 85.764% (+0.4%) from 85.357% when pulling 75e8a61d3adbbe047e8d7890345304d3640820bc on compareable into a8ea7cac7a6261b8b6b2e61d9ddd5d6ba54cca86 on main.