skyscraper 0.7.0

XPath for HTML web scraping
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

//! Functions for querying an [XpathItemTree] using an xpath expression.
//!
//! This module contains the functions used to scrape documents using xpath expressions.

use thiserror::Error;

use crate::xpath::{
    self, xpath_item_set::XpathItemSet, ExpressionApplyError, ExpressionParseError, XpathItemTree,
};

use super::{
    grammar::data_model::{AttributeNode, ElementNode, XpathItem},
    Xpath,
};

impl Xpath {
    /// Find attributes in an [XpathItemTree] using an xpath expression.
    ///
    /// Non-attribute items in the result are silently filtered out.
    pub fn find_attributes<'tree>(
        &self,
        tree: &'tree XpathItemTree,
    ) -> Result<Vec<&'tree AttributeNode>, ExpressionApplyError> {
        let items = self.apply(tree)?;

        Ok(items
            .iter()
            .filter_map(|item| item.as_node().ok())
            .filter_map(|node| node.as_attribute_node().ok())
            .collect())
    }

    /// Find elements in an [XpathItemTree] using an xpath expression.
    ///
    /// Non-element items in the result are silently filtered out.
    pub fn find_elements<'tree>(
        &self,
        tree: &'tree XpathItemTree,
    ) -> Result<Vec<&'tree ElementNode>, ExpressionApplyError> {
        let items = self.apply(tree)?;

        Ok(items
            .iter()
            .filter_map(|item| item.as_node().ok())
            .filter_map(|node| node.as_element_node().ok())
            .collect())
    }

    /// Find elements from an [XpathItem] in an [XpathItemTree] using an xpath expression.
    /// The expression will be evaluated relative to the given item.
    ///
    /// Non-element items in the result are silently filtered out.
    pub fn find_elements_from_item<'tree>(
        &self,
        tree: &'tree XpathItemTree,
        item: XpathItem<'tree>,
    ) -> Result<Vec<&'tree ElementNode>, ExpressionApplyError> {
        let items = self.apply_to_item(tree, item)?;

        Ok(items
            .iter()
            .filter_map(|item| item.as_node().ok())
            .filter_map(|node| node.as_element_node().ok())
            .collect())
    }

    /// Find elements from an [ElementNode] in an [XpathItemTree] using an xpath expression.
    /// The expression will be evaluated relative to the given element.
    pub fn find_elements_from_element<'tree>(
        &self,
        tree: &'tree XpathItemTree,
        element: &'tree ElementNode,
    ) -> Result<Vec<&'tree ElementNode>, ExpressionApplyError> {
        let item = element.to_item(tree);

        self.find_elements_from_item(tree, item)
    }
}

/// Error that occurs when using a function that both parses a string into an [Xpath](crate::xpath::Xpath) expression and immediately applies it to a [XpathItemTree].
#[derive(PartialEq, Debug, Error)]
pub enum ParseApplyError {
    /// Error parsing the xpath expression.
    #[error("Failed to parse xpath: {0}")]
    ParseError(#[from] ExpressionParseError),

    /// Error applying the xpath expression.
    #[error("Failed to apply xpath: {0}")]
    ApplyError(#[from] ExpressionApplyError),

}

/// Find items in an [XpathItemTree] using an xpath expression.
///
/// **Note**: If the same xpath expression is being used multiple times, consider using the [xpath::parse] function to parse the expression once,
/// and then using the [Xpath::find] method on the parsed expression.
/// Parsing xpath expression takes effort, so it's best to do it once and then reuse the parsed expression.
///
/// # Example
///
/// ```rust
/// use skyscraper::html;
/// use skyscraper::xpath::{query::find, grammar::data_model::ElementNode};
///
/// let tree = html::parse("<html><body><div>Example 1</div><div>Example 2</div></body></html>").unwrap();
///
/// let items = find(&tree, "//div").unwrap();
///
/// let nodes: Vec<&ElementNode> = items
///     .into_iter()
///     .map(|item| item.extract_as_node().extract_as_element_node())
///     .collect();
/// ```
pub fn find<'tree>(
    tree: &'tree XpathItemTree,
    xpath: &str,
) -> Result<XpathItemSet<'tree>, ParseApplyError> {
    let xpath = xpath::parse(xpath)?;

