feat: TUI support for Lidarr library

src/app/app_tests.rs

@@ -8,6 +8,7 @@ mod tests {
   use tokio::sync::mpsc;
 
   use crate::app::{App, AppConfig, Data, ServarrConfig, interpolate_env_vars};
+  use crate::models::servarr_data::lidarr::lidarr_data::LidarrData;
   use crate::models::servarr_data::radarr::radarr_data::{ActiveRadarrBlock, RadarrData};
   use crate::models::servarr_data::sonarr::sonarr_data::{ActiveSonarrBlock, SonarrData};
   use crate::models::{HorizontallyScrollableText, TabRoute};
@@ -185,6 +186,7 @@ mod tests {
       ..SonarrData::default()
     };
     let data = Data {
+      lidarr_data: LidarrData::default(),
       radarr_data,
       sonarr_data,
     };

src/app/context_clues.rs

@@ -1,5 +1,6 @@
 use crate::app::App;
 use crate::app::key_binding::{DEFAULT_KEYBINDINGS, KeyBinding};
+use crate::app::lidarr::lidarr_context_clues::LidarrContextClueProvider;
 use crate::app::radarr::radarr_context_clues::RadarrContextClueProvider;
 use crate::app::sonarr::sonarr_context_clues::SonarrContextClueProvider;
 use crate::models::Route;
@@ -21,6 +22,7 @@ impl ContextClueProvider for ServarrContextClueProvider {
     match app.get_current_route() {
       Route::Radarr(_, _) => RadarrContextClueProvider::get_context_clues(app),
       Route::Sonarr(_, _) => SonarrContextClueProvider::get_context_clues(app),
+      Route::Lidarr(_, _) => LidarrContextClueProvider::get_context_clues(app),
       _ => None,
     }
   }

src/app/lidarr/lidarr_context_clues.rs

@@ -0,0 +1,25 @@
+use crate::app::App;
+use crate::app::context_clues::{ContextClue, ContextClueProvider};
+use crate::models::Route;
+
+#[cfg(test)]
+#[path = "lidarr_context_clues_tests.rs"]
+mod lidarr_context_clues_tests;
+
+pub(in crate::app) struct LidarrContextClueProvider;
+
+impl ContextClueProvider for LidarrContextClueProvider {
+  fn get_context_clues(app: &mut App<'_>) -> Option<&'static [ContextClue]> {
+    let Route::Lidarr(active_lidarr_block, _context_option) = app.get_current_route() else {
+      panic!("LidarrContextClueProvider::get_context_clues called with non-Lidarr route");
+    };
+
+    match active_lidarr_block {
+      _ => app
+        .data
+        .lidarr_data
+        .main_tabs
+        .get_active_route_contextual_help(),
+    }
+  }
+}

src/app/lidarr/lidarr_context_clues_tests.rs

@@ -0,0 +1,92 @@
+#[cfg(test)]
+mod tests {
+  use crate::app::context_clues::ContextClueProvider;
+  use crate::app::key_binding::DEFAULT_KEYBINDINGS;
+  use crate::app::lidarr::lidarr_context_clues::LidarrContextClueProvider;
+  use crate::app::App;
+  use crate::models::servarr_data::lidarr::lidarr_data::{
+    ActiveLidarrBlock, ARTISTS_CONTEXT_CLUES,
+  };
+  use crate::models::servarr_data::radarr::radarr_data::ActiveRadarrBlock;
+
+  #[test]
+  fn test_artists_context_clues() {
+    let mut artists_context_clues_iter = ARTISTS_CONTEXT_CLUES.iter();
+
+    assert_some_eq_x!(
+      artists_context_clues_iter.next(),
+      &(DEFAULT_KEYBINDINGS.sort, DEFAULT_KEYBINDINGS.sort.desc)
+    );
+    assert_some_eq_x!(
+      artists_context_clues_iter.next(),
+      &(DEFAULT_KEYBINDINGS.search, DEFAULT_KEYBINDINGS.search.desc)
+    );
+    assert_some_eq_x!(
+      artists_context_clues_iter.next(),
+      &(DEFAULT_KEYBINDINGS.filter, DEFAULT_KEYBINDINGS.filter.desc)
+    );
+    assert_some_eq_x!(
+      artists_context_clues_iter.next(),
+      &(
+        DEFAULT_KEYBINDINGS.refresh,
+        DEFAULT_KEYBINDINGS.refresh.desc
+      )
+    );
+    assert_some_eq_x!(
+      artists_context_clues_iter.next(),
+      &(DEFAULT_KEYBINDINGS.esc, "cancel filter")
+    );
+    assert_none!(artists_context_clues_iter.next());
+  }
+
+  #[test]
+  #[should_panic(
+    expected = "LidarrContextClueProvider::get_context_clues called with non-Lidarr route"
+  )]
+  fn test_lidarr_context_clue_provider_get_context_clues_non_lidarr_route() {
+    let mut app = App::test_default();
+    app.push_navigation_stack(ActiveRadarrBlock::default().into());
+
+    LidarrContextClueProvider::get_context_clues(&mut app);
+  }
+
+  #[test]
+  fn test_lidarr_context_clue_provider_artists_block() {
+    let mut app = App::test_default();
+    app.push_navigation_stack(ActiveLidarrBlock::Artists.into());
+
+    let context_clues = LidarrContextClueProvider::get_context_clues(&mut app);
+
+    assert_some_eq_x!(context_clues, &ARTISTS_CONTEXT_CLUES);
+  }
+
+  #[test]
+  fn test_lidarr_context_clue_provider_artists_sort_prompt_block() {
+    let mut app = App::test_default();
+    app.push_navigation_stack(ActiveLidarrBlock::ArtistsSortPrompt.into());
+
+    let context_clues = LidarrContextClueProvider::get_context_clues(&mut app);
+
+    assert_some_eq_x!(context_clues, &ARTISTS_CONTEXT_CLUES);
+  }
+
+  #[test]
+  fn test_lidarr_context_clue_provider_search_artists_block() {
+    let mut app = App::test_default();
+    app.push_navigation_stack(ActiveLidarrBlock::SearchArtists.into());
+
+    let context_clues = LidarrContextClueProvider::get_context_clues(&mut app);
+
+    assert_some_eq_x!(context_clues, &ARTISTS_CONTEXT_CLUES);
+  }
+
+  #[test]
+  fn test_lidarr_context_clue_provider_filter_artists_block() {
+    let mut app = App::test_default();
+    app.push_navigation_stack(ActiveLidarrBlock::FilterArtists.into());
+
+    let context_clues = LidarrContextClueProvider::get_context_clues(&mut app);
+
+    assert_some_eq_x!(context_clues, &ARTISTS_CONTEXT_CLUES);
+  }
+}

