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
//! Forking a repository, and making a new one, as GitHub's two forms do;
//! then the new repository's page, which follows GitHub until it's
//! there, and (for a new one) an offer to clone it.

use crate::route::{Route, code};
use std::path::PathBuf;

use crate::api::housekeeping::{MadeRepo, NewFork, NewRepo, Owners, Templates};
use crate::api::model::RepoId;
use crate::picker::fuzzy_score;
use crate::ui::page::Page;
use crate::ui::pages::{Mark, WriteFormView};

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

/// Forking a repository; the form's page asked.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Fork {
    pub route: Route,
    pub new: NewFork,
}

/// Making a new repository; the form's page asked.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Make {
    pub route: Route,
    pub new: NewRepo,
}

/// Cloning a new repository into `dir`, with your own git.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CloneTo {
    pub url: String,
    pub dir: PathBuf,
}

fn owners(state: &State) -> Option<&Owners> {
    state.picked(&DataKey::Owners)
}

/// `,F`: the repository's fork form.
#[must_use]
pub(super) fn open_fork(state: &mut State) -> Vec<Cmd> {
    let Some(repo) = state.route().and_then(Route::repo).cloned() else {
        return state.just_say("Open a repository first: a fork is of one");
    };
    super::open(state, FormOf::Fork(repo))
}

/// Fills the fork's form once GitHub says who you are: your account, the
/// repository's name, its default branch only.
#[must_use]
pub(super) fn follow_fork(state: &mut State, route: &Route, repo: &RepoId) -> Vec<Cmd> {
    if form(state, route).started {
        return Vec::new();
    }
    let Some(viewer) = owners(state).map(|o| o.viewer.clone()) else {
        return Vec::new();
    };
    let f = form_mut(state, route);
    f.started = true;
    f.set(Field::Owner, viewer);
    f.set(Field::Name, repo.name.clone());
    Vec::new()
}

/// Fills the new repository's form once GitHub says who you are; then
/// its name is asked for.
#[must_use]
pub(super) fn follow_new(state: &mut State, route: &Route) -> Vec<Cmd> {
    if form(state, route).started {
        return Vec::new();
    }
    let Some(viewer) = owners(state).map(|o| o.viewer.clone()) else {
        return Vec::new();
    };
    let f = form_mut(state, route);
    f.started = true;
    f.set(Field::Owner, viewer);
    if state.overlay.is_none() {
        return super::open_field(state, route, Field::Name);
    }
    Vec::new()
}

/// Why `name` can't name a repository, if it can't: GitHub takes
/// letters, digits, `-`, `_` and `.`, and turns anything else into `-`.
pub(super) fn name_problem(name: &str) -> Option<String> {
    let ok = |c: char| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.');
    if name.is_empty() {
        Some("A repository needs a name".into())
    } else if !name.chars().all(ok) {
        Some("A repository's name is letters, digits, -, _ and .".into())
    } else if name == "." || name == ".." || name.len() > 100 {
        Some("That can't be a repository's name".into())
    } else {
        None
    }
}

/// The owner, as GitHub's API takes it: none for your account.
fn org(state: &State, f: &Form) -> Option<String> {
    let viewer = owners(state).map(|o| o.viewer.as_str());
    let owner = f.get(Field::Owner);
    (Some(owner) != viewer && !owner.is_empty()).then(|| owner.to_owned())
}

/// Why the form can't be sent yet: who you are unknown, a bad name.
pub(super) fn repo_problem(f: &Form) -> Option<String> {
    if f.get(Field::Owner).is_empty() {
        return Some("Still asking GitHub who you are".into());
    }
    name_problem(f.get(Field::Name).trim())
}

/// [`repo_problem`], and a fork to where the repository is already.
pub(super) fn fork_problem(state: &State, repo: &RepoId, f: &Form) -> Option<String> {
    let owner = f.get(Field::Owner);
    if owner.eq_ignore_ascii_case(&repo.owner) {
        let parent = state.overview(repo).and_then(|o| o.parent.clone());
        return Some(match parent {
            Some(parent) => {
                format!("{repo} is {owner}'s fork of {parent} already: choose another owner")
            }
            None => format!("{owner} owns {repo}: fork it to another owner"),
        });
    }
    repo_problem(f)
}

