feat: TUI support for Lidarr library

src/handlers/lidarr_handlers/library/library_handler_tests.rs

@@ -0,0 +1,272 @@
+#[cfg(test)]
+mod tests {
+  use std::cmp::Ordering;
+
+  use pretty_assertions::assert_str_eq;
+  use serde_json::Number;
+  use strum::IntoEnumIterator;
+
+  use crate::handlers::lidarr_handlers::library::{LibraryHandler, artists_sorting_options};
+  use crate::handlers::KeyEventHandler;
+  use crate::models::lidarr_models::{Artist, ArtistStatistics, ArtistStatus};
+  use crate::models::servarr_data::lidarr::lidarr_data::{ActiveLidarrBlock, LIBRARY_BLOCKS};
+
+  #[test]
+  fn test_library_handler_accepts() {
+    for lidarr_block in ActiveLidarrBlock::iter() {
+      if LIBRARY_BLOCKS.contains(&lidarr_block) {
+        assert!(LibraryHandler::accepts(lidarr_block));
+      } else {
+        assert!(!LibraryHandler::accepts(lidarr_block));
+      }
+    }
+  }
+
+  #[test]
+  fn test_artists_sorting_options_name() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| {
+      a.artist_name
+        .text
+        .to_lowercase()
+        .cmp(&b.artist_name.text.to_lowercase())
+    };
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[0].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Name");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_type() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| {
+      a.artist_type
+        .as_ref()
+        .unwrap_or(&String::new())
+        .to_lowercase()
+        .cmp(
+          &b.artist_type
+            .as_ref()
+            .unwrap_or(&String::new())
+            .to_lowercase(),
+        )
+    };
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[1].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Type");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_status() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| {
+      a.status
+        .to_string()
+        .to_lowercase()
+        .cmp(&b.status.to_string().to_lowercase())
+    };
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[2].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Status");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_quality_profile() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering =
+      |a, b| a.quality_profile_id.cmp(&b.quality_profile_id);
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[3].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Quality Profile");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_metadata_profile() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering =
+      |a, b| a.metadata_profile_id.cmp(&b.metadata_profile_id);
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[4].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Metadata Profile");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_albums() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| {
+      a.statistics
+        .as_ref()
+        .map_or(0, |stats| stats.album_count)
+        .cmp(&b.statistics.as_ref().map_or(0, |stats| stats.album_count))
+    };
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[5].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Albums");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_tracks() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| {
+      a.statistics
+        .as_ref()
+        .map_or(0, |stats| stats.track_count)
+        .cmp(&b.statistics.as_ref().map_or(0, |stats| stats.track_count))
+    };
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[6].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Tracks");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_size() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| {
+      a.statistics
+        .as_ref()
+        .map_or(0, |stats| stats.size_on_disk)
+        .cmp(&b.statistics.as_ref().map_or(0, |stats| stats.size_on_disk))
+    };
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[7].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Size");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_monitored() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| a.monitored.cmp(&b.monitored);
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[8].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Monitored");
+  }
+
+  #[test]
+  fn test_artists_sorting_options_tags() {
+    let expected_cmp_fn: fn(&Artist, &Artist) -> Ordering = |a, b| {
+      let a_str = a
+        .tags
+        .iter()
+        .map(|tag| tag.as_i64().unwrap().to_string())
+        .collect::<Vec<String>>()
+        .join(",");
+      let b_str = b
+        .tags
+        .iter()
+        .map(|tag| tag.as_i64().unwrap().to_string())
+        .collect::<Vec<String>>()
+        .join(",");
+      a_str.cmp(&b_str)
+    };
+    let mut expected_artists_vec = artists_vec();
+    expected_artists_vec.sort_by(expected_cmp_fn);
+
+    let sort_option = artists_sorting_options()[9].clone();
+    let mut sorted_artists_vec = artists_vec();
+    sorted_artists_vec.sort_by(sort_option.cmp_fn.unwrap());
+
+    assert_eq!(sorted_artists_vec, expected_artists_vec);
+    assert_str_eq!(sort_option.name, "Tags");
+  }
+
+  fn artists_vec() -> Vec<Artist> {
+    vec![
+      Artist {
+        id: 3,
+        artist_name: "Test Artist 1".into(),
+        artist_type: Some("Group".to_owned()),
+        status: ArtistStatus::Ended,
+        quality_profile_id: 1,
+        metadata_profile_id: 1,
+        monitored: false,
+        tags: vec![Number::from(1), Number::from(2)],
+        statistics: Some(ArtistStatistics {
+          album_count: 5,
+          track_count: 50,
+          size_on_disk: 789,
+          ..ArtistStatistics::default()
+        }),
+        ..Artist::default()
+      },
+      Artist {
+        id: 2,
+        artist_name: "Test Artist 2".into(),
+        artist_type: Some("Solo".to_owned()),
+        status: ArtistStatus::Continuing,
+        quality_profile_id: 2,
+        metadata_profile_id: 2,
+        monitored: false,
+        tags: vec![Number::from(1), Number::from(3)],
+        statistics: Some(ArtistStatistics {
+          album_count: 10,
+          track_count: 100,
+          size_on_disk: 456,
+          ..ArtistStatistics::default()
+        }),
+        ..Artist::default()
+      },
+      Artist {
+        id: 1,
+        artist_name: "Test Artist 3".into(),
+        artist_type: None,
+        status: ArtistStatus::Deleted,
+        quality_profile_id: 3,
+        metadata_profile_id: 3,
+        monitored: true,
+        tags: vec![Number::from(2), Number::from(3)],
+        statistics: Some(ArtistStatistics {
+          album_count: 3,
+          track_count: 30,
+          size_on_disk: 123,
+          ..ArtistStatistics::default()
+        }),
+        ..Artist::default()
+      },
+    ]
+  }
+}