src/app/lidarr/lidarr_tests.rs

@@ -0,0 +1,28 @@
+#[cfg(test)]
+mod tests {
+  use crate::app::App;
+  use crate::models::servarr_data::lidarr::lidarr_data::ActiveLidarrBlock;
+  use crate::network::NetworkEvent;
+  use crate::network::lidarr_network::LidarrEvent;
+  use tokio::sync::mpsc;
+
+  #[tokio::test]
+  async fn test_dispatch_by_lidarr_block_artists() {
+    let (tx, mut rx) = mpsc::channel::<NetworkEvent>(500);
+    let mut app = App::test_default();
+    app.network_tx = Some(tx);
+
+    app.dispatch_by_lidarr_block(&ActiveLidarrBlock::Artists).await;
+
+    assert_eq!(
+      rx.recv().await.unwrap(),
+      LidarrEvent::GetQualityProfiles.into()
+    );
+    assert_eq!(
+      rx.recv().await.unwrap(),
+      LidarrEvent::GetMetadataProfiles.into()
+    );
+    assert_eq!(rx.recv().await.unwrap(), LidarrEvent::GetTags.into());
+    assert_eq!(rx.recv().await.unwrap(), LidarrEvent::ListArtists.into());
+  }
+}

src/app/lidarr/mod.rs

