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

//! A repository's wiki: a page, and the form that writes one.

use super::{Family, Route, Target, Url};
use crate::api::browse::WikiPage;
use crate::api::model::RepoId;
use crate::browse::{Build, Width};
use crate::chrome::Section;
use crate::data::DataKey;
use crate::state::State;
use crate::ui::pages::{self, url as links};

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Page {
    /// A wiki page (its Home without one; its pages for `_pages`).
    Wiki { repo: RepoId, page: Option<String> },
    /// The form writing a wiki page (a new one without `page`).
    WikiEdit { repo: RepoId, page: Option<String> },
}

pub use Page::*;

impl Page {
    fn parts(&self) -> (&RepoId, Option<&String>) {
        match self {
            Wiki { repo, page } | WikiEdit { repo, page } => (repo, page.as_ref()),
        }
    }
}

impl Family for Page {
    fn url(&self) -> String {
        let (repo, page) = self.parts();
        let wiki = format!("{}/wiki", links::repo(repo));
        match (self, page) {
            (Wiki { .. }, Some(page)) => format!("{wiki}/{}", links::encode_path(page)),
            (Wiki { .. }, None) => wiki,
            (WikiEdit { .. }, Some(page)) => format!("{wiki}/{}/_edit", links::encode_path(page)),
            (WikiEdit { .. }, None) => format!("{wiki}/_new"),
        }
    }

    fn title(&self) -> String {
        let (repo, page) = self.parts();
        match (self, page) {
            (Wiki { .. }, Some(page)) => format!("{repo} · {}", page.replace('-', " ")),
            (Wiki { .. }, None) => format!("{repo} · Wiki"),
            (WikiEdit { .. }, Some(page)) => format!("{repo} · Editing {page}"),
            (WikiEdit { .. }, None) => format!("{repo} · New wiki page"),
        }
    }

    fn repo(&self) -> Option<&RepoId> {
        Some(self.parts().0)
    }

    fn up(&self, _: &State) -> Option<Route> {
        let (repo, page) = self.parts();
        let repo = repo.clone();
        Some(match (self, page) {
            (Wiki { .. }, None) => Route::Code(super::code::Repo(repo)),
            (Wiki { .. }, Some(_)) => Route::Wiki(Wiki { repo, page: None }),
            (WikiEdit { .. }, page) => Route::Wiki(Wiki {
                repo,
                page: page.cloned(),
            }),
        })
    }

    fn needs(&self) -> Vec<DataKey> {
        let (repo, page) = self.parts();
        let own = match self {
            Wiki { .. } => DataKey::Wiki(repo.clone(), page.cloned()),
            WikiEdit { .. } => crate::wiki::form::key(repo, page),
        };
        vec![DataKey::Repo(repo.clone()), own]
    }

    fn width(&self) -> Width {
        Width::Reading
    }

    fn section(&self) -> Section {
        Section::Wiki
    }

    fn form(&self) -> Option<&'static crate::forms::Kind> {
        matches!(self, WikiEdit { .. }).then_some(&crate::wiki::form::FORM)
    }

    fn build(&self, b: Build<'_>, page: &mut crate::ui::page::Page) {
        let (repo, name) = self.parts();
        let title = self.title();
        match self {
            Wiki { .. } => {
                let key = DataKey::Wiki(repo.clone(), name.cloned());
                if let Some(w) = b.get(&key).show(page, &title) {
                    pages::wiki(page, repo, w);
                }
            }
            WikiEdit { .. } => {
                let key = crate::wiki::form::key(repo, name);
                if b.get::<WikiPage>(&key).show(page, &title).is_some() {
                    crate::wiki::form::build(b.state, page, &Route::Wiki(self.clone()));
                }
            }
        }
    }
}

pub(super) fn parse_repo(repo: &RepoId, rest: &[&str], _: &Url<'_>) -> Option<Target> {
    let repo = repo.clone();
    let page = match rest {
        ["wiki", "_new"] => WikiEdit { repo, page: None },
        ["wiki", page, "_edit"] if !page.contains(char::is_control) => WikiEdit {
            repo,
            page: Some((*page).to_owned()),
        },
        // A wiki's comparisons are on GitHub.
        ["wiki", .., "_compare"] => return None,
        // A wiki's own pages but its list (history, comparisons).
        ["wiki", special, ..] if special.starts_with('_') && *special != "_pages" => return None,
        // A page's revisions and history: the page.
        ["wiki", rest @ ..] if !rest.iter().any(|p| p.contains(char::is_control)) => Wiki {
            repo,
            page: rest.first().map(|p| (*p).to_owned()),
        },
        _ => return None,
    };
    Some(Target::Page(Route::Wiki(page)))
}

#[cfg(test)]
pub(crate) fn arb() -> impl proptest::strategy::Strategy<Value = Route> {
    use crate::route::arb::repo;
    use proptest::prelude::*;
    let name = || prop::option::of("[A-Za-z0-9][A-Za-z0-9 _-]{0,15}");
    let page = prop_oneof![
        (repo(), name()).prop_map(|(repo, page)| WikiEdit { repo, page }),
        (repo(), name())
            .prop_filter("not a writing page", |(_, p)| {
                !matches!(p.as_deref(), Some("_new" | "_edit" | "_compare"))
            })
            .prop_map(|(repo, page)| Wiki { repo, page }),
    ];
    page.prop_map(Route::Wiki)
}