annatto 0.50.0

Converts linguistic data formats based on the graphANNIS data model as intermediate representation and can apply consistency tests.
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

use std::{fs::File, io::Write, path::Path};

use annatto::{GraphOp, ModuleConfiguration, ReadFrom, WriteAs, util::documentation::ModuleInfo};

use facet::{Facet, Variant};
use facet_reflect::peek_enum_variants;
use itertools::Itertools;

pub(crate) fn create(output_directory: &Path) -> anyhow::Result<()> {
    let importers = peek_enum_variants(ReadFrom::SHAPE).unwrap_or_default();
    let exporters = peek_enum_variants(WriteAs::SHAPE).unwrap_or_default();
    let graph_ops = peek_enum_variants(GraphOp::SHAPE).unwrap_or_default();

    // Create an index file with a list of all the modules
    write_module_list_table(output_directory, importers, exporters, graph_ops)?;

    // Create a module information for each module of all types
    write_importer_files(importers, output_directory)?;
    write_exporter_files(exporters, output_directory)?;
    write_graph_op_files(graph_ops, output_directory)?;

    Ok(())
}

fn write_module_list_table(
    output_directory: &Path,
    importers: &[Variant],
    exporters: &[Variant],
    graph_ops: &[Variant],
) -> anyhow::Result<()> {
    let mut table_builder = tabled::builder::Builder::new();
    table_builder.push_record(vec!["Type", "Modules"]);

    let import_row = vec![
        "Import formats".to_string(),
        importers
            .iter()
            .map(|m| {
                let module_name = m.name.to_lowercase();
                let file_stem = module_name.replace("unstable:", "");
                format!("[{module_name}](importers/{file_stem}.md)")
            })
            .join(", "),
    ];
    table_builder.push_record(import_row);

    let export_row = vec![
        "Export formats".to_string(),
        exporters
            .iter()
            .map(|m| {
                let module_name = m.name.to_lowercase();
                let file_stem = module_name.replace("unstable:", "");
                format!("[{module_name}](exporters/{file_stem}.md)")
            })
            .join(", "),
    ];
    table_builder.push_record(export_row);

    let graph_op_row = vec![
        "Graph operations".to_string(),
        graph_ops
            .iter()
            .map(|m| {
                let module_name = m.name.to_lowercase();
                let file_stem = module_name.replace("unstable:", "");
                format!("[{module_name}](graph_ops/{file_stem}.md)")
            })
            .join(", "),
    ];
    table_builder.push_record(graph_op_row);

    let mut table = table_builder.build();
    table.with(tabled::settings::Style::markdown());

    std::fs::create_dir_all(output_directory)?;
    std::fs::write(output_directory.join("README.md"), table.to_string())?;
    Ok(())
}

fn write_importer_files(importers: &[Variant], output_directory: &Path) -> anyhow::Result<()> {
    let importers_directory = output_directory.join("importers");
    std::fs::create_dir_all(&importers_directory)?;

    for m in importers {
        let ModuleInfo { name, doc, configs } = ModuleInfo::from(m);
        let path = importers_directory.join(format!("{}.md", name.replace("unstable:", "")));
        let mut output = File::create(path)?;
        writeln!(output, "# {name} (importer)")?;
        writeln!(output)?;
        writeln!(output, "{doc}")?;
        writeln!(output)?;
        write_module_fields(output, &configs)?;
    }

    Ok(())
}

fn write_exporter_files(exporters: &[Variant], output_directory: &Path) -> anyhow::Result<()> {
    let exporters_directory = output_directory.join("exporters");
    std::fs::create_dir_all(&exporters_directory)?;

    for m in exporters {
        let ModuleInfo { name, doc, configs } = ModuleInfo::from(m);
        let path = exporters_directory.join(format!("{}.md", name.replace("unstable:", "")));
        let mut output = File::create(path)?;
        writeln!(output, "# {name} (exporter)")?;
        writeln!(output)?;
        writeln!(output, "{doc}")?;
        writeln!(output)?;
        write_module_fields(output, &configs)?;
    }

    Ok(())
}
fn write_graph_op_files(graph_ops: &[Variant], output_directory: &Path) -> anyhow::Result<()> {
    let graph_ops_directory = output_directory.join("graph_ops");
    std::fs::create_dir_all(&graph_ops_directory)?;

    for m in graph_ops {
        let ModuleInfo { name, doc, configs } = ModuleInfo::from(m);
        let path = graph_ops_directory.join(format!("{}.md", name.replace("unstable:", "")));
        let mut output = File::create(path)?;
        writeln!(output, "# {name} (graph_operation)")?;
        writeln!(output)?;
        writeln!(output, "{doc}")?;
        writeln!(output)?;
        write_module_fields(output, &configs)?;
    }

    Ok(())
}

fn write_module_fields<W>(mut output: W, fields: &[ModuleConfiguration]) -> anyhow::Result<()>
where
    W: Write,
{
    if fields.is_empty() {
        writeln!(output, "*No Configuration*")?;
    } else {
        writeln!(output, "## Configuration")?;
        writeln!(output)?;

        for f in fields {
            writeln!(output, "###  {}", f.name)?;
            writeln!(output)?;

            if f.description.is_empty() {
                writeln!(output, "*No description*")?;
            } else {
                writeln!(output, "{}", f.description)?;
            }
            writeln!(output)?;
        }
    }

    Ok(())
}

#[cfg(test)]
mod tests;