upstream-ontologist 0.3.0

tracking of upstream project metadata
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

use clap::Parser;
use serde::Serialize;
use std::collections::HashSet;
use std::io::Write;

use std::path::PathBuf;
use upstream_ontologist::UpstreamDatum;

#[derive(Serialize, Default)]
struct SoftwareSourceCode {
    name: Option<String>,
    version: Option<String>,
    #[serde(rename = "codeRepository")]
    code_repository: Option<String>,
    #[serde(rename = "issueTracker")]
    issue_tracker: Option<String>,
    license: Option<String>,
    description: Option<String>,
    // TODO(jelmer): Support setting contIntegration
    // TODO(jelmer): Support keywords
    // TODO(jelmer): Support funder
    // TODO(jelmer): Support funding
    // TODO(jelmer): Support creation date
    // TODO(jelmer): Support first release date
    // TODO(jelmer): Support unique identifier
    // TODO(jelmer): Support runtime platform
    // TODO(jelmer): Support other software requirements
    // TODO(jelmer): Support operating system
    // TODO(jelmer): Support development status
    // TODO(jelmer): Support reference publication
    // TODO(jelmer): Support part of
    // TODO(jelmer): Support Author
    #[serde(rename = "downloadUrl")]
    download_url: Option<String>,
    #[serde(rename = "relatedLink")]
    related_link: HashSet<String>,
}

fn valid_spdx_identifier(name: &str) -> bool {
    name.chars()
        .all(|c| c.is_ascii_alphanumeric() || c == '-' || c == '+')
}

fn codemeta_file_from_upstream_info(data: Vec<UpstreamDatum>) -> SoftwareSourceCode {
    let mut result = SoftwareSourceCode {
        ..Default::default()
    };
    for upstream_datum in data {
        match upstream_datum {
            UpstreamDatum::Name(n) => {
                result.name = Some(n);
            }
            UpstreamDatum::Homepage(h) => {
                result.related_link.insert(h);
            }
            UpstreamDatum::Description(d) => {
                result.description = Some(d);
            }
            UpstreamDatum::Download(d) => {
                result.download_url = Some(d);
            }
            UpstreamDatum::MailingList(ml) => {
                result.related_link.insert(ml);
            }
            UpstreamDatum::BugDatabase(bd) => {
                result.issue_tracker = Some(bd);
            }
            UpstreamDatum::Screenshots(us) => {
                for u in us {
                    result.related_link.insert(u);
                }
            }
            UpstreamDatum::Wiki(r) => {
                result.related_link.insert(r);
            }
            UpstreamDatum::Repository(r) => {
                result.code_repository = Some(r);
            }
            UpstreamDatum::RepositoryBrowse(r) => {
                result.related_link.insert(r);
            }
            UpstreamDatum::License(l) => {
                if valid_spdx_identifier(&l) {
                    result.license = Some(format!("https://spdx.org/licenses/{}", l));
                }
            }
            UpstreamDatum::Version(v) => {
                result.version = Some(v);
            }
            UpstreamDatum::Documentation(a) => {
                result.related_link.insert(a);
            }
            _ => {}
        }
    }
    result
}

#[derive(Parser, Debug)]
#[command(author, version)]
struct Args {
    /// Whether to allow running code from the package
    #[clap(long)]
    trust: bool,

    /// Whether to enable debug logging
    #[clap(long)]
    debug: bool,

    /// Do not probe external services
    #[clap(long)]
    disable_net_access: bool,

    /// Check guesssed metadata against external sources
    #[clap(long)]
    check: bool,

    /// Path to sources
    #[clap(default_value = ".")]
    path: PathBuf,

    /// Consult external directory for metadata
    #[clap(long)]
    consult_external_directory: bool,
}

#[tokio::main]
async fn main() {
    let args = Args::parse();

    env_logger::builder()
        .format(|buf, record| writeln!(buf, "{}", record.args()))
        .filter(
            None,
            if args.debug {
                log::LevelFilter::Debug
            } else {
                log::LevelFilter::Info
            },
        )
        .init();

    let path = args.path.canonicalize().unwrap();

    let upstream_info = upstream_ontologist::get_upstream_info(
        path.as_path(),
        Some(args.trust),
        Some(!args.disable_net_access),
        Some(args.consult_external_directory),
        Some(args.check),
    )
    .await
    .unwrap();

    let codemeta = codemeta_file_from_upstream_info(upstream_info.into());

    std::io::stdout()
        .write_all(serde_json::to_string_pretty(&codemeta).unwrap().as_bytes())
        .unwrap();
}