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
//! Module for the version manifest.
//!
//! A version manifest can be used to configure and specify how versions are parsed and compared.
//! For example, you can configure the maximum depth of a version number, and set whether text
//! parts are ignored in a version string.
/// Version manifest (configuration).
///
/// A manifest (configuration) that is used respectively when parsing and comparing version strings.
#[derive(Debug, PartialEq)]
pub struct VersionManifest {
/// The maximum depth of a version number. This specifies the maximum number of parts.
max_depth: Option<usize>,
/// True to ignore text parts in version strings.
ignore_text: bool,
}
/// Version manifest implementation.
impl VersionManifest {
/// Constructor.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let mut manifest = VersionManifest::new();
///
/// // Ignore text parts
/// manifest.set_ignore_text(true);
/// ```
pub fn new() -> Self {
VersionManifest {
max_depth: None,
ignore_text: false,
}
}
/// The maximum depth of a version number.
/// None if no depth is configured.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let manifest = VersionManifest::new();
///
/// match manifest.max_depth() {
/// &Some(depth) => println!("Maximum depth of {}", depth),
/// &None => println!("No maximum depth")
/// }
/// ```
pub fn max_depth(&self) -> &Option<usize> {
&self.max_depth
}
/// The maximum depth of a version number as numerical value.
/// Zero is returned if no depth is configured.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let manifest = VersionManifest::new();
///
/// println!("Maximum depth of {}", manifest.max_depth_number());
/// ```
pub fn max_depth_number(&self) -> usize {
if self.max_depth.is_some() {
self.max_depth.unwrap()
} else {
0
}
}
/// Set the maximum depth of a version number.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let mut manifest = VersionManifest::new();
///
/// // Set the maximum depth to 3
/// manifest.set_max_depth(Some(3));
///
/// // Don't use a maximum depth
/// manifest.set_max_depth(None);
/// ```
pub fn set_max_depth(&mut self, max_depth: Option<usize>) {
if max_depth.is_some() && max_depth.unwrap() > 0 {
self.max_depth = max_depth;
} else {
self.max_depth = None;
}
}
/// Set the maximum depth of a version number.
/// Use zero to disable the maximum depth.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let mut manifest = VersionManifest::new();
///
/// // Set the maximum depth to 3
/// manifest.set_max_depth_number(3);
///
/// // Don't use a maximum depth
/// manifest.set_max_depth_number(0);
/// ```
pub fn set_max_depth_number(&mut self, max_depth: usize) {
if max_depth > 0 {
self.max_depth = Some(max_depth);
} else {
self.max_depth = None;
}
}
/// Check whether there's a maximum configured depth.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let mut manifest = VersionManifest::new();
///
/// assert!(!manifest.has_max_depth());
///
/// manifest.set_max_depth(Some(3));
/// assert!(manifest.has_max_depth());
/// ```
pub fn has_max_depth(&self) -> bool {
self.max_depth.is_some() && self.max_depth.unwrap() > 0
}
/// Check whether to ignore text parts in version numbers.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let manifest = VersionManifest::new();
///
/// if manifest.ignore_text() {
/// println!("Text parts are ignored");
/// } else {
/// println!("Text parts are not ignored");
/// }
/// ```
pub fn ignore_text(&self) -> bool {
self.ignore_text
}
/// Set whether to ignore text parts.
///
/// # Examples
///
/// ```
/// use version_compare::VersionManifest;
///
/// let mut manifest = VersionManifest::new();
///
/// // Ignore text parts
/// manifest.set_ignore_text(true);
///
/// // Don't ignore text parts
/// manifest.set_ignore_text(false);
/// ```
pub fn set_ignore_text(&mut self, ignore_text: bool) {
self.ignore_text = ignore_text;
}
}
#[cfg_attr(tarpaulin, skip)]
#[cfg(test)]
mod tests {
use crate::version_manifest::VersionManifest;
#[test]
fn max_depth() {
let mut manifest = VersionManifest::new();
manifest.max_depth = Some(1);
assert_eq!(manifest.max_depth(), &Some(1));
manifest.max_depth = Some(3);
assert_eq!(manifest.max_depth(), &Some(3));
manifest.max_depth = None;
assert_eq!(manifest.max_depth(), &None);
}
#[test]
fn max_depth_number() {
let mut manifest = VersionManifest::new();
manifest.max_depth = Some(1);
assert_eq!(manifest.max_depth_number(), 1);
manifest.max_depth = Some(3);
assert_eq!(manifest.max_depth_number(), 3);
manifest.max_depth = None;
assert_eq!(manifest.max_depth_number(), 0);
}
#[test]
fn set_max_depth() {
let mut manifest = VersionManifest::new();
manifest.set_max_depth(Some(1));
assert_eq!(manifest.max_depth, Some(1));
manifest.set_max_depth(Some(3));
assert_eq!(manifest.max_depth, Some(3));
manifest.set_max_depth(Some(0));
assert_eq!(manifest.max_depth, None);
manifest.set_max_depth(None);
assert_eq!(manifest.max_depth, None);
}
#[test]
fn set_max_depth_number() {
let mut manifest = VersionManifest::new();
manifest.set_max_depth_number(1);
assert_eq!(manifest.max_depth, Some(1));
manifest.set_max_depth_number(3);
assert_eq!(manifest.max_depth, Some(3));
manifest.set_max_depth_number(0);
assert_eq!(manifest.max_depth, None);
}
#[test]
fn has_max_depth() {
let mut manifest = VersionManifest::new();
manifest.max_depth = Some(1);
assert!(manifest.has_max_depth());
manifest.max_depth = Some(3);
assert!(manifest.has_max_depth());
manifest.max_depth = None;
assert!(!manifest.has_max_depth());
}
#[test]
fn ignore_text() {
let mut manifest = VersionManifest::new();
manifest.ignore_text = true;
assert!(manifest.ignore_text());
manifest.ignore_text = false;
assert!(!manifest.ignore_text());
}
#[test]
fn set_ignore_text() {
let mut manifest = VersionManifest::new();
manifest.set_ignore_text(true);
assert!(manifest.ignore_text);
manifest.set_ignore_text(false);
assert!(!manifest.ignore_text);
}
}