feat: Refactor all keybinding tips into a dynamically changing menu that can be invoked via '?' [#32]

2025-08-12 16:27:34 -06:00
parent 1f4870d082
commit 00ab0f27f7
64 changed files with 1627 additions and 903 deletions
@@ -1,22 +1,16 @@
 use std::sync::atomic::Ordering;

 use ratatui::layout::{Constraint, Layout, Rect};
-use ratatui::text::Text;
-use ratatui::widgets::{Cell, ListItem, Paragraph, Row};
+use ratatui::widgets::{Cell, ListItem, Row};
 use ratatui::Frame;

-use crate::app::context_clues::{
-  build_context_clue_string, BARE_POPUP_CONTEXT_CLUES, CONFIRMATION_PROMPT_CONTEXT_CLUES,
-};
-use crate::app::sonarr::sonarr_context_clues::ADD_SERIES_SEARCH_RESULTS_CONTEXT_CLUES;
 use crate::models::servarr_data::sonarr::modals::AddSeriesModal;
 use crate::models::servarr_data::sonarr::sonarr_data::{ActiveSonarrBlock, ADD_SERIES_BLOCKS};
 use crate::models::sonarr_models::AddSeriesSearchResult;
 use crate::models::Route;
 use crate::ui::styles::ManagarrStyle;
 use crate::ui::utils::{
-  borderless_block, get_width_from_percentage, layout_block, layout_paragraph_borderless,
-  title_block_centered,
+  get_width_from_percentage, layout_block, layout_paragraph_borderless, title_block_centered,
 };
 use crate::ui::widgets::button::Button;
 use crate::ui::widgets::checkbox::Checkbox;
@@ -78,13 +72,10 @@ fn draw_add_series_search(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
      AddSeriesSearchResult::default()
    };

-  let [search_box_area, results_area, help_area] = Layout::vertical([
-    Constraint::Length(3),
-    Constraint::Fill(0),
-    Constraint::Length(3),
-  ])
-  .margin(1)
-  .areas(area);
+  let [search_box_area, results_area] =
+    Layout::vertical([Constraint::Length(3), Constraint::Fill(0)])
+      .margin(1)
+      .areas(area);
  let block_content = &app
    .data
    .sonarr_data
@@ -150,27 +141,17 @@ fn draw_add_series_search(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
        let search_box = InputBox::new(block_content)
          .offset(offset)
          .block(title_block_centered("Add Series"));
-        let help_text = Text::from(build_context_clue_string(&BARE_POPUP_CONTEXT_CLUES).help());
-        let help_paragraph = Paragraph::new(help_text)
-          .block(borderless_block())
-          .centered();

        search_box.show_cursor(f, search_box_area);
        f.render_widget(layout_block().default(), results_area);
        f.render_widget(search_box, search_box_area);
-        f.render_widget(help_paragraph, help_area);
      }
      ActiveSonarrBlock::AddSeriesEmptySearchResults => {
-        let help_text = Text::from(build_context_clue_string(&BARE_POPUP_CONTEXT_CLUES).help());
-        let help_paragraph = Paragraph::new(help_text)
-          .block(borderless_block())
-          .centered();
        let error_message = Message::new("No series found matching your query!");
        let error_message_popup = Popup::new(error_message).size(Size::Message);

        f.render_widget(layout_block().default(), results_area);
        f.render_widget(error_message_popup, f.area());
-        f.render_widget(help_paragraph, help_area);
      }
      ActiveSonarrBlock::AddSeriesSearchResults
      | ActiveSonarrBlock::AddSeriesPrompt
@@ -181,11 +162,6 @@ fn draw_add_series_search(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
      | ActiveSonarrBlock::AddSeriesSelectRootFolder
      | ActiveSonarrBlock::AddSeriesAlreadyInLibrary
      | ActiveSonarrBlock::AddSeriesTagsInput => {
-        let help_text =
-          Text::from(build_context_clue_string(&ADD_SERIES_SEARCH_RESULTS_CONTEXT_CLUES).help());
-        let help_paragraph = Paragraph::new(help_text)
-          .block(borderless_block())
-          .centered();
        let search_results_table = ManagarrTable::new(
          app.data.sonarr_data.add_searched_series.as_mut(),
          search_results_row_mapping,
@@ -206,7 +182,6 @@ fn draw_add_series_search(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
        ]);

        f.render_widget(search_results_table, results_area);
-        f.render_widget(help_paragraph, help_area);
      }
      _ => (),
    }
@@ -297,7 +272,7 @@ fn draw_confirmation_prompt(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {

  f.render_widget(title_block_centered(&title), area);

-  let [paragraph_area, root_folder_area, monitor_area, quality_profile_area, language_profile_area, series_type_area, season_folder_area, tags_area, _, buttons_area, help_area] =
+  let [paragraph_area, root_folder_area, monitor_area, quality_profile_area, language_profile_area, series_type_area, season_folder_area, tags_area, _, buttons_area] =
    Layout::vertical([
      Constraint::Length(6),
      Constraint::Length(3),
@@ -309,16 +284,12 @@ fn draw_confirmation_prompt(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
      Constraint::Length(3),
      Constraint::Fill(1),
      Constraint::Length(3),
-      Constraint::Length(1),
    ])
    .margin(1)
    .areas(area);

  let prompt_paragraph = layout_paragraph_borderless(&prompt);
-  let help_text = Text::from(build_context_clue_string(&CONFIRMATION_PROMPT_CONTEXT_CLUES).help());
-  let help_paragraph = Paragraph::new(help_text).centered();
  f.render_widget(prompt_paragraph, paragraph_area);
-  f.render_widget(help_paragraph, help_area);

  let [add_area, cancel_area] =
    Layout::horizontal([Constraint::Percentage(50), Constraint::Percentage(50)])
@@ -2,11 +2,9 @@ use std::sync::atomic::Ordering;

 use ratatui::layout::{Constraint, Rect};
 use ratatui::prelude::Layout;
-use ratatui::text::Text;
-use ratatui::widgets::{ListItem, Paragraph};
+use ratatui::widgets::ListItem;
 use ratatui::Frame;

-use crate::app::context_clues::{build_context_clue_string, CONFIRMATION_PROMPT_CONTEXT_CLUES};
 use crate::app::App;
 use crate::models::servarr_data::sonarr::modals::EditSeriesModal;
 use crate::models::servarr_data::sonarr::sonarr_data::{
@@ -107,7 +105,7 @@ fn draw_edit_series_confirmation_prompt(f: &mut Frame<'_>, app: &mut App<'_>, ar
  let selected_quality_profile = quality_profile_list.current_selection();
  let selected_language_profile = language_profile_list.current_selection();

-  let [paragraph_area, monitored_area, season_folder_area, quality_profile_area, language_profile_area, series_type_area, path_area, tags_area, _, buttons_area, help_area] =
+  let [paragraph_area, monitored_area, season_folder_area, quality_profile_area, language_profile_area, series_type_area, path_area, tags_area, _, buttons_area] =
    Layout::vertical([
      Constraint::Length(6),
      Constraint::Length(3),
@@ -119,7 +117,6 @@ fn draw_edit_series_confirmation_prompt(f: &mut Frame<'_>, app: &mut App<'_>, ar
      Constraint::Length(3),
      Constraint::Fill(1),
      Constraint::Length(3),
-      Constraint::Length(1),
    ])
    .margin(1)
    .areas(area);
@@ -127,8 +124,6 @@ fn draw_edit_series_confirmation_prompt(f: &mut Frame<'_>, app: &mut App<'_>, ar
    Layout::horizontal([Constraint::Percentage(50), Constraint::Percentage(50)])
      .areas(buttons_area);

-  let help_text = Text::from(build_context_clue_string(&CONFIRMATION_PROMPT_CONTEXT_CLUES).help());
-  let help_paragraph = Paragraph::new(help_text).centered();
  let prompt_paragraph = layout_paragraph_borderless(&series_overview);
  let monitored_checkbox = Checkbox::new("Monitored")
    .checked(monitored.unwrap_or_default())
@@ -189,7 +184,6 @@ fn draw_edit_series_confirmation_prompt(f: &mut Frame<'_>, app: &mut App<'_>, ar
  f.render_widget(series_type_drop_down_button, series_type_area);
  f.render_widget(save_button, save_area);
  f.render_widget(cancel_button, cancel_area);
-  f.render_widget(help_paragraph, help_area);
 }

 fn draw_edit_series_select_series_type_popup(f: &mut Frame<'_>, app: &mut App<'_>) {
@@ -257,9 +257,6 @@ fn draw_episode_history_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect)
            .current_selection()
            .clone()
        };
-        let episode_history_table_footer = episode_details_modal
-          .episode_details_tabs
-          .get_active_tab_contextual_help();

        let history_row_mapping = |history_item: &SonarrHistoryItem| {
          let SonarrHistoryItem {
@@ -306,7 +303,6 @@ fn draw_episode_history_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect)
          ManagarrTable::new(Some(&mut episode_history_table), history_row_mapping)
            .block(layout_block_top_border())
            .loading(app.is_loading)
-            .footer(episode_history_table_footer)
            .headers(["Source Title", "Event Type", "Language", "Quality", "Date"])
            .constraints([
              Constraint::Percentage(40),
@@ -397,9 +393,6 @@ fn draw_episode_releases(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
            episode_details_modal.episode_releases.is_empty(),
          )
        };
-        let episode_release_table_footer = episode_details_modal
-          .episode_details_tabs
-          .get_active_tab_contextual_help();

        if let Route::Sonarr(active_sonarr_block, _) = app.get_current_route() {
          let episode_release_row_mapping = |release: &SonarrRelease| {
@@ -483,7 +476,6 @@ fn draw_episode_releases(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
          )
          .block(layout_block_top_border())
          .loading(app.is_loading || is_empty)
-          .footer(episode_release_table_footer)
          .sorting(active_sonarr_block == ActiveSonarrBlock::ManualEpisodeSearchSortPrompt)
          .headers([
            "Source", "Age", "⛔", "Title", "Indexer", "Size", "Peers", "Language", "Quality",
@@ -90,11 +90,6 @@ fn draw_library(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
    let language_profile_map = &app.data.sonarr_data.language_profiles_map;
    let tags_map = &app.data.sonarr_data.tags_map;
    let content = Some(&mut app.data.sonarr_data.series);
-    let help_footer = app
-      .data
-      .sonarr_data
-      .main_tabs
-      .get_active_tab_contextual_help();

    let series_table_row_mapping = |series: &Series| {
      series.title.scroll_left_or_reset(
@@ -154,7 +149,6 @@ fn draw_library(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
    let series_table = ManagarrTable::new(content, series_table_row_mapping)
      .block(layout_block_top_border())
      .loading(app.is_loading)
-      .footer(help_footer)
      .sorting(active_sonarr_block == ActiveSonarrBlock::SeriesSortPrompt)
      .searching(active_sonarr_block == ActiveSonarrBlock::SearchSeries)
      .filtering(active_sonarr_block == ActiveSonarrBlock::FilterSeries)
@@ -149,14 +149,6 @@ pub fn draw_season_details(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {

 fn draw_episodes_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
  if let Route::Sonarr(active_sonarr_block, _) = app.get_current_route() {
-    let help_footer = app
-      .data
-      .sonarr_data
-      .season_details_modal
-      .as_ref()
-      .expect("Season details modal is unpopulated")
-      .season_details_tabs
-      .get_active_tab_contextual_help();
    let episode_files = app
      .data
      .sonarr_data
@@ -222,7 +214,6 @@ fn draw_episodes_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
    let season_table = ManagarrTable::new(content, episode_row_mapping)
      .block(layout_block_top_border())
      .loading(app.is_loading)
-      .footer(help_footer)
      .searching(is_searching)
      .search_produced_empty_results(active_sonarr_block == ActiveSonarrBlock::SearchEpisodesError)
      .headers([
@@ -261,9 +252,6 @@ fn draw_season_history_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
          .current_selection()
          .clone()
      };
-      let season_history_table_footer = season_details_modal
-        .season_details_tabs
-        .get_active_tab_contextual_help();

      if let Route::Sonarr(active_sonarr_block, _) = app.get_current_route() {
        let history_row_mapping = |history_item: &SonarrHistoryItem| {
@@ -308,7 +296,6 @@ fn draw_season_history_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
          ManagarrTable::new(Some(&mut season_history_table), history_row_mapping)
            .block(layout_block_top_border())
            .loading(app.is_loading)
-            .footer(season_history_table_footer)
            .sorting(active_sonarr_block == ActiveSonarrBlock::SeasonHistorySortPrompt)
            .searching(active_sonarr_block == ActiveSonarrBlock::SearchSeasonHistory)
            .search_produced_empty_results(
@@ -363,9 +350,6 @@ fn draw_season_releases(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
          season_details_modal.season_releases.is_empty(),
        )
      };
-      let season_release_table_footer = season_details_modal
-        .season_details_tabs
-        .get_active_tab_contextual_help();

      if let Route::Sonarr(active_sonarr_block, _) = app.get_current_route() {
        let season_release_row_mapping = |release: &SonarrRelease| {
@@ -444,7 +428,6 @@ fn draw_season_releases(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
          ManagarrTable::new(Some(&mut season_release_table), season_release_row_mapping)
            .block(layout_block_top_border())
            .loading(app.is_loading || is_empty)
-            .footer(season_release_table_footer)
            .sorting(active_sonarr_block == ActiveSonarrBlock::ManualSeasonSearchSortPrompt)
            .headers([
              "Source", "Age", "⛔", "Title", "Indexer", "Size", "Peers", "Language", "Quality",
@@ -229,11 +229,6 @@ pub fn draw_series_details(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
 fn draw_seasons_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
  if let Route::Sonarr(active_sonarr_block, _) = app.get_current_route() {
    let content = Some(&mut app.data.sonarr_data.seasons);
-    let help_footer = app
-      .data
-      .sonarr_data
-      .series_info_tabs
-      .get_active_tab_contextual_help();
    let season_row_mapping = |season: &Season| {
      let Season {
        title,
@@ -279,7 +274,6 @@ fn draw_seasons_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
    let season_table = ManagarrTable::new(content, season_row_mapping)
      .block(layout_block_top_border())
      .loading(app.is_loading)
-      .footer(help_footer)
      .searching(is_searching)
      .search_produced_empty_results(active_sonarr_block == ActiveSonarrBlock::SearchSeasonError)
      .headers(["Monitored", "Season", "Episode Count", "Size on Disk"])
@@ -306,11 +300,6 @@ fn draw_series_history_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
      } else {
        series_history.current_selection().clone()
      };
-      let series_history_table_footer = app
-        .data
-        .sonarr_data
-        .series_info_tabs
-        .get_active_tab_contextual_help();

      if let Route::Sonarr(active_sonarr_block, _) = app.get_current_route() {
        let history_row_mapping = |history_item: &SonarrHistoryItem| {
@@ -349,7 +338,6 @@ fn draw_series_history_table(f: &mut Frame<'_>, app: &mut App<'_>, area: Rect) {
          ManagarrTable::new(Some(&mut series_history_table), history_row_mapping)
            .block(layout_block_top_border())
            .loading(app.is_loading)
-            .footer(series_history_table_footer)
            .sorting(active_sonarr_block == ActiveSonarrBlock::SeriesHistorySortPrompt)
            .searching(active_sonarr_block == ActiveSonarrBlock::SearchSeriesHistory)
            .search_produced_empty_results(