src/node/iters.rs: fixed DescendantNodes

[niklak]

• Fixed an issue where DescendantNodes could traverse beyond the initial node when iterating over descendants. This affected NodeRef::descendants and NodeRef::descendants_it.

Summary by CodeRabbit

• Bug Fixes
  • Corrected descendant traversal to ensure iteration does not exceed the intended element scope.
• Tests
  • Introduced tests to verify that descendant traversal remains within its defined boundaries.

[coderabbitai]

Walkthrough

This pull request updates the dom_query crate by refining descendant node traversal and enhancing node attribute retrieval. The changes prevent the DescendantNodes iterator from looping back to the starting node by introducing a new start_id field and logic checks. Additionally, new methods (Node::id_attr and Node::class) are added alongside updates to use bit_set::BitSet for duplicate management in Matches::next. A new test confirms the bounded behavior of descendant traversal, and a minor newline tweak was made in one test file.

Changes

File(s)	Summary
CHANGELOG.md	Updated changelog to include a new "Fixed" section for DescendantNodes, added Node::id_attr and Node::class, and updated Matches::next to use bit_set::BitSet instead of foldhash::HashSet.
src/node/iters.rs	Added a start_id field to the DescendantNodes iterator; updated the new and get_child_or_sibling methods to prevent revisiting the starting node during traversal.
tests/node-traversal.rs, tests/selection-traversal.rs	Added a new test test_descendants_bound to verify that traversal does not exceed the initial node; introduced a non-functional newline addition in the selection tests.

Possibly related PRs

• added NodeRef::descendants #39: Addresses changes in the DescendantNodes iterator and its integration with NodeRef, closely aligning with the modifications in this PR.
• add more tests for NodeRef #42: Focuses on improving traversal methods within the NodeRef structure, directly relating to this PR’s enhancements to node traversal.
• Implemented the NodeRef::id_attr and NodeRef::class methods #67: Implements node attribute retrieval methods similar to the new Node::id_attr and Node::class, showing a strong code-level connection.

Poem

In the field of code I hop and play,
Fixing nodes in my own curious way.
I skip over loops with a start so true,
Adding ID and class to brighten the view.
With BitSets and tests in a tidy bouquet,
I celebrate these changes—hip-hip-hooray!
🐇💻

---

📜 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 c8aa60f and 89d85e7.

📒 Files selected for processing (1)

• tests/node-traversal.rs (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• tests/node-traversal.rs

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.16%. Comparing base (c121c6d) to head (89d85e7).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #68      +/-   ##
==========================================
- Coverage   92.22%   92.16%   -0.07%     
==========================================
  Files          16       16              
  Lines        2741     2745       +4     
==========================================
+ Hits         2528     2530       +2     
- Misses        213      215       +2     

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

tests/node-traversal.rs (1)

133-148: Consider adding more test cases.

The test correctly verifies the basic functionality. Consider adding edge cases such as:

1. A node with no descendants
2. A node with only one descendant
3. A node with multiple levels of descendants but no siblings

Would you like me to help generate these additional test cases?

CHANGELOG.md (1)

14-15: Consider removing word duplication.

The entry correctly describes the fix, but there's a minor duplication of the word "Fixed". Consider this revision:

-### Fixed
-- Fixed an issue where `DescendantNodes` could traverse beyond the initial node when iterating over descendants. This affected `NodeRef::descendants` and `NodeRef::descendants_it`. 
+### Fixed
+- Issue where `DescendantNodes` could traverse beyond the initial node when iterating over descendants. This affected `NodeRef::descendants` and `NodeRef::descendants_it`. 

🧰 Tools

🪛 LanguageTool

[duplication] ~14-~14: Possible typo: you repeated a word.
Context: ...as possible, bit-set was chosen. ### Fixed - Fixed an issue where DescendantNodes could ...

(ENGLISH_WORD_REPEAT_RULE)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c121c6d and 282cd33.

📒 Files selected for processing (4)

• CHANGELOG.md (1 hunks)
• src/node/iters.rs (3 hunks)
• tests/node-traversal.rs (1 hunks)
• tests/selection-traversal.rs (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• tests/selection-traversal.rs

🧰 Additional context used

🪛 LanguageTool

CHANGELOG.md

[duplication] ~14-~14: Possible typo: you repeated a word.
Context: ...as possible, bit-set was chosen. ### Fixed - Fixed an issue where DescendantNodes could ...

(ENGLISH_WORD_REPEAT_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test-wasm

🔇 Additional comments (3)

src/node/iters.rs (3)

148-148: LGTM! Good addition of the start_id field.

The field is necessary to track the initial node and prevent traversal beyond it.

---

168-168: LGTM! Proper initialization of start_id.

The field is correctly initialized with the provided node_id.

---

180-182: LGTM! Proper boundary check to prevent infinite traversal.

The check correctly prevents traversal beyond the initial node by returning None when the parent matches start_id.