klirr-core 0.2.1

Zero-maintenance and smart FOSS generating beautiful invoices for services and expenses.
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

use crate::prelude::*;

/// The day of the month, e.g. 1 for the first day, 31 for the last day of a month.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Display, Serialize, Deserialize, Deref)]
pub struct Day(u8);

impl HasSample for Day {
    fn sample() -> Self {
        Self(1)
    }
    fn sample_other() -> Self {
        Self(15)
    }
}

impl std::str::FromStr for Day {
    type Err = crate::prelude::Error;

    /// Parses a day from a string, e.g. "1" for the first day, "31" for the last day of a month.
    /// # Errors
    /// Returns an error if the string is not a valid day or if it is out of range.
    /// # Examples
    /// ```
    /// extern crate klirr_core;
    /// use klirr_core::prelude::*;
    /// let day: Day = "15".parse().unwrap();
    /// assert_eq!(*day, 15);
    /// ```
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let day = s.parse::<i32>().map_err(|_| Error::InvalidDayFromString {
            invalid_string: s.to_string(),
            reason: "Invalid day format".to_string(),
        })?;
        Self::try_from(day)
    }
}

impl TryFrom<i32> for Day {
    type Error = crate::prelude::Error;
    fn try_from(day: i32) -> Result<Self> {
        if !(1..=31).contains(&day) {
            return Err(Error::InvalidDay {
                day,
                reason: "Day must be between 1 and 31".to_string(),
            });
        }
        Ok(Self(day as u8))
    }
}

impl TryFrom<u8> for Day {
    type Error = crate::prelude::Error;
    fn try_from(day: u8) -> Result<Self> {
        Self::try_from(day as i32)
    }
}

impl TryFrom<u32> for Day {
    type Error = crate::prelude::Error;
    fn try_from(day: u32) -> Result<Self> {
        Self::try_from(day as i32)
    }
}

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

    type Sut = Day;

    #[test]
    fn equality() {
        assert_eq!(Sut::sample(), Sut::sample());
        assert_eq!(Sut::sample_other(), Sut::sample_other());
    }

    #[test]
    fn inequality() {
        assert_ne!(Sut::sample(), Sut::sample_other());
    }

    #[test]
    fn test_day_conversion() {
        assert_eq!(Sut::try_from(1).unwrap(), Day(1));
        assert_eq!(Sut::try_from(15).unwrap(), Day(15));
        assert_eq!(Sut::try_from(31).unwrap(), Day(31));
        assert!(Sut::try_from(0).is_err());
        assert!(Sut::try_from(32).is_err());
    }

    #[test]
    fn test_day_from_str() {
        let day: Sut = "15".parse().unwrap();
        assert_eq!(day, Day(15));
    }

    #[test]
    fn test_day_from_invalid_all_reasons() {
        let invalid_strings = [
            "0",    // Invalid day (0)
            "32",   // Invalid day (greater than 31)
            "-1",   // Invalid day (negative)
            "abc",  // Invalid format (not a number)
            "15.5", // Invalid format (decimal)
        ];

        for &s in &invalid_strings {
            assert!(Sut::from_str(s).is_err(), "Expected error for input: {}", s);
        }
    }
}