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

/// An instance of a Fastx Record.
/// This is a two attribute object containing the sequence
/// ID and the Sequence.
#[derive(Debug)]
pub struct Record {
    id: String,
    seq: String
}
impl Record {

    /// # Usage
    /// Creates a new instance of a `[Record]`
    /// ```
    /// let record = fxread::Record::new();
    /// assert!(record.empty());
    /// ```
    pub fn new() -> Self {
        Self {
            id: String::new(),
            seq: String::new()
        }
    }

    /// Checks if `[Record]` is empty
    pub fn empty(&self) -> bool {
        self.id.is_empty() | self.seq.is_empty()
    }

    /// # Usage
    /// Sets the ID of the record
    /// ```
    /// let mut record = fxread::Record::new();
    /// record.set_id("some_id".to_string());
    /// assert_eq!(record.id(), "some_id");
    /// ```
    pub fn set_id(&mut self, token: String) {
        self.id = token;
    }

    /// # Usage
    /// Sets the Sequence of the record
    /// ```
    /// let mut record = fxread::Record::new();
    /// record.set_seq("ACGT".to_string());
    /// assert_eq!(record.seq(), "ACGT");
    /// ```
    pub fn set_seq(&mut self, token: String) {
        self.seq = token;
    }

    /// Returns a reference of the sequence ID
    pub fn id(&self) -> &str {
        &self.id
    }

    /// Returns a reference of the sequence 
    pub fn seq(&self) -> &str {
        &self.seq
    }

    /// Validates that the record is not partially constructed
    /// or composed of unexpected nucleotides
    pub fn valid(&self) -> bool {
        !self.empty() & self.valid_sequence()
    }

    /// Converts the sequence to uppercase
    pub fn seq_upper(&self) -> String {
        self.seq.to_ascii_uppercase()
    }

    /// Validates whether sequence is composed
    /// of valid nucleotides
    fn valid_sequence(&self) -> bool {
        self.seq.chars().all(|c| match c {
            'A'|'a'|'C'|'c'|'G'|'g'|'T'|'t'|'N'|'n'|'U'|'u' => true,
            _ => false
        })
    }

}

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

    #[test]
    fn create() {
        let record = Record::new();
        assert!(record.empty());
        assert!(!record.valid());
    }

    #[test]
    fn create_partial_id() {
        let mut record = Record::new();
        record.set_id(String::from("some_id"));
        assert!(record.empty());
        assert!(!record.valid());
    }

    #[test]
    fn create_partial_seq() {
        let mut record = Record::new();
        record.set_seq(String::from("ACGT"));
        assert!(record.empty());
        assert!(!record.valid());
    }

    #[test]
    fn valid() {
        let mut record = Record::new();
        record.set_id(String::from("some_id"));
        record.set_seq(String::from("ACGT"));
        assert!(!record.empty());
        assert!(record.valid());
    }

    #[test]
    fn invalid() {
        let mut record = Record::new();
        record.set_id(String::from("some_id"));
        record.set_seq(String::from("BCGT"));
        assert!(!record.empty());
        assert!(!record.valid());
    }

    #[test]
    fn valid_lowercase() {
        let mut record = Record::new();
        record.set_id(String::from("some_id"));
        record.set_seq(String::from("acgt"));
        assert!(!record.empty());
        assert!(record.valid());
    }

    #[test]
    fn invalid_lowercase() {
        let mut record = Record::new();
        record.set_id(String::from("some_id"));
        record.set_seq(String::from("bcgt"));
        assert!(!record.empty());
        assert!(!record.valid());
    }

    #[test]
    fn upper_conversion() {
        let mut record = Record::new();
        record.set_seq(String::from("acgt"));
        assert_eq!(record.seq_upper(), String::from("ACGT"));
    }
}