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

//! SAM header reference sequence alternative names.

use std::{error, fmt, ops::Deref, str::FromStr};

const DELIMITER: char = ',';

/// SAM header reference sequence alternative names (`AN`).
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct AlternativeNames(Vec<String>);

impl Deref for AlternativeNames {
    type Target = [String];

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl fmt::Display for AlternativeNames {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        for (i, name) in self.iter().enumerate() {
            if i > 0 {
                write!(f, "{DELIMITER}")?;
            }

            write!(f, "{name}")?;
        }

        Ok(())
    }
}

/// An error returned when raw SAM header reference sequence alternative names fail to parse.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// The input is empty.
    Empty,
    /// The raw names has an invalid name.
    InvalidName(String),
}

impl error::Error for ParseError {}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Empty => f.write_str("empty input"),
            Self::InvalidName(s) => write!(f, "invalid name: {s}"),
        }
    }
}

impl FromStr for AlternativeNames {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        use crate::record::reference_sequence_name::is_valid_name;

        if s.is_empty() {
            return Err(ParseError::Empty);
        }

        s.split(DELIMITER)
            .map(|name| {
                if is_valid_name(name) {
                    Ok(name.into())
                } else {
                    Err(ParseError::InvalidName(name.into()))
                }
            })
            .collect::<Result<_, _>>()
            .map(Self)
    }
}

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

    #[test]
    fn test_fmt() {
        let alternative_names = AlternativeNames(vec![String::from("0")]);
        assert_eq!(alternative_names.to_string(), "0");

        let alternative_names = AlternativeNames(vec![String::from("0"), String::from("SQ.0")]);
        assert_eq!(alternative_names.to_string(), "0,SQ.0");
    }

    #[test]
    fn test_from_str() {
        assert_eq!("0".parse(), Ok(AlternativeNames(vec![String::from("0")])));
        assert_eq!(
            "0,SQ.0".parse(),
            Ok(AlternativeNames(vec![
                String::from("0"),
                String::from("SQ.0")
            ]))
        );

        assert_eq!("".parse::<AlternativeNames>(), Err(ParseError::Empty));
        assert_eq!(
            ",".parse::<AlternativeNames>(),
            Err(ParseError::InvalidName(String::from("")))
        );
        assert_eq!(
            "0,*".parse::<AlternativeNames>(),
            Err(ParseError::InvalidName(String::from("*")))
        );
    }
}