summaryrefslogtreecommitdiff
path: root/backend/core/src/models/date_time_utc.rs
blob: d59d8f41c4ae6dc6eee3b6d0a8c9a9bf6e66c95d (plain)
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
use anyhow::{Error, Result};
use chrono::{DateTime, Datelike, Utc};
use diesel::{
    backend::Backend,
    deserialize::{self, FromSql, FromSqlRow},
    expression::AsExpression,
    serialize::{self, ToSql},
    sql_types::Text,
    sqlite::Sqlite,
};
use serde::{Deserialize, Serialize};

#[derive(
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Serialize,
    Deserialize,
    Clone,
    Debug,
    AsExpression,
    FromSqlRow,
)]
#[diesel(sql_type=Text)]
pub struct DateTimeUtc {
    chrono_datetime_utc: DateTime<Utc>,
}

impl DateTimeUtc {
    pub fn day_diff(&self, other: &DateTimeUtc) -> u32 {
        self.chrono_datetime_utc
            .num_days_from_ce()
            .abs_diff(other.chrono_datetime_utc.num_days_from_ce())
    }

    pub fn new(chrono_datetime_utc: &DateTime<Utc>) -> Self {
        Self {
            chrono_datetime_utc: chrono_datetime_utc.clone(),
        }
    }

    pub fn now() -> Self {
        Self::new(&Utc::now())
    }

    /// Constructs DateTimeUtc from a day string, YYYY-MM-DD, in UTC
    /// Example: "2024-10-24" -> Midnight 24 Oct 2024 UTC
    pub fn from_day_str(day_str: &str) -> Result<Self> {
        if !Self::is_day_str(day_str) {
            Err(Error::msg(format!("{} is not a day string in YYYY-MM-DD format", day_str)))
        } else {
            let mut date_str = String::from(day_str);
            date_str.push_str("T00:00:00.000Z");
            Ok(Self::from_date_str(&date_str)?)
        }
    }

    /// Constructs DateTimeUtc from a date string in ISO format, in UTC
    /// Example: "2024-10-24T10:30:00.000" -> 10.30am 24 Oct 2024 UTC
    pub fn from_date_str(date_time_utc: &str) -> Result<Self> {
        let chrono_datetime_utc = date_time_utc.parse::<DateTime<Utc>>()?;
        Ok(Self {
            chrono_datetime_utc,
        })
    }

    /// Converts to a day string, YYYY-MM-DD, in UTC
    /// Example: 10.30am 24 Oct 2024 UTC -> "2024-10-24"
    pub fn to_day_str(&self) -> String {
        let date_str = self.to_date_str();
        let day_str = date_str
            .split_at_checked(10)
            .unwrap()
            .0;
        String::from(day_str)
    }

    /// Converts to a date string in ISO format, in UTC
    /// Example: 10.30am 24 Oct 2024 UTC -> "2024-10-24T10:30:00.000Z"
    pub fn to_date_str(&self) -> String {
        self.chrono_datetime_utc.to_rfc3339()
    }


    fn is_day_str(str: &str) -> bool {
        if str.len() != 10 {
            return false;
        }
        for (ix, ch) in str.chars().enumerate() {
            if ix == 4 || ix == 7 {
                if ch != '-' {
                    return false;
                }
            } else {
                if ch < '0' || ch > '9' {
                    return false;
                }
            }
        }
        return true;
    }
}

impl ToSql<Text, Sqlite> for DateTimeUtc {
    fn to_sql<'b>(
        &'b self,
        out: &mut diesel::serialize::Output<'b, '_, Sqlite>,
    ) -> serialize::Result {
        out.set_value(self.to_date_str());
        Ok(serialize::IsNull::No)
    }
}

impl FromSql<Text, Sqlite> for DateTimeUtc {
    fn from_sql(bytes: <Sqlite as Backend>::RawValue<'_>) -> deserialize::Result<DateTimeUtc> {
        let str = <String as FromSql<Text, Sqlite>>::from_sql(bytes)?;
        Ok(Self::from_date_str(&str)?)
    }
}

#[cfg(test)]
mod test {
    use chrono::TimeZone;

    use super::*;

    #[test]
    fn given_midnight_when_day_diff_next_midnight_less_1s_then_return_0() {
        let start = DateTimeUtc::new(&Utc.with_ymd_and_hms(2000, 1, 1, 0, 0, 0).unwrap().to_utc());
        let end = DateTimeUtc::new(
            &Utc.with_ymd_and_hms(2000, 1, 1, 23, 59, 59)
                .unwrap()
                .to_utc(),
        );

        let day_diff = start.day_diff(&end);
        let neg_day_diff = end.day_diff(&start);

        assert_eq!(day_diff, 0);
        assert_eq!(day_diff, neg_day_diff);
    }

    #[test]
    fn given_midnight_when_day_diff_next_midnight_then_return_1() {
        let start = DateTimeUtc::new(&Utc.with_ymd_and_hms(2000, 1, 1, 0, 0, 0).unwrap().to_utc());
        let end = DateTimeUtc::new(&Utc.with_ymd_and_hms(2000, 1, 2, 0, 0, 0).unwrap().to_utc());

        let day_diff = start.day_diff(&end);
        let neg_day_diff = end.day_diff(&start);

        assert_eq!(day_diff, 1);
        assert_eq!(day_diff, neg_day_diff);
    }

    #[test]
    fn given_midnight_less_1s_when_day_diff_midnight_then_return_1() {
        let start = DateTimeUtc::new(
            &Utc.with_ymd_and_hms(2000, 1, 1, 23, 59, 59)
                .unwrap()
                .to_utc(),
        );
        let end = DateTimeUtc::new(&Utc.with_ymd_and_hms(2000, 1, 2, 0, 0, 0).unwrap().to_utc());

        let day_diff = start.day_diff(&end);
        let neg_day_diff = end.day_diff(&start);

        assert_eq!(day_diff, 1);
        assert_eq!(day_diff, neg_day_diff);
    }

    #[test]
    fn given_23_nov_1970_when_to_day_str_then_return_iso_day_str() {
        let date_time_utc = DateTimeUtc::new(
            &Utc.with_ymd_and_hms(1970, 11, 23, 0, 0, 0)
                .unwrap()
                .to_utc(),
        );

        assert_eq!(date_time_utc.to_day_str(), "1970-11-23");
    }
}