ghtui 0.2.0

A keyboard-driven terminal client for GitHub, with a pull request diff viewer that goes further than GitHub's
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
//! A repository's milestones: made, edited (title, due date,
//! description), closed or reopened, and deleted.

use crate::api::browse::{MilestoneDetail, MilestoneInfo, MilestoneList};
use crate::api::housekeeping::MilestoneChange;
use crate::api::model::RepoId;
use crate::route::{Route, issues};
use crate::ui::page::{Link, Page};
use crate::ui::pages::{Mark, TextBox, WriteFormView};

use super::{
    Expected, Field, Form, FormOf, MilestoneWrite, Subject, ask, expect, form, form_mut, form_row,
    item, refused, selected, setting,
};
use crate::data::DataKey;
use crate::keymap::Action;
use crate::nav::{Doable, row};
use crate::state::{Cmd, State};
use crate::work::{self, Cx, Failure, Job};

/// A milestone's change: a new one's (no number), or one's.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Save {
    pub repo: RepoId,
    pub number: Option<u64>,
    pub write: MilestoneWrite,
}

const WHAT: &str = "Changing milestones";

/// A milestone's link: its page.
fn milestone_url(repo: &RepoId, number: u64) -> String {
    format!("{}/milestone/{number}", crate::ui::pages::url::repo(repo))
}

/// The milestone on screen: its own page's, or the one selected in the
/// list.
fn picked(state: &State) -> Option<MilestoneInfo> {
    match state.route()? {
        Route::Issues(issues::Milestone { repo, number }) => state
            .picked::<MilestoneDetail>(&DataKey::Milestone(repo.clone(), *number))
            .map(|d| d.info.clone()),
        Route::Issues(issues::Milestones { repo, closed }) => {
            let list =
                state.picked::<MilestoneList>(&DataKey::Milestones(repo.clone(), *closed))?;
            selected(state, &list.results.items, |m| {
                milestone_url(repo, m.number)
            })
            .cloned()
        }
        _ => None,
    }
}

/// `,o` or `,e`: the milestone's form.
#[must_use]
pub(super) fn open(state: &mut State, repo: &RepoId, number: Option<u64>) -> Vec<Cmd> {
    if let Some(why) = refused(state, repo, WHAT) {
        return state.just_say(why);
    }
    super::open(
        state,
        FormOf::Milestone {
            repo: repo.clone(),
            number,
        },
    )
}

#[must_use]
pub(super) fn edit(state: &mut State, repo: &RepoId) -> Vec<Cmd> {
    let Some(m) = picked(state) else {
        return state.just_say("Select a milestone first");
    };
    open(state, repo, Some(m.number))
}

/// Fills the form from the milestone once it's loaded; a new one starts
/// with its title.
#[must_use]
pub(super) fn follow(
    state: &mut State,
    route: &Route,
    repo: &RepoId,
    number: Option<u64>,
) -> Vec<Cmd> {
    if form(state, route).started {
        return Vec::new();
    }
    let info = match number {
        Some(n) => {
            let key = DataKey::Milestone(repo.clone(), n);
            let Some(d) = state.picked::<MilestoneDetail>(&key) else {
                return Vec::new();
            };
            Some(d.info.clone())
        }
        None => None,
    };
    let f = form_mut(state, route);
    f.started = true;
    if let Some(m) = info {
        f.set(Field::Title, m.title);
        let due = m.due_on.as_deref().and_then(|d| d.get(..10)).unwrap_or("");
        f.set(Field::Due, due);
        f.text = m.description;
    }
    if number.is_none() && state.overlay.is_none() {
        return super::open_field(state, route, Field::Title);
    }
    Vec::new()
}

