projvar 0.19.9

A tiny CLI tool that tries to gather project specific meta-data in different ways, to store them into key=value pairs in a file for later use by other tools. See --list for the keys set by this tool.
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

// SPDX-FileCopyrightText: 2021 Robin Vobruba <hoijui.quaero@gmail.com>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

pub mod env;
pub mod file;
pub mod json;

use cli_utils::BoxResult;

use std::ffi::OsStr;
use std::fmt;
use std::path::PathBuf;
use std::str::FromStr;

use crate::environment::Environment;
use crate::storage;

pub const DEFAULT_FILE_OUT: &str = ".projvars.env.txt";

pub trait VarSink: fmt::Display {
    /// Indicates whether this sink of variables is usable.
    /// It might not be usable if the underlying data-sink (e.g. a file) can not be written to,
    /// or is not reachable (e.g. a DB on the network).
    fn is_usable(&self, environment: &Environment) -> bool;

    /// Tries to store a list of variable `values`.
    ///
    /// # Errors
    ///
    /// If the underlying data-sink (e.g. a file) can not be written to,
    /// or is not reachable (e.g. a DB on the network).
    /// or innumerable other kinds of problems,
    /// depending on the kind of the sink.
    fn store(
        &self,
        environment: &Environment,
        values: &[storage::Value],
        // values: Box<dyn Iterator<Item = (Key, &Variable, &(Confidence, String))>>,
    ) -> BoxResult<()>;
}

/// Returns a list of sinks commonly used when using this crate as CLI tool
///
/// # Panics
///
/// if [`DEFAULT_FILE_OUT`] fails to be parsed as a valid file-system path
#[must_use]
pub fn cli_list(
    env_out: bool,
    dry: bool,
    default_out_file: bool,
    additional_out_files: Vec<PathBuf>,
) -> Vec<Box<dyn VarSink>> {
    let mut sinks: Vec<Box<dyn VarSink>> = vec![];
    if env_out {
        sinks.push(Box::new(env::VarSink {}));
    }
    if default_out_file {
        log::info!("Using the default out file: {DEFAULT_FILE_OUT}");
        sinks.push(Box::new(file::VarSink {
            file: PathBuf::from_str(DEFAULT_FILE_OUT).unwrap(),
        }));
    }
    for out_file in additional_out_files {
        if out_file
            .extension()
            .and_then(OsStr::to_str)
            .is_some_and(|ext| ext.to_lowercase().ends_with("json"))
        {
            log::trace!("Going to sink to JSON file: {}", out_file.display());
            sinks.push(Box::new(json::VarSink { file: out_file }));
        } else {
            log::trace!("Going to sink to ENV file: {}", out_file.display());
            sinks.push(Box::new(file::VarSink { file: out_file }));
        }
    }
    if dry {
        sinks.clear();
    } else if sinks.is_empty() {
        log::warn!("No sinks registered! The results of this run will not be stored anywhere.");
    } else {
        for sink in &sinks {
            log::trace!("Registered sink {sink}.");
        }
    }
    sinks
}