indicate 0.2.0

Library behind cargo-indicate
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

use std::{
    collections::BTreeMap, error::Error, ffi::OsStr, fs, path::Path, sync::Arc,
};

use serde::Deserialize;
use trustfall::TransparentValue;

use crate::errors::FileParseError;

/// Type representing a thread-safe JSON object, like
/// ```json
/// {
///     "name": "hello",
///     "value": true,
/// }
/// ```
type QueryArgs = BTreeMap<Arc<str>, TransparentValue>;

/// A full Trustfall query, with both query and arguments to be used
#[derive(Debug, Clone, Deserialize)]
pub struct FullQuery {
    pub query: String,
    pub args: QueryArgs,
}

impl FullQuery {
    /// Extracts a query from a file
    ///
    /// # Errors
    ///
    /// Will return an error variant if
    ///
    /// - The path cannot be read for some reason, or
    /// - The file has a supported file extension, but failed to deserialize, or
    /// - The file is of an unsupported file extension, or
    /// - The file is of an unknown file extension
    pub fn from_path(path: &Path) -> Result<FullQuery, Box<dyn Error>> {
        if !path.exists() {
            Err(Box::new(FileParseError::NotFound(
                path.to_string_lossy().to_string(),
            )))
        } else {
            let raw_query = fs::read_to_string(path)?;
            match path.extension().and_then(OsStr::to_str) {
                // TODO: Add support for other file types
                Some("json") => {
                    let q: FullQuery =
                        serde_json::from_str::<FullQuery>(&raw_query)?;
                    Ok(q)
                }
                Some("ron") => {
                    let q = ron::from_str::<FullQuery>(&raw_query)?;
                    Ok(q)
                }
                Some(ext) => {
                    Err(Box::new(FileParseError::UnsupportedFileExtension {
                        ext: String::from(ext),
                        path: path.to_string_lossy().to_string(),
                    }))
                }
                None => Err(Box::new(FileParseError::UnknownFileExtension(
                    path.to_string_lossy().to_string(),
                ))),
            }
        }
    }
}

pub struct FullQueryBuilder {
    query: String,
    args: Option<QueryArgs>,
}

impl FullQueryBuilder {
    #[must_use]
    pub fn new(query: String) -> Self {
        Self { query, args: None }
    }

    #[must_use]
    pub fn query(mut self, query: String) -> Self {
        self.query = query;
        self
    }

    #[must_use]
    pub fn args(mut self, args: QueryArgs) -> Self {
        self.args = Some(args);
        self
    }

    #[must_use]
    pub fn build(self) -> FullQuery {
        FullQuery {
            query: self.query,
            args: self.args.unwrap_or(BTreeMap::new()),
        }
    }
}

#[cfg(test)]
mod test {
    use std::{fs, path::Path};

    use test_case::test_case;

    use super::FullQuery;

    #[test_case("test_data/queries/count_dependencies.in.ron" ; "parse count_dependencies ron")]
    #[test_case("test_data/queries/dependency_package_info.in.ron" ; "parse dependency package info ron")]
    fn deserialize_ron(query_path: &str) {
        let s = fs::read_to_string(Path::new(query_path))
            .unwrap_or_else(|_| panic!("could not read file {query_path}"));
        ron::from_str::<FullQuery>(&s)
            .unwrap_or_else(|_| panic!("could not deserialize {query_path}"));
    }

    #[test_case("test_data/queries/count_dependencies.in.json" ; "parse count_dependencies json")]
    fn deserialize_json(query_path: &str) {
        let s = fs::read_to_string(Path::new(query_path))
            .unwrap_or_else(|_| panic!("could not read file {query_path}"));
        serde_json::from_str::<FullQuery>(&s)
            .unwrap_or_else(|_| panic!("could not deserialize {query_path}"));
    }
}