gitprint 0.4.0

Convert git repositories into beautifully formatted, printer-friendly PDFs
Documentation
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
//! User report pipeline: fetch GitHub data in parallel, then render PDF.

use tokio::task::JoinSet;

use crate::github::{self, CommitDetail, GitHubEvent, GitHubRepo, GitHubUser};
use crate::pdf;
use crate::types::{ActivityFilter, UserReportConfig};

/// Pre-fetched GitHub data consumed by the PDF render phase.
///
/// Separating the fetch phase from the render phase keeps the render logic
/// testable without any network I/O.
pub(crate) struct UserReportData {
    pub user: GitHubUser,
    pub total_stars: u64,
    pub starred_repos: Vec<GitHubRepo>,
    pub active_repos: Vec<GitHubRepo>,
    pub pushed_repos: Vec<GitHubRepo>,
    pub events: Vec<GitHubEvent>,
    pub commit_msgs: std::collections::HashMap<String, String>,
    pub commit_details: Vec<(String, CommitDetail)>,
}

/// Fetches all GitHub data for the user report (Phases 1 & 2).
///
/// Separated from [`run`] so that [`crate::preview`] can reuse the same fetch
/// logic without triggering PDF rendering.
pub(crate) async fn fetch_data(config: &UserReportConfig) -> anyhow::Result<UserReportData> {
    let token = config.github_token.as_deref();
    let username = &config.username;

    // ── Phase 1: parallel API fetches ─────────────────────────────────────────
    let (user_res, starred_res, active_res, pushed_res, events_res, search_commits_res) = tokio::join!(
        github::get_user(username, token),
        github::get_user_starred_repos(username, 5, token),
        github::get_user_repos(username, "updated", 5, token),
        github::get_user_repos(username, "pushed", config.last_repos, token),
        github::get_user_events(username, 100, token),
        async {
            if config.no_diffs || config.last_commits == 0 {
                Ok(vec![])
            } else {
                github::search_user_commits(username, config.last_commits, token).await
            }
        },
    );

    let user = user_res?;
    let starred_repos = starred_res.unwrap_or_default();

    let events = {
        let raw = coalesce_push_events(events_res.unwrap_or_default());
        let date_filtered = raw.into_iter().filter(|e| {
            let date = e.created_at.get(..10).unwrap_or(&e.created_at);
            config.since.as_deref().is_none_or(|s| date >= s)
                && config.until.as_deref().is_none_or(|u| date <= u)
        });
        match config.activity {
            ActivityFilter::All => date_filtered.collect::<Vec<_>>(),
            ActivityFilter::Commits => date_filtered
                .filter(|e| e.kind == "PushEvent")
                .collect::<Vec<_>>(),
        }
    };

    let push_event_repos: std::collections::HashSet<String> = events
        .iter()
        .filter(|e| e.kind == "PushEvent")
        .map(|e| e.repo.name.clone())
        .collect();
    let other_event_repos: std::collections::HashSet<String> = events
        .iter()
        .filter(|e| e.kind != "PushEvent")
        .map(|e| e.repo.name.clone())
        .collect();

    let pushed_repos: Vec<_> = pushed_res
        .unwrap_or_default()
        .into_iter()
        .filter(|r| {
            !r.fork && (push_event_repos.is_empty() || push_event_repos.contains(&r.full_name))
        })
        .collect();

    let pushed_names: std::collections::HashSet<&str> =
        pushed_repos.iter().map(|r| r.full_name.as_str()).collect();
    let active_repos: Vec<_> = active_res
        .unwrap_or_default()
        .into_iter()
        .filter(|r| {
            !r.fork
                && !pushed_names.contains(r.full_name.as_str())
                && (other_event_repos.is_empty() || other_event_repos.contains(&r.full_name))
        })
        .collect();

    let total_stars: u64 = starred_repos.iter().map(|r| r.stargazers_count).sum();

    // ── Phase 2: fetch commit details in parallel ──────────────────────────────
    let search_commits = match search_commits_res {
        Ok(commits) => commits,
        Err(e) if e.to_string().contains("rate limit") => return Err(e),
        Err(_) => vec![],
    };
    let commit_msgs: std::collections::HashMap<String, String> = search_commits
        .iter()
        .map(|(_, sha, msg)| (sha.clone(), msg.clone()))
        .collect();

    let commit_details: Vec<(String, CommitDetail)> = if !config.no_diffs && config.last_commits > 0
    {
        let shas: Vec<(String, String)> = search_commits
            .into_iter()
            .map(|(repo, sha, _)| (repo, sha))
            .collect();
        eprintln!("Fetching {} commit diff(s)...", shas.len());
        let mut set: JoinSet<anyhow::Result<(String, CommitDetail)>> = JoinSet::new();
        shas.into_iter().for_each(|(repo, sha)| {
            let tok = token.map(str::to_string);
            set.spawn(async move {
                github::get_commit_detail(&repo, &sha, tok.as_deref())
                    .await
                    .map(|cd| (repo, cd))
            });
        });
        let mut details: Vec<(String, CommitDetail)> = set
            .join_all()
            .await
            .into_iter()
            .filter_map(|r| match r {
                Ok(pair) => Some(Ok(pair)),
                Err(e) if e.to_string().contains("rate limit") => Some(Err(e)),
                Err(_) => None,
            })
            .collect::<anyhow::Result<Vec<_>>>()?;
        details.sort_unstable_by(|(_, a), (_, b)| b.commit.author.date.cmp(&a.commit.author.date));
        details
    } else {
        vec![]
    };

    Ok(UserReportData {
        user,
        total_stars,
        starred_repos,
        active_repos,
        pushed_repos,
        events,
        commit_msgs,
        commit_details,
    })
}

