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

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

use crate::settings::{Settings, STUB};
use crate::storage::Storage;
use crate::tools::git;
use std::collections::HashMap;
use std::convert::TryFrom;

pub struct Environment {
    pub settings: Settings,
    /// The input variables, as supplied by the environment,
    /// on the command line or through input files.
    pub vars: HashMap<String, String>,
    /// The output values we evaluated for the project properties we want to know.
    pub output: Storage,
    pub repo: Option<git::Repo>,
}

impl Environment {
    #[must_use]
    pub fn new(settings: Settings) -> Self {
        let vars = HashMap::<String, String>::new();
        let output = Storage::new();
        let repo = git::Repo::try_from(settings.repo_path.as_deref()).ok();
        Self {
            settings,
            vars,
            output,
            repo,
        }
    }

    #[must_use]
    pub fn stub() -> Self {
        Self::new(STUB.clone())
    }

    #[must_use]
    pub const fn repo(&self) -> Option<&git::Repo> {
        // TODO DEPRECATED Just use the repo property directly, instead
        self.repo.as_ref()
    }
}