Implementing Calendar logic
This commit is contained in:
1904
Cargo.lock
generated
Normal file
1904
Cargo.lock
generated
Normal file
File diff suppressed because it is too large
Load Diff
@@ -6,3 +6,9 @@ edition = "2021"
|
|||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
chrono = { version = "0.4", features = ["serde"] }
|
||||||
|
actix-web = "3"
|
||||||
|
crossbeam = "0.8"
|
||||||
|
pam = "0.7"
|
||||||
|
serde = { version = "1.0", features = ["derive"] }
|
||||||
|
serde_json = "1.0"
|
||||||
|
|||||||
24
README.md
24
README.md
@@ -27,10 +27,10 @@ Calendars consist of:
|
|||||||
- YYYY-MM-DD
|
- YYYY-MM-DD
|
||||||
- Add a specific date to a calendar's exclusion list
|
- Add a specific date to a calendar's exclusion list
|
||||||
- Month and Day
|
- Month and Day
|
||||||
- Month, Day of week, and Number (e.g. 2nd Friday)
|
- Month, Day of week, and an offset (e.g. 2nd Friday)
|
||||||
- Number can be relative, so 1 is first, -1 is last
|
- Number can be relative, so 1 is first, -1 is last
|
||||||
- Optional `description`
|
- Optional `description`
|
||||||
- Optional `observed` attribute that is `next`, `prev`, `closest`, `none` (default)
|
- Optional `observed` attribute that is `Next`, `Prev`, `Closest`, `NoAdjustment` (default)
|
||||||
that is in the day of week mask and not also a holiday
|
that is in the day of week mask and not also a holiday
|
||||||
- A public flag, which if true will make the calendar publicly available
|
- A public flag, which if true will make the calendar publicly available
|
||||||
- A name, which can contain letters, numbers, dashes, and underscores
|
- A name, which can contain letters, numbers, dashes, and underscores
|
||||||
@@ -86,8 +86,8 @@ A JSON definition for a calendar looks as follows:
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"month": "January",
|
"month": "January",
|
||||||
"dow": "M",
|
"dow": ["Mon"],
|
||||||
"-1",
|
"offset": "-1",
|
||||||
"observed": "closest",
|
"observed": "closest",
|
||||||
"description": "Final Monday Margarita Day"
|
"description": "Final Monday Margarita Day"
|
||||||
},
|
},
|
||||||
@@ -148,13 +148,15 @@ By default, Jobs are run as the user that submitted them.
|
|||||||
"description": "Description of job",
|
"description": "Description of job",
|
||||||
"calendar": "US Holidays",
|
"calendar": "US Holidays",
|
||||||
"timezone": "Atlantic/Reykjavik",
|
"timezone": "Atlantic/Reykjavik",
|
||||||
"schedule": {
|
"schedules": [
|
||||||
"start": {
|
{
|
||||||
"minute": "5",
|
"start": {
|
||||||
"hour": "*",
|
"minute": "5",
|
||||||
},
|
"hour": "*",
|
||||||
"frequency": "15m"
|
},
|
||||||
},
|
"frequency": "15m"
|
||||||
|
}
|
||||||
|
],
|
||||||
"command": {
|
"command": {
|
||||||
},
|
},
|
||||||
"environment": {
|
"environment": {
|
||||||
|
|||||||
309
src/calendar.rs
Normal file
309
src/calendar.rs
Normal file
@@ -0,0 +1,309 @@
|
|||||||
|
use chrono::naive::NaiveDate;
|
||||||
|
use chrono::{Datelike, Month, Weekday};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use std::collections::HashSet;
|
||||||
|
|
||||||
|
/*
|
||||||
|
There are a few gaping holes here, and some deficiencies:
|
||||||
|
|
||||||
|
- Holidays are only calculated within a year. If a holiday in a prior
|
||||||
|
year is bumped to the next year, it won't be considered.
|
||||||
|
- Holiday impact is searched forward. If there is a mix of AdjustmentPolicy's
|
||||||
|
then some weird stuff can happen (Holidays occur A, B, but end up getting
|
||||||
|
observed B, A)
|
||||||
|
- No support for holiday ranges (e.g. Golden Week)
|
||||||
|
*/
|
||||||
|
|
||||||
|
#[derive(Copy, Clone, Serialize, Deserialize, Debug)]
|
||||||
|
enum AdjustmentPolicy {
|
||||||
|
Prev,
|
||||||
|
Next,
|
||||||
|
Closest,
|
||||||
|
NoAdjustment,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Serialize, Deserialize, Debug)]
|
||||||
|
enum DateSpec {
|
||||||
|
SpecificDate {
|
||||||
|
date: NaiveDate,
|
||||||
|
description: String,
|
||||||
|
},
|
||||||
|
MonthDay {
|
||||||
|
month: chrono::Month,
|
||||||
|
day: u32,
|
||||||
|
observed: AdjustmentPolicy,
|
||||||
|
description: String,
|
||||||
|
since: Option<NaiveDate>,
|
||||||
|
until: Option<NaiveDate>,
|
||||||
|
},
|
||||||
|
MonthNthDay {
|
||||||
|
month: Month,
|
||||||
|
dow: Weekday,
|
||||||
|
offset: i8,
|
||||||
|
observed: AdjustmentPolicy,
|
||||||
|
description: String,
|
||||||
|
since: Option<NaiveDate>,
|
||||||
|
until: Option<NaiveDate>,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
impl DateSpec {
|
||||||
|
/// Get exact date of event and its policy, if it occured in that year
|
||||||
|
fn resolve(&self, year: i32) -> Option<(NaiveDate, AdjustmentPolicy)> {
|
||||||
|
use DateSpec::*;
|
||||||
|
|
||||||
|
match self {
|
||||||
|
SpecificDate { date, .. } => Some((*date, AdjustmentPolicy::NoAdjustment)),
|
||||||
|
MonthDay {
|
||||||
|
month,
|
||||||
|
day,
|
||||||
|
since,
|
||||||
|
until,
|
||||||
|
observed,
|
||||||
|
..
|
||||||
|
} => {
|
||||||
|
if since.is_some() && since.unwrap().year() > year {
|
||||||
|
None
|
||||||
|
} else if until.is_some() && until.unwrap().year() < year {
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
Some((
|
||||||
|
NaiveDate::from_ymd(year, month.number_from_month(), *day),
|
||||||
|
*observed,
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
MonthNthDay {
|
||||||
|
month,
|
||||||
|
dow,
|
||||||
|
offset,
|
||||||
|
since,
|
||||||
|
until,
|
||||||
|
observed,
|
||||||
|
..
|
||||||
|
} => {
|
||||||
|
if since.is_some() && since.unwrap().year() > year {
|
||||||
|
None
|
||||||
|
} else if until.is_some() && until.unwrap().year() < year {
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
let month_num = month.number_from_month();
|
||||||
|
if *offset < 0i8 {
|
||||||
|
let mut date = if month_num == 12 {
|
||||||
|
NaiveDate::from_ymd(year, 12, 31)
|
||||||
|
} else {
|
||||||
|
NaiveDate::from_ymd(year, month_num + 1, 1).pred()
|
||||||
|
};
|
||||||
|
while date.weekday() != *dow {
|
||||||
|
date = date.pred()
|
||||||
|
}
|
||||||
|
let mut off = offset + 1;
|
||||||
|
while off < 0 {
|
||||||
|
date = date.checked_sub_signed(chrono::Duration::days(7)).unwrap();
|
||||||
|
off += 1;
|
||||||
|
}
|
||||||
|
Some((date, *observed))
|
||||||
|
} else {
|
||||||
|
let mut date = NaiveDate::from_ymd(year, month_num, 1);
|
||||||
|
while date.weekday() != *dow {
|
||||||
|
date = date.succ()
|
||||||
|
}
|
||||||
|
let mut off = offset - 1;
|
||||||
|
while off > 0 {
|
||||||
|
date = date.checked_add_signed(chrono::Duration::days(7)).unwrap();
|
||||||
|
off -= 1;
|
||||||
|
}
|
||||||
|
Some((date, *observed))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Serialize, Deserialize, Default, Debug)]
|
||||||
|
struct Calendar {
|
||||||
|
description: String,
|
||||||
|
dow: HashSet<Weekday>,
|
||||||
|
public: bool,
|
||||||
|
excluded: Vec<DateSpec>,
|
||||||
|
inherits: Vec<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Calendar {
|
||||||
|
fn adjust_holidays(&self, holidays: &Vec<(NaiveDate, AdjustmentPolicy)>) -> HashSet<NaiveDate> {
|
||||||
|
let mut observed = HashSet::new();
|
||||||
|
|
||||||
|
for (date, policy) in holidays.iter() {
|
||||||
|
match self.adjust_holiday(*date, policy, &observed) {
|
||||||
|
Some(holiday) => {
|
||||||
|
observed.insert(holiday);
|
||||||
|
}
|
||||||
|
None => {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
observed
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Adjust a date given existing holidays and adjustment policy
|
||||||
|
fn adjust_holiday(
|
||||||
|
&self,
|
||||||
|
date: NaiveDate,
|
||||||
|
policy: &AdjustmentPolicy,
|
||||||
|
holidays: &HashSet<NaiveDate>,
|
||||||
|
) -> Option<NaiveDate> {
|
||||||
|
let mut actual = date.clone();
|
||||||
|
|
||||||
|
let is_blocked =
|
||||||
|
|x: NaiveDate| -> bool { (!self.dow.contains(&x.weekday())) || holidays.contains(&x) };
|
||||||
|
|
||||||
|
use AdjustmentPolicy::*;
|
||||||
|
match policy {
|
||||||
|
Next => {
|
||||||
|
while is_blocked(actual) {
|
||||||
|
actual = actual.succ();
|
||||||
|
}
|
||||||
|
Some(actual)
|
||||||
|
}
|
||||||
|
Prev => {
|
||||||
|
while is_blocked(actual) {
|
||||||
|
actual = actual.pred();
|
||||||
|
}
|
||||||
|
Some(actual)
|
||||||
|
}
|
||||||
|
Closest => {
|
||||||
|
let prev = self
|
||||||
|
.adjust_holiday(date, &AdjustmentPolicy::Prev, holidays)
|
||||||
|
.unwrap();
|
||||||
|
let next = self
|
||||||
|
.adjust_holiday(date, &AdjustmentPolicy::Next, holidays)
|
||||||
|
.unwrap();
|
||||||
|
if (date - prev) < (next - date) {
|
||||||
|
Some(prev)
|
||||||
|
} else {
|
||||||
|
Some(next)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
NoAdjustment => {
|
||||||
|
if is_blocked(actual) {
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
Some(actual)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get the set of all holidays in a given year
|
||||||
|
pub fn get_holidays(&self, date: NaiveDate) -> HashSet<NaiveDate> {
|
||||||
|
let holidays: Vec<(NaiveDate, AdjustmentPolicy)> = self
|
||||||
|
.excluded
|
||||||
|
.iter()
|
||||||
|
.map(|x| x.resolve(date.year()))
|
||||||
|
.filter(|x| x.is_some())
|
||||||
|
.map(|x| x.unwrap())
|
||||||
|
.collect();
|
||||||
|
self.adjust_holidays(&holidays)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns true if the given date is a holiday / non-business day
|
||||||
|
fn is_holiday(&self, date: NaiveDate) -> bool {
|
||||||
|
self.get_holidays(date).contains(&date)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the set of valid calendar dates within the specified range
|
||||||
|
pub fn date_range(&self, from: NaiveDate, to: NaiveDate) -> Vec<NaiveDate> {
|
||||||
|
let mut result = Vec::new();
|
||||||
|
let mut cur = from;
|
||||||
|
let year = from.year();
|
||||||
|
let mut holidays = self.get_holidays(cur);
|
||||||
|
|
||||||
|
while cur < to {
|
||||||
|
if cur.year() != year {
|
||||||
|
holidays = self.get_holidays(cur);
|
||||||
|
}
|
||||||
|
if !self.dow.contains(&cur.weekday()) || holidays.contains(&cur) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
result.push(cur);
|
||||||
|
cur = cur.succ();
|
||||||
|
}
|
||||||
|
result
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn check_double_observed() {
|
||||||
|
use chrono::Month::*;
|
||||||
|
use chrono::Weekday::*;
|
||||||
|
|
||||||
|
let cal = Calendar {
|
||||||
|
description: "Test description".to_owned(),
|
||||||
|
dow: HashSet::from([Mon, Tue, Wed, Thu, Fri]),
|
||||||
|
public: false,
|
||||||
|
excluded: vec![
|
||||||
|
DateSpec::MonthDay {
|
||||||
|
month: December,
|
||||||
|
day: 25u32,
|
||||||
|
observed: AdjustmentPolicy::Next,
|
||||||
|
description: "Christmas".to_owned(),
|
||||||
|
since: None,
|
||||||
|
until: None,
|
||||||
|
},
|
||||||
|
DateSpec::MonthDay {
|
||||||
|
month: December,
|
||||||
|
day: 26u32,
|
||||||
|
observed: AdjustmentPolicy::Next,
|
||||||
|
description: "Boxing Day".to_owned(),
|
||||||
|
since: None,
|
||||||
|
until: None,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
inherits: vec![],
|
||||||
|
};
|
||||||
|
|
||||||
|
// Christmas falls on a Saturday, observed was Monday
|
||||||
|
assert!(cal.is_holiday(NaiveDate::from_ymd(2021, 12, 27)));
|
||||||
|
|
||||||
|
// Boxing Day falls on a Sunday, observed is a Tuesday
|
||||||
|
assert!(cal.is_holiday(NaiveDate::from_ymd(2021, 12, 28)));
|
||||||
|
|
||||||
|
assert!(!cal.is_holiday(NaiveDate::from_ymd(2021, 12, 24)));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn check_crossing_years() {
|
||||||
|
use chrono::Month::*;
|
||||||
|
use chrono::Weekday::*;
|
||||||
|
|
||||||
|
let cal = Calendar {
|
||||||
|
description: "Test description".to_owned(),
|
||||||
|
dow: HashSet::from([Mon, Tue, Wed, Thu, Fri]),
|
||||||
|
public: false,
|
||||||
|
excluded: vec![
|
||||||
|
DateSpec::MonthDay {
|
||||||
|
month: December,
|
||||||
|
day: 25u32,
|
||||||
|
observed: AdjustmentPolicy::Next,
|
||||||
|
description: "Christmas".to_owned(),
|
||||||
|
since: None,
|
||||||
|
until: None,
|
||||||
|
},
|
||||||
|
DateSpec::MonthDay {
|
||||||
|
month: December,
|
||||||
|
day: 26u32,
|
||||||
|
observed: AdjustmentPolicy::Next,
|
||||||
|
description: "Boxing Day".to_owned(),
|
||||||
|
since: None,
|
||||||
|
until: None,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
inherits: vec![],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
36
src/main.rs
36
src/main.rs
@@ -1,3 +1,37 @@
|
|||||||
|
pub mod calendar;
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
println!("Hello, world!");
|
println!("Hello, world");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
use actix_web::{get, post, web, App, HttpResponse, HttpServer, Responder};
|
||||||
|
//use pam_auth::Authenticator;
|
||||||
|
use pam::Authenticator;
|
||||||
|
|
||||||
|
#[get("/ok")]
|
||||||
|
async fn ok() -> impl Responder {
|
||||||
|
HttpResponse::Ok().body("Service is up!")
|
||||||
|
}
|
||||||
|
|
||||||
|
#[get("/v1/api/calendars")]
|
||||||
|
async fn list_calendars(req_body: String) -> impl Responder {
|
||||||
|
HttpResponse::Ok().body(req_body)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn manual_hello() -> impl Responder {
|
||||||
|
HttpResponse::Ok().body("Hey there!")
|
||||||
|
}
|
||||||
|
|
||||||
|
#[actix_web::main]
|
||||||
|
async fn main() -> std::io::Result<()> {
|
||||||
|
HttpServer::new(|| {
|
||||||
|
App::new().service(ok)
|
||||||
|
//.service(echo)
|
||||||
|
//.route("/hey", web::get().to(manual_hello))
|
||||||
|
})
|
||||||
|
.bind("127.0.0.1:8080")?
|
||||||
|
.run()
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user