From 709f6ca6ca8bb17eac30ca9a688f192c390be5d8 Mon Sep 17 00:00:00 2001
From: Alex Clarke <alex.j.tusa@gmail.com>
Date: Thu, 6 Mar 2025 16:00:50 -0700
Subject: [PATCH] test: Added integration tests for the ValidateTheme macro

---
 Cargo.lock                                    |  1 +
 .../enum_display_style_derive/src/lib.rs      | 15 ++---
 proc_macros/validate_theme_derive/Cargo.toml  |  3 +
 proc_macros/validate_theme_derive/src/lib.rs  | 67 ++++++++++++++++++-
 src/ui/theme.rs                               |  1 -
 ...display_style_derive_integration_tests.rs} |  2 +-
 ...validate_theme_derive_integration_tests.rs | 35 ++++++++++
 7 files changed, 112 insertions(+), 12 deletions(-)
 rename tests/{integration_test.rs => enum_display_style_derive_integration_tests.rs} (94%)
 create mode 100644 tests/validate_theme_derive_integration_tests.rs

diff --git a/Cargo.lock b/Cargo.lock
index a48aebe..4af079c 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2752,6 +2752,7 @@ dependencies = [
 name = "validate_theme_derive"
 version = "0.1.0"
 dependencies = [
+ "log",
  "quote",
  "syn 2.0.99",
 ]
diff --git a/proc_macros/enum_display_style_derive/src/lib.rs b/proc_macros/enum_display_style_derive/src/lib.rs
index 9d8f360..3e2c941 100644
--- a/proc_macros/enum_display_style_derive/src/lib.rs
+++ b/proc_macros/enum_display_style_derive/src/lib.rs
@@ -5,7 +5,7 @@ use darling::FromVariant;
 use quote::quote;
 use syn::{Data, DeriveInput, parse_macro_input};
 
-/// Derive macro for the EnumDisplayStyle trait.
+/// Derive macro for generating a `to_display_str` method for an enum.
 ///
 /// # Example
 ///
@@ -16,13 +16,12 @@ use syn::{Data, DeriveInput, parse_macro_input};
 ///
 /// #[derive(EnumDisplayStyle)]
 /// enum Weekend {
-///   Saturday,
-///   Sunday,
+///     Saturday,
+///     Sunday,
 /// }
 ///
 /// assert_eq!(Weekend::Saturday.to_display_str(), "Saturday");
 /// assert_eq!(Weekend::Sunday.to_display_str(), "Sunday");
-///
 /// ```
 ///
 /// Using custom values for the display style:
@@ -32,10 +31,10 @@ use syn::{Data, DeriveInput, parse_macro_input};
 ///
 /// #[derive(EnumDisplayStyle)]
 /// enum MonitorStatus {
-///   #[display_style(name = "Monitor Transactions")]
-///   Active,
-///   #[display_style(name = "Don't Monitor Transactions")]
-///   None,
+///     #[display_style(name = "Monitor Transactions")]
+///     Active,
+///     #[display_style(name = "Don't Monitor Transactions")]
+///     None,
 /// }
 ///
 /// assert_eq!(MonitorStatus::Active.to_display_str(), "Monitor Transactions");
diff --git a/proc_macros/validate_theme_derive/Cargo.toml b/proc_macros/validate_theme_derive/Cargo.toml
index 8c55170..084f7a4 100644
--- a/proc_macros/validate_theme_derive/Cargo.toml
+++ b/proc_macros/validate_theme_derive/Cargo.toml
@@ -9,3 +9,6 @@ proc-macro = true
 [dependencies]
 quote = "1.0.39"
 syn = "2.0.99"
+
+[dev-dependencies]
+log = "0.4.17"
diff --git a/proc_macros/validate_theme_derive/src/lib.rs b/proc_macros/validate_theme_derive/src/lib.rs
index d82648b..686beea 100644
--- a/proc_macros/validate_theme_derive/src/lib.rs
+++ b/proc_macros/validate_theme_derive/src/lib.rs
@@ -2,6 +2,69 @@ use proc_macro::TokenStream;
 use quote::quote;
 use syn::{parse_macro_input, Data, DeriveInput, Fields};
 
+/// Derive macro for generating a `validate` method for a Theme struct.
+/// The `validate` method ensures that all values with the `validate` attribute are not `None`.
+/// Otherwise, an error message it output to both the log file and stdout and the program exits.
+/// 
+/// # Example
+/// 
+/// Valid themes pass through the program transitively without any messages being output.
+/// 
+/// ```
+/// use validate_theme_derive::ValidateTheme;
+/// 
+/// #[derive(ValidateTheme, Default)]
+/// struct Theme {
+///     pub name: String,
+///     #[validate]
+///     pub good: Option<Style>,
+///     #[validate]
+///     pub bad: Option<Style>,
+///     pub ugly: Option<Style>,
+/// }
+/// 
+/// struct Style {
+/// 	color: String,
+/// }
+/// 
+/// let theme = Theme {
+/// 	good: Some(Style { color: "Green".to_owned() }),
+/// 	bad: Some(Style { color: "Red".to_owned() }),
+/// 	..Theme::default()
+/// };
+/// 
+/// // Since only `good` and `bad` have the `validate` attribute, the `validate` method will only check those fields.
+/// theme.validate();
+/// // Since both `good` and `bad` have values, the program will not exit and no message is output.
+/// ```
+/// 
+/// Invalid themes will output an error message to both the log file and stdout and the program will exit.
+///
+/// ```should_panic
+/// use validate_theme_derive::ValidateTheme;
+///
+/// #[derive(ValidateTheme, Default)]
+/// struct Theme {
+///     pub name: String,
+///     #[validate]
+///     pub good: Option<Style>,
+///     #[validate]
+///     pub bad: Option<Style>,
+///     pub ugly: Option<Style>,
+/// }
+///
+/// struct Style {
+///     color: String,
+/// }
+///
+/// let theme = Theme {
+///     bad: Some(Style { color: "Red".to_owned() }),
+///     ..Theme::default()
+/// };
+/// 
+/// // Since `good` has the `validate` attribute and since `good` is `None`, the `validate` method will output an error message and exit the program.
+/// theme.validate();
+/// ```
 #[proc_macro_derive(ValidateTheme, attributes(validate))]
 pub fn derive_validate_theme(input: TokenStream) -> TokenStream {
 	let input = parse_macro_input!(input as DeriveInput);
@@ -22,8 +85,8 @@ pub fn derive_validate_theme(input: TokenStream) -> TokenStream {
 					validation_checks.push(quote! {
 						if self.#field_name.is_none() {
 							log::error!("{} is missing a color value.", stringify!(#field_name));
-								eprintln!("{} is missing a color value.", stringify!(#field_name));
-								process::exit(1);
+							eprintln!("{} is missing a color value.", stringify!(#field_name));
+							std::process::exit(1);
 						}
 					})
 				}
diff --git a/src/ui/theme.rs b/src/ui/theme.rs
index b8805e2..9821ce3 100644
--- a/src/ui/theme.rs
+++ b/src/ui/theme.rs
@@ -1,4 +1,3 @@
-use crate::process;
 use anyhow::Result;
 use derivative::Derivative;
 use ratatui::style::Color;
diff --git a/tests/integration_test.rs b/tests/enum_display_style_derive_integration_tests.rs
similarity index 94%
rename from tests/integration_test.rs
rename to tests/enum_display_style_derive_integration_tests.rs
index 277fed7..cf6c13f 100644
--- a/tests/integration_test.rs
+++ b/tests/enum_display_style_derive_integration_tests.rs
@@ -8,7 +8,7 @@ fn test_derive_enum_display_style() {
 }
 
 #[derive(EnumDisplayStyle)]
-pub enum TestEnum {
+enum TestEnum {
   #[display_style(name = "Testing 123")]
   Test,
   Ignored,
diff --git a/tests/validate_theme_derive_integration_tests.rs b/tests/validate_theme_derive_integration_tests.rs
new file mode 100644
index 0000000..832f6a2
--- /dev/null
+++ b/tests/validate_theme_derive_integration_tests.rs
@@ -0,0 +1,35 @@
+use validate_theme_derive::ValidateTheme;
+
+#[test]
+fn test_validate_theme_derive() {
+	let theme = Theme {
+		name: "test".to_string(),
+		good: Some(Style {
+			color: "Green".to_owned(),
+		}),
+		bad: Some(Style {
+			color: "Red".to_owned(),
+		}),
+		ugly: Some(Style {
+			color: "Magenta".to_owned(),
+		}),
+	};
+
+	theme.validate();
+}
+
+#[allow(dead_code)]
+struct Style {
+	color: String,
+}
+
+#[allow(dead_code)]
+#[derive(ValidateTheme)]
+struct Theme {
+	pub name: String,
+	#[validate]
+	pub good: Option<Style>,
+	#[validate]
+	pub bad: Option<Style>,
+	pub ugly: Option<Style>,
+}
\ No newline at end of file