use crate::gradient::Gradient;
use indicatif::{ProgressState, ProgressStyle};
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum BarStyle {
#[default]
Main,
Minified,
Steps,
Spinner,
ClearOnFinish,
}
impl BarStyle {
pub const DEFAULT_GRADIENT_WIDTH: usize = 25;
pub fn to_progress_style(
&self,
gradient: Option<Gradient>,
width: usize,
unit: Option<String>,
) -> ProgressStyle {
let (bar_key, spinner_color) = match gradient {
Some(_) => ("{grad_bar}", "cyan"),
None => ("{wide_bar:.cyan/blue}", "green"),
};
let unit = match unit {
Some(unit) => unit.replace('{', "{{").replace('}', "}}"),
None => "chunks".to_string(),
};
let template = match self {
BarStyle::Main | BarStyle::ClearOnFinish => format!(
"{{spinner:.{spinner_color}}} {{msg}} [{{elapsed_precise}}] [{bar_key}] {{bytes}}/{{total_bytes}} ({{percent}}%) {{eta}}",
spinner_color = spinner_color,
bar_key = bar_key,
),
BarStyle::Minified => format!(
"{{spinner:.{spinner_color}}} {{msg}} [{bar_key}] {{bytes}}/{{total_bytes}} ({{percent}}%)",
),
BarStyle::Steps => format!(
"{{spinner:.{spinner_color}}} {{msg}} [{bar_key}] {{pos}}/{{len}} {unit} ({{percent}}%) {{elapsed_precise}}",
bar_key = bar_key,
),
BarStyle::Spinner => format!("{{spinner:.{spinner_color}}} {{msg}}"),
};
let chars = "█▉▊▋▌▍▎▏░";
let tick = "⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏ ";
let mut style = ProgressStyle::with_template(&template)
.expect("the template is valid")
.progress_chars(chars)
.tick_chars(tick);
if let Some(gradient) = gradient {
let grad = gradient;
let w = width.max(1);
style = style.with_key(
"grad_bar",
move |state: &ProgressState, wout: &mut dyn std::fmt::Write| {
let _ = write!(wout, "{}", grad.render(state.fraction(), w));
},
);
}
style
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn all_styles_build_without_panic() {
let gradients = [None, Some(Gradient::Ocean), Some(Gradient::Violet)];
for gradient in gradients {
for style in [
BarStyle::Main,
BarStyle::Minified,
BarStyle::Steps,
BarStyle::Spinner,
BarStyle::ClearOnFinish,
] {
let _ = style.to_progress_style(gradient, 30, Some(String::from("meters")));
}
}
}
#[test]
fn default_gradient_width_is_25() {
assert_eq!(BarStyle::DEFAULT_GRADIENT_WIDTH, 25);
}
#[test]
fn zero_width_builds_without_panic() {
for style in [
BarStyle::Main,
BarStyle::Minified,
BarStyle::Steps,
BarStyle::Spinner,
BarStyle::ClearOnFinish,
] {
let _ = style.to_progress_style(Some(Gradient::Ocean), 0, Some(String::from("liters")));
let _ = style.to_progress_style(None, 0, None);
}
}
#[test]
fn large_width_builds_without_panic() {
let _ = BarStyle::Main.to_progress_style(Some(Gradient::Sunset), 500, None);
}
#[test]
fn bar_style_is_copy_clone_debug() {
let s = BarStyle::Main;
let s2 = s;
let s3 = s;
let _ = format!("{:?}", s3);
assert_eq!(s, s2);
}
#[test]
fn all_variants_are_distinct() {
let styles = [
BarStyle::Main,
BarStyle::Minified,
BarStyle::Steps,
BarStyle::Spinner,
BarStyle::ClearOnFinish,
];
for (i, a) in styles.iter().enumerate() {
for (j, b) in styles.iter().enumerate() {
if i == j {
assert_eq!(a, b);
} else {
assert_ne!(a, b);
}
}
}
}
}