wiki-tui 0.5.0

A simple and easy to use Wikipedia Text User Interface
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

/// SearchMetadata can be used to configure what metadata the search should return
pub struct SearchMetadata {
    /// The number of results found
    total_hits: bool,
    /// A suggestion for the search query
    suggestion: bool,
    /// The rewritten query
    rewritten_query: bool,
}

/// A helper macro for generating setter functions in the SearchMetadata struct
macro_rules! build_setter {
    ($(#[$meta:meta])* $value: ident) => {
        $(#[$meta])*
        #[must_use]
        pub fn $value(mut self) -> Self {
            self.$value = true;
            self
        }
    };
}

impl SearchMetadata {
    /// Creates a new SearchMetadata struct with its defaults
    pub fn new() -> SearchMetadata {
        SearchMetadata {
            total_hits: false,
            suggestion: false,
            rewritten_query: false,
        }
    }

    build_setter!(
        /// The number of results found
        total_hits
    );
    build_setter!(
        /// A suggestion for the search query
        suggestion
    );
    build_setter!(
        /// The rewritten query
        rewritten_query
    );

    /// This function generates a url parameter for itself
    pub fn build(&self) -> String {
        let mut query = "&srinfo=".to_string();

        // a helper macro used to build values
        macro_rules! build_value {
            ($value: ident, $value_str: expr) => {
                if self.$value {
                    query.push_str($value_str);
                    query.push('|');
                }
            };
        }

        // build the values
        build_value!(total_hits, "totalhits");
        build_value!(suggestion, "suggestion");
        build_value!(rewritten_query, "rewrittenquery");

        // remove any trailing '|' symbols
        if query.ends_with('|') {
            query.pop();
        }
        query
    }
}

impl Default for SearchMetadata {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    #[test]
    fn build() {
        use super::SearchMetadata;
        assert_eq!(SearchMetadata::new().build(), "&srinfo=".to_string());
    }

    #[test]
    fn complete_build() {
        use super::SearchMetadata;
        assert_eq!(
            SearchMetadata::new()
                .total_hits()
                .rewritten_query()
                .suggestion()
                .build(),
            "&srinfo=totalhits|suggestion|rewrittenquery".to_string()
        );
    }

    #[test]
    fn some_build() {
        use super::SearchMetadata;
        assert_eq!(
            SearchMetadata::new().total_hits().rewritten_query().build(),
            "&srinfo=totalhits|rewrittenquery".to_string()
        );
    }
}