src/handlers/lidarr_handlers/library/mod.rs

@@ -0,0 +1,211 @@
+use crate::{
+  app::App,
+  event::Key,
+  handlers::{KeyEventHandler, handle_clear_errors},
+  matches_key,
+  models::{
+    lidarr_models::Artist,
+    servarr_data::lidarr::lidarr_data::{ActiveLidarrBlock, LIBRARY_BLOCKS},
+    stateful_table::SortOption,
+  },
+};
+
+use super::handle_change_tab_left_right_keys;
+use crate::handlers::table_handler::{TableHandlingConfig, handle_table};
+
+#[cfg(test)]
+#[path = "library_handler_tests.rs"]
+mod library_handler_tests;
+
+pub(super) struct LibraryHandler<'a, 'b> {
+  key: Key,
+  app: &'a mut App<'b>,
+  active_lidarr_block: ActiveLidarrBlock,
+  _context: Option<ActiveLidarrBlock>,
+}
+
+impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveLidarrBlock> for LibraryHandler<'a, 'b> {
+  fn handle(&mut self) {
+    let artists_table_handling_config =
+      TableHandlingConfig::new(ActiveLidarrBlock::Artists.into())
+        .sorting_block(ActiveLidarrBlock::ArtistsSortPrompt.into())
+        .sort_options(artists_sorting_options())
+        .searching_block(ActiveLidarrBlock::SearchArtists.into())
+        .search_error_block(ActiveLidarrBlock::SearchArtistsError.into())
+        .search_field_fn(|artist| &artist.artist_name.text)
+        .filtering_block(ActiveLidarrBlock::FilterArtists.into())
+        .filter_error_block(ActiveLidarrBlock::FilterArtistsError.into())
+        .filter_field_fn(|artist| &artist.artist_name.text);
+
+    if !handle_table(
+      self,
+      |app| &mut app.data.lidarr_data.artists,
+      artists_table_handling_config,
+    ) {
+      self.handle_key_event();
+    }
+  }
+
+  fn accepts(active_block: ActiveLidarrBlock) -> bool {
+    LIBRARY_BLOCKS.contains(&active_block)
+  }
+
+  fn ignore_special_keys(&self) -> bool {
+    self.app.ignore_special_keys_for_textbox_input
+  }
+
+  fn new(
+    key: Key,
+    app: &'a mut App<'b>,
+    active_block: ActiveLidarrBlock,
+    context: Option<ActiveLidarrBlock>,
+  ) -> LibraryHandler<'a, 'b> {
+    LibraryHandler {
+      key,
+      app,
+      active_lidarr_block: active_block,
+      _context: context,
+    }
+  }
+
+  fn get_key(&self) -> Key {
+    self.key
+  }
+
+  fn is_ready(&self) -> bool {
+    !self.app.is_loading && !self.app.data.lidarr_data.artists.is_empty()
+  }
+
+  fn handle_scroll_up(&mut self) {}
+
+  fn handle_scroll_down(&mut self) {}
+
+  fn handle_home(&mut self) {}
+
+  fn handle_end(&mut self) {}
+
+  fn handle_delete(&mut self) {}
+
+  fn handle_left_right_action(&mut self) {
+    if self.active_lidarr_block == ActiveLidarrBlock::Artists {
+      handle_change_tab_left_right_keys(self.app, self.key);
+    }
+  }
+
+  fn handle_submit(&mut self) {}
+
+  fn handle_esc(&mut self) {
+    handle_clear_errors(self.app);
+  }
+
+  fn handle_char_key_event(&mut self) {
+    let key = self.key;
+    if self.active_lidarr_block == ActiveLidarrBlock::Artists && matches_key!(refresh, key) {
+      self.app.should_refresh = true;
+    }
+  }
+
+  fn app_mut(&mut self) -> &mut App<'b> {
+    self.app
+  }
+
+  fn current_route(&self) -> crate::models::Route {
+    self.app.get_current_route()
+  }
+}
+
+fn artists_sorting_options() -> Vec<SortOption<Artist>> {
+  vec![
+    SortOption {
+      name: "Name",
+      cmp_fn: Some(|a, b| {
+        a.artist_name
+          .text
+          .to_lowercase()
+          .cmp(&b.artist_name.text.to_lowercase())
+      }),
+    },
+    SortOption {
+      name: "Type",
+      cmp_fn: Some(|a, b| {
+        a.artist_type
+          .as_ref()
+          .unwrap_or(&String::new())
+          .to_lowercase()
+          .cmp(
+            &b.artist_type
+              .as_ref()
+              .unwrap_or(&String::new())
+              .to_lowercase(),
+          )
+      }),
+    },
+    SortOption {
+      name: "Status",
+      cmp_fn: Some(|a, b| {
+        a.status
+          .to_string()
+          .to_lowercase()
+          .cmp(&b.status.to_string().to_lowercase())
+      }),
+    },
+    SortOption {
+      name: "Quality Profile",
+      cmp_fn: Some(|a, b| a.quality_profile_id.cmp(&b.quality_profile_id)),
+    },
+    SortOption {
+      name: "Metadata Profile",
+      cmp_fn: Some(|a, b| a.metadata_profile_id.cmp(&b.metadata_profile_id)),
+    },
+    SortOption {
+      name: "Albums",
+      cmp_fn: Some(|a, b| {
+        a.statistics
+          .as_ref()
+          .map_or(0, |stats| stats.album_count)
+          .cmp(&b.statistics.as_ref().map_or(0, |stats| stats.album_count))
+      }),
+    },
+    SortOption {
+      name: "Tracks",
+      cmp_fn: Some(|a, b| {
+        a.statistics
+          .as_ref()
+          .map_or(0, |stats| stats.track_count)
+          .cmp(&b.statistics.as_ref().map_or(0, |stats| stats.track_count))
+      }),
+    },
+    SortOption {
+      name: "Size",
+      cmp_fn: Some(|a, b| {
+        a.statistics
+          .as_ref()
+          .map_or(0, |stats| stats.size_on_disk)
+          .cmp(&b.statistics.as_ref().map_or(0, |stats| stats.size_on_disk))
+      }),
+    },
+    SortOption {
+      name: "Monitored",
+      cmp_fn: Some(|a, b| a.monitored.cmp(&b.monitored)),
+    },
+    SortOption {
+      name: "Tags",
+      cmp_fn: Some(|a, b| {
+        let a_str = a
+          .tags
+          .iter()
+          .map(|tag| tag.as_i64().unwrap().to_string())
+          .collect::<Vec<String>>()
+          .join(",");
+        let b_str = b
+          .tags
+          .iter()
+          .map(|tag| tag.as_i64().unwrap().to_string())
+          .collect::<Vec<String>>()
+          .join(",");
+
+        a_str.cmp(&b_str)
+      }),
+    },
+  ]
+}

