add parent method to xml type

satoren commented 1 month ago

Summary by CodeRabbit

New Features
- Introduced new functions for retrieving parent elements in XML structures, enhancing navigation capabilities.
- Added parent function to the Yex.Xml protocol for handling XML relationships.
- Enhanced Yex.XmlElement, Yex.XmlText, and Yex.XmlFragment modules with new functions for sibling and parent retrieval.
Tests
- Added test cases to verify the functionality of the new parent retrieval methods for XML elements, text, and fragments.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduced in this pull request enhance the XML handling capabilities within the Yex module. New functions for retrieving parent XML elements, fragments, and text have been added to the Yex.Nif, Yex.Xml, Yex.XmlElement, and Yex.XmlText modules. Corresponding updates to the protocol and type definitions ensure that these new functions integrate seamlessly with existing functionality. Additionally, new test cases have been implemented to verify the correctness of the parent retrieval features.

Changes

File	Change Summary
lib/nif.ex	Added functions: `xml_fragment_parent/2`, `xml_element_parent/2`, `xml_text_parent/2` returning NIF error if not loaded.
lib/shared_type/xml.ex	Added function `parent/1` to `Yex.Xml` protocol, delegating to `Yex.XmlText` and `Yex.XmlElement`.
lib/shared_type/xml_element.ex	Added functions: `next_sibling/1`, `prev_sibling/1`, `parent/1` to `Yex.XmlElement`.
lib/shared_type/xml_text.ex	Added type definition for `t`, and functions: `prev_sibling/1`, `parent/1`, `next_sibling/1`.
lib/shared_type/xml_fragment.ex	Added function `parent/1` to `Yex.XmlFragment`, and new module `Yex.XmlFragmentPrelim` with `new/1`.
native/yex/src/xml.rs	Added functions: `xml_fragment_parent`, `xml_element_parent`, `xml_text_parent` for parent retrieval.
native/yex/src/yinput.rs	Modified `NifYInput::XmlFragmentPrelim` to map to `TypeRef::XmlFragment` in `into_content` method.
test/shared_type/xml_element_test.exs	Added test case for `Yex.Xml.parent/1` in `YexXmlElementTest`.
test/shared_type/xml_text_test.exs	Added test case for `Yex.Xml.parent/1` in `YexXmlTextTest`.
test/shared_type/xml_fragment_test.exs	Added doctest for `Yex.XmlFragmentPrelim` and test case for `XmlFragment.parent/1` in `YexXmlFragmentTest`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Yex.Xml
    participant Yex.XmlElement
    participant Yex.Nif

    User->>Yex.Xml: parent(xml)
    Yex.Xml->>Yex.XmlElement: parent(xml)
    Yex.XmlElement->>Yex.Nif: xml_element_parent(xml, cur_txn)
    Yex.Nif-->>Yex.XmlElement: :erlang.nif_error(:nif_not_loaded)
    Yex.XmlElement-->>Yex.Xml: result
    Yex.Xml-->>User: result

🐰 In the XML grove, where elements play,
A parent is sought, come what may.
With functions anew, we hop and we cheer,
For fragments and text, their paths are now clear!
Let's dance through the nodes, with joy in our hearts,
As XML's magic in code now imparts! 🌼

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 , 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 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

coveralls commented 1 month ago

coverage: 86.102% (+0.3%) from 85.764% when pulling a11920648cc888dddad90998ff4a84877cf7d559 on parent into b6cf79f792169156fccd5102106ca766e3277b76 on main.

satoren / y_ex