/// Whether `date` is a day of the calendar, written `YYYY-MM-DD`.
fn valid_date(date: &str) -> bool {
    let parts: Vec<&str> = date.split('-').collect();
    let [y, m, d] = parts.as_slice() else {
        return false;
    };
    let digits = |s: &str, n: usize| s.len() == n && s.chars().all(|c| c.is_ascii_digit());
    if !(digits(y, 4) && digits(m, 2) && digits(d, 2)) {
        return false;
    }
    let (Ok(y), Ok(m), Ok(d)) = (y.parse::<u32>(), m.parse::<u32>(), d.parse::<u32>()) else {
        return false;
    };
    let leap = y % 4 == 0 && (y % 100 != 0 || y % 400 == 0);
    let days = match m {
        1 | 3 | 5 | 7 | 8 | 10 | 12 => 31,
        4 | 6 | 9 | 11 => 30,
        2 if leap => 29,
        2 => 28,
        _ => return false,
    };
    (1..=days).contains(&d)
}

/// The due date picker's rows: the date typed, or none.
pub(super) fn due_rows(
    route: &Route,
    q: &str,
) -> Vec<(
    crate::ui::overlays::PaletteItem,
    Option<crate::picker::Choice>,
)> {
    let set = |d: &str| setting(route, Field::Due, d);
    let mut rows = Vec::new();
    if !q.is_empty() {
        rows.push(if valid_date(q) {
            item(format!("Due by {q}"), "↵", set(q))
        } else {
            item("A date is YYYY-MM-DD", "", None)
        });
    }
    rows.push(item("No due date", "", set("")));
    rows
}

/// The milestone as the form has it, or why it can't be saved.
pub(super) fn change(f: &Form) -> Result<MilestoneChange, String> {
    let title = f.get(Field::Title).trim();
    if title.is_empty() {
        return Err("A milestone needs a title".into());
    }
    let due = f.get(Field::Due).trim();
    if !due.is_empty() && !valid_date(due) {
        return Err("A due date is YYYY-MM-DD".into());
    }
    Ok(MilestoneChange {
        title: title.to_owned(),
        description: f.text.trim_end().to_owned(),
        due_on: (!due.is_empty()).then(|| due.to_owned()),
    })
}

#[must_use]
pub(super) fn submit(
    state: &mut State,
    route: &Route,
    repo: &RepoId,
    number: Option<u64>,
) -> Vec<Cmd> {
    if let Some(why) = refused(state, repo, WHAT) {
        return crate::forms::say(state, why);
    }
    let change = match change(&form(state, route)) {
        Ok(c) => c,
        Err(why) => {
            return crate::forms::say(state, why);
        }
    };
    crate::forms::form_sending(state, route);
    state.info(format!("Saving the milestone {}…", change.title));
    work::start(Save {
        repo: repo.clone(),
        number,
        write: MilestoneWrite::Save(change),
    })
}

/// `,x`: closes the milestone, or reopens it. GitHub doesn't ask.
#[must_use]
pub(super) fn toggle(state: &mut State, repo: &RepoId) -> Vec<Cmd> {
    if let Some(why) = refused(state, repo, WHAT) {
        return state.just_say(why);
    }
    let Some(m) = picked(state) else {
        return state.just_say("Select a milestone first");
    };
    let verb = if m.closed { "Reopening" } else { "Closing" };
    state.info(format!("{verb} {}…", m.title));
    work::start(Save {
        repo: repo.clone(),
        number: Some(m.number),
        write: MilestoneWrite::Close(!m.closed),
    })
}

/// `,D`: asks first, as GitHub does.
#[must_use]
pub(super) fn ask_delete(state: &mut State, repo: &RepoId) -> Vec<Cmd> {
    if let Some(why) = refused(state, repo, WHAT) {
        return state.just_say(why);
    }
    let Some(m) = picked(state) else {
        return state.just_say("Select a milestone first");
    };
    let all = m.open + m.done;
    let on = match all {
        0 => "Nothing is in it".to_owned(),
        1 => "Its issue or pull request stays, without a milestone".to_owned(),
        n => format!("Its {n} issues and pull requests stay, without a milestone"),
    };
    let subject = Subject::Milestone(repo.clone(), m.number);
    ask(
        state,
        format!("Delete the milestone {}?", m.title),
        vec![(on, false), ("It can't be brought back".into(), true)],
        vec![("Delete milestone".into(), super::Answer::Delete(subject))],
    );
    Vec::new()
}

