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

//! SAM header header version.

use std::{error, fmt, num, str::FromStr};

const MAJOR_VERSION: u32 = 1;
const MINOR_VERSION: u32 = 6;

const DELIMITER: char = '.';

/// A SAM header header version (`VN`).
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub struct Version {
    major: u32,
    minor: u32,
}

impl Version {
    /// Creates a new version.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_sam::header::record::value::map::header::Version;
    /// let version = Version::new(1, 6);
    /// ```
    pub const fn new(major: u32, minor: u32) -> Self {
        Self { major, minor }
    }

    /// Returns the major version.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_sam::header::record::value::map::header::Version;
    /// let version = Version::new(1, 6);
    /// assert_eq!(version.major(), 1);
    /// ```
    pub const fn major(&self) -> u32 {
        self.major
    }

    /// Returns the minor version.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_sam::header::record::value::map::header::Version;
    /// let version = Version::new(1, 6);
    /// assert_eq!(version.minor(), 6);
    /// ```
    pub const fn minor(&self) -> u32 {
        self.minor
    }
}

impl Default for Version {
    fn default() -> Self {
        Self::new(MAJOR_VERSION, MINOR_VERSION)
    }
}

impl fmt::Display for Version {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}{}{}", self.major(), DELIMITER, self.minor())
    }
}

/// An error returned when a raw SAM header header version fails to parse.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// The input is empty.
    Empty,
    /// The input is invalid.
    Invalid,
    /// The major version is invalid.
    InvalidMajorVersion(num::ParseIntError),
    /// The minor version is invalid.
    InvalidMinorVersion(num::ParseIntError),
}

impl error::Error for ParseError {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            Self::InvalidMajorVersion(e) | Self::InvalidMinorVersion(e) => Some(e),
            _ => None,
        }
    }
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Empty => f.write_str("empty input"),
            Self::Invalid => f.write_str("invalid input"),
            Self::InvalidMajorVersion(_) => f.write_str("invalid major version"),
            Self::InvalidMinorVersion(_) => f.write_str("invalid minor version"),
        }
    }
}

impl FromStr for Version {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if s.is_empty() {
            return Err(ParseError::Empty);
        }

        match s.split_once(DELIMITER) {
            Some((a, b)) => {
                let major = a.parse().map_err(ParseError::InvalidMajorVersion)?;
                let minor = b.parse().map_err(ParseError::InvalidMinorVersion)?;
                Ok(Self::new(major, minor))
            }
            None => Err(ParseError::Invalid),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default() {
        let version = Version::default();
        assert_eq!(version, Version::new(MAJOR_VERSION, MINOR_VERSION));
    }

    #[test]
    fn test_fmt() {
        let version = Version::new(1, 6);
        assert_eq!(version.to_string(), "1.6");
    }

    #[test]
    fn test_from_str() {
        assert_eq!("1.6".parse(), Ok(Version::new(1, 6)));

        assert_eq!("".parse::<Version>(), Err(ParseError::Empty));
        assert_eq!("1".parse::<Version>(), Err(ParseError::Invalid));

        assert!(matches!(
            ".".parse::<Version>(),
            Err(ParseError::InvalidMajorVersion(_))
        ));

        assert!(matches!(
            "x.6".parse::<Version>(),
            Err(ParseError::InvalidMajorVersion(_))
        ));

        assert!(matches!(
            "1.x".parse::<Version>(),
            Err(ParseError::InvalidMinorVersion(_))
        ));

        assert!(matches!(
            "1.6.1".parse::<Version>(),
            Err(ParseError::InvalidMinorVersion(_))
        ));
    }
}