flowsurface-data 0.9.0

Data aggregation, indexing, and configuration utilities for Flowsurface
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

use super::registry::IndicatorRegistration;
use super::scripting::registration;
use std::collections::BTreeMap;
use std::path::{Path, PathBuf};

/// Identifies how a source file entered the host catalog.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PackageOrigin {
    /// A source bundled with the application or overridden for development.
    Bundled,
    /// A source discovered in a user or development directory.
    Installed,
}

/// Load results for a set of explicit indicator source files.
#[derive(Debug, Default)]
pub struct IndicatorLoadReport {
    pub registrations: Vec<IndicatorRegistration>,
    pub diagnostics: Vec<String>,
    pub loaded_sources: Vec<LoadedIndicatorSource>,
}

/// Metadata for a source that compiled and passed host registration.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LoadedIndicatorSource {
    pub path: PathBuf,
    pub id: String,
}

/// Return sorted indicator source files, including collection subdirectories.
pub fn indicator_files_in_directory(
    path: impl AsRef<Path>,
) -> Result<(Vec<PathBuf>, Vec<String>), String> {
    indicator_engine::source_files_in_directory(path)
}

/// Load valid source files and retain diagnostics for files that could not
/// be activated. The application uses this form so one broken file does not
/// disable unrelated indicators.
pub fn load_from_files_report(paths: &[PathBuf], origin: PackageOrigin) -> IndicatorLoadReport {
    load_compiled_report(
        paths
            .iter()
            .map(|path| (path.clone(), indicator_engine::compile_file(path))),
        origin,
    )
}

pub(super) fn load_compiled_report(
    sources: impl IntoIterator<
        Item = (
            PathBuf,
            Result<indicator_engine::CompiledIndicator, Vec<indicator_engine::Diagnostic>>,
        ),
    >,
    origin: PackageOrigin,
) -> IndicatorLoadReport {
    let mut report = IndicatorLoadReport::default();
    let mut ids = BTreeMap::<String, PathBuf>::new();
    for (path, compiled) in sources {
        if path.extension().and_then(|extension| extension.to_str()) != Some("ind") {
            report.diagnostics.push(format!(
                "{}: indicator source files must use the .ind extension",
                path.display()
            ));
            continue;
        }
        let compiled = match compiled {
            Ok(compiled) => compiled,
            Err(diagnostics) => {
                report.diagnostics.extend(
                    diagnostics
                        .into_iter()
                        .map(|diagnostic| diagnostic.to_string()),
                );
                continue;
            }
        };
        let id = compiled.descriptor.id.as_str().to_owned();
        let expected_file_name = compiled.descriptor.id.source_file_name();
        if let Err(diagnostic) = validate_source_filename(&path, &id, &expected_file_name) {
            report.diagnostics.push(diagnostic);
            continue;
        }
        match registration(compiled, origin) {
            Ok(registration) => {
                report.loaded_sources.push(LoadedIndicatorSource {
                    path: path.clone(),
                    id: id.clone(),
                });
                if let Some(previous) = ids.get(&id) {
                    report.diagnostics.push(format!(
                        "{}: duplicate indicator ID '{}' (already defined in {})",
                        path.display(),
                        id,
                        previous.display()
                    ));
                    continue;
                }
                ids.insert(id, path.clone());
                report.registrations.push(registration);
            }
            Err(errors) => report.diagnostics.extend(errors),
        }
    }
    report
}

fn validate_source_filename(path: &Path, id: &str, expected_file_name: &str) -> Result<(), String> {
    let actual_file_name = path
        .file_name()
        .and_then(|name| name.to_str())
        .unwrap_or("<non-UTF-8 filename>");
    if actual_file_name == expected_file_name {
        return Ok(());
    }

    Err(format!(
        "{}: source filename '{}' must be '{}' for indicator ID '{}'; rename the file before installing",
        path.display(),
        actual_file_name,
        expected_file_name,
        id
    ))
}

#[cfg(test)]
pub(crate) fn repository_registrations() -> Vec<super::registry::IndicatorRegistration> {
    let report = super::bundled::load_bundled_sources();
    assert!(
        report.diagnostics.is_empty(),
        "repository indicator sources should load without diagnostics: {:?}",
        report.diagnostics
    );
    report.registrations
}