Implement display for Scheme and Color structs

Author: JamyGolden

Cargo.lock

@@ -24,7 +24,7 @@ strip-ansi-escapes = "0.2.0"
 
 [dependencies.tinted-builder]
 path = "../tinted-builder"
-version = "0.4.0"
+version = "0.4.1"
 
 [[bin]]
 name = "tinted-builder-rust"

tinted-builder-rust/Cargo.toml

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.4.1 - 2024-06-15
+
+## Fixed
+
+- Implement `Display` trait for `Scheme` and `Color`
+  `Scheme` themselves.
+
 ## 0.4.0 - 2024-06-15
 
 ## Added

tinted-builder/CHANGELOG.md

@@ -1,7 +1,7 @@
 [package]
 name = "tinted-builder"
 description = "A Tinted Theming template builder which uses yaml color schemes to generate theme files."
-version = "0.4.0"
+version = "0.4.1"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 readme = "README.md"

tinted-builder/Cargo.toml

@@ -2,7 +2,7 @@ mod color;
 
 use regex::Regex;
 use serde::{Deserialize, Deserializer};
-use std::collections::HashMap;
+use std::{collections::HashMap, fmt};
 
 use crate::constants::{REQUIRED_BASE16_PALETTE_KEYS, REQUIRED_BASE24_PALETTE_KEYS};
 
@@ -30,6 +30,33 @@ pub struct Scheme {
     pub palette: HashMap<String, Color>,
 }
 
+impl fmt::Display for Scheme {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        writeln!(f, "author: {}", self.author)?;
+        if let Some(ref desc) = self.description {
+            writeln!(f, "description: {}", desc)?;
+        }
+        writeln!(f, "name: {}", self.name)?;
+        writeln!(f, "slug: {}", self.slug)?;
+        writeln!(f, "system: {}", self.system)?;
+        writeln!(f, "variant: {}", self.variant)?;
+        writeln!(f, "palette:")?;
+
+        let mut palette_vec: Vec<(String, Color)> = self
+            .palette
+            .clone()
+            .iter()
+            .map(|(k, v)| (k.to_string(), v.clone()))
+            .collect();
+        palette_vec.sort_by_key(|k| k.0.clone());
+
+        for (key, value) in palette_vec {
+            writeln!(f, "  {}: {}", key, value)?;
+        }
+        Ok(())
+    }
+}
+
 pub(crate) fn slugify(input: &str) -> String {
     let char_map: HashMap<char, &str> = [
         ('á', "a"),

tinted-builder/src/scheme.rs

@@ -1,12 +1,47 @@
+use std::fmt;
+
 use anyhow::{Context, Result};
 
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct Color {
     pub hex: (String, String, String),
     pub rgb: (u8, u8, u8),
     pub dec: (f32, f32, f32),
 }
 
+impl Color {
+    pub fn new(hex_color: String) -> Result<Color> {
+        let hex_full = match process_hex_input(&hex_color) {
+            Some(valid_hex) => valid_hex,
+            None => {
+                anyhow::bail!("Provided hex value is not formatted correctly");
+            }
+        };
+
+        let hex: (String, String, String) = (
+            hex_full[0..2].to_lowercase(),
+            hex_full[2..4].to_lowercase(),
+            hex_full[4..6].to_lowercase(),
+        );
+        let rgb = hex_to_rgb(&hex)
+            .unwrap_or_else(|_| panic!("Unable to convert hex value to rgb: {}", hex_full));
+        let (r, g, b) = rgb;
+        let dec: (f32, f32, f32) = (r as f32 / 255.0, g as f32 / 255.0, b as f32 / 255.0);
+
+        Ok(Color { hex, rgb, dec })
+    }
+
+    pub fn to_hex(&self) -> String {
+        format!("#{}{}{}", &self.hex.0, &self.hex.1, &self.hex.2)
+    }
+}
+
+impl fmt::Display for Color {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "{}", &self.to_hex())
+    }
+}
+
 fn hex_to_rgb(hex: &(String, String, String)) -> Result<(u8, u8, u8)> {
     let r = u8::from_str_radix(hex.0.as_str(), 16)
         .context("Invalid hex character for red component")?;
@@ -48,26 +83,3 @@ fn process_hex_input(input: &str) -> Option<String> {
         _ => None,
     }
 }
-
-impl Color {
-    pub fn new(hex_color: String) -> Result<Color> {
-        let hex_full = match process_hex_input(&hex_color) {
-            Some(valid_hex) => valid_hex,
-            None => {
-                anyhow::bail!("Provided hex value is not formatted correctly");
-            }
-        };
-
-        let hex: (String, String, String) = (
-            hex_full[0..2].to_lowercase(),
-            hex_full[2..4].to_lowercase(),
-            hex_full[4..6].to_lowercase(),
-        );
-        let rgb = hex_to_rgb(&hex)
-            .unwrap_or_else(|_| panic!("Unable to convert hex value to rgb: {}", hex_full));
-        let (r, g, b) = rgb;
-        let dec: (f32, f32, f32) = (r as f32 / 255.0, g as f32 / 255.0, b as f32 / 255.0);
-
-        Ok(Color { hex, rgb, dec })
-    }
-}