gir_parser/
version.rs

1use std::str::FromStr;
2
3use serde::Deserialize;
4use xmlserde::XmlValue;
5
6#[derive(Debug, Default, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
7pub struct Version(u16, Option<u16>, Option<u16>);
8
9impl Version {
10    pub fn new(major: u16, minor: u16, patch: u16) -> Self {
11        Self(major, Some(minor), Some(patch))
12    }
13
14    pub fn major(self) -> u16 {
15        self.0
16    }
17
18    pub fn minor(self) -> Option<u16> {
19        self.1
20    }
21
22    pub fn patch(self) -> Option<u16> {
23        self.2
24    }
25}
26
27impl<'de> Deserialize<'de> for Version {
28    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
29    where
30        D: serde::Deserializer<'de>,
31    {
32        let str = <String as Deserialize>::deserialize(deserializer)?;
33        Self::from_str(&str).map_err(serde::de::Error::custom)
34    }
35}
36
37impl FromStr for Version {
38    type Err = String;
39
40    /// Parse a `Version` from a string.
41    /// Currently always return Ok
42    fn from_str(s: &str) -> Result<Self, String> {
43        if s.contains('.') {
44            let mut parts = s
45                .splitn(4, '.')
46                .map(str::parse)
47                .take_while(Result::is_ok)
48                .map(Result::unwrap);
49            Ok(Self(parts.next().unwrap_or(0), parts.next(), parts.next()))
50        } else {
51            let val = s.parse::<u16>();
52            Ok(Self(val.unwrap_or(0), None, None))
53        }
54    }
55}
56
57impl XmlValue for Version {
58    fn serialize(&self) -> String {
59        self.to_string()
60    }
61
62    fn deserialize(s: &str) -> Result<Self, String> {
63        Self::from_str(s)
64    }
65}
66
67impl std::fmt::Display for Version {
68    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
69        match *self {
70            Self(major, None, None) => write!(f, "{major}"),
71            Self(major, Some(minor), None) => write!(f, "{major}.{minor}"),
72            Self(major, None, Some(patch)) => write!(f, "{major}.0.{patch}"),
73            Self(major, Some(minor), Some(patch)) => write!(f, "{major}.{minor}.{patch}"),
74        }
75    }
76}
77
78impl PartialEq<str> for Version {
79    fn eq(&self, other: &str) -> bool {
80        Version::from_str(other) == Ok(*self)
81    }
82}
83
84#[cfg(test)]
85mod tests {
86    use super::*;
87
88    #[test]
89    fn accessors() {
90        let version = Version(5, Some(10), None);
91        assert_eq!(version.major(), 5);
92        assert_eq!(version.minor(), Some(10));
93        assert_eq!(version.patch(), None);
94
95        let version = Version(7, None, None);
96        assert_eq!(version.major(), 7);
97        assert_eq!(version.minor(), None);
98        assert_eq!(version.patch(), None);
99
100        let version = Version::new(1, 2, 3);
101        assert_eq!(version.major(), 1);
102        assert_eq!(version.minor(), Some(2));
103        assert_eq!(version.patch(), Some(3));
104    }
105
106    #[test]
107    fn from_str() {
108        // Full version
109        let version = Version::from_str("1.2.3").unwrap();
110        assert_eq!(version, Version::new(1, 2, 3));
111
112        // Major.minor
113        let version = Version::from_str("2.5").unwrap();
114        assert_eq!(version, Version(2, Some(5), None));
115
116        // Major only with dot
117        let version = Version::from_str("3.").unwrap();
118        assert_eq!(version, Version(3, None, None));
119
120        // Major only without dot
121        let version = Version::from_str("4").unwrap();
122        assert_eq!(version, Version(4, None, None));
123
124        // Four parts (only first three are used)
125        let version = Version::from_str("1.2.3.4").unwrap();
126        assert_eq!(version, Version::new(1, 2, 3));
127
128        // Invalid parts are ignored
129        let version = Version::from_str("5.invalid.7").unwrap();
130        assert_eq!(version, Version(5, None, None));
131
132        // Completely invalid input defaults to 0
133        let version = Version::from_str("invalid").unwrap();
134        assert_eq!(version, Version(0, None, None));
135
136        // Empty string defaults to 0
137        let version = Version::from_str("").unwrap();
138        assert_eq!(version, Version(0, None, None));
139
140        assert_eq!(Version::new(1, 2, 3).to_string(), "1.2.3");
141        assert_eq!(Version(2, Some(5), None).to_string(), "2.5");
142        assert_eq!(Version(3, None, None).to_string(), "3");
143        assert_eq!(Version(4, None, Some(6)).to_string(), "4.0.6");
144    }
145
146    #[test]
147    fn eq_str() {
148        // Test exact matches
149        let version = Version::new(1, 2, 3);
150        assert_eq!(version, *"1.2.3");
151        assert!(version == *"1.2.3");
152
153        // Test major.minor format
154        let version = Version(2, Some(5), None);
155        assert_eq!(version, *"2.5");
156        assert!(version == *"2.5");
157
158        // Test major only format
159        let version = Version(3, None, None);
160        assert_eq!(version, *"3");
161        assert!(version == *"3");
162
163        // Test non-matching versions
164        let version = Version::new(1, 2, 3);
165        assert_ne!(version, *"1.2.4");
166        assert_ne!(version, *"2.2.3");
167        assert_ne!(version, *"1.3.3");
168
169        // Test invalid string comparison
170        let version = Version::new(1, 2, 3);
171        assert_ne!(version, *"invalid");
172        assert_ne!(version, *"");
173    }
174
175    #[test]
176    fn ordering() {
177        // Major version comparison
178        assert!(Version(2, None, None) > Version(1, None, None));
179        assert!(Version(1, None, None) < Version(2, None, None));
180
181        // Minor version comparison
182        assert!(Version(1, Some(5), None) > Version(1, Some(3), None));
183        assert!(Version(1, Some(2), None) < Version(1, Some(4), None));
184
185        // Patch version comparison
186        assert!(Version::new(1, 2, 5) > Version::new(1, 2, 3));
187        assert!(Version::new(1, 2, 1) < Version::new(1, 2, 2));
188
189        // None is less than Some
190        assert!(Version(1, None, None) < Version(1, Some(0), None));
191        assert!(Version(1, Some(2), None) < Version::new(1, 2, 0));
192
193        // Equality
194        assert_eq!(Version::new(1, 2, 3), Version::new(1, 2, 3));
195        assert_eq!(Version(5, None, None), Version(5, None, None));
196    }
197}
gir_parser/version.rs

gir_parser/
version.rs