/// Runs the full user report pipeline and writes a PDF to `config.output_path`.
pub async fn run(config: &UserReportConfig) -> anyhow::Result<()> {
    let start = std::time::Instant::now();

    eprintln!("Fetching GitHub data for @{}...", config.username);
    let data = fetch_data(config).await?;

    eprintln!("Rendering PDF...");
    let (doc, total_pages) = render_to_doc(config, &data)?;
    pdf::save_pdf(&doc, &config.output_path).await?;

    let elapsed = elapsed_str(start.elapsed());
    let pdf_size = tokio::fs::metadata(&config.output_path)
        .await
        .map(|m| m.len())
        .unwrap_or(0);
    eprintln!(
        "{}{} pages, {}, {}",
        config.output_path.display(),
        total_pages,
        format_size(pdf_size),
        elapsed,
    );
    Ok(())
}

/// Render the user report PDF from pre-fetched data.
///
/// Returns the assembled `PdfDocument` (ready to save) and the page count.
/// No network I/O is performed — all data must be supplied via `data`.
pub(crate) fn render_to_doc(
    config: &UserReportConfig,
    data: &UserReportData,
) -> anyhow::Result<(printpdf::PdfDocument, usize)> {
    let mut doc = printpdf::PdfDocument::new(&format!("{} — GitHub User Report", config.username));
    let fonts = pdf::fonts::load_fonts(&mut doc)?;
    let mut builder = pdf::create_user_builder(config, fonts);

    // Cover page
    pdf::user_cover::render(&mut builder, &data.user, data.total_stars);

    // Activity feed — capped to the requested display limit.
    let display_events = &data.events[..config.events.min(data.events.len())];
    pdf::user_activity::render(&mut builder, display_events, &data.commit_msgs);

    // Repository sections — pass events + fetched commit msgs for rich context
    render_repos_section(
        &mut builder,
        "Top Starred Repositories",
        &data.starred_repos,
        5,
        &data.events,
        &data.commit_msgs,
    );
    render_repos_section(
        &mut builder,
        "Repos You Were Active In",
        &data.active_repos,
        5,
        &data.events,
        &data.commit_msgs,
    );
    render_repos_section(
        &mut builder,
        "Repos User Pushed To",
        &data.pushed_repos,
        config.last_repos,
        &data.events,
        &data.commit_msgs,
    );

    // Commit diffs
    if !data.commit_details.is_empty() {
        // Build SHA → branch from push events so each diff header can show the branch.
        let sha_to_branch: std::collections::HashMap<&str, &str> = data
            .events
            .iter()
            .filter(|e| e.kind == "PushEvent")
            .filter_map(|e| {
                let sha = e.payload["head"].as_str()?;
                let branch = e.payload["ref"].as_str()?.trim_start_matches("refs/heads/");
                Some((sha, branch))
            })
            .collect();

        let bold = builder.font(true, false).clone();
        let black = printpdf::Color::Rgb(printpdf::Rgb::new(0.0, 0.0, 0.0, None));
        builder.write_centered("Recent Commits", &bold, printpdf::Pt(16.0), black);
        builder.vertical_space(12.0);
        data.commit_details.iter().for_each(|(repo, detail)| {
            let branch = sha_to_branch.get(detail.sha.as_str()).copied();
            pdf::diff::render_commit(&mut builder, detail, repo, branch, config.font_size as f32);
        });
    }

    let pages = builder.finish();
    let page_count = pages.len();
    doc.with_pages(pages);
    Ok((doc, page_count))
}

