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

use super::*;

/// A representation of a Cron Expression.
#[derive(Debug)]
pub struct CronExpression {
    fields: [CronField; Self::FIELD_COUNT],
}

impl Display for CronExpression {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), std::fmt::Error> { 
        write!(formatter, "{} {} {} {} {}", 
            &self.fields[0],
            &self.fields[1],
            &self.fields[2],
            &self.fields[3],
            &self.fields[4])?;
        Ok(())
    }
}

impl FromStr for CronExpression {
    type Err = CronParsingError;

    fn from_str(string: &str) -> Result<Self, Self::Err> { 
        CronExpression::parse::<CurdsCronParser>(string)
    }
}

impl CronExpression {
    const FIELD_COUNT : usize = 5;
    const FIELD_DELIMITER : char = ' ';

    fn parse<TFieldParser>(expression: &str) -> Result<CronExpression, CronParsingError>
    where TFieldParser : CronFieldParser {
        let parts: Vec<&str> = expression
            .split(Self::FIELD_DELIMITER)
            .filter(|part| part.len() > 0)
            .collect();
        if parts.len() != Self::FIELD_COUNT {
            return Err(CronParsingError::FieldCount { 
                expression: expression.to_owned(),
                parts: parts.len()
            });
        }
        Ok(CronExpression { 
            fields : [   
                TFieldParser::parse(CronDatePart::Minutes, parts[0])?,
                TFieldParser::parse(CronDatePart::Hours, parts[1])?,
                TFieldParser::parse(CronDatePart::DayOfMonth, parts[2])?,
                TFieldParser::parse(CronDatePart::Month, parts[3])?,
                TFieldParser::parse(CronDatePart::DayOfWeek, parts[4])?,
            ]
        })
    }

    /// Test whether the current CronExpression is a match for a given DateTime.
    /// ```
    /// use chrono::{DateTime, Utc};
    /// use curds_cron::CronExpression;
    /// let test_expression = "25 * * * *".parse::<CronExpression>()?;
    /// assert_eq!(false, test_expression.is_match(&"2021-04-01T00:00:00Z".parse::<DateTime<Utc>>()?));
    /// assert_eq!(true, test_expression.is_match(&"2021-04-01T00:25:00Z".parse::<DateTime<Utc>>()?));
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn is_match<Tz>(&self, datetime: &DateTime<Tz>) -> bool 
    where Tz: TimeZone {
        for field in &self.fields {
            if !field.is_match(datetime) {
                return false;
            }
        }
        true
    }
}

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

    #[test]
    fn displays_fields() {
        let test_object = CronExpression {
            fields: [
                CronField::new(CronDatePart::Hours, vec![CronValue::Any]),
                CronField::new(CronDatePart::Hours, vec![CronValue::Any]),
                CronField::new(CronDatePart::Hours, vec![CronValue::Any]),
                CronField::new(CronDatePart::Hours, vec![CronValue::Any]),
                CronField::new(CronDatePart::Hours, vec![CronValue::Any]),
            ],
        };

        assert_eq!("* * * * *", &format!("{}", test_object));
    }

    #[test]
    fn too_long_expression_fails() {
        CronExpression::parse::<CurdsCronParser>("* * * * * *")
            .expect_err("Expected a long expression to fail");
    }

    #[test]
    fn too_short_expression_fails() {
        CronExpression::parse::<CurdsCronParser>("* * * *")
            .expect_err("Expected a short expression to fail");
    }

    macro_rules! expect_parsing {
        ($context:expr, $sequence:expr => ($($expected_part:expr, $expected_value:expr),+)) => {
            $(
                $context
                    .expect()
                    .with(predicate::eq($expected_part), predicate::eq($expected_value))
                    .times(1)
                    .in_sequence(&mut $sequence)
                    .returning(|_, _| {
                        Ok(CronField::new($expected_part, Vec::<CronValue>::new()))
                    });
            )+
        };
    }

    #[test]
    fn parses_correctly_with_parser() -> Result<(), CronParsingError> {
        let mut sequence = Sequence::new();
        let context = MockCronFieldParser::parse_context();
        expect_parsing! { context, sequence =>
            (
                CronDatePart::Minutes, "Minutes",
                CronDatePart::Hours, "Hours",
                CronDatePart::DayOfMonth, "DayOfMonth",
                CronDatePart::Month, "Month",
                CronDatePart::DayOfWeek, "DayOfWeek"
            )
        }

        CronExpression::parse::<MockCronFieldParser>("Minutes Hours DayOfMonth Month DayOfWeek")?;
        Ok(())
    }

    fn false_field() -> CronField { 
        CronField::new(CronDatePart::Minutes, vec![CronValue::Single(99)]) 
    }
    fn true_field() -> CronField { 
        CronField::new(CronDatePart::Minutes, vec![CronValue::Any])
    }

    #[test]
    fn any_nonmatch_field_returns_false() {
        let expression = CronExpression {
            fields: [true_field(), false_field(), true_field(), true_field(), true_field()]
        };

        assert_eq!(false, expression.is_match(&Utc::now()));
    }

    #[test]
    fn all_fields_match_returns_true() {
        let expression = CronExpression {
            fields: [true_field(), true_field(), true_field(), true_field(), true_field()]
        };

        assert_eq!(true, expression.is_match(&Utc::now()));
    }
}