xot 0.31.2

Full-featured XML tree library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

use xot::Xot;

#[test]
fn test_text_content_str() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<a>text</a>"#).unwrap();
    let doc_el = xot.document_element(doc).unwrap();
    assert_eq!(xot.text_content_str(doc_el), Some("text"));
}

#[test]
fn test_text_content_str_no_text() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<a/>"#).unwrap();
    let doc_el = xot.document_element(doc).unwrap();
    assert_eq!(xot.text_content_str(doc_el), Some(""));
}

#[test]
fn test_text_content_str_mixed_content() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<a>text<b/></a>"#).unwrap();
    let doc_el = xot.document_element(doc).unwrap();
    assert_eq!(xot.text_content_str(doc_el), None);
}

#[test]
fn test_compare() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a>text</a>"#).unwrap();
    let doc2 = xot.parse(r#"<a>text</a>"#).unwrap();

    assert!(xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_different_text() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a>text A</a>"#).unwrap();
    let doc2 = xot.parse(r#"<a>text B</a>"#).unwrap();

    assert!(!xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_different_structure() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a></a>"#).unwrap();
    let doc2 = xot.parse(r#"<a><b/></a>"#).unwrap();

    assert!(!xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_different_namespace() {
    let mut xot = Xot::new();
    let doc1 = xot
        .parse(r#"<a xmlns="http://example.com/a"></a>"#)
        .unwrap();
    let doc2 = xot
        .parse(r#"<a xmlns="http://example.com/b"></a>"#)
        .unwrap();

    assert!(!xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_same_attributes() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a x="X"></a>"#).unwrap();
    let doc2 = xot.parse(r#"<a x="X"></a>"#).unwrap();

    assert!(xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_different_attributes() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a x="X"></a>"#).unwrap();
    let doc2 = xot.parse(r#"<a x="Y"></a>"#).unwrap();

    assert!(!xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_different_attributes_extra() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a x="X"></a>"#).unwrap();
    let doc2 = xot.parse(r#"<a x="X" y="Y"></a>"#).unwrap();

    assert!(!xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_value_the_same_structure_different() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<article><body><sec id="1"><sec id="2"><title>T1</title><p>P1</p><p>P2</p></sec></sec><sec id="3"><title>T2</title><p>P3</p></sec></body></article>"#
    ).unwrap();
    let doc2 = xot.parse(r#"<article><body><sec id="1"><sec id="2"><title>T1</title><p>P1</p><p>P2</p></sec><sec id="3"><title>T2</title><p>P3</p></sec></sec></body></article>"#).unwrap();
    assert!(!xot.deep_equal(doc1, doc2));
}

#[test]
fn test_compare_children() {
    let mut xot = Xot::new();
    let root1 = xot
        .parse(r#"<a><b z="Y">Alpha<x/>Gamma</b><b>Alpha<x/></b></a>"#)
        .unwrap();
    let root2 = xot.parse(r#"<a><b z="Z">Alpha<x/>Gamma</b></a>"#).unwrap();
    let doc1 = xot.document_element(root1).unwrap();
    let doc2 = xot.document_element(root2).unwrap();
    let doc1_b0 = xot.first_child(doc1).unwrap();
    let doc1_b1 = xot.next_sibling(doc1_b0).unwrap();
    let doc2_b0 = xot.first_child(doc2).unwrap();

    assert!(xot.deep_equal_children(doc1_b0, doc2_b0));
    assert!(!xot.deep_equal_children(doc1_b1, doc2_b0));
}

#[test]
fn test_advanced_compare_text() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a>text</a>"#).unwrap();
    let doc2 = xot.parse(r#"<a>TEXT</a>"#).unwrap();
    // case insensitive compare
    assert!(xot.advanced_deep_equal(
        doc1,
        doc2,
        |_| true,
        |a, b| a.to_lowercase() == b.to_lowercase()
    ));
}

#[test]
fn test_advanced_compare_text2() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a>text</a>"#).unwrap();
    let doc2 = xot.parse(r#"<a>different</a>"#).unwrap();

    // case insensitive compare doesn't matter, it's still different
    assert!(!xot.advanced_deep_equal(
        doc1,
        doc2,
        |_| true,
        |a, b| a.to_lowercase() == b.to_lowercase()
    ));
}

#[test]
fn test_advanced_compare_attribute_text() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a alpha="alpha">text</a>"#).unwrap();
    let doc2 = xot.parse(r#"<a alpha="ALPHA">text</a>"#).unwrap();
    // no text compares as equal, so this is not equal
    assert!(xot.advanced_deep_equal(
        doc1,
        doc2,
        |_| true,
        |a, b| a.to_lowercase() == b.to_lowercase()
    ));
}

#[test]
fn test_advanced_compare_filter() {
    let mut xot = Xot::new();
    let doc1 = xot.parse(r#"<a>text<!--comment--></a>"#).unwrap();
    let doc2 = xot.parse(r#"<a>text</a>"#).unwrap();
    // compare, disregarding comments
    assert!(xot.advanced_deep_equal(doc1, doc2, |node| !xot.is_comment(node), |a, b| a == b));
}

#[test]
fn test_first_child_with_namespace() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc xmlns:foo="FOO">bar</doc>"#).unwrap();
    let element = xot.document_element(doc).unwrap();
    let value = xot.value(xot.first_child(element).unwrap());
    if let xot::Value::Text(text) = value {
        assert_eq!(text.get(), "bar");
    } else {
        unreachable!();
    }
}

#[test]
fn test_first_child_with_attribute() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc foo="FOO">bar</doc>"#).unwrap();
    let element = xot.document_element(doc).unwrap();
    let value = xot.value(xot.first_child(element).unwrap());
    if let xot::Value::Text(text) = value {
        assert_eq!(text.get(), "bar");
    } else {
        unreachable!();
    }
}

#[test]
fn test_first_child_missing_with_attribute() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc foo="FOO"/>"#).unwrap();
    let element = xot.document_element(doc).unwrap();
    assert_eq!(xot.first_child(element), None);
}

#[test]
fn test_last_child_with_attribute() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc foo="FOO">bar</doc>"#).unwrap();
    let element = xot.document_element(doc).unwrap();
    let value = xot.value(xot.last_child(element).unwrap());
    if let xot::Value::Text(text) = value {
        assert_eq!(text.get(), "bar");
    } else {
        unreachable!();
    }
}

#[test]
fn test_last_child_missing_with_attribute() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc foo="FOO"/>"#).unwrap();
    let element = xot.document_element(doc).unwrap();
    assert_eq!(xot.last_child(element), None);
}

#[test]
fn test_previous_sibling_with_attribute() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc foo="FOO">bar</doc>"#).unwrap();
    let doc = xot.document_element(doc).unwrap();
    let bar = xot.first_child(doc).unwrap();
    assert_eq!(xot.previous_sibling(bar), None);
}

#[test]
fn test_next_sibling_with_attribute() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc foo="FOO">bar</doc>"#).unwrap();
    let doc = xot.document_element(doc).unwrap();
    let bar = xot.first_child(doc).unwrap();
    assert_eq!(xot.next_sibling(bar), None);
}

#[test]
fn test_children() {
    let mut xot = Xot::new();
    let doc = xot.parse(r#"<doc foo="FOO">bar</doc>"#).unwrap();
    let doc = xot.document_element(doc).unwrap();
    let children = xot.children(doc).collect::<Vec<_>>();
    assert_eq!(children.len(), 1);
}

#[test]
fn test_document_element_for_fragment_with_single_element() {
    let mut xot = Xot::new();
    let doc = xot.parse_fragment(r#"<a>text</a>"#).unwrap();
    let doc_el = xot.document_element(doc).unwrap();
    assert_eq!(xot.text_content_str(doc_el), Some("text"));
}

#[test]
fn test_document_element_for_fragment_with_multiple_elements() {
    let mut xot = Xot::new();
    let doc = xot.parse_fragment(r#"<a>text</a><b/>"#).unwrap();
    let doc_el = xot.document_element(doc).unwrap();
    assert_eq!(xot.text_content_str(doc_el), Some("text"));
}

#[test]
fn test_document_element_for_fragment_without_elements() {
    let mut xot = Xot::new();
    let doc = xot.parse_fragment(r#""#).unwrap();
    assert!(matches!(
        xot.document_element(doc),
        Err(xot::Error::NoElementAtTopLevel)
    ));
}