volumeleaders-agent 0.2.1

Agent-oriented CLI for VolumeLeaders data
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

/// Toggle-style filter used by the VolumeLeaders API.
///
/// A value of -1 leaves the filter unselected, 0 excludes matching rows,
/// and 1 returns only matching rows.
#[derive(Clone, Copy, Debug, Default, PartialEq, clap::ValueEnum)]
pub enum TriStateFilter {
    /// Leave the filter unselected (default).
    #[default]
    #[value(name = "-1")]
    All,
    /// Exclude rows matching the filter.
    #[value(name = "0")]
    Disabled,
    /// Return only rows matching the filter.
    #[value(name = "1")]
    Enabled,
}

impl TriStateFilter {
    /// Returns the integer value expected by API filter parameters.
    pub fn as_i8(self) -> i8 {
        match self {
            Self::All => -1,
            Self::Disabled => 0,
            Self::Enabled => 1,
        }
    }
}

/// Sort direction for DataTables API requests.
#[derive(Clone, Copy, Debug, PartialEq, clap::ValueEnum)]
pub enum OrderDirection {
    /// Ascending order.
    #[value(name = "asc")]
    Asc,
    /// Descending order.
    #[value(name = "desc")]
    Desc,
}

impl OrderDirection {
    /// Returns the API string value for DataTables sorting.
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Asc => "asc",
            Self::Desc => "desc",
        }
    }
}

/// Grouping dimension for summary commands.
#[derive(Clone, Copy, Debug, PartialEq, clap::ValueEnum)]
pub enum SummaryGroup {
    /// Group by ticker symbol.
    #[value(name = "ticker")]
    Ticker,
    /// Group by trading day.
    #[value(name = "day")]
    Day,
    /// Group by ticker and day combined.
    #[value(name = "ticker,day")]
    TickerDay,
}

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

    #[test]
    fn tri_state_filter_as_i8() {
        assert_eq!(TriStateFilter::All.as_i8(), -1);
        assert_eq!(TriStateFilter::Disabled.as_i8(), 0);
        assert_eq!(TriStateFilter::Enabled.as_i8(), 1);
    }

    #[test]
    fn tri_state_filter_default_is_all() {
        assert_eq!(TriStateFilter::default(), TriStateFilter::All);
    }

    #[test]
    fn order_direction_as_str() {
        assert_eq!(OrderDirection::Asc.as_str(), "asc");
        assert_eq!(OrderDirection::Desc.as_str(), "desc");
    }
}