forkctl 0.0.19

Control audited StGit downstream patch stacks
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

use crate::manifest::{CheckStage, HistoryEvent, Manifest, PatchKind};
use anyhow::{Context, Result};
use askama::Template;

#[derive(Template)]
#[template(path = "patches.md", escape = "none")]
struct LedgerTemplate<'a> {
    target_selector: String,
    base_sha: &'a str,
    patches: Vec<PatchRow>,
    disabled: Vec<DisabledRow>,
    checks: Vec<CheckRow>,
    history: Vec<HistoryRow>,
}

struct PatchRow {
    name: String,
    kind: &'static str,
    purpose: String,
    upstream_status: String,
    drop_when: String,
}

struct CheckRow {
    patch: String,
    name: String,
    stage: &'static str,
    glob: String,
    run: String,
}

struct HistoryRow {
    kind: &'static str,
    patch: String,
    commit: String,
    target: String,
    target_commit: String,
    purpose: String,
}

struct DisabledRow {
    name: String,
    commit: String,
    reason: String,
    position: usize,
}

pub fn render(manifest: &Manifest) -> Result<String> {
    let history = history_rows(manifest);
    let checks = manifest
        .patches
        .iter()
        .flat_map(|patch| {
            patch.checks.iter().map(|check| CheckRow {
                patch: escape(&patch.name),
                name: escape(&check.name),
                stage: match check.at {
                    CheckStage::Stack => "stack",
                    CheckStage::Patch => "patch",
                },
                glob: escape(
                    &patch
                        .check_globs(check)
                        .iter()
                        .map(String::as_str)
                        .collect::<Vec<_>>()
                        .join(", "),
                ),
                run: escape(&check.run),
            })
        })
        .collect();
    LedgerTemplate {
        target_selector: escape(&manifest.base.target.selector),
        base_sha: &manifest.base.stack,
        patches: manifest
            .patches
            .iter()
            .map(|patch| PatchRow {
                name: escape(&patch.name),
                kind: patch_kind(patch.kind),
                purpose: escape(&patch.purpose),
                upstream_status: escape(&patch.upstream_status),
                drop_when: escape(&patch.drop_when),
            })
            .collect(),
        disabled: manifest
            .disabled_patches
            .iter()
            .map(|record| DisabledRow {
                name: escape(&record.patch.name),
                commit: record.commit.clone(),
                reason: escape(&record.reason),
                position: record.position,
            })
            .collect(),
        checks,
        history,
    }
    .render()
    .context("render PATCHES.md")
}

fn history_rows(manifest: &Manifest) -> Vec<HistoryRow> {
    manifest
        .history
        .iter()
        .flat_map(|event| match event {
            HistoryEvent::Rebase {
                target,
                dropped,
                path_changes,
                ..
            } => dropped
                .iter()
                .map(|item| HistoryRow {
                    kind: "upstream merged",
                    patch: escape(&item.patch.name),
                    commit: item.commit.clone(),
                    target: escape(&target.selector),
                    target_commit: target.commit.clone(),
                    purpose: escape(&item.patch.purpose),
                })
                .chain(path_changes.iter().map(|item| HistoryRow {
                    kind: "replay path change",
                    patch: escape(&item.patch),
                    commit: item.commit.clone(),
                    target: escape(&target.selector),
                    target_commit: target.commit.clone(),
                    purpose: format!(
                        "Lost paths after replay: {}",
                        escape(
                            &item
                                .lost_paths
                                .iter()
                                .map(String::as_str)
                                .collect::<Vec<_>>()
                                .join(", ")
                        )
                    ),
                }))
                .collect::<Vec<_>>(),
            HistoryEvent::PatchRemoved { record } => vec![HistoryRow {
                kind: "removed",
                patch: escape(&record.patch.name),
                commit: record.commit.clone(),
                target: "—".into(),
                target_commit: "—".into(),
                purpose: escape(&record.reason),
            }],
            HistoryEvent::PatchEnabled { record, .. } => vec![HistoryRow {
                kind: "re-enabled",
                patch: escape(&record.patch.name),
                commit: record.commit.clone(),
                target: "—".into(),
                target_commit: "—".into(),
                purpose: escape(&record.reason),
            }],
        })
        .collect()
}

fn patch_kind(kind: PatchKind) -> &'static str {
    match kind {
        PatchKind::Source => "source",
        PatchKind::Tooling => "tooling",
    }
}

fn escape(value: &str) -> String {
    value
        .replace('\\', "\\\\")
        .replace('|', "\\|")
        .replace('`', "\\`")
}