    Ok(xpath.apply(tree)?)
}

/// Find attributes in an [XpathItemTree] using an xpath expression.
///
/// **Note**: If the same xpath expression is being used multiple times, consider using the [xpath::parse] function to parse the expression once,
/// and then using the [Xpath::find_attributes] method on the parsed expression.
/// Parsing xpath expression takes effort, so it's best to do it once and then reuse the parsed expression.
///
/// # Example
///
/// ```rust
/// use skyscraper::html;
/// use skyscraper::xpath::{query::find_attributes, grammar::data_model::AttributeNode};
///
/// let tree = html::parse("<html><body><div id=\"example\">Example 1</div></body></html>").unwrap();
///
/// let attributes = find_attributes(&tree, "//div/@id").unwrap();
///
/// let attribute = attributes[0];
///
/// assert_eq!(attribute.name, "id");
/// assert_eq!(attribute.value, "example");
/// ```
pub fn find_attributes<'tree>(
    tree: &'tree XpathItemTree,
    xpath: &str,
) -> Result<Vec<&'tree AttributeNode>, ParseApplyError> {
    let xpath = xpath::parse(xpath)?;

    Ok(xpath.find_attributes(tree)?)
}

/// Find elements in an [XpathItemTree] using an xpath expression.
///
/// **Note**: If the same xpath expression is being used multiple times, consider using the [xpath::parse] function to parse the expression once,
/// and then using the [Xpath::find_elements] method on the parsed expression.
/// Parsing xpath expression takes effort, so it's best to do it once and then reuse the parsed expression.
///
/// # Example
///
/// ```rust
/// use skyscraper::html;
/// use skyscraper::xpath::{query::find_elements, grammar::data_model::ElementNode};
///
/// let tree = html::parse("<html><body><div id=\"example\">Example 1</div></body></html>").unwrap();
///
/// let elements = find_elements(&tree, "//div").unwrap();
///
/// let element = elements[0];
///
/// assert_eq!(element.name, "div");
/// ```
pub fn find_elements<'tree>(
    tree: &'tree XpathItemTree,
    xpath: &str,
) -> Result<Vec<&'tree ElementNode>, ParseApplyError> {
    let xpath = xpath::parse(xpath)?;

    Ok(xpath.find_elements(tree)?)
}

#[cfg(test)]
mod tests {
    use crate::html;

    use super::*;

    #[test]
    fn find_attributes_should_find_attribute() {
        // arrange
        let html = r#"<html><body><div id="example">Example 1</div></body></html>"#;
        let tree = html::parse(html).unwrap();

        // act
        let attributes = find_attributes(&tree, "//div/@id").unwrap();

        // assert
        let attribute = attributes[0];

        assert_eq!(attribute.name, "id");
        assert_eq!(attribute.value, "example");
    }

    #[test]
    fn find_elements_should_find_element() {
        // arrange
        let html = r#"<html><body><div id="example">Example 1</div></body></html>"#;
        let tree = html::parse(html).unwrap();

        // act
        let elements = find_elements(&tree, "//div").unwrap();

        // assert
        let element = elements[0];

        assert_eq!(element.name, "div");
    }

    #[test]
    fn find_elements_from_item_should_find_element() {
        // arrange
        let html = r#"<html><body><div id="example">Example 1</div></body></html>"#;
        let tree = html::parse(html).unwrap();

        let items = find(&tree, "//body").unwrap();

        let xpath = xpath::parse("//div").unwrap();

        // act
        let elements = xpath
            .find_elements_from_item(&tree, items[0].clone())
            .unwrap();

        // assert
        let element = elements[0];

        assert_eq!(element.name, "div");
    }

    #[test]
    fn find_elements_from_element_should_find_element() {
        // arrange
        let html = r#"<html><body><div id="example">Example 1</div></body></html>"#;
        let tree = html::parse(html).unwrap();

        let first_elements = find_elements(&tree, "//body").unwrap();

        let xpath = xpath::parse("//div").unwrap();

        // act
        let elements = xpath
            .find_elements_from_element(&tree, first_elements[0])
            .unwrap();

        // assert
        let element = elements[0];

        assert_eq!(element.name, "div");
    }
}