#[must_use]
pub(super) fn delete(state: &mut State, repo: RepoId, number: u64) -> Vec<Cmd> {
    crate::forms::sending(state);
    work::start(Save {
        repo,
        number: Some(number),
        write: MilestoneWrite::Delete,
    })
}

impl Job for Save {
    type Out = Option<u64>;

    async fn run(&self, cx: &Cx) -> Result<Option<u64>, Failure> {
        let (gh, repo) = (&cx.gh, &self.repo);
        Ok(match (self.number, &self.write) {
            (None, MilestoneWrite::Save(m)) => Some(gh.create_milestone(repo, m).await?.number),
            (Some(n), MilestoneWrite::Save(m)) => {
                gh.update_milestone(repo, n, m).await?;
                Some(n)
            }
            (Some(n), MilestoneWrite::Close(closed)) => {
                gh.set_milestone_closed(repo, n, *closed).await?;
                Some(n)
            }
            (Some(n), MilestoneWrite::Delete) => {
                gh.delete_milestone(repo, n).await?;
                Some(n)
            }
            (None, _) => None,
        })
    }

    /// GitHub's answer: back on the list or the milestone's page, which
    /// follows GitHub until it shows the change.
    fn done(self, state: &mut State, result: Result<Option<u64>, Failure>) -> Vec<Cmd> {
        let work = self;
        let Save {
            repo,
            number,
            write,
        } = work;
        let form = Route::Housekeeping(FormOf::Milestone {
            repo: repo.clone(),
            number,
        });
        let made = number.is_none();
        let number = match result {
            Ok(Some(n)) => n,
            Ok(None) => return Vec::new(),
            Err(why) => {
                if matches!(write, MilestoneWrite::Close(_)) {
                    state.error(why.to_string());
                    return Vec::new();
                }
                return crate::forms::failed(state, &form, why.to_string());
            }
        };
        let asked = state.route().cloned();
        if let Some(route) = &asked {
            crate::forms::close_sender(state, route);
        }
        state.forms.take::<Form>(&form);
        let mut cmds = Vec::new();
        if state.route() == Some(&form) {
            cmds.extend(state.back());
            state.forward.clear();
        }
        let (closed, title) = match &write {
            MilestoneWrite::Save(m) => {
                let verb = if made { "Created" } else { "Saved" };
                state.info(format!("{verb} the milestone {}", m.title));
                (Some(false), Some(m.title.clone()))
            }
            MilestoneWrite::Close(closed) => {
                state.info(if *closed {
                    "Closed the milestone"
                } else {
                    "Reopened the milestone"
                });
                (Some(*closed), None)
            }
            MilestoneWrite::Delete => {
                state.info("Deleted the milestone");
                (None, None)
            }
        };
        // A deleted milestone's page is gone: its list instead.
        if write == MilestoneWrite::Delete
            && let Some(Route::Issues(issues::Milestone { repo: r, number: n })) =
                state.route().cloned()
            && r == repo
            && n == number
        {
            let list = Route::Issues(issues::Milestones {
                repo: repo.clone(),
                closed: false,
            });
            cmds.extend(state.replace(list, true, None));
        }
        // An edit keeps it open or closed as it was: its title is what's
        // waited for, on the list it's on.
        let closed = match (&write, closed) {
            (MilestoneWrite::Save(_), _) => match state.route() {
                Some(Route::Issues(issues::Milestones { closed, .. })) => Some(*closed),
                Some(Route::Issues(issues::Milestone { repo: r, number: n }))
                    if *r == repo && *n == number =>
                {
                    state
                        .picked::<MilestoneDetail>(&DataKey::Milestone(repo.clone(), number))
                        .map(|d| d.info.closed)
                }
                _ => Some(false),
            },
            (_, closed) => closed,
        };
        let list = match state.route() {
            Some(Route::Issues(issues::Milestones { repo: r, closed })) if *r == repo => {
                Some(Some(*closed))
            }
            Some(Route::Issues(issues::Milestone { repo: r, number: n }))
                if *r == repo && *n == number =>
            {
                Some(None)
            }
            _ => None,
        };
        if let (Some(list), Some(page)) = (list, state.route().cloned()) {
            expect(
                state,
                page.clone(),
                Expected::Milestone {
                    repo,
                    number,
                    list,
                    closed,
                    title,
                },
            );
            cmds.extend(state.ensure_route(&page, true));
        }
        cmds
    }
}

