links 0.1.0

find links from html and javascript 🧬
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

//! Scrape URLs from HTML and JavaScript easily.
//!
//! *HTML only scrapes URLs from <script>*
//! *JavaScript is not yet implemented*

/// Document type, either [`DocumentKind::HTML`] or [`DocumentKind::JavaScript`]
enum DocumentKind {
    /// An HTML document
    HTML,

    /// A JavaScript script
    JavaScript,
}

/// Describes a document
///
/// # See Also
///
/// [`Document::html`]
///
/// [`Document::js`]
pub struct Document<'a> {
    /// The kind of document
    kind: DocumentKind,

    /// The full text of the document
    text: &'a str,
}

impl<'a> Document<'a> {
    /// Wraps the given HTML code into a [`Document`].
    ///
    /// No syntax check is made for now.
    /// The given code is expected to be valid.
    ///
    /// # Example
    ///
    /// ```rust
    /// links::Document::html("<html><head><title>Hello World</title></head><body><h1>Welcome</h1></html>");
    /// ```
    pub fn html(html: &'a str) -> Self {
        Document { kind: DocumentKind::HTML, text: html }
    }

    /// Wraps the given JavaScript script into a [`Document`]
    ///
    /// No syntax check is made for now.
    /// The given code is expected to be valid.
    ///
    /// # Example
    ///
    /// ```rust
    /// links::Document::js("alert(1)");
    /// ```
    pub fn js(script: &'a str) -> Self {
        Document { kind: DocumentKind::JavaScript, text: script }
    }

    /// Returns string slices that contains absolute or relative URLs
    ///
    /// # Panics
    ///
    /// The method panics if the syntax of the document is invalid
    ///
    /// # Example
    ///
    /// ```rust
    /// assert_eq!(vec!["/main.js"], links::Document::html(r#"<script src="/main.js"></script>"#).urls());
    /// ```
    pub fn urls(&self) -> Vec<&'a str> {
        match self.kind {
            DocumentKind::HTML => links_html::get_urls_from_html(self.text),
            DocumentKind::JavaScript => links_js::get_urls_from_js(self.text)
        }
    }
}