snakedown 0.3.0

This is a snakedown. Hand over your docs, nice and clean, and nobody gets confused.
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

use color_eyre::{Result, eyre::eyre};
use flate2::bufread::ZlibDecoder;
use std::{
    fs::File,
    io::{BufRead, BufReader, Read},
    path::Path,
};
use tracing::error;

use crate::parsing::sphinx::types::ExternalSphinxRef;

#[derive(Debug, PartialEq)]
pub enum SphinxInvVersion {
    V1,
    V2,
}

fn parse_inv_version<R: Read>(reader: &mut BufReader<R>) -> Result<SphinxInvVersion> {
    let mut line = String::new();
    reader.read_line(&mut line)?;
    // this is how sphinx itself does it https://github.com/sphinx-doc/sphinx/blob/ac3f74a3e0fbb326f73989a16dfa369e072064ca/sphinx/util/inventory.py#L126
    // this part should only have ascii so we should be fine using just chars
    // even though they might be unicode
    let v: String = line.chars().skip(27).collect::<String>().trim().to_string();
    let version: usize = v.parse()?;

    match version {
        1 => Ok(SphinxInvVersion::V1),
        2 => Ok(SphinxInvVersion::V2),
        _ => Err(eyre!("unknown version: {version}")),
    }
}

fn parse_inv_project_name<R: Read>(reader: &mut BufReader<R>) -> Result<String> {
    let mut line = String::new();
    reader.read_line(&mut line)?;
    // this is how sphinx itself does it https://github.com/sphinx-doc/sphinx/blob/ac3f74a3e0fbb326f73989a16dfa369e072064ca/sphinx/util/inventory.py#L126
    let (_, proj_name) = line.split_at(11);

    Ok(proj_name.trim().to_string())
}

fn parse_inv_project_version<R: Read>(reader: &mut BufReader<R>) -> Result<String> {
    let mut line = String::new();
    reader.read_line(&mut line)?;
    // this is how sphinx itself does it https://github.com/sphinx-doc/sphinx/blob/ac3f74a3e0fbb326f73989a16dfa369e072064ca/sphinx/util/inventory.py#L126
    let (_, proj_version) = line.split_at(11);

    Ok(proj_version.trim().to_string())
}

fn parse_sphinx_inv_header<R: Read>(
    reader: &mut BufReader<R>,
) -> Result<(SphinxInvVersion, String, String)> {
    let inv_version = parse_inv_version(reader)?;
    if inv_version != SphinxInvVersion::V2 {
        return Err(eyre!("Inventory file format not supported"));
    }
    let inv_project_name = parse_inv_project_name(reader)?;
    let inv_project_version = parse_inv_project_version(reader)?;
    let mut warning_header = String::new();
    reader.read_line(&mut warning_header)?;

    if !warning_header.contains("zlib") {
        return Err(eyre!("Sphinx inventory file was not compressed with zlib"));
    }

    Ok((inv_version, inv_project_name, inv_project_version))
}

fn decompress_remaining_zlib_data<R: Read>(reader: &mut BufReader<R>) -> Result<String> {
    // Read the rest of the file and decompress it using zlib
    let mut compressed_data = Vec::new();
    reader.read_to_end(&mut compressed_data)?;

    let mut decoder = ZlibDecoder::new(&compressed_data[..]);
    let mut decompressed_data = Vec::new();
    decoder.read_to_end(&mut decompressed_data)?;
    let decompressed_text = String::from_utf8(decompressed_data)?;
    Ok(decompressed_text)
}

pub fn parse_objects_inv<R: Read>(mut reader: BufReader<R>) -> Result<Vec<ExternalSphinxRef>> {
    let mut references = vec![];
    let (_inv_ver, _proj_name, _proj_ver) = parse_sphinx_inv_header(&mut reader)?;

    let decompressed = decompress_remaining_zlib_data(&mut reader)?;

    for line in decompressed.lines() {
        match ExternalSphinxRef::try_from(line) {
            Ok(sr) => references.push(sr),
            Err(e) => error!("Error {} occurred while parsing line: {}", e, line),
        }
    }
    Ok(references)
}

pub fn parse_objects_inv_file(path: &Path) -> Result<Vec<ExternalSphinxRef>> {
    let file = File::open(path)?;
    let reader = BufReader::new(&file);
    parse_objects_inv(reader)
}

#[cfg(test)]
mod test {
    use assert_fs::TempDir;
    use color_eyre::Result;
    use std::fs::File;
    use std::io::{BufReader, Write};
    use std::path::PathBuf;

    use crate::parsing::sphinx::inv_file::{
        SphinxInvVersion, decompress_remaining_zlib_data, parse_inv_version,
        parse_objects_inv_file, parse_sphinx_inv_header,
    };
    use crate::parsing::sphinx::types::ExternalSphinxRef;