src/handlers/lidarr_handlers/lidarr_handler_tests.rs

@@ -0,0 +1,15 @@
+#[cfg(test)]
+mod tests {
+  use strum::IntoEnumIterator;
+
+  use crate::handlers::KeyEventHandler;
+  use crate::handlers::lidarr_handlers::LidarrHandler;
+  use crate::models::servarr_data::lidarr::lidarr_data::ActiveLidarrBlock;
+
+  #[test]
+  fn test_lidarr_handler_accepts() {
+    for lidarr_block in ActiveLidarrBlock::iter() {
+      assert!(LidarrHandler::accepts(lidarr_block));
+    }
+  }
+}

src/handlers/lidarr_handlers/mod.rs

@@ -0,0 +1,102 @@
+use library::LibraryHandler;
+
+use crate::{
+  app::App, event::Key, matches_key, models::servarr_data::lidarr::lidarr_data::ActiveLidarrBlock,
+};
+
+use super::KeyEventHandler;
+
+mod library;
+
+#[cfg(test)]
+#[path = "lidarr_handler_tests.rs"]
+mod lidarr_handler_tests;
+
+pub(super) struct LidarrHandler<'a, 'b> {
+  key: Key,
+  app: &'a mut App<'b>,
+  active_lidarr_block: ActiveLidarrBlock,
+  context: Option<ActiveLidarrBlock>,
+}
+
+impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveLidarrBlock> for LidarrHandler<'a, 'b> {
+  fn handle(&mut self) {
+    match self.active_lidarr_block {
+      _ if LibraryHandler::accepts(self.active_lidarr_block) => {
+        LibraryHandler::new(self.key, self.app, self.active_lidarr_block, self.context).handle();
+      }
+      _ => self.handle_key_event(),
+    }
+  }
+
+  fn accepts(_active_block: ActiveLidarrBlock) -> bool {
+    true
+  }
+
+  fn ignore_special_keys(&self) -> bool {
+    self.app.ignore_special_keys_for_textbox_input
+  }
+
+  fn new(
+    key: Key,
+    app: &'a mut App<'b>,
+    active_block: ActiveLidarrBlock,
+    context: Option<ActiveLidarrBlock>,
+  ) -> LidarrHandler<'a, 'b> {
+    LidarrHandler {
+      key,
+      app,
+      active_lidarr_block: active_block,
+      context,
+    }
+  }
+
+  fn get_key(&self) -> Key {
+    self.key
+  }
+
+  fn is_ready(&self) -> bool {
+    true
+  }
+
+  fn handle_scroll_up(&mut self) {}
+
+  fn handle_scroll_down(&mut self) {}
+
+  fn handle_home(&mut self) {}
+
+  fn handle_end(&mut self) {}
+
+  fn handle_delete(&mut self) {}
+
+  fn handle_left_right_action(&mut self) {}
+
+  fn handle_submit(&mut self) {}
+
+  fn handle_esc(&mut self) {}
+
+  fn handle_char_key_event(&mut self) {}
+
+  fn app_mut(&mut self) -> &mut App<'b> {
+    self.app
+  }
+
+  fn current_route(&self) -> crate::models::Route {
+    self.app.get_current_route()
+  }
+}
+
+pub fn handle_change_tab_left_right_keys(app: &mut App<'_>, key: Key) {
+  let key_ref = key;
+  match key_ref {
+    _ if matches_key!(left, key, app.ignore_special_keys_for_textbox_input) => {
+      app.data.lidarr_data.main_tabs.previous();
+      app.pop_and_push_navigation_stack(app.data.lidarr_data.main_tabs.get_active_route());
+    }
+    _ if matches_key!(right, key, app.ignore_special_keys_for_textbox_input) => {
+      app.data.lidarr_data.main_tabs.next();
+      app.pop_and_push_navigation_stack(app.data.lidarr_data.main_tabs.get_active_route());
+    }
+    _ => (),
+  }
+}

