ghastoolkit 0.12.2

GitHub Advanced Security Toolkit in 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

use serde::{Deserialize, Serialize};

use crate::supplychain::License;

/// List of Licenses for a dependency
///
/// # Example
///
/// ```rust
/// use ghastoolkit::supplychain::Licenses;
///
/// // Parse a string into a list of licenses
/// let licenses = Licenses::from("MIT, Apache-2.0");
/// # assert_eq!(licenses.len(), 2);
/// // Do some with the licenses
///
/// ```
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq)]
pub struct Licenses {
    licenses: Vec<License>,
}

impl Licenses {
    /// Create a new list of licenses
    pub fn new() -> Self {
        Self {
            licenses: Vec::new(),
        }
    }

    /// Push a new license to the list
    pub fn push(&mut self, license: License) {
        self.licenses.push(license);
    }

    /// Check if the list of licenses is empty
    pub fn is_empty(&self) -> bool {
        self.licenses.is_empty()
    }

    /// Get the length of the list of licenses
    pub fn len(&self) -> usize {
        self.licenses.len()
    }

    /// Check if the list contains a particular license
    pub fn contains(&self, license: &License) -> bool {
        self.licenses.contains(license)
    }

    /// Parse a string into a list of licenses.
    /// It will split the string by "and" or ","
    pub fn parse(value: &str) -> Licenses {
        match value.to_lowercase().as_str() {
            value if value.contains("and") => Licenses::parse_sep(value, "and"),
            value if value.contains(',') => Licenses::parse_sep(value, ","),
            _ => {
                let mut licenses = Licenses::new();
                licenses.push(License::from(value));
                licenses
            }
        }
    }

    fn parse_sep(value: &str, sep: &str) -> Licenses {
        let mut licenses = Licenses::new();
        for license in value.split(sep) {
            licenses.push(License::from(license.trim()));
        }
        licenses
    }
}

impl IntoIterator for Licenses {
    type Item = License;
    type IntoIter = std::vec::IntoIter<License>;

    fn into_iter(self) -> Self::IntoIter {
        self.licenses.into_iter()
    }
}

impl From<&str> for Licenses {
    fn from(value: &str) -> Self {
        Licenses::parse(value)
    }
}

impl From<String> for Licenses {
    fn from(value: String) -> Self {
        Licenses::parse(value.as_str())
    }
}

impl From<Vec<&str>> for Licenses {
    fn from(value: Vec<&str>) -> Self {
        let mut licenses = Licenses::new();
        for license in value {
            licenses.push(License::from(license));
        }
        licenses
    }
}

#[cfg(test)]
mod tests {
    use crate::supplychain::{License, Licenses};

    #[test]
    fn test_single_license() {
        let licenses = Licenses::from("Apache-2.0");

        let correct = Licenses {
            licenses: vec![License::Apache(String::from("2.0"))],
        };

        assert_eq!(licenses, correct);
        assert_eq!(licenses.len(), 1);
    }

    #[test]
    fn test_licenses_from_str() {
        let licenses = Licenses::from("Apache-2.0 AND MIT");

        let correct = Licenses {
            licenses: vec![License::Apache(String::from("2.0")), License::MIT],
        };

        assert_eq!(licenses, correct);
        assert_eq!(licenses.len(), 2);
    }

    #[test]
    fn test_licenses_from_vec() {
        let licenses = Licenses::from(vec!["Apache-2.0", "MIT"]);

        let correct = Licenses {
            licenses: vec![License::Apache(String::from("2.0")), License::MIT],
        };

        assert_eq!(licenses, correct);
        assert_eq!(licenses.len(), 2);
    }

    #[test]
    fn test_licenses_commasep() {
        let licenses = Licenses::from("Apache-2.0, MIT");

        let correct = Licenses {
            licenses: vec![License::Apache(String::from("2.0")), License::MIT],
        };

        assert_eq!(licenses, correct);
    }
}