// ── Helpers ────────────────────────────────────────────────────────────────────

/// Keep only the first PushEvent per (date, repo, branch) — GitHub emits one per push, so a busy
/// day can produce many identical-looking entries. Keeping the first (newest) is sufficient.
fn coalesce_push_events(events: Vec<GitHubEvent>) -> Vec<GitHubEvent> {
    let mut seen = std::collections::HashSet::new();
    events
        .into_iter()
        .filter(|event| {
            if event.kind != "PushEvent" {
                return true;
            }
            let date = event.created_at.get(..10).unwrap_or(&event.created_at);
            let branch = event.payload["ref"].as_str().unwrap_or("");
            seen.insert((
                date.to_string(),
                event.repo.name.clone(),
                branch.to_string(),
            ))
        })
        .collect()
}

fn render_repos_section(
    builder: &mut crate::pdf::layout::PageBuilder,
    title: &str,
    repos: &[GitHubRepo],
    limit: usize,
    events: &[GitHubEvent],
    commit_msgs: &std::collections::HashMap<String, String>,
) {
    if limit == 0 || repos.is_empty() {
        return;
    }
    let capped: Vec<_> = repos.iter().take(limit).cloned().collect();
    pdf::user_repos::render(builder, title, &capped, events, commit_msgs);
}

fn format_size(bytes: u64) -> String {
    if bytes < 1024 {
        format!("{bytes} B")
    } else if bytes < 1024 * 1024 {
        format!("{:.1} KB", bytes as f64 / 1024.0)
    } else {
        format!("{:.1} MB", bytes as f64 / (1024.0 * 1024.0))
    }
}

