config: (de)serialization

Author: Sk7Str1p3

src/cli.rs

@@ -6,12 +6,12 @@ use clap::builder::PossibleValuesParser;
 use clap::builder::TypedValueParser as _;
 use clap::{value_parser, Args, Command, Parser, ValueHint};
 use clap_complete::{generate, Generator, Shell};
+use merge::Merge;
 use num_format::CustomFormat;
 use onefetch_image::ImageProtocol;
 use onefetch_manifest::ManifestType;
 use regex::Regex;
-use serde::Serialize;
-use merge::Merge;
+use serde::{de::Visitor, Serializer, Deserialize, Serialize};
 use std::env;
 use std::io;
 use std::path::PathBuf;
@@ -21,17 +21,19 @@ use strum::IntoEnumIterator;
 const COLOR_RESOLUTIONS: [&str; 5] = ["16", "32", "64", "128", "256"];
 pub const NO_BOTS_DEFAULT_REGEX_PATTERN: &str = r"(?:-|\s)[Bb]ot$|\[[Bb]ot\]";
 
-#[derive(Clone, Debug, Parser, PartialEq, Eq, Merge)]
+#[derive(Clone, Debug, Parser, PartialEq, Eq, Merge, Serialize, Deserialize)]
 #[command(version, about)]
 pub struct CliOptions {
     /// Run as if onefetch was started in <input> instead of the current working directory
     #[arg(default_value = ".", hide_default_value = true, value_hint = ValueHint::DirPath)]
     #[merge(skip)]
+    #[serde(skip)]
     pub input: PathBuf,
     /// Specify a custom path to a config file.
     /// Default config is located at ${HOME}/.config/onefetch/config.conf.
     #[arg(long, value_hint = ValueHint::AnyPath)]
     #[merge(skip)]
+    #[serde(skip)]
     pub config_path: Option<PathBuf>,
     #[command(flatten)]
     pub info: InfoCliOptions,
@@ -49,7 +51,7 @@ pub struct CliOptions {
     pub other: OtherCliOptions,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Merge)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Serialize, Deserialize)]
 #[command(next_help_heading = "INFO")]
 pub struct InfoCliOptions {
     /// Allows you to disable FIELD(s) from appearing in the output
@@ -132,7 +134,7 @@ pub struct InfoCliOptions {
     pub r#type: Vec<LanguageType>,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Merge)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Serialize, Deserialize)]
 #[command(next_help_heading = "ASCII")]
 pub struct AsciiCliOptions {
     /// Takes a non-empty STRING as input to replace the ASCII logo
@@ -164,6 +166,7 @@ pub struct AsciiCliOptions {
         hide_possible_values = true
     )]
     #[merge(skip)]
+    #[serde(skip)]
     pub ascii_language: Option<Language>,
     /// Specify when to use true color
     ///
@@ -173,7 +176,7 @@ pub struct AsciiCliOptions {
     pub true_color: When,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Merge)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Serialize, Deserialize)]
 #[command(next_help_heading = "IMAGE")]
 pub struct ImageCliOptions {
     /// Path to the IMAGE file
@@ -183,6 +186,7 @@ pub struct ImageCliOptions {
     /// Which image PROTOCOL to use
     #[arg(long, value_enum, requires = "image", value_name = "PROTOCOL")]
     #[merge(skip)]
+    #[serde(skip)]
     pub image_protocol: Option<ImageProtocol>,
     /// VALUE of color resolution to use with SIXEL backend
     #[arg(
@@ -197,7 +201,7 @@ pub struct ImageCliOptions {
     pub color_resolution: usize,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Merge)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Serialize, Deserialize)]
 #[command(next_help_heading = "TEXT FORMATTING")]
 pub struct TextForamttingCliOptions {
     /// Changes the text colors (X X X...)
@@ -229,7 +233,7 @@ pub struct TextForamttingCliOptions {
     #[merge(strategy = merge::bool::overwrite_false)]
     pub no_bold: bool,
 }
-#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge, Serialize, Deserialize)]
 #[command(next_help_heading = "VISUALS")]
 pub struct VisualsCliOptions {
     /// Hides the color palette
@@ -248,29 +252,33 @@ pub struct VisualsCliOptions {
     pub nerd_fonts: bool,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge, Serialize, Deserialize)]
 #[command(next_help_heading = "DEVELOPER")]
 pub struct DeveloperCliOptions {
     /// Outputs Onefetch in a specific format
     #[arg(long, short, value_name = "FORMAT", value_enum)]
     #[merge(skip)]
+    #[serde(skip)]
     pub output: Option<SerializationFormat>,
     /// If provided, outputs the completion file for given SHELL
     #[arg(long = "generate", value_name = "SHELL", value_enum)]
     #[merge(skip)]
+    #[serde(skip)]
     pub completion: Option<Shell>,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge, Serialize, Deserialize)]
 #[command(next_help_heading = "OTHER")]
 pub struct OtherCliOptions {
     /// Prints out supported languages
     #[arg(long, short)]
     #[merge(skip)]
+    #[serde(skip)]
     pub languages: bool,
     /// Prints out supported package managers
     #[arg(long, short)]
     #[merge(skip)]
+    #[serde(skip)]
     pub package_managers: bool,
 }
 
@@ -386,14 +394,14 @@ pub fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
     generate(gen, cmd, cmd.get_name().to_string(), &mut io::stdout());
 }
 