src/handlers/mod.rs

@@ -1,3 +1,4 @@
+use lidarr_handlers::LidarrHandler;
 use radarr_handlers::RadarrHandler;
 use sonarr_handlers::SonarrHandler;
 
@@ -15,6 +16,7 @@ use crate::models::stateful_table::StatefulTable;
 use crate::models::{HorizontallyScrollableText, Route};
 
 mod keybinding_handler;
+mod lidarr_handlers;
 mod radarr_handlers;
 mod sonarr_handlers;
 
@@ -125,6 +127,9 @@ pub fn handle_events(key: Key, app: &mut App<'_>) {
       Route::Sonarr(active_sonarr_block, context) => {
         SonarrHandler::new(key, app, active_sonarr_block, context).handle()
       }
+      Route::Lidarr(active_lidarr_block, context) => {
+        LidarrHandler::new(key, app, active_lidarr_block, context).handle()
+      }
       _ => (),
     }
   }
@@ -187,6 +192,9 @@ fn handle_prompt_toggle(app: &mut App<'_>, key: Key) {
       Route::Sonarr(_, _) => {
         app.data.sonarr_data.prompt_confirm = !app.data.sonarr_data.prompt_confirm
       }
+      Route::Lidarr(_, _) => {
+        app.data.lidarr_data.prompt_confirm = !app.data.lidarr_data.prompt_confirm
+      }
       _ => (),
     },
     _ => (),