fn elapsed_str(d: std::time::Duration) -> String {
    if d.as_millis() < 1000 {
        format!("{}ms", d.as_millis())
    } else {
        format!("{:.1}s", d.as_secs_f64())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::github::{CommitAuthor, CommitFile, CommitInfo, EventRepo, GitHubUser};
    use crate::types::{ActivityFilter, PaperSize};

    fn make_push_event(repo: &str) -> GitHubEvent {
        GitHubEvent {
            kind: "PushEvent".to_string(),
            repo: EventRepo {
                name: repo.to_string(),
            },
            payload: serde_json::json!({ "ref": "refs/heads/main", "commits": [] }),
            created_at: "2024-03-01T12:00:00Z".to_string(),
        }
    }

    #[test]
    fn coalesce_keeps_first_push_per_day_branch() {
        let events = vec![
            make_push_event("alice/a"),
            make_push_event("alice/a"),
            make_push_event("alice/a"),
        ];
        let out = coalesce_push_events(events);
        assert_eq!(out.len(), 1);
    }

    #[test]
    fn coalesce_keeps_different_branches_separate() {
        let mut ev2 = make_push_event("alice/a");
        ev2.payload["ref"] = serde_json::json!("refs/heads/dev");
        let events = vec![make_push_event("alice/a"), ev2];
        assert_eq!(coalesce_push_events(events).len(), 2);
    }

    #[test]
    fn coalesce_preserves_non_push_events() {
        let events = vec![
            GitHubEvent {
                kind: "WatchEvent".to_string(),
                repo: EventRepo {
                    name: "alice/a".to_string(),
                },
                payload: serde_json::json!({}),
                created_at: "2024-03-01T00:00:00Z".to_string(),
            },
            make_push_event("alice/a"),
            make_push_event("alice/a"),
        ];
        let out = coalesce_push_events(events);
        assert_eq!(out.len(), 2);
        assert_eq!(out[0].kind, "WatchEvent");
    }

    // ── render_to_doc offline tests ───────────────────────────────────────────

    fn mock_user() -> GitHubUser {
        GitHubUser {
            login: "alice".to_string(),
            name: Some("Alice".to_string()),
            bio: None,
            location: None,
            company: None,
            blog: None,
            email: None,
            public_repos: 5,
            followers: 10,
            following: 5,
            created_at: "2020-01-01T00:00:00Z".to_string(),
            html_url: "https://github.com/alice".to_string(),
        }
    }

    fn mock_config(commits: usize) -> UserReportConfig {
        UserReportConfig {
            username: "alice".to_string(),
            output_path: "/tmp/test-commits.pdf".into(),
            paper_size: PaperSize::A4,
            landscape: false,
            last_repos: 0,
            last_commits: commits,
            no_diffs: false,
            font_size: 8.0,
            github_token: None,
            since: None,
            until: None,
            activity: ActivityFilter::All,
            events: 0,
        }
    }

    /// Generate a mock `(repo, CommitDetail)` with a large diff patch so it
    /// occupies several lines in the rendered PDF.
    fn mock_commit_detail(idx: usize) -> (String, CommitDetail) {
        let patch: String = (0..80).map(|i| format!("+added line {i}\n")).collect();
        (
            format!("alice/repo{idx}"),
            CommitDetail {
                sha: format!("{idx:040x}"),
                html_url: format!("https://github.com/alice/repo{idx}/commit/{idx:040x}"),
                commit: CommitInfo {
                    message: format!("commit #{idx}: add many lines"),
                    author: CommitAuthor {
                        name: "Alice".to_string(),
                        date: format!("2024-03-{:02}T12:00:00Z", idx % 28 + 1),
                    },
                },
                files: vec![CommitFile {
                    filename: format!("src/module{idx}.rs"),
                    status: "modified".to_string(),
                    additions: 80,
                    deletions: 0,
                    patch: Some(patch),
                }],
            },
        )
    }

    fn empty_report_data() -> UserReportData {
        UserReportData {
            user: mock_user(),
            total_stars: 0,
            starred_repos: vec![],
            active_repos: vec![],
            pushed_repos: vec![],
            events: vec![],
            commit_msgs: std::collections::HashMap::new(),
            commit_details: vec![],
        }
    }

    #[test]
    fn render_to_doc_no_commits_succeeds() {
        let (_, pages) = render_to_doc(&mock_config(0), &empty_report_data()).unwrap();
        assert!(pages > 0);
    }

    /// More commits with large diffs must produce more PDF pages than zero commits.
    /// This verifies the `--last-commits` flag actually drives the diff render path.
    #[test]
    fn more_commits_yields_more_pages() {
        let (_, pages_baseline) = render_to_doc(&mock_config(0), &empty_report_data()).unwrap();

        let data_with_commits = UserReportData {
            commit_details: (0..10).map(mock_commit_detail).collect(),
            ..empty_report_data()
        };
        let (_, pages_with_commits) = render_to_doc(&mock_config(10), &data_with_commits).unwrap();

        assert!(
            pages_with_commits > pages_baseline,
            "expected more pages with commits ({pages_with_commits}) than without ({pages_baseline})"
        );
    }
}