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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
use std::iter::Peekable;
use std::slice::Iter;
use comp_op::CompOp;
use version_part::VersionPart;
/// Version struct. A wrapper for a version number string.
pub struct Version<'a> {
version: &'a str,
parts: Vec<VersionPart<'a>>
}
/// Version struct implementation.
impl<'a> Version<'a> {
/// Create a `Version` instance from a version string.
///
/// The version string should be passed to the `version` parameter.
///
/// # Examples
///
/// ```
/// use version_compare::comp_op::CompOp;
/// use version_compare::version::Version;
///
/// let ver = Version::from("1.2.3").unwrap();
///
/// assert_eq!(ver.compare(&Version::from("1.2.3").unwrap()), CompOp::Eq);
/// ```
pub fn from(version: &'a str) -> Option<Self> {
// Split the version string
let parts = Self::split_version_str(version);
// Return nothing if the parts are none
if parts.is_none() {
return None;
}
// Create and return the object
Some(Version {
version: version,
parts: parts.unwrap()
})
}
/// Split the given version string, in it's version parts.
/// TODO: Move this method to some sort of helper class, maybe as part of `VersionPart`.
fn split_version_str(version: &'a str) -> Option<Vec<VersionPart>> {
// Split the version string, and create a vector to put the parts in
let split = version.split('.');
let mut parts = Vec::new();
// Loop over the parts, and parse them
for part in split {
// Skip empty parts
if part.is_empty() {
continue;
}
// Try to parse the value as an number
match part.parse::<i32>() {
Ok(number) => parts.push(VersionPart::Number(number)),
Err(_) => parts.push(VersionPart::Text(part))
}
}
// Return the list of parts
Some(parts)
}
/// Get the original version string.
///
/// # Examples
///
/// ```
/// use version_compare::version::Version;
///
/// let ver = Version::from("1.2.3").unwrap();
///
/// assert_eq!(ver.as_str(), "1.2.3");
/// ```
pub fn as_str(&self) -> &str {
&self.version
}
/// Get the number of parts in this version string.
///
/// # Examples
///
/// ```
/// use version_compare::version::Version;
///
/// let ver_a = Version::from("1.2.3").unwrap();
/// let ver_b = Version::from("1.2.3.4").unwrap();
///
/// assert_eq!(ver_a.part_count(), 3);
/// assert_eq!(ver_b.part_count(), 4);
/// ```
pub fn part_count(&self) -> usize {
self.parts.len()
}
/// Compare this version to the given `other` version.
///
/// This method returns one of the following comparison operators:
/// - Lt
/// - Eq
/// - Gt
///
/// # Examples:
///
/// ```
/// use version_compare::comp_op::CompOp;
/// use version_compare::version::Version;
///
/// assert_eq!(Version::from("1.2").unwrap().compare(&Version::from("1.3.2").unwrap()), CompOp::Lt);
/// assert_eq!(Version::from("1.9").unwrap().compare(&Version::from("1.9").unwrap()), CompOp::Eq);
/// assert_eq!(Version::from("0.3.0.0").unwrap().compare(&Version::from("0.3").unwrap()), CompOp::Eq);
/// assert_eq!(Version::from("2").unwrap().compare(&Version::from("1.7.3").unwrap()), CompOp::Gt);
/// ```
pub fn compare(&self, other: &Version) -> CompOp {
// Compare the versions with their peekable iterators
Self::compare_iter(
self.parts.iter().peekable(),
other.parts.iter().peekable()
)
}
/// Compare this version to the given `other` version,
/// and check whether the given comparison operator is valid.
///
/// # Examples:
///
/// ```
/// use version_compare::comp_op::CompOp;
/// use version_compare::version::Version;
///
/// assert!(Version::from("1.2").unwrap().compare_to(&Version::from("1.3.2").unwrap(), &CompOp::Lt));
/// assert!(Version::from("1.2").unwrap().compare_to(&Version::from("1.3.2").unwrap(), &CompOp::Le));
/// assert!(Version::from("1.2").unwrap().compare_to(&Version::from("1.2").unwrap(), &CompOp::Eq));
/// assert!(Version::from("1.2").unwrap().compare_to(&Version::from("1.2").unwrap(), &CompOp::Le));
/// ```
pub fn compare_to(&self, other: &Version, operator: &CompOp) -> bool {
// Get the comparison result
let result = self.compare(&other);
// Match the result against the given operator
match result {
CompOp::Eq =>
match operator {
&CompOp::Eq | &CompOp::Le | &CompOp::Ge => true,
_ => false
},
CompOp::Lt =>
match operator {
&CompOp::Ne | &CompOp::Lt | &CompOp::Le => true,
_ => false
},
CompOp::Gt =>
match operator {
&CompOp::Ne | &CompOp::Gt | &CompOp::Ge => true,
_ => false
},
// This should never be reached
_ => panic!()
}
}
/// Compare two version numbers based on the iterators of their version parts.
///
/// This method returns one of the following comparison operators:
/// - Lt
/// - Eq
/// - Gt
fn compare_iter(mut iter: Peekable<Iter<VersionPart<'a>>>, mut other_iter: Peekable<Iter<VersionPart<'a>>>) -> CompOp {
// Iterate through the parts of this version
let mut other_part: Option<&VersionPart>;
// Iterate over the iterator, without consuming it
loop {
match iter.next() {
Some(part) => {
// Skip this part if it's non-numeric
match part {
&VersionPart::Number(_) => {},
_ => continue
}
// Get the next numerical part for the other version
loop {
// Get the next other part
other_part = other_iter.next();
// Make sure it's a number or none
match other_part {
Some(val) =>
match val {
&VersionPart::Number(_) => break,
_ => {}
},
None => break
}
}
// If there are no parts left in the other version, try to determine the result
if other_part.is_none() {
// In the main version: if the current part is zero, continue to the next one
match part {
&VersionPart::Number(num) =>
if num == 0 {
continue;
},
_ => {}
}
// The main version is greater
return CompOp::Gt;
}
// Match both part as numbers to destruct their numerical values
match part {
&VersionPart::Number(num) =>
match other_part.unwrap() {
&VersionPart::Number(other_num) => {
// Compare the numbers
match num {
n if n < other_num => return CompOp::Lt,
n if n > other_num => return CompOp::Gt,
n if n == other_num => continue,
// This part can't be reached
_ => panic!()
}
},
// This part can't be reached
_ => panic!()
},
// This part can't be reached
_ => panic!()
}
},
None => break
}
}
// Check whether we should iterate over the other iterator, if it has any items left
match other_iter.peek() {
// Compare based on the other iterator
Some(_) => Self::compare_iter(other_iter, iter).as_flipped(),
// Nothing more to iterate over, the versions should be equal
None => CompOp::Eq
}
}
}
#[cfg(test)]
mod tests {
use comp_op::CompOp;
use test::test_version::TEST_VERSIONS;
use test::test_version_set::TEST_VERSION_SETS;
use version::Version;
#[test]
fn as_str() {
// Test for each test version
for version in TEST_VERSIONS {
// The input version string must be the same as the returned string
assert_eq!(Version::from(&version.0).unwrap().as_str(), version.0);
}
}
#[test]
fn part_count() {
// Test for each test version
for version in TEST_VERSIONS {
// The number of parts must match the metadata
assert_eq!(Version::from(&version.0).unwrap().part_count(), version.1);
}
}
#[test]
fn compare() {
// Compare each version in the version set
for entry in TEST_VERSION_SETS {
// Get both versions
let version_a = Version::from(&entry.0).unwrap();
let version_b = Version::from(&entry.1).unwrap();
// Compare them
assert_eq!(
version_a.compare(&version_b),
entry.2.clone()
);
}
}
#[test]
fn compare_to() {
// Compare each version in the version set
for entry in TEST_VERSION_SETS {
// Get both versions
let version_a = Version::from(&entry.0).unwrap();
let version_b = Version::from(&entry.1).unwrap();
// Test
assert!(version_a.compare_to(&version_b, &entry.2));
// Make sure the inverse operator is not correct
assert_eq!(version_a.compare_to(&version_b, &entry.2.invert()), false);
}
// Assert an exceptional case, compare to not equal
assert!(
Version::from("1.2").unwrap().compare_to(
&Version::from("1.2.3").unwrap(),
&CompOp::Ne)
);
}
}