idid 0.1.2

Track, edit, and view what you did.
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
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
183
184
185
186
187
188

use chrono::NaiveDate;

#[derive(Debug)]
pub struct DateFilter {
    date_ranges: Vec<(NaiveDate, NaiveDate)>,
    dates: Vec<NaiveDate>,

    // The oldest and newest date from dates or date_ranges
    pub oldest_date: Option<NaiveDate>,
    pub newest_date: Option<NaiveDate>,
}

impl DateFilter {
    /// New DateFilter
    ///
    /// # Arguments
    /// * date_ranges - range in pairs, but pair ordering is not important
    /// * individual_dates - individual days
    ///
    /// # Returns
    /// A new DateFilter
    /// # Example
    ///
    /// use idid::date_filter::DateFilter;
    /// let range = [];
    /// let dates = [];
    /// let filter = DateFilter::new(&range, &dates);
    ///
    pub fn new(date_ranges: &[NaiveDate], individual_dates: &[NaiveDate]) -> Self {
        let mut oldest_date: Option<NaiveDate> = None;
        let mut newest_date: Option<NaiveDate> = None;

        // Process individual dates
        let sorted_individual_dates = {
            let mut sorting = individual_dates.to_vec();
            sorting.sort();
            sorting
        };
        // Get the oldest and newest so far
        if !sorted_individual_dates.is_empty() {
            oldest_date = sorted_individual_dates.first().cloned();
            newest_date = sorted_individual_dates.last().cloned();
        }

        let mut processed_ranges = Vec::new();
        if !date_ranges.is_empty() {
            for pair in date_ranges.chunks_exact(2) {
                let (start, end) = match pair {
                    [start, end] => (*start, *end),
                    _ => panic!("Invalid pair of dates"),
                };
                // Swap start and end if they are in the wrong order
                let (start, end) = if start > end {
                    (end, start)
                } else {
                    (start, end)
                };

                processed_ranges.push((start, end));
                newest_date = newest_date.map_or(Some(end), |newest| Some(newest.max(end)));
            }

            // Sort by the begin of each range
            processed_ranges.sort_by(|a, b| a.0.cmp(&b.0));

            // Once sorted the processed_ranges oldest is obvious
            if let Some((first_start, _)) = processed_ranges.first() {
                oldest_date = match oldest_date {
                    Some(current_oldest) if *first_start < current_oldest => Some(*first_start),
                    None => Some(*first_start),
                    _ => oldest_date,
                };
            }
        }
        Self {
            date_ranges: processed_ranges,
            dates: sorted_individual_dates,
            oldest_date,
            newest_date,
        }
    }

    /// Are there any dates or ranges
    pub fn is_empty(&self) -> bool {
        self.dates.is_empty() && self.date_ranges.is_empty()
    }

    /// Does the given date match any of the dates or date_ranges
    ///
    /// # Arguments
    /// * date - for comparison
    ///
    /// # Returns
    /// `bool` if the given date matches either one of the struct dates
    /// or is in any of the inclusive date ranges.
    pub fn contains(&self, date: &NaiveDate) -> bool {
        if let (Some(oldest), Some(newest)) = (self.oldest_date, self.newest_date) {
            if date < &oldest || &newest < date {
                return false;
            }
        }
        self.dates.contains(date)
            || self
                .date_ranges
                .iter()
                .any(|(begin, cease)| date >= begin && date <= cease)
    }
}

#[cfg(test)]
pub fn ymd(year: i32, month: u32, day: u32) -> NaiveDate {
    NaiveDate::from_ymd_opt(year, month, day).unwrap()
}

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

    #[test]
    fn test_filter_empty() {
        let range = [];
        let dates = [];

        let filter = DateFilter::new(&range, &dates);
        println!("Filter: {:#?}", filter);
        assert!(filter.date_ranges.is_empty());
        assert!(filter.dates.is_empty());
        assert_eq!(filter.oldest_date, None);
        assert_eq!(filter.newest_date, None);
        assert_eq!(
            filter.contains(&NaiveDate::from_ymd_opt(2024, 4, 1).unwrap()),
            false
        );
    }

    #[test]
    fn test_filter_only_dates() {
        let individual_dates = vec![ymd(2024, 3, 1), ymd(2024, 2, 1), ymd(2024, 4, 1)];
        let filter = DateFilter::new(&[], &individual_dates);
        assert_eq!(filter.contains(&ymd(2024, 3, 1)), true);
        assert_eq!(filter.contains(&ymd(2024, 1, 1)), false);
        assert_eq!(filter.oldest_date, filter.dates.first().cloned());
        assert_eq!(filter.newest_date, filter.dates.last().cloned());
    }

    #[test]
    fn test_filter_only_ranges() {
        let date_ranges = vec![
            ymd(2024, 3, 1),
            ymd(2024, 3, 10),
            ymd(2024, 1, 10),
            ymd(2024, 1, 1),
        ];
        let filter = DateFilter::new(&date_ranges, &[]);
        assert!(!filter.date_ranges.is_empty());

        let expected_oldest = filter.date_ranges.first().map(|(start, _)| *start);
        assert_eq!(filter.oldest_date, expected_oldest);

        let expected_newest = filter.date_ranges.last().map(|(_, end)| *end);
        assert_eq!(filter.newest_date, expected_newest);

        assert_eq!(filter.contains(&ymd(2024, 1, 1)), true);
        assert_eq!(filter.contains(&ymd(2024, 1, 10)), true);
        assert_eq!(filter.contains(&ymd(2024, 1, 5)), true);
        assert_eq!(filter.contains(&ymd(2024, 2, 1)), false);
    }

    #[test]
    fn test_filter_both_ranges_and_dates() {
        let date_ranges = vec![
            ymd(2024, 1, 1),
            ymd(2024, 1, 10),
            ymd(2024, 3, 1),
            ymd(2024, 3, 10),
        ];
        let individual_dates = vec![ymd(2024, 4, 1), ymd(2024, 2, 1), ymd(2024, 3, 15)];
        let filter = DateFilter::new(&date_ranges, &individual_dates);

        assert_eq!(filter.oldest_date, Some(ymd(2024, 1, 1)));
        assert_eq!(filter.newest_date, Some(ymd(2024, 4, 1)));

        assert_eq!(filter.contains(&ymd(2024, 1, 5)), true);
        assert_eq!(filter.contains(&ymd(2024, 1, 1)), true);
        assert_eq!(filter.contains(&ymd(2024, 1, 10)), true);
        assert_eq!(filter.contains(&ymd(2024, 6, 1)), false);
    }
}