/// The owner picker's rows: you, then your organizations.
pub(super) fn owner_rows(
    state: &State,
    route: &Route,
    q: &str,
) -> Vec<(
    crate::ui::overlays::PaletteItem,
    Option<crate::picker::Choice>,
)> {
    let Some(o) = owners(state) else {
        return vec![item("Asking GitHub who you are…", "", None)];
    };
    let set = |login: &str| setting(route, Field::Owner, login);
    let mut rows = Vec::new();
    if fuzzy_score(q, &o.viewer).is_some() {
        rows.push(item(o.viewer.clone(), "your account", set(&o.viewer)));
    }
    for (login, can) in &o.orgs {
        if fuzzy_score(q, login).is_none() {
            continue;
        }
        rows.push(if *can {
            item(login.clone(), "organization", set(login))
        } else {
            item(
                login.clone(),
                "the organization doesn't let you make repositories",
                None,
            )
        });
    }
    if o.more > 0 {
        rows.push(item(
            format!("{} more organizations GitHub didn't list", o.more),
            "",
            None,
        ));
    }
    rows
}

/// The `.gitignore` or licence picker's rows: none, then GitHub's.
/// The licence row, by the licence's name (`MIT License`), not the key
/// GitHub's API takes (`mit`).
fn licence_row(state: &State, f: &Form) -> crate::ui::pages::FormRow {
    let mut row = form_row(f, Field::License, "None");
    let templates = state.picked::<Templates>(&DataKey::Templates);
    let named = templates.and_then(|t| {
        (t.licenses.iter())
            .find(|(key, _)| *key == row.value)
            .map(|(_, name)| name.clone())
    });
    if let Some(name) = named {
        row.value = name;
    }
    row
}

pub(super) fn template_rows(
    state: &State,
    route: &Route,
    field: Field,
    q: &str,
) -> Vec<(
    crate::ui::overlays::PaletteItem,
    Option<crate::picker::Choice>,
)> {
    let set = |value: &str| setting(route, field, value);
    let Some(t) = state.picked::<Templates>(&DataKey::Templates) else {
        return vec![item("Loading GitHub's templates…", "", None)];
    };
    let mut rows = Vec::new();
    if fuzzy_score(q, "none").is_some() {
        rows.push(item("None", "", set("")));
    }
    let mut hits: Vec<(usize, String, String)> = match field {
        Field::Gitignore => (t.gitignores.iter())
            .filter_map(|g| Some((fuzzy_score(q, g)?, g.clone(), g.clone())))
            .collect(),
        _ => (t.licenses.iter())
            .filter_map(|(key, name)| Some((fuzzy_score(q, name)?, name.clone(), key.clone())))
            .collect(),
    };
    hits.sort_by_key(|(score, ..)| *score);
    for (_, label, value) in hits {
        rows.push(item(label, "", set(&value)));
    }
    rows
}

/// The fork's form sent.
#[must_use]
pub(super) fn fork(state: &mut State, route: &Route, repo: &RepoId) -> Vec<Cmd> {
    let f = form(state, route);
    if let Some(why) = fork_problem(state, repo, &f) {
        return crate::forms::say(state, why);
    }
    let new = NewFork {
        repo: repo.clone(),
        org: org(state, &f),
        name: f.get(Field::Name).trim().to_owned(),
        default_branch_only: !f.on(Field::AllBranches),
    };
    crate::forms::form_sending(state, route);
    state.info(format!("Forking {repo}…"));
    work::start(Fork {
        route: route.clone(),
        new,
    })
}

/// The new repository's form sent.
#[must_use]
pub(super) fn create(state: &mut State, route: &Route) -> Vec<Cmd> {
    let f = form(state, route);
    if let Some(why) = repo_problem(&f) {
        return crate::forms::say(state, why);
    }
    let template = |field| Some(f.get(field).to_owned()).filter(|v| !v.is_empty());
    let new = NewRepo {
        org: org(state, &f),
        name: f.get(Field::Name).trim().to_owned(),
        description: f.get(Field::Description).trim().to_owned(),
        private: f.on(Field::Private),
        readme: f.on(Field::Readme),
        gitignore: template(Field::Gitignore),
        license: template(Field::License),
    };
    crate::forms::form_sending(state, route);
    state.info(format!("Creating {}…", new.name));
    work::start(Make {
        route: route.clone(),
        new,
    })
}

/// Made: the form gives way to the repository's page, which follows
/// GitHub until it's there.
#[must_use]
fn opened(state: &mut State, route: &Route, made: &MadeRepo) -> Option<Vec<Cmd>> {
    crate::forms::done::<Form>(state, route);
    let repo = made.repo()?;
    if state.route() != Some(route) {
        return Some(Vec::new());
    }
    let page = Route::Code(code::Repo(repo.clone()));
    let cmds = state.replace(page.clone(), true, None);
    expect(state, page, Expected::Repo(repo));
    Some(cmds)
}

