shdo 0.5.0

A kanban board for the terminal: tasks are Markdown files in a git repository
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
//! First-run setup: language, data directory and public holidays.

use std::path::PathBuf;

use anyhow::Result;
use ratatui::DefaultTerminal;
use ratatui::crossterm::event::{self, Event, KeyCode, KeyEvent, KeyEventKind, KeyModifiers};
use ratatui::layout::{Constraint, Layout, Position};
use ratatui::style::{Modifier, Style};
use ratatui::text::{Line, Span};
use ratatui::widgets::{Block, Paragraph, Wrap};
use rust_i18n::t;

use super::form::Input;
use super::ui::{input_view, key_hints, popup};
use crate::config::{self, AppConfig};
use crate::holidays::{GERMAN_STATES, Region};
use crate::i18n::{self, Lang};
use crate::store::{DirState, Store};
use crate::theme::Palette;

#[derive(Clone, Copy, PartialEq, Debug)]
enum Step {
    Language,
    Dir,
    /// Only for a new board: start with home/work buckets or none.
    Buckets,
    Country,
    State,
    Summary,
}

struct Setup {
    step: Step,
    lang: usize,
    dir: Input,
    /// The user saw the warning about a non-empty directory and wants it anyway.
    foreign_confirmed: bool,
    /// 0 = no holidays, 1 = Germany
    country: usize,
    state: usize,
    /// 0 = home and work, 1 = none (only asked for a new board)
    buckets: usize,
    error: Option<String>,
}

enum Outcome {
    Continue,
    Abort,
    Done,
}

impl Setup {
    fn new(cfg: &AppConfig, cli_dir: Option<&std::path::Path>) -> Setup {
        let lang = cfg.lang();
        let dir = config::contract_tilde(&cfg.data_dir(cli_dir));
        let (country, state) = match cfg.holidays.as_deref() {
            Some(h) => {
                let code = h.trim().to_lowercase();
                let code = code.strip_prefix("de-").unwrap_or(&code).to_string();
                match GERMAN_STATES.iter().position(|(c, _, _)| *c == code) {
                    Some(i) => (1, i),
                    None => (0, 0),
                }
            }
            // No choice yet: German users most likely want German holidays
            None => (usize::from(lang == Lang::De), 0),
        };
        Setup {
            step: Step::Language,
            lang: Lang::ALL.iter().position(|l| *l == lang).unwrap_or(0),
            dir: Input::with(&dir),
            foreign_confirmed: false,
            country,
            state,
            buckets: 0,
            error: None,
        }
    }

    fn lang(&self) -> Lang {
        Lang::ALL[self.lang]
    }

    fn store(&self) -> Store {
        Store::new(config::expand_tilde(self.dir.text.trim()))
    }

    fn holidays(&self) -> Option<String> {
        (self.country == 1).then(|| Region::setting_for_state(GERMAN_STATES[self.state].0))
    }

    /// Steps shown to the user (the state only matters for Germany).
    fn steps(&self) -> Vec<Step> {
        let mut steps = vec![Step::Language, Step::Dir];
        if self.new_board() {
            steps.push(Step::Buckets);
        }
        steps.push(Step::Country);
        if self.country == 1 {
            steps.push(Step::State);
        }
        steps.push(Step::Summary);
        steps
    }

    /// An existing shdo directory keeps its buckets; only a new board asks for them.
    fn new_board(&self) -> bool {
        self.store().dir_state() != DirState::Shdo
    }

    fn go(&mut self, delta: isize) {
        let steps = self.steps();
        let i = steps.iter().position(|s| *s == self.step).unwrap_or(0) as isize + delta;
        self.step = steps[i.clamp(0, steps.len() as isize - 1) as usize];
        self.error = None;
    }

