Merge pull request #91 from tofubert/feature/colour-usernames

Feature/colour usernames

Author: tofubert

Cargo.lock

@@ -67,6 +67,7 @@ async-trait = "=0.1.88"
 serde_with = "=3.14.0"
 tokio-util = "=0.7.15"
 tui-logger = { version = "=0.17.3", features = ["crossterm" ] }
+colorhash = "0.1.3"
 
 
 [workspace.lints.rust]

Cargo.toml

@@ -106,4 +106,9 @@ impl NCMessage {
     pub fn has_reactions(&self) -> bool {
         !self.0.reactions.is_empty()
     }
+
+    /// return actorId
+    pub fn get_actor_id(&self) -> String {
+        self.0.actorId.clone()
+    }
 }

src/backend/nc_message.rs

@@ -4,7 +4,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 pub struct NCReqDataParticipants {
     attendeeId: i32,
     actorType: String,
-    actorId: String,
+    pub actorId: String,
     pub displayName: String,
     participantType: i32,
     lastPing: i32,

src/backend/nc_request/nc_req_data_user.rs

@@ -0,0 +1,112 @@
+use color_hash::color_hash_hex;
+use ratatui::style::{Color, Style};
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
+use std::fs::File;
+use std::io::{BufReader, BufWriter};
+use std::path::{Path, PathBuf};
+use std::str::FromStr;
+
+#[derive(Serialize, Deserialize, Default)]
+pub struct UserStyles {
+    /// Map between user and style
+    pub user_style_map: HashMap<String, Style>,
+    /// Styles to allocate to users
+    pub styles: Vec<Style>,
+    /// Index of next style to allocate
+    pub styles_index: usize,
+    /// Path to use for serialization/deserialization
+    #[serde(skip)]
+    pub data_log_path: PathBuf,
+}
+
+impl UserStyles {
+    pub fn new(data_log_path: &Path) -> Self {
+        // First try to read data from saved data
+        let mut tmp_data_log_path = data_log_path.to_path_buf();
+        tmp_data_log_path.push("UserStyles.json");
+        let path = tmp_data_log_path.as_path();
+        if path.exists() {
+            let buf_reader = BufReader::new(File::open(path).unwrap());
+            let mut user_styles: Self = serde_json::from_reader(buf_reader).unwrap();
+            user_styles.data_log_path = tmp_data_log_path;
+            return user_styles;
+        }
+
+        let mut styles = Vec::new();
+        UserStyles::generate_new_styles(&mut styles);
+        Self {
+            user_style_map: HashMap::<String, Style>::new(),
+            styles,
+            styles_index: 0,
+            data_log_path: tmp_data_log_path,
+        }
+    }
+
+    pub fn update(&mut self, user_id: &str) {
+        if !self.user_style_map.contains_key(user_id) {
+            log::trace!("added {user_id}");
+            self.user_style_map.insert(
+                user_id.to_string(),
+                *self.styles.get(self.styles_index).expect("style not found"),
+            );
+            self.styles_index += 1;
+            if self.styles_index >= self.styles.len() {
+                UserStyles::generate_new_styles(&mut self.styles);
+            }
+        }
+    }
+
+    pub fn write_to_log(&self) -> Result<(), std::io::Error> {
+        let path = self.data_log_path.as_path();
+        let file = match std::fs::File::create(path) {
+            Err(why) => {
+                log::error!(
+                    "couldn't create user_styles log file {}: {}",
+                    path.as_os_str()
+                        .to_str()
+                        .expect("Path didn't become string"),
+                    why,
+                );
+                return Err(why);
+            }
+            Ok(file) => file,
+        };
+        let buf_writer = BufWriter::new(file);
+        serde_json::to_writer(buf_writer, &self)?;
+        Ok(())
+    }
+
+    fn generate_new_styles(styles: &mut Vec<Style>) {
+        for _ in 0..50 {
+            styles.push(
+                Color::from_str(RandomColor::new().to_hex().as_str())
+                    .expect("not a color")
+                    .into(),
+            );
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn update() {
+        let mut user_styles = UserStyles::new(&PathBuf::new());
+        let user_id_0 = "Terror";
+        user_styles.update(user_id_0);
+        let user_id_1 = "Licky";
+        user_styles.update(user_id_1);
+
+        assert_eq!(
+            user_styles.user_style_map.get(user_id_0).unwrap(),
+            user_styles.styles.first().unwrap(),
+        );
+        assert_eq!(
+            user_styles.user_style_map.get(user_id_1).unwrap(),
+            user_styles.styles.get(1).unwrap(),
+        );
+    }
+}

src/ui/user_styles.rs

@@ -2,6 +2,7 @@ use crate::backend::nc_request::Token;
 use crate::backend::{nc_room::NCRoomInterface, nc_talk::NCBackend};
 use crate::config::Config;
 use chrono::{DateTime, Local, Utc};
+use colorhash::ColorHash;
 use ratatui::{
     prelude::*,
     widgets::{Block, Cell, HighlightSpacing, Row, Table, TableState},
@@ -23,6 +24,7 @@ pub struct ChatBox<'a> {
     unread_message_style: Style,
     table_header_style: Style,
     date_format: String,
+    user_styles: ColorHash,
 }
 
 impl ChatBox<'_> {
@@ -40,6 +42,7 @@ impl ChatBox<'_> {
             default_highlight_style: config.theme.default_highlight_style(),
             table_header_style: config.theme.table_header_style(),
             date_format: config.data.ui.date_format.clone(),
+            user_styles: ColorHash::new().lightness(70.0),
         }
     }
 
@@ -90,13 +93,24 @@ impl ChatBox<'_> {
                 last_date = date_str;
             }
 
