muse2 2.1.0

A tool for running simulations of energy systems
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

//! Code related to CLI interface for managing the settings file
use crate::settings::{Settings, get_settings_file_path};
use anyhow::{Context, Result, bail};
use clap::Subcommand;
use std::fs;
use std::io::{self, Write};
use std::path::Path;

/// Subcommands for settings
#[derive(Subcommand)]
pub enum SettingsSubcommands {
    /// Edit the program settings file
    Edit,
    /// Delete the settings file, if any
    Delete,
    /// Get the path to where the settings file is read from
    Path,
    /// Show the contents of the `settings.toml`, if present
    Show,
    /// Show the default settings for `settings.toml`
    ShowDefault,
}

impl SettingsSubcommands {
    /// Execute the supplied settings subcommand
    pub fn execute(self) -> Result<()> {
        match self {
            Self::Edit => handle_edit_command()?,
            Self::Delete => handle_delete_command()?,
            Self::Path => handle_path_command(),
            Self::Show => handle_show_command()?,
            Self::ShowDefault => handle_show_default_command(),
        }

        Ok(())
    }
}

/// Get the path to the settings file, creating it if it doesn't exist
fn ensure_settings_file_exists(file_path: &Path) -> Result<()> {
    if file_path.is_file() {
        // File already exists
        return Ok(());
    }

    if let Some(dir_path) = file_path.parent() {
        // Create parent directory
        fs::create_dir_all(dir_path)
            .with_context(|| format!("Failed to create directory: {}", dir_path.display()))?;
    }

    // Create placeholder settings file
    fs::write(file_path, Settings::default_file_contents())?;

    Ok(())
}

/// Handle the `edit` command
fn handle_edit_command() -> Result<()> {
    let file_path = get_settings_file_path();
    ensure_settings_file_exists(&file_path)?;

    // Allow user to edit in text editor
    println!("Opening settings file for editing: {}", file_path.display());
    edit::edit_file(&file_path)?;

    Ok(())
}

/// Handle the `delete` command
fn handle_delete_command() -> Result<()> {
    let file_path = get_settings_file_path();
    if file_path.exists() {
        fs::remove_file(&file_path)
            .with_context(|| format!("Error deleting file: {}", file_path.display()))?;
        println!("Deleted settings file: {}", file_path.display());
    } else {
        eprintln!("No settings file to delete");
    }

    Ok(())
}

/// Handle the `path` command
fn handle_path_command() {
    let file_path = get_settings_file_path();
    if file_path.is_file() {
        println!("{}", file_path.display());
    } else {
        eprintln!("Settings file not found at: {}", file_path.display());
    }
}

/// Handle the `show` command
fn handle_show_command() -> Result<()> {
    let file_path = get_settings_file_path();

    match fs::read(&file_path) {
        // Write contents of file to stdout
        Ok(ref contents) => io::stdout().write_all(contents)?,
        Err(err) => {
            if err.kind() == io::ErrorKind::NotFound {
                bail!("Settings file not found at: {}", file_path.display())
            }
            // Some other kind of IO error occurred; just return it
            Err(err)?;
        }
    }

    Ok(())
}

/// Handle the `show-default` command
fn handle_show_default_command() {
    print!("{}", Settings::default_file_contents());
}