/// The menu's rows on the milestones and a milestone's page.
pub(super) fn doables(state: &State, out: &mut Vec<Doable>) {
    let repo = state.route().and_then(Route::repo);
    let why = repo.and_then(|r| refused(state, r, WHAT));
    out.push(row(
        "New",
        Action::NewHere,
        "New milestone",
        "new",
        why.clone(),
    ));
    let m = picked(state);
    let row_why = why.or_else(|| m.is_none().then(|| "no milestone is selected".to_owned()));
    let title = m.as_ref().map_or("the milestone", |m| m.title.as_str());
    let close = match &m {
        Some(m) if m.closed => format!("Reopen {title}"),
        _ => format!("Close {title}"),
    };
    out.push(row(
        "Edit",
        Action::EditComment,
        format!("Edit {title}"),
        "edit",
        row_why.clone(),
    ));
    out.push(row("Edit", Action::Close, close, "close", row_why.clone()));
    out.push(row(
        "Edit",
        Action::DeleteComment,
        format!("Delete {title}"),
        "",
        row_why,
    ));
}

/// The form's page.
pub(super) fn build(state: &State, page: &mut Page, route: &Route) {
    let Route::Housekeeping(of @ FormOf::Milestone { repo, number }) = route else {
        return;
    };
    let f = form(state, route);
    let heading = match number {
        Some(_) => format!("Edit the milestone in {repo}"),
        None => format!("New milestone in {repo}"),
    };
    let mut status = Vec::new();
    if f.get(Field::Due).is_empty() {
        status.push(("No due date: it's sorted last".to_owned(), Mark::Fine, None));
    }
    let write = state.first_key(Action::Comment);
    let save_key = state.first_key(Action::Create);
    let composing = crate::forms::composing(state, route, 0);
    let body = if composing { "" } else { f.text.as_str() };
    let view = WriteFormView {
        heading,
        base: Some(crate::ui::markdown::LinkBase::new(repo, "HEAD", "")),
        rows: vec![
            form_row(&f, Field::Title, "Title"),
            form_row(&f, Field::Due, "No due date"),
        ],
        status,
        boxes: vec![TextBox {
            title: "Description".into(),
            untitled: "Description",
            body,
            markdown: true,
            empty: "No description.",
            hint: "In Markdown (ctrl-e for $EDITOR)",
            link: Link::Form(crate::ui::form::Row::Text(0)),
            actions: Vec::new(),
        }],
        after: Vec::new(),
        write: &write,
        button: super::button(of, &f),
        save_key: &save_key,
        why_not: super::problem(state, route, of),
        error: state.forms.sent(route).error.as_deref(),
    };
    crate::ui::pages::write_form(page, &view);
}

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

    #[test]
    fn due_dates_are_days_of_the_calendar() {
        assert!(valid_date("2026-02-28"));
        assert!(valid_date("2028-02-29"));
        assert!(!valid_date("2026-02-29"));
        assert!(!valid_date("2026-13-01"));
        assert!(!valid_date("26-01-01"));
        assert!(!valid_date("tomorrow"));
    }
}