Skip to content

Merge consequent text and CDATA events into one string #520

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Feb 20, 2023
Merged

Merge consequent text and CDATA events into one string #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d0fa030
Create an intermediate event and a reader that will convert intermedi…
Mingun Dec 17, 2022
2b88487
Always unescape text content
Mingun Jan 4, 2023
da0f6fe
Decode texts on time of converting events from PayloadEvent to DeEvent
Mingun Dec 10, 2022
fc6c674
Reformat `read_string_impl` to increase readability
Mingun Jan 22, 2023
6628898
Trim text events during conversion from Event to PayloadEvent
Mingun Dec 11, 2022
488b70e
Trim text events from end during conversion from PayloadEvent to DeEvent
Mingun Dec 17, 2022
4a96285
Add tests for text merging
Mingun Dec 10, 2022
c4a1eb4
Do not trim spaces in events using Reader capabilities
Mingun Jan 4, 2023
6a11473
Merge consequent text events
Mingun Dec 6, 2022
ac1ad0c
Add warning to the `trim_text` and `trim_text_end` methods
Mingun Jan 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
enums from textual content
- [#556]: `to_writer` and `to_string` now accept `?Sized` types
- [#556]: Add new `to_writer_with_root` and `to_string_with_root` helper functions
- [#520]: Add methods `BytesText::inplace_trim_start` and `BytesText::inplace_trim_end`
to trim leading and trailing spaces from text events

### Bug Fixes

Expand All @@ -25,12 +27,18 @@
sequence type (for example, `Vec` or tuple)
- [#540]: Fix a compilation error (probably a rustc bug) in some circumstances.
`Serializer::new` and `Serializer::with_root` now accepts only references to `Write`r.
- [#520]: Merge consequent (delimited only by comments and processing instructions)
Copy link
Collaborator

Choose a reason for hiding this comment

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

If this only applies to the serde deserializer, that should probably be noted here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, if this is something that isn't practical to handle in the low-level API for the time being, then it would be good to document the limitation. And if it may be possible to do in the future (perhaps requiring API changes to do so) then we should clone #474.

I appreciate the detailed writeup of the issue, by the way.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I clearly indicated that this applies only to the deserializer. The documentation thing probably solved by the last commit in this branch (16fca58)?

texts and CDATA when deserialize using serde deserializer. `DeEvent::Text` and
`DeEvent::CData` events was replaced by `DeEvent::Text` with merged content.
The same behavior for the `Reader` does not implemented (yet?) and should be
implemented manually

### Misc Changes

[externally tagged]: https://serde.rs/enum-representations.html#externally-tagged
[#490]: https://github.com/tafia/quick-xml/pull/490
[#510]: https://github.com/tafia/quick-xml/issues/510
[#520]: https://github.com/tafia/quick-xml/pull/520
[#537]: https://github.com/tafia/quick-xml/issues/537
[#540]: https://github.com/tafia/quick-xml/issues/540
[#541]: https://github.com/tafia/quick-xml/pull/541
Expand Down
73 changes: 25 additions & 48 deletions src/de/map.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,14 +239,14 @@ where
// We shouldn't have both `$value` and `$text` fields in the same
// struct, so if we have `$value` field, the we should deserialize
// text content to `$value`
DeEvent::Text(_) | DeEvent::CData(_) if self.has_value_field => {
DeEvent::Text(_) if self.has_value_field => {
self.source = ValueSource::Content;
// Deserialize `key` from special attribute name which means
// that value should be taken from the text content of the
// XML node
seed.deserialize(VALUE_KEY.into_deserializer()).map(Some)
}
DeEvent::Text(_) | DeEvent::CData(_) => {
DeEvent::Text(_) => {
self.source = ValueSource::Text;
// Deserialize `key` from special attribute name which means
// that value should be taken from the text content of the
Expand Down Expand Up @@ -307,19 +307,11 @@ where
// </any-tag>
// The whole map represented by an `<any-tag>` element, the map key
// is implicit and equals to the `TEXT_KEY` constant, and the value
// is a `Text` or a `CData` event (the value deserializer will see one
// of that events)
// is a `Text` event (the value deserializer will see that event)
// This case are checked by "xml_schema_lists::element" tests in tests/serde-de.rs
ValueSource::Text => match self.de.next()? {
DeEvent::Text(e) => seed.deserialize(SimpleTypeDeserializer::from_text_content(
// Comment to prevent auto-formatting
e.decode(true)?,
)),
DeEvent::CData(e) => seed.deserialize(SimpleTypeDeserializer::from_text_content(
// Comment to prevent auto-formatting
e.decode()?,
)),
// SAFETY: We set `Text` only when we seen `Text` or `CData`
DeEvent::Text(e) => seed.deserialize(SimpleTypeDeserializer::from_text_content(e)),
// SAFETY: We set `Text` only when we seen `Text`
_ => unreachable!(),
},
// This arm processes the following XML shape:
Expand Down Expand Up @@ -431,7 +423,7 @@ where
///
/// The whole map represented by an `<any-tag>` element, the map key is
/// implicit and equals to the [`VALUE_KEY`] constant, and the value is
/// a [`Text`], a [`CData`], or a [`Start`] event (the value deserializer
/// a [`Text`], or a [`Start`] event (the value deserializer
/// will see one of those events). In the first two cases the value of this
/// field do not matter (because we already see the textual event and there
/// no reasons to look "inside" something), but in the last case the primitives
Expand All @@ -452,7 +444,6 @@ where
/// as accepting "text content" which the currently `$text` means.
///
/// [`Text`]: DeEvent::Text
/// [`CData`]: DeEvent::CData
/// [`Start`]: DeEvent::Start
allow_start: bool,
}
Expand All @@ -464,11 +455,11 @@ where
/// Returns a next string as concatenated content of consequent [`Text`] and
/// [`CData`] events, used inside [`deserialize_primitives!()`].
///
/// [`Text`]: DeEvent::Text
/// [`CData`]: DeEvent::CData
/// [`Text`]: crate::events::Event::Text
/// [`CData`]: crate::events::Event::CData
#[inline]
fn read_string(&mut self, unescape: bool) -> Result<Cow<'de, str>, DeError> {
self.map.de.read_string_impl(unescape, self.allow_start)
fn read_string(&mut self) -> Result<Cow<'de, str>, DeError> {
self.map.de.read_string_impl(self.allow_start)
}
}

Expand Down Expand Up @@ -631,8 +622,8 @@ impl<'de> TagFilter<'de> {
/// Depending on [`Self::filter`], only some of that possible constructs would be
/// an element.
///
/// [`Text`]: DeEvent::Text
/// [`CData`]: DeEvent::CData
/// [`Text`]: crate::events::Event::Text
/// [`CData`]: crate::events::Event::CData
struct MapValueSeqAccess<'de, 'a, 'm, R>
where
R: XmlRead<'de>,
Expand Down Expand Up @@ -697,7 +688,7 @@ where
// opened tag `self.map.start`
DeEvent::Eof => Err(DeError::UnexpectedEof),

// Start(tag), Text, CData
// Start(tag), Text
_ => seed
.deserialize(SeqItemDeserializer { map: self.map })
.map(Some),
Expand Down Expand Up @@ -725,11 +716,11 @@ where
/// Returns a next string as concatenated content of consequent [`Text`] and
/// [`CData`] events, used inside [`deserialize_primitives!()`].
///
/// [`Text`]: DeEvent::Text
/// [`CData`]: DeEvent::CData
/// [`Text`]: crate::events::Event::Text
/// [`CData`]: crate::events::Event::CData
#[inline]
fn read_string(&mut self, unescape: bool) -> Result<Cow<'de, str>, DeError> {
self.map.de.read_string_impl(unescape, true)
fn read_string(&mut self) -> Result<Cow<'de, str>, DeError> {
self.map.de.read_string_impl(true)
}
}

Expand Down Expand Up @@ -781,31 +772,17 @@ where
V: Visitor<'de>,
{
match self.map.de.next()? {
DeEvent::Text(e) => SimpleTypeDeserializer::from_text_content(
// Comment to prevent auto-formatting
e.decode(true)?,
)
.deserialize_seq(visitor),
DeEvent::CData(e) => SimpleTypeDeserializer::from_text_content(
// Comment to prevent auto-formatting
e.decode()?,
)
.deserialize_seq(visitor),
DeEvent::Text(e) => {
SimpleTypeDeserializer::from_text_content(e).deserialize_seq(visitor)
}
// This is a sequence element. We cannot treat it as another flatten
// sequence if type will require `deserialize_seq` We instead forward
// it to `xs:simpleType` implementation
DeEvent::Start(e) => {
let value = match self.map.de.next()? {
DeEvent::Text(e) => SimpleTypeDeserializer::from_text_content(
// Comment to prevent auto-formatting
e.decode(true)?,
)
.deserialize_seq(visitor),
DeEvent::CData(e) => SimpleTypeDeserializer::from_text_content(
// Comment to prevent auto-formatting
e.decode()?,
)
.deserialize_seq(visitor),
DeEvent::Text(e) => {
SimpleTypeDeserializer::from_text_content(e).deserialize_seq(visitor)
}
e => Err(DeError::Unsupported(
format!("unsupported event {:?}", e).into(),
)),
Expand All @@ -814,8 +791,8 @@ where
self.map.de.read_to_end(e.name())?;
value
}
// SAFETY: we use that deserializer only when Start(element), Text,
// or CData event Start(tag), Text, CData was peeked already
// SAFETY: we use that deserializer only when Start(element) or Text
// event was peeked already
_ => unreachable!(),
}
}
Expand Down
Loading