-#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug)]
+#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug, Serialize, Deserialize)]
 pub enum When {
     Auto,
     Never,
     Always,
 }
 
-#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug, Serialize, Copy)]
+#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug, Serialize, Deserialize, Copy)]
 pub enum NumberSeparator {
     Plain,
     Comma,
@@ -512,3 +520,37 @@ impl FromStr for MyRegex {
         Ok(MyRegex(Regex::new(s)?))
     }
 }
+
+impl Serialize for MyRegex {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+        {serializer.serialize_str(self.0.as_str())}
+}
+
+pub struct RegVisitor;
+
+impl <'de>Visitor<'de> for RegVisitor {
+    type Value = MyRegex;
+
+    fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
+        formatter.write_str("regex")
+    }
+
+    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
+        where
+            E: serde::de::Error, {
+        match MyRegex::from_str(v) {
+            Ok(regex) => Ok(regex),
+            Err(error) => Err(serde::de::Error::custom(error))
+        }
+    }
+}
+
+impl <'de>Deserialize<'de> for MyRegex {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+        where
+            D: serde::Deserializer<'de>, {
+        deserializer.deserialize_str(RegVisitor)
+    }
+}

src/config.rs

@@ -0,0 +1,52 @@
+use crate::cli::CliOptions;
+use anyhow::{anyhow, Result};
+use dirs::config_dir;
+use merge::Merge;
+use std::{
+    fs::{self, create_dir, File},
+    io::{BufReader, Read},
+    path::Path,
+};
+
+pub fn read_cfg<P: AsRef<Path>>(path: &P) -> Result<CliOptions> {
+    let file = File::open(&path)?;
+    let mut buf_reader = BufReader::new(file);
+    let mut contents = String::new();
+    buf_reader.read_to_string(&mut contents)?;
+    Ok(toml::from_str(contents.as_str()).unwrap())
+}
+
+pub fn load_cfg<P: AsRef<Path>>(path: Option<&P>) -> Result<CliOptions> {
+    match path {
+        Some(config_path) => read_cfg(config_path),
+        None => {
+            let mut default_path = config_dir().unwrap();
+            default_path.push("/onefetch/config.toml");
+            if default_path.exists() {
+                read_cfg(&default_path)
+            } else {
+                create_dir(&default_path)?;
+                write_default(&default_path);
+                Err(anyhow!(
+                    "Configuration file at {:?} does not exist!",
+                    default_path
+                ))
+            }
+        }
+    }
+}
+
+pub fn write_default<P: AsRef<Path>>(default: &P) {
+    let toml = toml::to_string(&CliOptions::default()).expect("Config is not serializable!");
+    fs::write(default, toml).expect("Could not write config!")
+}
+
+pub fn populate_cfg(cfg: CliOptions) -> CliOptions {
+    match load_cfg(cfg.config_path.as_ref()) {
+        Ok(mut config) => {
+            config.merge(cfg);
+            config
+        },
+        Err(_) => cfg
+    }
+}

src/info/langs/language.rs

@@ -1,6 +1,5 @@
 use crate::info::utils::info_field::InfoField;
 use owo_colors::OwoColorize;
-use serde::Serialize;
 use tokei;
 
 include!(concat!(env!("OUT_DIR"), "/language.rs"));

src/info/langs/language.tera

@@ -5,6 +5,7 @@ use owo_colors::{
 use std::fmt;
 use std::fmt::Write;
 use strum::EnumIter;
+use serde::{Serialize, Deserialize};
 
 pub struct Colors {
     basic_colors: Vec<DynColors>,
@@ -13,7 +14,7 @@ pub struct Colors {
 
 const DEFAULT_CHIP_ICON: char = '\u{25CF}';
 
-#[derive(Clone, PartialEq, Eq, Debug, clap::ValueEnum)]
+#[derive(Clone, PartialEq, Eq, Debug, clap::ValueEnum, Deserialize, Serialize)]
 pub enum LanguageType {
     Programming,
     Markup,

src/info/utils/info_field.rs

@@ -1,5 +1,6 @@
 use crate::{info::utils::get_style, ui::text_colors::TextColors};
 use owo_colors::OwoColorize;
+use serde::{Deserialize, Serialize};
 use std::fmt;
 
 #[typetag::serialize]
@@ -55,7 +56,7 @@ pub trait InfoField {
     }
 }
 
-#[derive(Clone, clap::ValueEnum, Debug, Eq, PartialEq)]
+#[derive(Clone, clap::ValueEnum, Debug, Serialize, Deserialize, Eq, PartialEq)]
 pub enum InfoType {
     Project,
     Description,

src/lib.rs

@@ -1,4 +1,5 @@
 // Lib is present to allow for benchmarks and integration tests
 pub mod cli;
+pub mod config;
 pub mod info;
 pub mod ui;

src/main.rs

@@ -4,6 +4,7 @@ use anyhow::Result;
 use clap::{CommandFactory, Parser};
 use human_panic::setup_panic;
 use onefetch::cli::{self, CliOptions};
+use onefetch::config;
 use onefetch::info::build_info;
 use onefetch::ui::printer::Printer;
 use std::io;
@@ -14,7 +15,7 @@ fn main() -> Result<()> {
     #[cfg(windows)]
     enable_ansi_support::enable_ansi_support()?;
 
-    let cli_options = cli::CliOptions::parse();
+    let cli_options = config::populate_cfg(cli::CliOptions::parse());
 
     if cli_options.other.languages {
         return cli::print_supported_languages();