cliboard 0.1.0

Live math whiteboard for your terminal — render LaTeX equations in the browser with per-step AI chat
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Document {
    pub title: String,
    pub theme: Theme,
    pub blocks: Vec<Block>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum Theme {
    #[default]
    Dark,
    Light,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum Block {
    Step {
        id: usize,
        title: String,
        equations: Vec<String>,
        notes: Vec<String>,
        is_result: bool,
    },
    Prose {
        content: String,
    },
    Divider,
}

impl Document {
    pub fn new(title: &str) -> Self {
        Document {
            title: title.to_string(),
            theme: Theme::default(),
            blocks: Vec::new(),
        }
    }

    pub fn step_count(&self) -> usize {
        self.blocks.iter().filter(|b| matches!(b, Block::Step { .. })).count()
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Selection {
    pub step_id: usize,
    pub title: String,
    pub latex: String,
    pub unicode: String,
    pub formatted: String,
    pub notes: Vec<String>,
    pub selected_at: String,
}

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

    #[test]
    fn test_document_new_defaults() {
        let doc = Document::new("My Title");
        assert_eq!(doc.title, "My Title");
        assert_eq!(doc.theme, Theme::Dark);
        assert!(doc.blocks.is_empty());
    }

    #[test]
    fn test_document_new_untitled() {
        let doc = Document::new("Untitled");
        assert_eq!(doc.title, "Untitled");
    }

    #[test]
    fn test_step_count_empty() {
        let doc = Document::new("Test");
        assert_eq!(doc.step_count(), 0);
    }

    #[test]
    fn test_step_count_only_steps() {
        let doc = Document {
            title: "T".to_string(),
            theme: Theme::Dark,
            blocks: vec![
                Block::Step {
                    id: 1,
                    title: "A".to_string(),
                    equations: vec![],
                    notes: vec![],
                    is_result: false,
                },
                Block::Step {
                    id: 2,
                    title: "B".to_string(),
                    equations: vec![],
                    notes: vec![],
                    is_result: false,
                },
            ],
        };
        assert_eq!(doc.step_count(), 2);
    }

    #[test]
    fn test_step_count_mixed_blocks() {
        let doc = Document {
            title: "T".to_string(),
            theme: Theme::Dark,
            blocks: vec![
                Block::Prose {
                    content: "intro".to_string(),
                },
                Block::Step {
                    id: 1,
                    title: "S1".to_string(),
                    equations: vec![],
                    notes: vec![],
                    is_result: false,
                },
                Block::Divider,
                Block::Step {
                    id: 2,
                    title: "S2".to_string(),
                    equations: vec![],
                    notes: vec![],
                    is_result: true,
                },
                Block::Prose {
                    content: "outro".to_string(),
                },
            ],
        };
        assert_eq!(doc.step_count(), 2);
    }

    #[test]
    fn test_theme_default() {
        assert_eq!(Theme::default(), Theme::Dark);
    }

    #[test]
    fn test_theme_equality() {
        assert_eq!(Theme::Dark, Theme::Dark);
        assert_eq!(Theme::Light, Theme::Light);
        assert_ne!(Theme::Dark, Theme::Light);
    }
}