Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added custom results_path argument #47 #52

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ pub struct Args {
#[arg(long)]
pub save_results: Option<bool>,

/// path to save the test results, enabled only when save_results is true
#[arg(long, requires = "save_results")]
pub results_path: Option<String>,

/// Add subcommands here
#[command(subcommand)]
pub history: Option<SubCommand>,
Expand Down
20 changes: 20 additions & 0 deletions src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ pub struct Config {
pub uppercase_ratio: f64,
pub colors: ColorScheme,
pub save_results: bool,
pub results_path: Option<PathBuf>,
}

/// Used by `serde` crate to parse config file into a rust struct
Expand All @@ -87,6 +88,7 @@ struct ConfigFile {
pub uppercase_ratio: Option<f64>,
pub colors: Option<ConfigFileColorScheme>,
pub save_results: Option<bool>,
pub results_path: Option<String>,
}

/// Struct used be `serde` crate to parse colors config from config file
Expand All @@ -113,6 +115,7 @@ impl Config {
uppercase_ratio: 0.15,
colors: ColorScheme::default(),
save_results: true,
results_path: None,
}
}

Expand Down Expand Up @@ -210,6 +213,12 @@ fn augment_config_with_config_file(config: &mut Config, mut config_file: fs::Fil
if let Some(save_results) = config_from_file.save_results {
config.save_results = save_results;
}

if let Some(true) = config_from_file.save_results {
if let Some(path) = config_from_file.results_path {
config.results_path = Some(PathBuf::from(path));
}
}
}

Ok(())
Expand Down Expand Up @@ -259,6 +268,12 @@ fn augment_config_with_args(config: &mut Config, args: Args) {
if let Some(save_results_flag) = args.save_results {
config.save_results = save_results_flag;
}

if let Some(true) = args.save_results {
if let Some(path) = args.results_path {
config.results_path = Some(PathBuf::from(path));
}
}
}

#[cfg(test)]
Expand Down Expand Up @@ -288,6 +303,7 @@ mod tests {
uppercase: None,
uppercase_ratio: None,
save_results: None,
results_path: None,
history: None,
};
let config = Config::new(args, PathBuf::new()).expect("Unable to create config");
Expand All @@ -314,6 +330,7 @@ mod tests {
uppercase: None,
uppercase_ratio: None,
save_results: None,
results_path: None,
history: None,
};
let config =
Expand All @@ -336,6 +353,7 @@ mod tests {
uppercase: None,
uppercase_ratio: None,
save_results: Some(false),
results_path: None,
history: None,
};
let config = Config::new(args, PathBuf::new()).expect("Unable to create config");
Expand Down Expand Up @@ -363,6 +381,7 @@ mod tests {
uppercase: None,
uppercase_ratio: None,
save_results: Some(true),
results_path: Some(String::from("/some-path")),
history: None,
};
let config =
Expand All @@ -376,5 +395,6 @@ mod tests {
Some(PathBuf::from("/etc/dict/words"))
);
assert_eq!(config.save_results, true);
assert_eq!(config.results_path, Some(PathBuf::from("/some-path")));
}
}
1 change: 1 addition & 0 deletions src/expected_input.rs
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ mod tests {
uppercase_ratio: 0.45,
colors: ColorScheme::default(),
save_results: false,
results_path: None,
};

let expected_input = ExpectedInput::new(&config).expect("unable to create expected input");
Expand Down
2 changes: 2 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ mod tests {
symbols: None,
symbols_ratio: None,
save_results: None,
results_path: None,
history: None,
};

Expand Down Expand Up @@ -312,6 +313,7 @@ mod tests {
symbols: None,
symbols_ratio: None,
save_results: None,
results_path: None,
history: None,
};

Expand Down
8 changes: 7 additions & 1 deletion src/test_results.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ pub struct TestResults {
pub dictionary_path: Option<String>,
pub uppercase: Option<bool>,
pub uppercase_ratio: Option<f64>,
pub results_path: Option<PathBuf>,

// tells if test was successfully completed and results should be displayed and saved.
#[serde(skip)]
Expand Down Expand Up @@ -120,13 +121,18 @@ impl TestResults {

completed,
save: config.save_results,
results_path: config.results_path,
}
}

/// saves test statistics and configuration to a file in users home directory
pub fn save_to_file(&self) -> Result<(), anyhow::Error> {
let results_file_path =
let default_results_path =
get_results_file_path().context("Unable to ge results file path")?;
let results_file_path = match &self.results_path {
Some(results_path) => results_path,
None => &default_results_path,
};

let results = read_previous_results().context("Unable to read previous results")?;

Expand Down