Project Chimera
Меню

Исходники

121 строк · 6 КиБ

code/crates/chl-selfupdate/src/version.rs

1//! Сравнение версий лаунчера.
2//!
3//! Ровно то, что нужно, и ничего сверх: версия этого проекта — три числа
4//! через точку (`0.1.0`, `version.workspace` в `code/Cargo.toml`). Тянуть
5//! ради этого крейт `semver` со суффиксами предрелизов и метаданными сборки
6//! было бы платой за формат, которого проект не использует; зато отказ на
7//! непонятной строке здесь явный, а не «вроде меньше».
8
9use anyhow::{Result, bail};
10
11/// Версия как набор чисел. Хранится списком, а не тройкой: `0.2` и `0.2.0`
12/// должны сравняться, а не разойтись из-за длины записи.
13#[derive(Debug, Clone, PartialEq, Eq)]
14pub struct Version(Vec<u64>);
15
16impl Version {
17 pub fn parse(text: &str) -> Result<Self> {
18 let text = text.trim();
19 if text.is_empty() {
20 bail!("пустая версия");
21 }
22 let mut parts = Vec::new();
23 for p in text.split('.') {
24 let n: u64 = p
25 .parse()
26 .map_err(|_| anyhow::anyhow!("версия {text:?} — не числа через точку"))?;
27 parts.push(n);
28 }
29 // Хвостовые нули отбрасываются здесь, при разборе, а не учитываются
30 // при сравнении. Иначе выведенный `PartialEq` (по списку) и `Ord`
31 // (с добиванием нулями) разошлись бы: `0.2` было бы «не равно»
32 // `0.2.0` для `==` и «равно» для `cmp` — нарушение контракта `Ord`,
33 // из которого потом растут неповторимые баги в сортировках и
34 // множествах.
35 while parts.len() > 1 && parts.last() == Some(&0) {
36 parts.pop();
37 }
38 Ok(Self(parts))
39 }
40
41 /// Число на позиции `i`, отсутствующее считается нулём — это и делает
42 /// `0.2` равным `0.2.0`.
43 fn at(&self, i: usize) -> u64 {
44 self.0.get(i).copied().unwrap_or(0)
45 }
46}
47
48impl PartialOrd for Version {
49 fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
50 Some(self.cmp(other))
51 }
52}
53
54impl Ord for Version {
55 fn cmp(&self, other: &Self) -> std::cmp::Ordering {
56 let n = self.0.len().max(other.0.len());
57 for i in 0..n {
58 match self.at(i).cmp(&other.at(i)) {
59 std::cmp::Ordering::Equal => continue,
60 other => return other,
61 }
62 }
63 std::cmp::Ordering::Equal
64 }
65}
66
67/// Строго новее ли `candidate`, чем `current`.
68///
69/// Возвращает ошибку, а не `false`, если любая из строк не разбирается:
70/// «манифест сообщил версию, которую мы не понимаем» — это повод сказать об
71/// этом вслух, а не молча решить, что обновляться не надо. Молчаливое
72/// `false` здесь означало бы лаунчер, который перестал обновляться и не
73/// объяснил почему.
74pub fn is_newer(current: &str, candidate: &str) -> Result<bool> {
75 Ok(Version::parse(candidate)? > Version::parse(current)?)
76}
77
78#[cfg(test)]
79mod tests {
80 use super::*;
81
82 #[test]
83 fn патч_новее_предыдущего() {
84 assert!(is_newer("0.1.0", "0.1.1").unwrap());
85 assert!(!is_newer("0.1.1", "0.1.0").unwrap());
86 }
87
88 #[test]
89 fn минор_сравнивается_числом_а_не_строкой() {
90 // Строковое сравнение сказало бы, что "0.9.0" больше "0.10.0", —
91 // самая частая ошибка в самодельных сравнениях версий.
92 assert!(is_newer("0.9.0", "0.10.0").unwrap());
93 assert!(!is_newer("0.10.0", "0.9.0").unwrap());
94 }
95
96 #[test]
97 fn та_же_версия_не_новее() {
98 assert!(!is_newer("0.1.0", "0.1.0").unwrap());
99 }
100
101 #[test]
102 fn короткая_запись_равна_дополненной_нулями() {
103 assert_eq!(Version::parse("0.2").unwrap(), Version::parse("0.2.0").unwrap());
104 assert!(!is_newer("0.2.0", "0.2").unwrap());
105 assert!(is_newer("0.2", "0.2.1").unwrap());
106 }
107
108 #[test]
109 fn непонятная_версия_даёт_ошибку_а_не_false() {
110 assert!(is_newer("0.1.0", "две тысячи двадцать шесть").is_err());
111 assert!(is_newer("не версия", "0.1.0").is_err());
112 assert!(is_newer("0.1.0", "").is_err());
113 assert!(is_newer("0.1.0", "1.0.0-rc1").is_err(), "суффиксы этот проект не использует");
114 }
115
116 #[test]
117 fn пробелы_вокруг_не_мешают() {
118 assert!(is_newer(" 0.1.0 ", " 0.2.0\n").unwrap());
119 }
120}
121