@@ -0,0 +1,97 @@
+use crate::{
+  models::servarr_data::lidarr::lidarr_data::ActiveLidarrBlock,
+  network::lidarr_network::LidarrEvent,
+};
+
+use super::App;
+
+pub(in crate::app) mod lidarr_context_clues;
+
+#[cfg(test)]
+#[path = "lidarr_tests.rs"]
+mod lidarr_tests;
+
+impl App<'_> {
+  pub(super) async fn dispatch_by_lidarr_block(&mut self, active_lidarr_block: &ActiveLidarrBlock) {
+    match active_lidarr_block {
+      ActiveLidarrBlock::Artists => {
+        self
+          .dispatch_network_event(LidarrEvent::GetQualityProfiles.into())
+          .await;
+        self
+          .dispatch_network_event(LidarrEvent::GetMetadataProfiles.into())
+          .await;
+        self
+          .dispatch_network_event(LidarrEvent::GetTags.into())
+          .await;
+        self
+          .dispatch_network_event(LidarrEvent::ListArtists.into())
+          .await;
+      }
+      _ => (),
+    }
+
+    self.check_for_lidarr_prompt_action().await;
+    self.reset_tick_count();
+  }
+
+  async fn check_for_lidarr_prompt_action(&mut self) {
+    if self.data.lidarr_data.prompt_confirm {
+      self.data.lidarr_data.prompt_confirm = false;
+      if let Some(lidarr_event) = self.data.lidarr_data.prompt_confirm_action.take() {
+        self.dispatch_network_event(lidarr_event.into()).await;
+        self.should_refresh = true;
+      }
+    }
+  }
+
+  pub(super) async fn lidarr_on_tick(&mut self, active_lidarr_block: ActiveLidarrBlock) {
+    if self.is_first_render {
+      self.refresh_lidarr_metadata().await;
+      self.dispatch_by_lidarr_block(&active_lidarr_block).await;
+      self.is_first_render = false;
+      return;
+    }
+
+    if self.should_refresh {
+      self.dispatch_by_lidarr_block(&active_lidarr_block).await;
+      self.refresh_lidarr_metadata().await;
+    }
+
+    if self.is_routing {
+      if !self.should_refresh {
+        self.cancellation_token.cancel();
+      } else {
+        self.dispatch_by_lidarr_block(&active_lidarr_block).await;
+      }
+    }
+
+    if self.tick_count.is_multiple_of(self.tick_until_poll) {
+      self.refresh_lidarr_metadata().await;
+    }
+  }
+
+  async fn refresh_lidarr_metadata(&mut self) {
+    self
+      .dispatch_network_event(LidarrEvent::GetQualityProfiles.into())
+      .await;
+    self
+      .dispatch_network_event(LidarrEvent::GetMetadataProfiles.into())
+      .await;
+    self
+      .dispatch_network_event(LidarrEvent::GetTags.into())
+      .await;
+    self
+      .dispatch_network_event(LidarrEvent::GetRootFolders.into())
+      .await;
+    self
+      .dispatch_network_event(LidarrEvent::GetDownloads(500).into())
+      .await;
+    self
+      .dispatch_network_event(LidarrEvent::GetDiskSpace.into())
+      .await;
+    self
+      .dispatch_network_event(LidarrEvent::GetStatus.into())
+      .await;
+  }
+}

src/app/mod.rs

@@ -13,7 +13,7 @@ use tokio_util::sync::CancellationToken;
 use veil::Redact;
 
 use crate::cli::Command;
-use crate::models::servarr_data::lidarr::lidarr_data::ActiveLidarrBlock;
+use crate::models::servarr_data::lidarr::lidarr_data::{ActiveLidarrBlock, LidarrData};
 use crate::models::servarr_data::radarr::radarr_data::{ActiveRadarrBlock, RadarrData};
 use crate::models::servarr_data::sonarr::sonarr_data::{ActiveSonarrBlock, SonarrData};
 use crate::models::servarr_models::KeybindingItem;
@@ -26,6 +26,7 @@ mod app_tests;
 pub mod context_clues;
 pub mod key_binding;
 mod key_binding_tests;
+pub mod lidarr;
 pub mod radarr;
 pub mod sonarr;
 
@@ -197,6 +198,7 @@ impl App<'_> {
       match self.get_current_route() {
         Route::Radarr(active_radarr_block, _) => self.radarr_on_tick(active_radarr_block).await,
         Route::Sonarr(active_sonarr_block, _) => self.sonarr_on_tick(active_sonarr_block).await,
+        Route::Lidarr(active_lidarr_block, _) => self.lidarr_on_tick(active_lidarr_block).await,
         _ => (),
       }
 
@@ -299,6 +301,7 @@ impl App<'_> {
   pub fn test_default_fully_populated() -> Self {
     App {
       data: Data {
+        lidarr_data: LidarrData::test_default_fully_populated(),
         radarr_data: RadarrData::test_default_fully_populated(),
         sonarr_data: SonarrData::test_default_fully_populated(),
       },
@@ -329,6 +332,7 @@ impl App<'_> {
 
 #[derive(Default)]
 pub struct Data<'a> {
+  pub lidarr_data: LidarrData<'a>,
   pub radarr_data: RadarrData<'a>,
   pub sonarr_data: SonarrData<'a>,
 }