doist 0.4.0

doist is an unofficial command line app for interacting with the Todoist API
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

use owo_colors::{OwoColorize, Stream};
use serde::{Deserialize, Serialize};
use serde_with::serde_as;

/// LabelID specifies the unique ID of a [`Label`].
pub type LabelID = String;

/// Label is a tag associated with a Task. Marked with `@name` in the UI.
///
/// Taken from the [Developer Documentation](https://developer.todoist.com/api/v1/#tag/Labels).
#[serde_as]
#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Clone)]
pub struct Label {
    /// Unique ID of a label.
    pub id: LabelID,
    /// Name of the label. Written as `@name` in the UI.
    pub name: String,
    /// The display color of the label as given from the API.
    pub color: String,
    /// The order among labels if we were to sort them.
    pub order: isize,
    /// Toggle for marking a label as a favorite.
    pub is_favorite: bool,
}

impl Ord for Label {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        match self.order.cmp(&other.order) {
            core::cmp::Ordering::Equal => {}
            ord => return ord,
        }
        self.id.cmp(&other.id)
    }
}

impl PartialOrd for Label {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl std::fmt::Display for Label {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        format!("@{}", self.name)
            .if_supports_color(Stream::Stdout, |text| text.bright_blue())
            .fmt(f)
    }
}

/// Command used with [`super::Gateway::create_label`] to create a new [`Label`].
#[derive(Debug, Serialize, Deserialize, Default)]
pub struct CreateLabel {
    /// Name of the label to create.
    pub name: String,
    /// Order of the label in lists.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<isize>,
    /// Color of the label icon.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub color: Option<String>,
    /// Mark as favorite or not.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_favorite: Option<bool>,
}

#[cfg(test)]
impl Label {
    /// This is initializer is used for tests, as in general the tool relies on the API and not
    /// local state.
    pub fn new(id: &str, name: &str) -> Label {
        Label {
            id: id.to_string(),
            name: name.to_string(),
            color: "".to_string(),
            order: 0,
            is_favorite: false,
        }
    }
}

#[cfg(test)]
mod test {
    #[test]
    fn succeeds_with_bad_color() {
        let label = r#"{"id":"123","name":"hello","color":"wow","order":0,"is_favorite":false}"#;
        assert!(serde_json::from_str::<'_, super::Label>(label).is_ok());
    }
}