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
/*
* SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
* SPDX-License-Identifier: BSD-2-Clause
*/
//! Parse version strings and compare them.
//!
//! The [`Version`] struct may be used to break a version string down
//! into its separate components and then compare it to another one,
//! e.g. to decide whether a certain feature is really supported.
//!
//! ```rust
//! use std::cmp;
//! # use std::error::Error;
//!
//! use feature_check::version::Version;
//!
//! # fn main() -> Result<(), Box<dyn Error>> {
//! let v1: Version = "2.1".parse()?;
//! let v2: Version = "2.2.b2".parse()?;
//! println!("{v1} {res:?} {v2}", res = v1.cmp(&v2));
//! println!("equal? {res}", res = v1 == v2);
//! println!("smaller: {res}", res = cmp::min(&v1, &v2));
//! println!("larger: {res}", res = cmp::max(&v1, &v2));
//! println!("v1: {v1}");
//! for comp in &v1 {
//! println!(
//! "- {num}/{rest}",
//! num = match comp.num {
//! Some(value) => value.to_string(),
//! None => "(none)".to_string(),
//! },
//! rest = comp.rest,
//! );
//! }
//! println!("v2: {v2}");
//! for comp in v2.into_iter() {
//! println!(
//! "- {num}/{rest}",
//! num = match comp.num {
//! Some(value) => value.to_string(),
//! None => "(none)".to_string(),
//! },
//! rest = comp.rest,
//! );
//! }
//! # Ok(())
//! # }
//! ```
use std::cmp::Ordering;
use std::fmt::{Display, Formatter, Result as FmtResult};
use std::slice::Iter;
use std::str::FromStr;
use std::vec::IntoIter as VecIntoIter;
use anyhow::Error as AnyError;
use serde::Serialize;
use thiserror::Error;
use crate::expr::parser;
/// An error that occurred while parsing a version string.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ParseError {
/// A parser failed.
#[error("Could not parse '{0}' as a version string")]
ParseFailure(String, #[source] AnyError),
/// A parser left some bytes out.
#[error("Could not parse '{0}' as a version string: {1} bytes left over")]
ParseLeftovers(String, usize),
}
/// A single version component, e.g. "3" or "b2".
#[derive(Debug, Clone, Eq, PartialEq)]
#[non_exhaustive]
#[allow(clippy::module_name_repetitions)]
pub struct VersionComponent {
/// The numeric portion of the version component.
pub num: Option<u32>,
/// The freeform portion of the version component.
pub rest: String,
}
/// Compare two already-extracted version components.
fn compare_single(left: &VersionComponent, right: &VersionComponent) -> Ordering {
left.num.map_or_else(
|| {
if right.num.is_some() {
Ordering::Less
} else {
left.rest.cmp(&right.rest)
}
},
|ver_left| {
right.num.map_or(Ordering::Greater, |ver_right| {
let res = ver_left.cmp(&ver_right);
if res == Ordering::Equal {
left.rest.cmp(&right.rest)
} else {
res
}
})
},
)
}
/// Compare two lists of already-extracted version components.
fn compare_components(left: &[VersionComponent], right: &[VersionComponent]) -> Ordering {
left.split_first().map_or_else(
|| {
right.first().map_or(Ordering::Equal, |ver_right| {
if ver_right.num.is_some() {
Ordering::Less
} else {
Ordering::Greater
}
})
},
|(comp_left, rest_left)| {
right.split_first().map_or_else(
|| {
if comp_left.num.is_some() {
Ordering::Greater
} else {
Ordering::Less
}
},
|(comp_right, rest_right)| {
let res = compare_single(comp_left, comp_right);
if res == Ordering::Equal {
compare_components(rest_left, rest_right)
} else {
res
}
},
)
},
)
}
/// A version string, both in full and broken down into components.
#[derive(Debug, Clone, Serialize)]
#[serde(transparent)]
pub struct Version {
/// The full version string.
value: String,
/// The components of the version string.
#[serde(skip)]
components: Vec<VersionComponent>,
}
impl Version {
/// Create a version object with the specified attributes.
#[inline]
#[must_use]
pub fn new(value: String, components: Vec<VersionComponent>) -> Self {
Self { value, components }
}
/// Return an iterator over the version components.
#[inline]
pub fn iter(&self) -> Iter<'_, VersionComponent> {
self.components.iter()
}
}
impl FromStr for Version {
type Err = ParseError;
#[inline]
fn from_str(value: &str) -> Result<Self, Self::Err> {
parser::parse_version(value)
}
}
impl AsRef<str> for Version {
#[inline]
fn as_ref(&self) -> &str {
&self.value
}
}
impl Display for Version {
#[inline]
fn fmt(&self, fmt: &mut Formatter<'_>) -> FmtResult {
write!(fmt, "{}", self.as_ref())
}
}
impl PartialEq for Version {
#[inline]
fn eq(&self, other: &Self) -> bool {
self.cmp(other) == Ordering::Equal
}
}
impl Eq for Version {}
impl PartialOrd for Version {
#[inline]
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
impl Ord for Version {
#[inline]
fn cmp(&self, other: &Self) -> Ordering {
compare_components(&self.components, &other.components)
}
}
impl IntoIterator for Version {
type Item = VersionComponent;
type IntoIter = VecIntoIter<Self::Item>;
#[inline]
fn into_iter(self) -> Self::IntoIter {
self.components.into_iter()
}
}
impl<'data> IntoIterator for &'data Version {
type Item = &'data VersionComponent;
type IntoIter = Iter<'data, VersionComponent>;
#[inline]
fn into_iter(self) -> Self::IntoIter {
self.components.iter()
}
}
#[cfg(test)]
mod tests {
#![allow(clippy::default_numeric_fallback)]
#![allow(clippy::panic_in_result_fn)]
use std::error::Error;
#[test]
fn test_num_only() -> Result<(), Box<dyn Error>> {
let expected: [super::VersionComponent; 1] = [super::VersionComponent {
num: Some(616),
rest: String::new(),
}];
let ver: super::Version = "616".parse()?;
let components = ver.into_iter().collect::<Vec<_>>();
assert_eq!(&expected[..], &*components);
Ok(())
}
#[test]
fn test_rest_only() -> Result<(), Box<dyn Error>> {
let expected: [super::VersionComponent; 1] = [super::VersionComponent {
num: None,
rest: "whee".to_owned(),
}];
let ver: super::Version = "whee".parse()?;
let components = ver.into_iter().collect::<Vec<_>>();
assert_eq!(&expected[..], &*components);
Ok(())
}
#[test]
fn test_both() -> Result<(), Box<dyn Error>> {
let expected: [super::VersionComponent; 1] = [super::VersionComponent {
num: Some(29),
rest: "palms".to_owned(),
}];
let ver: super::Version = "29palms".parse()?;
let components = ver.into_iter().collect::<Vec<_>>();
assert_eq!(&expected[..], &*components);
Ok(())
}
#[test]
fn test_three() -> Result<(), Box<dyn Error>> {
let expected: [super::VersionComponent; 3] = [
super::VersionComponent {
num: Some(1),
rest: String::new(),
},
super::VersionComponent {
num: Some(5),
rest: "a".to_owned(),
},
super::VersionComponent {
num: None,
rest: "beta3".to_owned(),
},
];
// let ver = super::Version::from_str("1.5a2.beta3")?;
let ver: super::Version = "1.5a.beta3".parse()?;
let components = ver.into_iter().collect::<Vec<_>>();
assert_eq!(&expected[..], &*components);
Ok(())
}
}