iptmnet 1.10.0

A convenient CLI for the IPTMNet API
Documentation 
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

// iptmnet A CLI interface to the IPTMNet Rest API
// Copyright (C) 2022  Ali Sajid Imami
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

use std::fmt::{Display, Formatter, Result};

use serde_aux::prelude::*;

use serde::Deserialize;

/// # The Organism Struct
///
/// The `Organism` Struct encodes the representation of a given organism in the iptmnet
/// database.
///
/// It contains the same information as the one available in the iPTMNet API
///
/// ## Example:
///
/// ### Using the constructor method:
///```
/// use iptmlib::models::organism::Organism;
/// let organism_fun = Organism::new("Homo sapiens", "9606", "Human");
/// ```
#[derive(Clone, Debug, Eq, PartialEq, Deserialize)]
pub struct Organism {
    /// The Species of the organism.
    ///
    /// Example: "Homo sapiens"
    species: String,
    #[serde(deserialize_with = "deserialize_number_from_string")]
    /// The Taxon Code for the organism.
    ///
    /// This taxon code is the one that is assigned by InterPro/Uniprot.
    /// The list can be viewed at <http://www.ebi.ac.uk/interpro/taxonomy/uniprot>
    ///
    /// Example: 9606 for Homo sapiens
    taxon_code: u32,

    /// The common name of the organism, if it exists.
    ///
    /// This common name is pulled from the same InterPro/UniProt database.
    ///
    /// Example: Human
    common_name: String,
}

impl Display for Organism {
    fn fmt(&self, f: &mut Formatter) -> Result {
        write!(
            f,
            "{} - {} ({})",
            self.common_name, self.taxon_code, self.species
        )
    }
}

impl Organism {
    pub fn new(species: &str, taxon_code: &str, common_name: &str) -> Self {
        let taxon_code_parsed: u32 = taxon_code.parse().unwrap();
        Organism {
            species: species.to_string(),
            taxon_code: taxon_code_parsed,
            common_name: common_name.to_string(),
        }
    }

    pub fn common_name(&self) -> &str {
        self.common_name.as_ref()
    }

    pub fn taxon_code(&self) -> u32 {
        self.taxon_code
    }

    pub fn species(&self) -> &str {
        self.species.as_ref()
    }
}

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

    #[test]
    fn test_organism_initialization() {
        let org = Organism::new("Homo Sapiens", "9606", "Human");

        assert_eq!(org.species, "Homo Sapiens");
        assert_eq!(org.taxon_code, 9606);
        assert_eq!(org.common_name, "Human")
    }

    #[test]
    fn test_print() {
        let org = Organism::new("Homo Sapiens", "9606", "Human");

        assert_eq!(format!("{org}"), "Human - 9606 (Homo Sapiens)")
    }

    #[test]
    fn test_getters() {
        let org = Organism::new("Homo Sapiens", "9606", "Human");

        assert_eq!(org.species(), "Homo Sapiens");
        assert_eq!(org.taxon_code(), 9606);
        assert_eq!(org.common_name(), "Human")
    }
}