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

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

use cli_utils::BoxResult;

use crate::environment::Environment;
use crate::storage;
use crate::var::{self, Confidence};
use std::borrow::Cow;
use std::collections::HashMap;
use std::fmt;
use std::fs::File;
use std::io::LineWriter;
use std::io::Write;
use std::path::PathBuf;

pub struct VarSink {
    pub file: PathBuf,
}

/// Stores evaluated values (output) into a file
/// in a BASH compatible way ("KEY=VALUE\n").
impl super::VarSink for VarSink {
    fn is_usable(&self, _environment: &Environment) -> bool {
        true
    }

    fn store(&self, environment: &Environment, values: &[storage::Value]) -> BoxResult<()> {
        log::trace!(
            "Reading previous values from ENV file (if it exists): '{}' ...",
            self.file.display()
        );
        let previous_vars = if self.file.exists() {
            var::parse_vars_file_reader(cli_utils::create_input_reader(Some(&self.file))?)?
        } else {
            HashMap::new()
        };

        log::trace!("Prepare and sort new/generated values ...");
        let mut output_values: Vec<(Cow<str>, &&(Confidence, String))> = values
            .iter()
            .map(|(_key, var, rated_value)| (var.key(environment), rated_value))
            .collect();
        output_values.sort();

        log::trace!(
            "Combine and write combined vars to ENV file: '{}' ...",
            self.file.display()
        );
        let file = File::create(self.file.as_path())?;
        let mut file = LineWriter::new(file);
        for (key, rated_value) in output_values {
            if environment.settings.overwrite.main() || !previous_vars.contains_key(key.as_ref()) {
                file.write_fmt(format_args!("{key}=\"{}\"\n", rated_value.1))?;
            }
        }
        Ok(())
    }
}

impl fmt::Display for VarSink {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}(file: {})",
            std::any::type_name::<Self>(),
            self.file.as_path().to_str().ok_or(fmt::Error {})?
        )
    }
}