+            let colour = self.user_styles.rgb(&message_data.get_actor_id());
+
+            #[allow(clippy::cast_possible_truncation)]
+            #[allow(clippy::cast_sign_loss)]
+            let name_style = Style::new().fg(Color::Rgb(
+                colour.red() as u8,
+                colour.green() as u8,
+                colour.blue() as u8,
+            ));
+
             let name = textwrap::wrap(
                 message_data.get_name().to_string().as_str(),
                 Options::new(NAME_WIDTH.into()).break_words(true),
             )
             .into_iter()
             .map(std::borrow::Cow::into_owned)
             .map(Line::from)
+            .map(|l| l.style(name_style))
             .collect_vec();
 
             let message_string = message_data
@@ -237,21 +251,25 @@ mod tests {
         let mut mock_nc_backend = MockNCTalk::new();
         let mut mock_room = MockNCRoomInterface::new();
         let timestamp_1 = DateTime::<Utc>::from_timestamp(2000, 0).unwrap();
+        let actor_id_1 = "abcd1234".to_string();
         let mock_message_1 = NCMessage::from(NCReqDataMessage {
             id: 0,
             message: "Butz".to_string(),
             messageType: "comment".to_string(),
             actorDisplayName: "Hundi".to_string(),
             timestamp: timestamp_1.timestamp(),
+            actorId: actor_id_1.clone(),
             ..Default::default()
         });
         let timestamp_2 = DateTime::<Utc>::from_timestamp(200_000, 0).unwrap();
+        let actor_id_2 = "1234abcd".to_string();
         let mock_message_2 = NCMessage::from(NCReqDataMessage {
             id: 1,
             message: "Bert".to_string(),
             messageType: "comment".to_string(),
             actorDisplayName: "Stinko".to_string(),
             timestamp: timestamp_2.timestamp(),
+            actorId: actor_id_2.clone(),
             ..Default::default()
         });
         let message_tree = BTreeMap::from([(1, mock_message_1), (2, mock_message_2)]);
@@ -294,6 +312,9 @@ mod tests {
 
         terminal.backend().assert_buffer(&expected);
 
+        let user_style_1 = Style::default().fg(Color::Rgb(196, 205, 151)); // Hash for Hundi
+        let user_style_2 = Style::default().fg(Color::Rgb(151, 205, 156)); // Hash for Stinko
+
         chat_box.update_messages(&mock_nc_backend, &"123".to_string());
 
         terminal
@@ -318,13 +339,15 @@ mod tests {
             Rect::new(0, 1, 40, 1),
             config.theme.default_highlight_style(),
         );
+        expected.set_style(Rect::new(6, 2, 20, 1), user_style_1);
         expected.set_style(
             Rect::new(27, 1, 13, 1),
             config
                 .theme
                 .default_highlight_style()
                 .add_modifier(Modifier::BOLD),
         );
+        expected.set_style(Rect::new(6, 4, 20, 1), user_style_2);
         expected.set_style(
             Rect::new(27, 3, 13, 1),
             config

src/ui/widget/chat_box.rs

@@ -33,6 +33,9 @@ impl Users<'_> {
             table_header_style: config.theme.table_header_style(),
         }
     }
+    pub fn get_user_list(&self) -> &Vec<Row<'_>> {
+        &self.user_list
+    }
     pub fn render_area(&self, frame: &mut Frame, area: Rect) {
         frame.render_stateful_widget(self, area, &mut self.state.clone());
     }