    fn write_test_header(header: &str) -> Result<(TempDir, PathBuf)> {
        let temp_dir = TempDir::new()?;
        let path = temp_dir.join("header_file.inv");
        let mut file = File::create(&path)?;
        file.write_all(header.as_bytes())?;

        Ok((temp_dir, path))
    }

    #[test]
    fn test_numpy_header() -> Result<()> {
        let header = "# Sphinx inventory version 2
# Project: NumPy
# Version: 2.3
# The remainder of this file is compressed using zlib.";

        let (_temp_dir, header_path) = write_test_header(header)?;
        let file = File::open(header_path)?;
        let mut reader = BufReader::new(&file);
        let (inv_ver, proj_name, proj_ver) = parse_sphinx_inv_header(&mut reader)?;
        assert_eq!(inv_ver, SphinxInvVersion::V2);
        assert_eq!(proj_name, "NumPy".to_string());
        assert_eq!(proj_ver, "2.3".to_string());
        Ok(())
    }

    #[test]
    fn test_garbange_header() -> Result<()> {
        let header = "# Sphinx inventory version 3.14...
# Project: asdfasdf
# Version: ll.3
# The remainder of this file is compressed using my butt.";

        let (_temp_dir, header_path) = write_test_header(header)?;
        let file = File::open(header_path)?;
        let mut reader = BufReader::new(&file);
        let result = parse_sphinx_inv_header(&mut reader);
        assert!(result.is_err());
        Ok(())
    }

    #[test]
    fn test_short_header() -> Result<()> {
        let header = "# Sphinx inventory version 2
# Project: NumPy
# Version: 2.3";

        let (_temp_dir, header_path) = write_test_header(header)?;
        let file = File::open(header_path)?;
        let mut reader = BufReader::new(&file);
        let result = parse_sphinx_inv_header(&mut reader);
        assert!(result.is_err());
        Ok(())
    }
    #[test]
    fn test_no_zlib_header() -> Result<()> {
        let header = "# Sphinx inventory version 2
# Project: NumPy
# Version: 2.3
# The remainder of this file is compressed using gzip.";

        let (_temp_dir, header_path) = write_test_header(header)?;
        let file = File::open(header_path)?;
        let mut reader = BufReader::new(&file);
        let result = parse_sphinx_inv_header(&mut reader);
        assert!(result.is_err());
        Ok(())
    }

    #[test]
    fn test_old_inv_version() -> Result<()> {
        let header = "# Sphinx inventory version 1";

        let (_temp_dir, header_path) = write_test_header(header)?;
        let file = File::open(header_path)?;
        let mut reader = BufReader::new(&file);
        let inv_ver = parse_inv_version(&mut reader)?;
        assert_eq!(inv_ver, SphinxInvVersion::V1);
        Ok(())
    }

    #[test]
    fn test_unknown_inv_version() -> Result<()> {
        let header = "# Sphinx inventory version 3.14";

        let (_temp_dir, header_path) = write_test_header(header)?;
        let file = File::open(header_path)?;
        let mut reader = BufReader::new(&file);
        let inv_ver = parse_inv_version(&mut reader);
        assert!(inv_ver.is_err());
        Ok(())
    }
    #[test]
    fn test_garbage_inv_version() -> Result<()> {
        let header = "# asdfasdfsadf";

        let (_temp_dir, header_path) = write_test_header(header)?;
        let file = File::open(header_path)?;
        let mut reader = BufReader::new(&file);
        let inv_ver = parse_inv_version(&mut reader);
        assert!(inv_ver.is_err());
        Ok(())
    }

    #[test]
    fn load_numpy_file_manually() -> Result<()> {
        let filename = "tests/sphinx_objects/numpy.inv";
        let file = File::open(filename)?;
        let mut reader = BufReader::new(&file);

        let (inv_ver, proj_name, proj_ver) = parse_sphinx_inv_header(&mut reader)?;
        assert_eq!(inv_ver, SphinxInvVersion::V2);
        assert_eq!(proj_name, "NumPy".to_string());
        assert_eq!(proj_ver, "2.3".to_string());

        let decompressed = decompress_remaining_zlib_data(&mut reader)?;

        for line in decompressed.lines() {
            let sphinx_ref = ExternalSphinxRef::try_from(line);
            assert!(sphinx_ref.is_ok(), "failed to parse line: {line}");
        }

        Ok(())
    }

    #[test]
    fn load_numpy_file_pub_func() -> Result<()> {
        let filename = PathBuf::from("tests/sphinx_objects/numpy.inv");
        let _ = parse_objects_inv_file(&filename)?;

        Ok(())
    }
}