    fn handle(&mut self, key: KeyEvent) -> Outcome {
        if key.code == KeyCode::Char('c') && key.modifiers.contains(KeyModifiers::CONTROL) {
            return Outcome::Abort;
        }
        let step_list = |len: usize, idx: &mut usize, code: KeyCode| match code {
            KeyCode::Char('j') | KeyCode::Down => *idx = (*idx + 1) % len,
            KeyCode::Char('k') | KeyCode::Up => *idx = (*idx + len - 1) % len,
            _ => {}
        };
        match (self.step, key.code) {
            (Step::Language, KeyCode::Esc) => return Outcome::Abort,
            (Step::Summary, KeyCode::Enter) => return Outcome::Done,
            (Step::Dir, KeyCode::Enter) => self.confirm_dir(),
            (_, KeyCode::Enter) => self.go(1),
            (_, KeyCode::Esc) => self.go(-1),
            (Step::Language, code) => {
                step_list(Lang::ALL.len(), &mut self.lang, code);
                // Switch right away so the following steps are in the chosen language
                i18n::set(self.lang());
            }
            (Step::Dir, _) => {
                self.dir.handle(key);
                self.foreign_confirmed = false;
                self.error = None;
            }
            (Step::Buckets, code) => step_list(2, &mut self.buckets, code),
            (Step::Country, code) => step_list(2, &mut self.country, code),
            (Step::State, code) => step_list(GERMAN_STATES.len(), &mut self.state, code),
            (Step::Summary, _) => {}
        }
        Outcome::Continue
    }

    fn confirm_dir(&mut self) {
        if self.dir.text.trim().is_empty() {
            self.error = Some(t!("setup.dir.empty_input").into_owned());
            return;
        }
        match self.store().dir_state() {
            DirState::NotADir => self.error = Some(t!("setup.dir.not_a_dir").into_owned()),
            DirState::Foreign { .. } if !self.foreign_confirmed => self.foreign_confirmed = true,
            _ => self.go(1),
        }
    }

    fn result(&self) -> config::Setup {
        config::Setup {
            language: self.lang(),
            dir: self.dir.text.trim().to_string(),
            holidays: self.holidays(),
        }
    }
}

/// "Home and Work (home, work)" in the active language.
fn bucket_pair_label() -> String {
    t!(
        "setup.buckets.both",
        home = t!("board.default.home"),
        work = t!("board.default.work")
    )
    .into_owned()
}

/// Describes the chosen directory: (text, is a warning).
fn dir_note(state: &DirState) -> (String, bool) {
    match state {
        DirState::Missing => (t!("setup.dir.missing").into_owned(), false),
        DirState::Empty => (t!("setup.dir.empty").into_owned(), false),
        DirState::Shdo => (t!("setup.dir.shdo").into_owned(), false),
        DirState::Foreign { entries, git: true } => {
            (t!("setup.dir.foreign_git", n = entries).into_owned(), true)
        }
        DirState::Foreign {
            entries,
            git: false,
        } => (t!("setup.dir.foreign", n = entries).into_owned(), true),
        DirState::NotADir => (t!("setup.dir.not_a_dir").into_owned(), true),
    }
}

/// Runs the setup dialog in the given terminal. Returns the choices, or `None` if aborted.
/// On success the config is written and the data directory is initialized.
pub fn run(
    terminal: &mut DefaultTerminal,
    cfg: &AppConfig,
    cfg_path: &std::path::Path,
    cli_dir: Option<PathBuf>,
    palette: &Palette,
) -> Result<Option<config::Setup>> {
    let mut setup = Setup::new(cfg, cli_dir.as_deref());
    i18n::set(setup.lang());
    loop {
        terminal.draw(|f| draw(f, &setup, palette, cfg_path))?;
        let Event::Key(key) = event::read()? else {
            continue;
        };
        if key.kind == KeyEventKind::Release {
            continue;
        }
        match setup.handle(key) {
            Outcome::Continue => {}
            Outcome::Abort => return Ok(None),
            Outcome::Done => break,
        }
    }
    let result = setup.result();
    let new_board = setup.new_board();
    config::write_setup(cfg_path, &result)?;
    let store = setup.store();
    store.init()?;
    if new_board && setup.buckets == 0 {
        // Without names: shown as Home/Work or Privat/Arbeit, following the language
        store.add_bucket("home", "")?;
        store.add_bucket("work", "")?;
    }
    let git = crate::git::Git::new(&store.dir, true);
    if !git.is_repo() {
        git.init()?;
    }
    Ok(Some(result))
}