impl Job for Fork {
    type Out = MadeRepo;

    async fn run(&self, cx: &Cx) -> Result<MadeRepo, Failure> {
        Ok(cx.gh.fork(&self.new).await?)
    }

    fn done(self, state: &mut State, result: Result<MadeRepo, Failure>) -> Vec<Cmd> {
        let Fork { route, .. } = &self;
        match result {
            Ok(made) => {
                state.info(format!(
                    "Forked as {}: GitHub may take a moment to copy it",
                    made.full_name
                ));
                opened(state, route, &made).unwrap_or_default()
            }
            Err(why) => crate::forms::failed(state, route, why.to_string()),
        }
    }
}

impl Job for Make {
    type Out = MadeRepo;

    async fn run(&self, cx: &Cx) -> Result<MadeRepo, Failure> {
        Ok(cx.gh.create_repo(&self.new).await?)
    }

    fn done(self, state: &mut State, result: Result<MadeRepo, Failure>) -> Vec<Cmd> {
        let Make { route, .. } = &self;
        let made = match result {
            Ok(made) => made,
            Err(why) => {
                return crate::forms::failed(state, route, why.to_string());
            }
        };
        state.info(format!("Created {}", made.full_name));
        let on_form = state.route() == Some(route);
        let cmds = opened(state, route, &made).unwrap_or_default();
        // Offered as GitHub's page offers it: its clone command, run here.
        let Some(repo) = made.repo().filter(|_| on_form) else {
            return cmds;
        };
        let dir = PathBuf::from(&repo.name);
        let fact = format!(
            "Into ./{} here, with your own git: git clone {}",
            dir.display(),
            made.clone_url
        );
        let url = made.clone_url.clone();
        let clone = super::Answer::Clone { url, dir };
        ask(
            state,
            format!("Clone {repo}?"),
            vec![(fact, false)],
            vec![("Clone it".into(), clone)],
        );
        cmds
    }
}

impl Job for CloneTo {
    type Out = ();
    const WRITES: bool = false;

    async fn run(&self, _: &Cx) -> Result<(), Failure> {
        super::git::clone(&self.url, &self.dir)
            .await
            .map_err(Failure::msg)
    }

    fn done(self, state: &mut State, result: Result<(), Failure>) -> Vec<Cmd> {
        let CloneTo { dir, .. } = &self;
        match result {
            Ok(()) => {
                state.overlay = None;
                state.just_say(format!("Cloned into ./{}", dir.display()))
            }
            Err(why) => crate::forms::say(state, why.to_string()),
        }
    }
}

/// The fork's or the new repository's page.
pub(super) fn build(state: &State, page: &mut Page, route: &Route, of: &FormOf) {
    let f = form(state, route);
    let (heading, rows, mut status) = match of {
        FormOf::Fork(repo) => (
            format!("Create a new fork of {repo}"),
            vec![
                form_row(&f, Field::Owner, "Asking GitHub who you are…"),
                form_row(&f, Field::Name, "Repository name"),
                form_row(&f, Field::AllBranches, ""),
            ],
            vec![(
                "A fork is a copy of the repository, under the owner you choose".to_owned(),
                Mark::Fine,
                None,
            )],
        ),
        _ => (
            "Create a new repository".to_owned(),
            vec![
                form_row(&f, Field::Owner, "Asking GitHub who you are…"),
                form_row(&f, Field::Name, "Repository name"),
                form_row(&f, Field::Description, "Description (optional)"),
                form_row(&f, Field::Private, ""),
                form_row(&f, Field::Readme, ""),
                form_row(&f, Field::Gitignore, "None"),
                licence_row(state, &f),
            ],
            Vec::new(),
        ),
    };
    let owner = f.get(Field::Owner);
    let name = f.get(Field::Name).trim();
    if !owner.is_empty() && !name.is_empty() {
        status.push((format!("It will be {owner}/{name}"), Mark::Fine, None));
    }
    let save_key = state.first_key(Action::Create);
    let view = WriteFormView {
        heading,
        base: None,
        rows,
        status,
        boxes: Vec::new(),
        after: Vec::new(),
        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 repository_names_are_githubs() {
        assert_eq!(name_problem("ghtui-live-1"), None);
        assert_eq!(name_problem("a.b_c"), None);
        assert!(name_problem("has space").is_some());
        assert!(name_problem("..").is_some());
        assert!(name_problem("").is_some());
    }
}