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.

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

implemented NodeRef::is_match and NodeRef::is #53

Merged
merged 1 commit into from
Dec 28, 2024
Merged

Conversation

niklak
Copy link
Owner

@niklak niklak commented Dec 28, 2024

Summary by CodeRabbit

  • New Features
    • Added is_match and is methods to NodeRef for checking node matching against matchers and selectors
    • Introduced new test coverage for node selection functionality

Copy link

coderabbitai bot commented Dec 28, 2024

Walkthrough

The pull request introduces new methods is_match and is to the NodeRef struct in the dom_query crate, enabling direct node matching against matchers and selectors. These methods provide a more straightforward way to check node characteristics without creating a Selection object. The changes also include performance optimizations for the Selection structure and the introduction of an atomic feature to improve concurrency capabilities.

Changes

File Change Summary
CHANGELOG.md Updated with new methods, feature additions, and deprecation notes
src/node/node_ref.rs Added is_match(&self, matcher: &Matcher) -> bool and is(&self, selector: &str) -> bool methods
tests/node-traversal.rs Added test_node_is() to verify new node matching functionality

Possibly related PRs

Poem

🐰 Hopping through the DOM with glee,
New methods sprung, so wild and free!
is and is_match, a rabbit's delight,
Selecting nodes with pure coding might!
Traversing HTML, no Selection in sight! 🌟


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.

Copy link

codecov bot commented Dec 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.56%. Comparing base (7cdd006) to head (34f101c).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #53      +/-   ##
==========================================
+ Coverage   91.54%   91.56%   +0.02%     
==========================================
  Files          14       14              
  Lines        2484     2490       +6     
==========================================
+ Hits         2274     2280       +6     
  Misses        210      210              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
tests/node-traversal.rs (1)

227-234: Great test coverage
The new test_node_is() function clearly verifies that the NodeRef::is method correctly matches the #parent node against both its ID-based selector (div#parent) and a pseudo-class selector (:has(#first-child)). Including a negative test (e.g., asserting a different selector returns false) would further strengthen coverage.

src/node/node_ref.rs (1)

652-653: Defensive selector handling
By returning false on a failed Matcher::new(sel) (e.g., invalid selector), the user experience is graceful. Consider logging or warning if invalid selectors might cause confusion in debugging.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7cdd006 and 34f101c.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • src/node/node_ref.rs (2 hunks)
  • tests/node-traversal.rs (1 hunks)
🔇 Additional comments (3)
tests/node-traversal.rs (1)

225-226: Looks good!
The test attributes are correctly applied for both #[cfg_attr(not(target_arch = "wasm32"), test)] and #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)], ensuring cross-platform testing.

src/node/node_ref.rs (1)

647-649: Method is_match is well-implemented
This method succinctly delegates to matcher.match_element(self), making the code easy to follow and maintain.

CHANGELOG.md (1)

7-11: Changelog entry is clear
Thank you for documenting the addition of NodeRef::is_match and NodeRef::is. This entry provides a concise summary for users to quickly understand and adopt the new methods.

@niklak niklak merged commit 180d641 into main Dec 28, 2024
10 checks passed
@niklak niklak deleted the feature/node-is branch December 28, 2024 20:07
This was referenced Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant