statical 0.2.0

A calendar aggregator and generator to make maintaining calendars on static websites easier.
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

use doku::Document;
use serde::{Deserialize, Serialize};
use std::{
    cell::OnceCell,
    ffi::OsStr,
    fmt::{self},
};

use super::types::config_color::ConfigColor;

/// A Config item representing a calendar source
#[derive(Debug, Deserialize, Serialize, Document, PartialEq, Eq)]
pub struct CalendarSourceConfig {
    /// The url or file path of the calendar
    ///
    /// NOTE: File paths are relative to the config file
    #[doku(
        example = "calendars/mycalendar_file.ics",
        example = "https://example.com/my/calendar/url/ical/"
    )]
    pub source: String,

    /// The name or internal identifier of the calendar
    ///
    /// Because this is to be used internally, there are a few restrictions
    ///
    /// 1. No spaces
    /// 2. Dash separated a.k.a. kebab-case
    /// 3. Must be unique per config file
    pub name: String,

    /// The user facing title for the calendar
    ///
    /// This will be pulled from the calendar if it contains a `X-WR-CALNAME` property.
    /// If you provide a title here, it will override any calendar provided title.
    pub title: Option<String>,

    /// Any valid CSS color notation
    pub(crate) color: ConfigColor,

    #[serde(skip)]
    pub(crate) adjusted_color: OnceCell<String>,

    /// An array of headers to pass along with the main request
    ///
    /// This is handy if you are retrieving calendars from a site which requires login.
    /// Cookie values and other necessary headers can be provided so the request can succeed.
    ///
    /// For example, meetup.com requires a header like the following:
    ///
    /// ```
    /// MEETUP_MEMBER=id=<IDENTIFIER>&s=<SESSION_TOKEN>
    /// ```
    /// We may add the ability to auto-retrieve cookies from a local browser at some point.
    pub cookies: Option<Vec<String>>,
}

// TODO: need to update this function for new fields
impl fmt::Display for CalendarSourceConfig {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.source,)
    }
}

// TODO: need to update this function for new fields
impl<'a> From<&'a CalendarSourceConfig> for &'a str {
    fn from(value: &'a CalendarSourceConfig) -> &str {
        &value.source
    }
}

// TODO: need to update this function for new fields
impl From<&CalendarSourceConfig> for String {
    fn from(value: &CalendarSourceConfig) -> Self {
        value.source.clone()
    }
}

// TODO: need to update this function for new fields
impl AsRef<OsStr> for CalendarSourceConfig {
    fn as_ref(&self) -> &std::ffi::OsStr {
        OsStr::new(&self.source)
    }
}