support configurable color scheme (#18)

Cargo.toml

@@ -17,6 +17,7 @@ serde = { version = "1.0.188", features = ["derive"] }
 serde_json = "1.0.107"
 tempfile = "3.8.0"
 tui = "0.19.0"
+ratatui = "0.23"
 
 [dev-dependencies]
-assert_cmd = "2.0.12"
+assert_cmd = "2.0.12"

src/args.rs

@@ -30,5 +30,5 @@ pub struct Args {
     /// uppercase-ratio argument
     #[arg(long)]
     pub uppercase_ratio: Option<f64>,
-    
+
 }

src/color_scheme.rs

@@ -0,0 +1,21 @@
+use ratatui::style::Color;
+
+#[derive(Debug)]
+pub struct ColorScheme {
+    pub correct_match_fg: Color,
+    pub correct_match_bg: Color,
+    pub incorrect_match_fg: Color,
+    pub incorrect_match_bg: Color,
+}
+
+impl ColorScheme {
+
+    pub fn default() -> Self {
+        Self {
+            correct_match_fg: Color::Green,
+            correct_match_bg: Color::Black,
+            incorrect_match_fg: Color::Gray,
+            incorrect_match_bg: Color::Red,
+        }
+    }
+}

src/config.rs

@@ -8,7 +8,7 @@
 //! | `numbers`         | `false`                | boolean      | flag indicating if numbers should be inserted in expected input      |
 //! | `numbers_ratio`   | `0.05` if numbers=TRUE | number       | ratio for putting numbers in the test                                |
 //! | `dictionary_path` | `"src/dict/words.txt"` | string       | dictionary words to sample from while creating test's expected input |
-//! 
+//!
 //! `NOTE: If provided numbers_ratio is not between 0 to 1.0, Default numbers_ratio = 0.05 will be used.`
 //!
 //!
@@ -36,6 +36,8 @@ use mockall::*;
 use serde::{Deserialize, Serialize};
 use std::{fs, io::Read, path::PathBuf, time::Duration};
 
+use crate::color_scheme::ColorScheme;
+
 use crate::Args;
 
 /// Main program configuration
@@ -47,6 +49,7 @@ pub struct Config {
     pub dictionary_path: PathBuf,
     pub uppercase: bool,
     pub uppercase_ratio: f64,
+    pub color_config: ColorScheme,
 }
 
 /// Used by `serde` crate to parse config file into a rust struct
@@ -57,7 +60,16 @@ struct ConfigFile {
     pub numbers_ratio: Option<f64>,
     pub dictionary_path: Option<String>,
     pub uppercase: Option<bool>,
-    pub uppercase_ratio: Option<f64>
+    pub uppercase_ratio: Option<f64>,
+    pub color_config: Option<ConfigFileColorScheme>,
+}
+
+#[derive(Deserialize, Serialize, Debug)]
+struct ConfigFileColorScheme {
+    pub correct_match_fg: Option<String>,
+    pub correct_match_bg: Option<String>,
+    pub incorrect_match_fg: Option<String>,
+    pub incorrect_match_bg: Option<String>,
 }
 
 #[automock]
@@ -70,7 +82,8 @@ impl Config {
             numbers_ratio: 0.05,
             dictionary_path: PathBuf::from("src/dict/words.txt"),
             uppercase: false,
-            uppercase_ratio: 0.45
+            uppercase_ratio: 0.45,
+            color_config: ColorScheme::default(),
         }
     }
 
@@ -136,6 +149,24 @@ fn augment_config_with_config_file(config: &mut Config, mut config_file: fs::Fil
                 config.uppercase_ratio = uppercase_ratio
             }
         }
+
+        if let Some(color_config) = config_from_file.color_config {
+            if let Some(correct_match_fg) = color_config.correct_match_fg {
+              config.color_config.correct_match_fg = correct_match_fg.parse().unwrap();
+            }
+
+            if let Some(correct_match_bg) = color_config.correct_match_bg {
+              config.color_config.correct_match_bg = correct_match_bg.parse().unwrap();
+            }
+
+            if let Some(incorrect_match_fg) = color_config.incorrect_match_fg {
+              config.color_config.incorrect_match_fg = incorrect_match_fg.parse().unwrap();
+            }
+
+            if let Some(incorrect_match_bg) = color_config.incorrect_match_bg {
+              config.color_config.incorrect_match_bg = incorrect_match_bg.parse().unwrap();
+            }
+        }
     }
 
     Ok(())
@@ -159,7 +190,7 @@ fn augment_config_with_args(config: &mut Config, args: Args) {
         if numbers_ratio >= 0.0 && numbers_ratio <= 1.0 {
             config.numbers_ratio = numbers_ratio
         }
-    }   
+    }
     if let Some(duration) = args.duration {
         config.duration = Duration::from_secs(duration);
     }

src/expected_input.rs

@@ -98,7 +98,7 @@ fn create_uppercase_words (string_vec: &mut Vec<String>, pos: usize, uppercase_r
             v[0] = v[0].to_uppercase().nth(0).unwrap();
             let s: String = v.into_iter().collect();
             string_vec[i] = s;
-        }    
+        }
     }
 }
 
@@ -125,6 +125,7 @@ impl ExpectedInputInterface for ExpectedInput {
 #[cfg(test)]
 mod tests {
     use std::{io::Write, time::Duration};
+    use crate::color_scheme::ColorScheme;
 
     use super::*;
 
@@ -148,7 +149,8 @@ mod tests {
             numbers_ratio: 0.05,
             dictionary_path: config_file.path().to_path_buf(),
             uppercase: false,
-            uppercase_ratio: 0.45
+            uppercase_ratio: 0.45,
+            color_config: ColorScheme::default(),
         };
 
         let expected_input = ExpectedInput::new(&config).expect("unable to create expected input");

src/main.rs

@@ -50,6 +50,7 @@
 
 mod args;
 mod config;
+mod color_scheme;
 mod expected_input;
 mod runner;
 
@@ -63,7 +64,7 @@ use crossterm::{
     },
 };
 use std::io;
-use tui::{backend::CrosstermBackend, Terminal};
+use ratatui::{backend::CrosstermBackend, Terminal};
 
 use args::Args;
 use config::Config;
@@ -170,7 +171,7 @@ mod tests {
 
     use anyhow::{Context, Result};
     use predicates::Predicate;
-    use tui::{backend::TestBackend, buffer::Buffer, Frame, Terminal};
+    use ratatui::{backend::TestBackend, buffer::Buffer, Frame, Terminal};
 
     use crate::{
         args::Args,

src/runner.rs

@@ -15,7 +15,8 @@ use anyhow::{Context, Result};
 use crossterm::event::{self, Event, KeyCode, KeyModifiers};
 use mockall::automock;
 use std::time::{Duration, Instant};
-use tui::{
+
+use ratatui::{
     backend::Backend,
     layout::{Alignment, Constraint, Direction, Layout, Rect},
     style::{Color, Style},
@@ -307,8 +308,8 @@ impl Runner {
         {
             let input = Paragraph::new(expected_input_char.to_string()).style(
                 match input_char == expected_input_char {
-                    true => Style::default().fg(Color::Green),
-                    false => Style::default().bg(Color::Red).fg(Color::Gray),
+                    true => Style::default().bg(self.config.color_config.correct_match_bg).fg(self.config.color_config.correct_match_fg),
+                    false => Style::default().bg(self.config.color_config.incorrect_match_bg).fg(self.config.color_config.incorrect_match_fg),
                 },
             );
             frame.render_widget(