fn draw(f: &mut ratatui::Frame, s: &Setup, c: &Palette, cfg_path: &std::path::Path) {
    let area = f.area();
    f.render_widget(Block::new().style(Style::new().bg(c.bg).fg(c.fg)), area);
    let keys: Vec<(&str, &str)> = match s.step {
        Step::Language => vec![("j/k", "kb.select"), ("⏎", "kb.next"), ("Esc", "kb.quit")],
        Step::Dir => vec![("⏎", "kb.next"), ("Esc", "kb.back"), ("^U", "kb.clear")],
        Step::Buckets | Step::Country | Step::State => {
            vec![("j/k", "kb.select"), ("⏎", "kb.next"), ("Esc", "kb.back")]
        }
        Step::Summary => vec![("⏎", "kb.finish"), ("Esc", "kb.back")],
    };
    let hints = key_hints(&keys, c, area.width);
    let [_, bar] =
        Layout::vertical([Constraint::Min(0), Constraint::Length(hints.len() as u16)]).areas(area);
    f.render_widget(Paragraph::new(hints), bar);

    let steps = s.steps();
    let n = steps.iter().position(|x| *x == s.step).unwrap_or(0) + 1;
    let title = format!(
        "{} · {}",
        t!("setup.title"),
        t!("setup.step", n = n, total = steps.len())
    );
    let (heading, hint) = match s.step {
        Step::Language => ("setup.lang.title", "setup.lang.hint"),
        Step::Dir => ("setup.dir.title", "setup.dir.hint"),
        Step::Buckets => ("setup.buckets.title", "setup.buckets.hint"),
        Step::Country => ("setup.country.title", "setup.country.hint"),
        Step::State => ("setup.state.title", "setup.state.hint"),
        Step::Summary => ("setup.summary.title", "setup.summary.hint"),
    };
    let mut lines = vec![
        Line::from(Span::styled(
            t!(heading).into_owned(),
            Style::new().fg(c.title).add_modifier(Modifier::BOLD),
        )),
        Line::from(Span::styled(
            t!(hint, path = config::contract_tilde(cfg_path)).into_owned(),
            Style::new().fg(c.dim),
        )),
        Line::default(),
    ];
    let choice = |sel: bool, text: String| {
        Line::from(vec![
            Span::styled(
                if sel { "→ " } else { "  " },
                Style::new().fg(c.border_active),
            ),
            Span::styled(
                text,
                if sel {
                    Style::new().add_modifier(Modifier::BOLD)
                } else {
                    Style::new()
                },
            ),
        ])
    };
    let mut cursor = None;
    match s.step {
        Step::Language => {
            for (i, l) in Lang::ALL.iter().enumerate() {
                lines.push(choice(i == s.lang, l.native_name().to_string()));
            }
        }
        Step::Dir => {
            let (visible, cx) = input_view(&s.dir, 52);
            cursor = Some((lines.len(), cx + 2));
            lines.push(Line::from(vec![
                Span::styled("▸ ", Style::new().fg(c.key)),
                Span::raw(visible),
            ]));
            lines.push(Line::default());
            let (note, warn) = dir_note(&s.store().dir_state());
            lines.push(Line::from(Span::styled(
                note,
                Style::new().fg(if warn { c.warn } else { c.done }),
            )));
            if s.foreign_confirmed {
                lines.push(Line::from(Span::styled(
                    t!("setup.dir.confirm").into_owned(),
                    Style::new().fg(c.warn).add_modifier(Modifier::BOLD),
                )));
            }
        }
        Step::Buckets => {
            lines.push(choice(s.buckets == 0, bucket_pair_label()));
            lines.push(choice(
                s.buckets == 1,
                t!("setup.buckets.none").into_owned(),
            ));
        }
        Step::Country => {
            lines.push(choice(
                s.country == 0,
                t!("setup.country.none").into_owned(),
            ));
            lines.push(choice(s.country == 1, t!("setup.country.de").into_owned()));
        }
        Step::State => {
            // Show a window around the selection so the list fits small terminals
            let visible = 8usize;
            let start = s
                .state
                .saturating_sub(visible / 2)
                .min(GERMAN_STATES.len() - visible);
            for (i, (_, _, name)) in GERMAN_STATES.iter().enumerate().skip(start).take(visible) {
                lines.push(choice(i == s.state, name.to_string()));
            }
        }
        Step::Summary => {
            let row = |k: &str, v: String| {
                Line::from(vec![
                    Span::styled(format!("{:<16}", t!(k)), Style::new().fg(c.dim)),
                    Span::raw(v),
                ])
            };
            lines.push(row("setup.summary.language", s.lang().native_name().into()));
            lines.push(row("setup.summary.dir", s.dir.text.trim().to_string()));
            let holidays = match s.holidays() {
                Some(_) => format!("{}, {}", t!("setup.country.de"), GERMAN_STATES[s.state].2),
                None => t!("setup.country.none").into_owned(),
            };
            let buckets = if !s.new_board() {
                t!("setup.buckets.existing").into_owned()
            } else if s.buckets == 0 {
                bucket_pair_label()
            } else {
                t!("setup.buckets.none").into_owned()
            };
            lines.push(row("setup.summary.buckets", buckets));
            lines.push(row("setup.summary.holidays", holidays));
            lines.push(Line::default());
            lines.push(Line::from(Span::styled(
                t!("setup.summary.later").into_owned(),
                Style::new().fg(c.dim),
            )));
        }
    }
    if let Some(e) = &s.error {
        lines.push(Line::default());
        lines.push(Line::from(Span::styled(
            e.clone(),
            Style::new().fg(c.overdue),
        )));
    }
    // Height including wrapped lines: popup width 64 minus border and padding
    let text_width = 64u16
        .min(area.width.saturating_sub(2))
        .saturating_sub(4)
        .max(1);
    // The cursor row counts wrapped lines above the input field, not just list entries
    let cursor = cursor.map(|(line, col)| {
        let above = Paragraph::new(lines[..line].to_vec()).wrap(Wrap { trim: false });
        (above.line_count(text_width), col)
    });
    let paragraph = Paragraph::new(lines).wrap(Wrap { trim: false });
    let rows = paragraph.line_count(text_width) as u16;
    let inner = popup(f, c, &title, 64, rows + 2);
    f.render_widget(paragraph, inner);
    if let Some((row, col)) = cursor {
        f.set_cursor_position(Position {
            x: inner.x + col as u16,
            y: inner.y + row as u16,
        });
    }
}

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

    fn key(code: KeyCode) -> KeyEvent {
        KeyEvent::from(code)
    }

    fn cfg(language: &str) -> AppConfig {
        toml::from_str(&format!("language = \"{language}\"")).unwrap()
    }

    #[test]
    fn german_preselects_german_holidays() {
        assert_eq!(Setup::new(&cfg("de"), None).country, 1);
        assert_eq!(Setup::new(&cfg("en"), None).country, 0);
    }

    #[test]
    fn walks_through_the_steps() {
        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().join("data");
        let mut s = Setup::new(&cfg("en"), Some(&dir));
        assert_eq!(s.step, Step::Language);
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::Dir);
        s.handle(key(KeyCode::Enter));
        // new directory: buckets are offered, home/work preselected
        assert_eq!(s.step, Step::Buckets);
        assert_eq!(s.buckets, 0);
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::Country);
        // Germany adds the state step
        s.handle(key(KeyCode::Down));
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::State);
        s.handle(key(KeyCode::Down));
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::Summary);
        assert_eq!(s.holidays().as_deref(), Some("de-by"));
        assert!(matches!(s.handle(key(KeyCode::Enter)), Outcome::Done));
        // back to the country step and choose none: the state step disappears
        s.handle(key(KeyCode::Esc));
        s.handle(key(KeyCode::Esc));
        s.handle(key(KeyCode::Up));
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::Summary);
        assert_eq!(s.holidays(), None);
    }

    #[test]
    fn foreign_directory_needs_confirmation() {
        let tmp = tempfile::tempdir().unwrap();
        std::fs::write(tmp.path().join("notes.txt"), "x").unwrap();
        let mut s = Setup::new(&cfg("en"), Some(tmp.path()));
        s.step = Step::Dir;
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::Dir);
        assert!(s.foreign_confirmed);
        s.handle(key(KeyCode::Enter));
        // a non-empty foreign directory still becomes a new board
        assert_eq!(s.step, Step::Buckets);
    }

    #[test]
    fn existing_board_skips_the_bucket_step() {
        let tmp = tempfile::tempdir().unwrap();
        Store::new(tmp.path().to_path_buf()).init().unwrap();
        let mut s = Setup::new(&cfg("en"), Some(tmp.path()));
        s.step = Step::Dir;
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::Country);
        assert!(!s.steps().contains(&Step::Buckets));
    }

    #[test]
    fn file_is_rejected_as_directory() {
        let tmp = tempfile::tempdir().unwrap();
        let file = tmp.path().join("file");
        std::fs::write(&file, "x").unwrap();
        let mut s = Setup::new(&cfg("en"), Some(&file));
        s.step = Step::Dir;
        s.handle(key(KeyCode::Enter));
        assert_eq!(s.step, Step::Dir);
        assert!(s.error.is_some());
    }
}