lazyspec 0.8.0

A little TUI & CLI for project documentation.
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

use anyhow::{bail, Result};
use std::path::Path;
use std::process::Command;

use crate::engine::config::Config;

/// Resolves the GitHub repo from config or by inferring from git remote.
pub fn resolve_repo(config: &Config, root: &Path) -> Result<String> {
    if let Some(ref gh) = config.documents.github {
        if let Some(ref repo) = gh.repo {
            return Ok(repo.clone());
        }
    }
    infer_github_repo(root)
}

/// Parses `owner/repo` from a git remote URL.
///
/// Supports SSH (`git@github.com:owner/repo.git`) and
/// HTTPS (`https://github.com/owner/repo.git` or without `.git`).
fn parse_owner_repo(url: &str) -> Result<String> {
    let path = if let Some(rest) = url.strip_prefix("git@") {
        // git@github.com:owner/repo.git
        rest.split_once(':').map(|(_, path)| path).unwrap_or(rest)
    } else if url.starts_with("https://") || url.starts_with("http://") {
        // https://github.com/owner/repo.git
        url.split("//")
            .nth(1)
            .and_then(|s| s.split_once('/').map(|x| x.1))
            .unwrap_or("")
    } else {
        bail!("unrecognised git remote URL format: {}", url);
    };

    let path = path.trim_end_matches(".git").trim_matches('/');

    let parts: Vec<&str> = path.splitn(3, '/').collect();
    if parts.len() < 2 || parts[0].is_empty() || parts[1].is_empty() {
        bail!("could not extract owner/repo from remote URL: {}", url);
    }

    Ok(format!("{}/{}", parts[0], parts[1]))
}

/// Infers `owner/repo` by running `git remote get-url origin` in the given
/// project root directory. Falls back to URL parsing of the remote.
pub fn infer_github_repo(project_root: &Path) -> Result<String> {
    let output = Command::new("git")
        .args(["remote", "get-url", "origin"])
        .current_dir(project_root)
        .output()?;

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        bail!("git remote get-url origin failed: {}", stderr.trim());
    }

    let url = String::from_utf8_lossy(&output.stdout).trim().to_string();
    parse_owner_repo(&url)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::engine::config::GithubConfig;

    #[test]
    fn resolve_repo_prefers_config() {
        let mut config = Config::default();
        config.documents.github = Some(GithubConfig {
            repo: Some("configured/repo".to_string()),
            cache_ttl: 60,
        });
        let repo = resolve_repo(&config, Path::new("/nonexistent")).unwrap();
        assert_eq!(repo, "configured/repo");
    }

    #[test]
    fn resolve_repo_fails_without_config_or_git() {
        let config = Config::default();
        let result = resolve_repo(&config, Path::new("/nonexistent"));
        assert!(result.is_err());
    }

    #[test]
    fn ssh_url() {
        let result = parse_owner_repo("git@github.com:owner/repo.git").unwrap();
        assert_eq!(result, "owner/repo");
    }

    #[test]
    fn https_url_with_dot_git() {
        let result = parse_owner_repo("https://github.com/owner/repo.git").unwrap();
        assert_eq!(result, "owner/repo");
    }

    #[test]
    fn https_url_without_dot_git() {
        let result = parse_owner_repo("https://github.com/owner/repo").unwrap();
        assert_eq!(result, "owner/repo");
    }

    #[test]
    fn ssh_url_without_dot_git() {
        let result = parse_owner_repo("git@github.com:owner/repo").unwrap();
        assert_eq!(result, "owner/repo");
    }

    #[test]
    fn https_url_with_trailing_slash() {
        let result = parse_owner_repo("https://github.com/owner/repo/").unwrap();
        assert_eq!(result, "owner/repo");
    }

    #[test]
    fn rejects_garbage() {
        assert!(parse_owner_repo("not-a-url").is_err());
    }

    #[test]
    fn rejects_url_missing_repo() {
        assert!(parse_owner_repo("https://github.com/owner").is_err());
    }

    #[test]
    fn ignores_extra_path_segments() {
        let result = parse_owner_repo("https://github.com/owner/repo/tree/main").unwrap();
        assert_eq!(result, "owner/repo");
    }
}