butterfly-bot 0.8.0

Butterfly Bot is an opinionated personal-ops AI assistant built for people who want results, not setup overhead.
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
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

use rust_fsm::*;

state_machine! {
    inbox_flow(New)

    New(HydrateAcknowledged) => Acknowledged,
    New(HydrateInProgress) => InProgress,
    New(HydrateBlocked) => Blocked,
    New(HydrateDone) => Done,
    New(HydrateDismissed) => Dismissed,

    New(Acknowledge) => Acknowledged,
    New(Start) => InProgress,
    New(Block) => Blocked,
    New(DoneEvent) => Done,
    New(Dismiss) => Dismissed,
    New(Snooze) => New,

    Acknowledged(Start) => InProgress,
    Acknowledged(Block) => Blocked,
    Acknowledged(DoneEvent) => Done,
    Acknowledged(Dismiss) => Dismissed,
    Acknowledged(Snooze) => New,

    InProgress(Block) => Blocked,
    InProgress(DoneEvent) => Done,
    InProgress(Dismiss) => Dismissed,
    InProgress(Snooze) => New,

    Blocked(Start) => InProgress,
    Blocked(DoneEvent) => Done,
    Blocked(Dismiss) => Dismissed,
    Blocked(Snooze) => New,

    Done(Reopen) => InProgress
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum InboxState {
    New,
    Acknowledged,
    InProgress,
    Blocked,
    Done,
    Dismissed,
}

impl InboxState {
    pub fn is_actionable(self) -> bool {
        matches!(
            self,
            InboxState::New
                | InboxState::Acknowledged
                | InboxState::InProgress
                | InboxState::Blocked
        )
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum InboxAction {
    Acknowledge,
    Start,
    Block,
    Done,
    Reopen,
    Dismiss,
    Snooze,
}

fn hydrate(machine: &mut inbox_flow::StateMachine, state: InboxState) -> Result<(), ()> {
    let input = match state {
        InboxState::New => return Ok(()),
        InboxState::Acknowledged => inbox_flow::Input::HydrateAcknowledged,
        InboxState::InProgress => inbox_flow::Input::HydrateInProgress,
        InboxState::Blocked => inbox_flow::Input::HydrateBlocked,
        InboxState::Done => inbox_flow::Input::HydrateDone,
        InboxState::Dismissed => inbox_flow::Input::HydrateDismissed,
    };
    machine.consume(&input).map_err(|_| ())?;
    Ok(())
}

fn expected_next_state(current: InboxState, action: InboxAction) -> Option<InboxState> {
    match (current, action) {
        (InboxState::New, InboxAction::Acknowledge) => Some(InboxState::Acknowledged),
        (InboxState::New, InboxAction::Start) => Some(InboxState::InProgress),
        (InboxState::New, InboxAction::Block) => Some(InboxState::Blocked),
        (InboxState::New, InboxAction::Done) => Some(InboxState::Done),
        (InboxState::New, InboxAction::Dismiss) => Some(InboxState::Dismissed),
        (InboxState::New, InboxAction::Snooze) => Some(InboxState::New),
        (InboxState::Acknowledged, InboxAction::Start) => Some(InboxState::InProgress),
        (InboxState::Acknowledged, InboxAction::Block) => Some(InboxState::Blocked),
        (InboxState::Acknowledged, InboxAction::Done) => Some(InboxState::Done),
        (InboxState::Acknowledged, InboxAction::Dismiss) => Some(InboxState::Dismissed),
        (InboxState::Acknowledged, InboxAction::Snooze) => Some(InboxState::New),
        (InboxState::InProgress, InboxAction::Block) => Some(InboxState::Blocked),
        (InboxState::InProgress, InboxAction::Done) => Some(InboxState::Done),
        (InboxState::InProgress, InboxAction::Dismiss) => Some(InboxState::Dismissed),
        (InboxState::InProgress, InboxAction::Snooze) => Some(InboxState::New),
        (InboxState::Blocked, InboxAction::Start) => Some(InboxState::InProgress),
        (InboxState::Blocked, InboxAction::Done) => Some(InboxState::Done),
        (InboxState::Blocked, InboxAction::Dismiss) => Some(InboxState::Dismissed),
        (InboxState::Blocked, InboxAction::Snooze) => Some(InboxState::New),
        (InboxState::Done, InboxAction::Reopen) => Some(InboxState::InProgress),
        _ => None,
    }
}

pub fn transition(current: InboxState, action: InboxAction) -> Option<InboxState> {
    let mut machine = inbox_flow::StateMachine::new();
    hydrate(&mut machine, current).ok()?;

    let input = match action {
        InboxAction::Acknowledge => inbox_flow::Input::Acknowledge,
        InboxAction::Start => inbox_flow::Input::Start,
        InboxAction::Block => inbox_flow::Input::Block,
        InboxAction::Done => inbox_flow::Input::DoneEvent,
        InboxAction::Reopen => inbox_flow::Input::Reopen,
        InboxAction::Dismiss => inbox_flow::Input::Dismiss,
        InboxAction::Snooze => inbox_flow::Input::Snooze,
    };

    machine.consume(&input).ok()?;
    expected_next_state(current, action)
}

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

    #[test]
    fn inbox_fsm_allows_happy_path() {
        assert_eq!(
            transition(InboxState::New, InboxAction::Acknowledge),
            Some(InboxState::Acknowledged)
        );
        assert_eq!(
            transition(InboxState::Acknowledged, InboxAction::Start),
            Some(InboxState::InProgress)
        );
        assert_eq!(
            transition(InboxState::InProgress, InboxAction::Done),
            Some(InboxState::Done)
        );
    }

    #[test]
    fn inbox_fsm_rejects_invalid_transition() {
        assert_eq!(transition(InboxState::Done, InboxAction::Start), None);
        assert_eq!(transition(InboxState::Dismissed, InboxAction::Done), None);
    }
}