[WIP] Keep text content in XML round-trip - #530
Closed
suleman-uzair wants to merge 7 commits into
Closed
suleman-uzair wants to merge 7 commits into
suleman-uzair wants to merge 7 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements XML entity reference preservation in the Nokogiri adapter to enable round-trip XML processing. The changes introduce special handling for XML entity references (like —, ®, &spacer;) so they maintain their original form during parse-serialize cycles, rather than being converted to their Unicode equivalents.
Key Changes
- Introduced entity node tracking using a special marker (
__entity) to distinguish entity references from regular text nodes - Added entity-specific methods in the Element class and Nokogiri adapter for detection and serialization
- Implemented comprehensive test coverage across all three XML adapters (Nokogiri, Oga, Ox) to verify entity handling behavior
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| spec/lutaml/model/entity_spec.rb | Adds comprehensive test coverage for entity handling across Nokogiri, Oga, and Ox adapters with mixed, ordered, and default content modes |
| lib/lutaml/model/xml/element.rb | Introduces constants and entity? method to identify entity reference nodes in the element tree |
| lib/lutaml/model/xml/nokogiri_adapter.rb | Implements entity node detection, serialization helpers, and special handling in ordered element building |
| lib/lutaml/model/xml/document.rb | Adds entity-aware text content processing in update_xml_with_entity_and_text method |
| lib/lutaml/model/xml/builder/nokogiri.rb | Adds add_entity method to create Nokogiri EntityReference nodes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
suleman-uzair
force-pushed
the
fix/import_later_with_register
branch
from
December 2, 2025 08:13
5539306 to
f901d8d
Compare
suleman-uzair
force-pushed
the
fix/roundtrip_xml_text_missing
branch
from
December 2, 2025 12:01
c11a81d to
2516b5f
Compare
suleman-uzair
force-pushed
the
fix/import_later_with_register
branch
2 times, most recently
from
December 4, 2025 07:16
ac0c619 to
249fd5e
Compare
Contributor
|
Not sure why merging #526 closed this? Reopening. @suleman-uzair is this ready? Thanks. |
Contributor
|
Trying to reopen. |
added 7 commits
December 5, 2025 16:13
suleman-uzair
force-pushed
the
fix/roundtrip_xml_text_missing
branch
from
December 5, 2025 11:18
829deb3 to
8371976
Compare
suleman-uzair
changed the base branch from
fix/import_later_with_register
to
main
December 5, 2025 11:18
Member
Author
@ronaldtse No, I'm currently working on the following PR to fix the failing CI checks: I'll let you know as soon as it's ready. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
suleman-uzair
changed the title
suleman-uzair
changed the title
ronaldtse
added a commit
that referenced
this pull request
Apr 1, 2026
Port PR #530 - Sanitize named HTML entities (like ©, —) to numeric character references before parsing, since XML parsers only support the 5 standard XML entities by default. - Add htmlentities gem dependency - Add sanitize_xml_for_entities to Document base class - Use sanitize in NokogiriAdapter and OgaAdapter parse methods - Add entity handling tests ( entity_spec.rb, nokogiri_adapter_spec.rb) - Update entity_fragmentation_spec expected Unicode chars - Update latin_encoding fixture with ⊚ entity
ronaldtse
force-pushed
the
fix/roundtrip_xml_text_missing
branch
from
April 1, 2026 12:35
05a6674 to
1694368
Compare
ronaldtse
added a commit
that referenced
this pull request
Apr 1, 2026
Port PR #530 - Sanitize named HTML entities (like ©, —) to numeric character references before parsing, since XML parsers only support the 5 standard XML entities by default. - Add htmlentities gem dependency - Add sanitize_xml_for_entities to Document base class - Use sanitize in NokogiriAdapter and OgaAdapter parse methods - Add entity handling tests ( entity_spec.rb, nokogiri_adapter_spec.rb) - Update entity_fragmentation_spec expected Unicode chars - Update latin_encoding fixture with ⊚ entity
Contributor
|
This is ported to #593 |
ronaldtse
force-pushed
the
fix/roundtrip_xml_text_missing
branch
from
April 1, 2026 13:34
2edba74 to
8371976
Compare
ronaldtse
added a commit
that referenced
this pull request
Apr 3, 2026
Port PR #530 - Sanitize named HTML entities (like ©, —) to numeric character references before parsing, since XML parsers only support the 5 standard XML entities by default. - Add htmlentities gem dependency - Add sanitize_xml_for_entities to Document base class - Use sanitize in NokogiriAdapter and OgaAdapter parse methods - Add entity handling tests ( entity_spec.rb, nokogiri_adapter_spec.rb) - Update entity_fragmentation_spec expected Unicode chars - Update latin_encoding fixture with ⊚ entity
Contributor
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the Nokogiri adapter to handle XML entities correctly in ordered and unordered processing.
closes #527