Refactored the UI module and the handlers module to do a more chain-of-responsibility method to manage the UI's and handlers for different key events. Also, initial work for indexer settings as well

This commit is contained in:
2023-08-08 10:50:07 -06:00
parent 718613d59f
commit cf11527fef
67 changed files with 5255 additions and 2216 deletions
@@ -0,0 +1,657 @@
#[cfg(test)]
mod tests {
use pretty_assertions::assert_str_eq;
use rstest::rstest;
use serde_json::Number;
use strum::IntoEnumIterator;
use crate::app::key_binding::DEFAULT_KEYBINDINGS;
use crate::app::radarr::{ActiveRadarrBlock, MOVIE_DETAILS_BLOCKS};
use crate::app::App;
use crate::event::Key;
use crate::handlers::radarr_handlers::library::movie_details_handler::{
sort_releases_by_selected_field, MovieDetailsHandler,
};
use crate::handlers::KeyEventHandler;
use crate::models::radarr_models::{
Credit, Language, MovieHistoryItem, Quality, QualityWrapper, Release, ReleaseField,
};
use crate::models::{HorizontallyScrollableText, ScrollableText};
mod test_handle_scroll_up_and_down {
use pretty_assertions::assert_eq;
use rstest::rstest;
use strum::IntoEnumIterator;
use crate::models::radarr_models::ReleaseField;
use crate::{
simple_stateful_iterable_vec, test_enum_scroll, test_iterable_scroll,
test_scrollable_text_scroll,
};
use super::*;
test_scrollable_text_scroll!(
test_movie_details_scroll,
MovieDetailsHandler,
movie_details,
ActiveRadarrBlock::MovieDetails
);
test_iterable_scroll!(
test_movie_history_scroll,
MovieDetailsHandler,
movie_history,
simple_stateful_iterable_vec!(MovieHistoryItem, HorizontallyScrollableText, source_title),
ActiveRadarrBlock::MovieHistory,
None,
source_title,
to_string
);
test_iterable_scroll!(
test_cast_scroll,
MovieDetailsHandler,
movie_cast,
simple_stateful_iterable_vec!(Credit, String, person_name),
ActiveRadarrBlock::Cast,
None,
person_name,
to_owned
);
test_iterable_scroll!(
test_crew_scroll,
MovieDetailsHandler,
movie_crew,
simple_stateful_iterable_vec!(Credit, String, person_name),
ActiveRadarrBlock::Crew,
None,
person_name,
to_owned
);
test_iterable_scroll!(
test_manual_search_scroll,
MovieDetailsHandler,
movie_releases,
simple_stateful_iterable_vec!(Release, HorizontallyScrollableText),
ActiveRadarrBlock::ManualSearch,
None,
title,
to_string
);
test_enum_scroll!(
test_manual_search_sort_scroll,
MovieDetailsHandler,
ReleaseField,
movie_releases_sort,
ActiveRadarrBlock::ManualSearchSortPrompt,
None
);
}
mod test_handle_home_end {
use strum::IntoEnumIterator;
use crate::models::radarr_models::ReleaseField;
use crate::{
extended_stateful_iterable_vec, test_enum_home_and_end, test_iterable_home_and_end,
test_scrollable_text_home_and_end,
};
use super::*;
test_scrollable_text_home_and_end!(
test_movie_details_home_end,
MovieDetailsHandler,
movie_details,
ActiveRadarrBlock::MovieDetails
);
test_iterable_home_and_end!(
test_movie_history_home_end,
MovieDetailsHandler,
movie_history,
extended_stateful_iterable_vec!(MovieHistoryItem, HorizontallyScrollableText, source_title),
ActiveRadarrBlock::MovieHistory,
None,
source_title,
to_string
);
test_iterable_home_and_end!(
test_cast_home_end,
MovieDetailsHandler,
movie_cast,
extended_stateful_iterable_vec!(Credit, String, person_name),
ActiveRadarrBlock::Cast,
None,
person_name,
to_owned
);
test_iterable_home_and_end!(
test_crew_home_end,
MovieDetailsHandler,
movie_crew,
extended_stateful_iterable_vec!(Credit, String, person_name),
ActiveRadarrBlock::Crew,
None,
person_name,
to_owned
);
test_iterable_home_and_end!(
test_manual_search_home_end,
MovieDetailsHandler,
movie_releases,
extended_stateful_iterable_vec!(Release, HorizontallyScrollableText),
ActiveRadarrBlock::ManualSearch,
None,
title,
to_string
);
test_enum_home_and_end!(
test_manual_search_sort_home_end,
MovieDetailsHandler,
ReleaseField,
movie_releases_sort,
ActiveRadarrBlock::ManualSearchSortPrompt,
None
);
}
mod test_handle_left_right_action {
use pretty_assertions::assert_eq;
use rstest::rstest;
use super::*;
#[rstest]
fn test_left_right_prompt_toggle(
#[values(
ActiveRadarrBlock::AutomaticallySearchMoviePrompt,
ActiveRadarrBlock::UpdateAndScanPrompt,
ActiveRadarrBlock::ManualSearchConfirmPrompt
)]
active_radarr_block: ActiveRadarrBlock,
#[values(Key::Left, Key::Right)] key: Key,
) {
let mut app = App::default();
MovieDetailsHandler::with(&key, &mut app, &active_radarr_block, &None).handle();
assert!(app.data.radarr_data.prompt_confirm);
MovieDetailsHandler::with(&key, &mut app, &active_radarr_block, &None).handle();
assert!(!app.data.radarr_data.prompt_confirm);
}
#[rstest]
#[case(ActiveRadarrBlock::MovieDetails, ActiveRadarrBlock::MovieHistory)]
#[case(ActiveRadarrBlock::MovieHistory, ActiveRadarrBlock::FileInfo)]
#[case(ActiveRadarrBlock::FileInfo, ActiveRadarrBlock::Cast)]
#[case(ActiveRadarrBlock::Cast, ActiveRadarrBlock::Crew)]
#[case(ActiveRadarrBlock::Crew, ActiveRadarrBlock::ManualSearch)]
#[case(ActiveRadarrBlock::ManualSearch, ActiveRadarrBlock::MovieDetails)]
fn test_movie_info_tabs_left_right_action(
#[case] left_block: ActiveRadarrBlock,
#[case] right_block: ActiveRadarrBlock,
) {
let mut app = App::default();
app.push_navigation_stack(right_block.into());
app.data.radarr_data.movie_info_tabs.index = app
.data
.radarr_data
.movie_info_tabs
.tabs
.iter()
.position(|tab_route| tab_route.route == right_block.into())
.unwrap_or_default();
MovieDetailsHandler::with(&DEFAULT_KEYBINDINGS.left.key, &mut app, &right_block, &None)
.handle();
assert_eq!(
app.get_current_route(),
app.data.radarr_data.movie_info_tabs.get_active_route()
);
assert_eq!(app.get_current_route(), &left_block.into());
MovieDetailsHandler::with(&DEFAULT_KEYBINDINGS.right.key, &mut app, &left_block, &None)
.handle();
assert_eq!(
app.get_current_route(),
app.data.radarr_data.movie_info_tabs.get_active_route()
);
assert_eq!(app.get_current_route(), &right_block.into());
}
}
mod test_handle_submit {
use pretty_assertions::assert_eq;
use rstest::rstest;
use crate::models::radarr_models::ReleaseField;
use crate::network::radarr_network::RadarrEvent;
use super::*;
const SUBMIT_KEY: Key = DEFAULT_KEYBINDINGS.submit.key;
#[test]
fn test_manual_search_submit() {
let mut app = App::default();
app.push_navigation_stack(ActiveRadarrBlock::ManualSearch.into());
MovieDetailsHandler::with(
&SUBMIT_KEY,
&mut app,
&ActiveRadarrBlock::ManualSearch,
&None,
)
.handle();
assert_eq!(
app.get_current_route(),
&ActiveRadarrBlock::ManualSearchConfirmPrompt.into()
);
}
#[rstest]
#[case(
ActiveRadarrBlock::AutomaticallySearchMoviePrompt,
RadarrEvent::TriggerAutomaticSearch
)]
#[case(ActiveRadarrBlock::UpdateAndScanPrompt, RadarrEvent::UpdateAndScan)]
#[case(
ActiveRadarrBlock::ManualSearchConfirmPrompt,
RadarrEvent::DownloadRelease
)]
fn test_movie_info_prompt_confirm_submit(
#[case] prompt_block: ActiveRadarrBlock,
#[case] expected_action: RadarrEvent,
) {
let mut app = App::default();
app.data.radarr_data.prompt_confirm = true;
app.push_navigation_stack(ActiveRadarrBlock::MovieDetails.into());
app.push_navigation_stack(prompt_block.into());
MovieDetailsHandler::with(&SUBMIT_KEY, &mut app, &prompt_block, &None).handle();
assert!(app.data.radarr_data.prompt_confirm);
assert_eq!(
app.get_current_route(),
&ActiveRadarrBlock::MovieDetails.into()
);
assert_eq!(
app.data.radarr_data.prompt_confirm_action,
Some(expected_action)
);
}
#[rstest]
fn test_movie_info_prompt_decline_submit(
#[values(
ActiveRadarrBlock::AutomaticallySearchMoviePrompt,
ActiveRadarrBlock::UpdateAndScanPrompt,
ActiveRadarrBlock::ManualSearchConfirmPrompt
)]
prompt_block: ActiveRadarrBlock,
) {
let mut app = App::default();
app.push_navigation_stack(ActiveRadarrBlock::MovieDetails.into());
app.push_navigation_stack(prompt_block.into());
MovieDetailsHandler::with(&SUBMIT_KEY, &mut app, &prompt_block, &None).handle();
assert!(!app.data.radarr_data.prompt_confirm);
assert_eq!(
app.get_current_route(),
&ActiveRadarrBlock::MovieDetails.into()
);
assert_eq!(app.data.radarr_data.prompt_confirm_action, None);
}
#[test]
fn test_manual_search_sort_prompt_submit() {
let mut app = App::default();
app.push_navigation_stack(ActiveRadarrBlock::ManualSearch.into());
app.push_navigation_stack(ActiveRadarrBlock::ManualSearchSortPrompt.into());
app.data.radarr_data.sort_ascending = Some(true);
app
.data
.radarr_data
.movie_releases_sort
.set_items(vec![ReleaseField::default()]);
app.data.radarr_data.movie_releases.set_items(release_vec());
let mut expected_vec = release_vec();
expected_vec.reverse();
MovieDetailsHandler::with(
&SUBMIT_KEY,
&mut app,
&ActiveRadarrBlock::ManualSearchSortPrompt,
&None,
)
.handle();
assert_eq!(
app.get_current_route(),
&ActiveRadarrBlock::ManualSearch.into()
);
assert_eq!(app.data.radarr_data.movie_releases.items, expected_vec);
}
}
mod test_handle_esc {
use pretty_assertions::assert_eq;
use rstest::rstest;
use crate::app::radarr::radarr_test_utils::utils::create_test_radarr_data;
use crate::assert_movie_info_tabs_reset;
use super::*;
const ESC_KEY: Key = DEFAULT_KEYBINDINGS.esc.key;
#[rstest]
fn test_movie_info_tabs_esc(
#[values(
ActiveRadarrBlock::MovieDetails,
ActiveRadarrBlock::MovieHistory,
ActiveRadarrBlock::FileInfo,
ActiveRadarrBlock::Cast,
ActiveRadarrBlock::Crew,
ActiveRadarrBlock::ManualSearch
)]
active_radarr_block: ActiveRadarrBlock,
) {
let mut app = App::default();
app.data.radarr_data = create_test_radarr_data();
app.push_navigation_stack(ActiveRadarrBlock::Movies.into());
app.push_navigation_stack(active_radarr_block.into());
MovieDetailsHandler::with(&ESC_KEY, &mut app, &active_radarr_block, &None).handle();
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::Movies.into());
assert_movie_info_tabs_reset!(app.data.radarr_data);
}
#[rstest]
fn test_movie_info_prompts_esc(
#[values(
ActiveRadarrBlock::AutomaticallySearchMoviePrompt,
ActiveRadarrBlock::UpdateAndScanPrompt,
ActiveRadarrBlock::ManualSearchConfirmPrompt,
ActiveRadarrBlock::ManualSearchSortPrompt
)]
prompt_block: ActiveRadarrBlock,
) {
let mut app = App::default();
app.data.radarr_data.prompt_confirm = true;
app.push_navigation_stack(ActiveRadarrBlock::Movies.into());
app.push_navigation_stack(prompt_block.into());
MovieDetailsHandler::with(&ESC_KEY, &mut app, &prompt_block, &None).handle();
assert!(!app.data.radarr_data.prompt_confirm);
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::Movies.into());
}
}
mod test_handle_key_char {
use bimap::BiMap;
use pretty_assertions::{assert_eq, assert_str_eq};
use rstest::rstest;
use strum::IntoEnumIterator;
use crate::app::radarr::radarr_test_utils::utils::create_test_radarr_data;
use crate::app::radarr::RadarrData;
use crate::app::radarr::EDIT_MOVIE_SELECTION_BLOCKS;
use crate::models::radarr_models::{MinimumAvailability, Movie};
use crate::models::HorizontallyScrollableText;
use crate::models::StatefulTable;
use crate::test_edit_movie_key;
use super::*;
#[rstest]
fn test_search_key(
#[values(
ActiveRadarrBlock::MovieDetails,
ActiveRadarrBlock::MovieHistory,
ActiveRadarrBlock::FileInfo,
ActiveRadarrBlock::Cast,
ActiveRadarrBlock::Crew,
ActiveRadarrBlock::ManualSearch
)]
active_radarr_block: ActiveRadarrBlock,
) {
let mut app = App::default();
MovieDetailsHandler::with(
&DEFAULT_KEYBINDINGS.search.key,
&mut app,
&active_radarr_block,
&None,
)
.handle();
assert_eq!(
app.get_current_route(),
&ActiveRadarrBlock::AutomaticallySearchMoviePrompt.into()
);
}
#[test]
fn test_sort_key() {
let mut app = App::default();
MovieDetailsHandler::with(
&DEFAULT_KEYBINDINGS.sort.key,
&mut app,
&ActiveRadarrBlock::ManualSearch,
&None,
)
.handle();
assert_eq!(
app.get_current_route(),
&ActiveRadarrBlock::ManualSearchSortPrompt.into()
);
assert!(!app.data.radarr_data.movie_releases_sort.items.is_empty());
assert!(app.data.radarr_data.sort_ascending.is_some());
assert_eq!(app.data.radarr_data.sort_ascending, Some(false));
}
#[rstest]
fn test_edit_key(
#[values(
ActiveRadarrBlock::MovieDetails,
ActiveRadarrBlock::MovieHistory,
ActiveRadarrBlock::FileInfo,
ActiveRadarrBlock::Cast,
ActiveRadarrBlock::Crew,
ActiveRadarrBlock::ManualSearch
)]
active_radarr_block: ActiveRadarrBlock,
) {
test_edit_movie_key!(
MovieDetailsHandler,
active_radarr_block,
active_radarr_block
);
}
#[rstest]
fn test_update_key(
#[values(
ActiveRadarrBlock::MovieDetails,
ActiveRadarrBlock::MovieHistory,
ActiveRadarrBlock::FileInfo,
ActiveRadarrBlock::Cast,
ActiveRadarrBlock::Crew,
ActiveRadarrBlock::ManualSearch
)]
active_radarr_block: ActiveRadarrBlock,
) {
let mut app = App::default();
MovieDetailsHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
&mut app,
&active_radarr_block,
&None,
)
.handle();
assert_eq!(
app.get_current_route(),
&ActiveRadarrBlock::UpdateAndScanPrompt.into()
);
}
#[rstest]
fn test_refresh_key(
#[values(
ActiveRadarrBlock::MovieDetails,
ActiveRadarrBlock::MovieHistory,
ActiveRadarrBlock::FileInfo,
ActiveRadarrBlock::Cast,
ActiveRadarrBlock::Crew,
ActiveRadarrBlock::ManualSearch
)]
active_radarr_block: ActiveRadarrBlock,
) {
let mut app = App::default();
MovieDetailsHandler::with(
&DEFAULT_KEYBINDINGS.refresh.key,
&mut app,
&active_radarr_block,
&None,
)
.handle();
assert_eq!(app.get_current_route(), &active_radarr_block.into());
assert!(app.is_routing);
}
}
#[rstest]
fn test_sort_releases_by_selected_field(
#[values(
ReleaseField::Source,
ReleaseField::Age,
ReleaseField::Title,
ReleaseField::Indexer,
ReleaseField::Size,
ReleaseField::Peers,
ReleaseField::Language,
ReleaseField::Quality
)]
field: ReleaseField,
) {
let mut expected_vec = release_vec();
let sorted_releases = sort_releases_by_selected_field(release_vec(), field, true);
assert_eq!(sorted_releases, expected_vec);
let sorted_releases = sort_releases_by_selected_field(release_vec(), field, false);
expected_vec.reverse();
assert_eq!(sorted_releases, expected_vec);
}
#[test]
fn test_sort_releases_by_selected_field_rejected() {
let mut expected_vec = Vec::from(&release_vec()[1..]);
expected_vec.push(release_vec()[0].clone());
let sorted_releases =
sort_releases_by_selected_field(release_vec(), ReleaseField::Rejected, true);
assert_eq!(sorted_releases, expected_vec);
let sorted_releases =
sort_releases_by_selected_field(release_vec(), ReleaseField::Rejected, false);
assert_eq!(sorted_releases, release_vec());
}
fn release_vec() -> Vec<Release> {
let release_a = Release {
protocol: "Protocol A".to_owned(),
age: Number::from(1),
title: HorizontallyScrollableText::from("Title A"),
indexer: "Indexer A".to_owned(),
size: Number::from(1),
rejected: true,
seeders: Some(Number::from(1)),
languages: Some(vec![Language {
name: "Language A".to_owned(),
}]),
quality: QualityWrapper {
quality: Quality {
name: "Quality A".to_owned(),
},
},
..Release::default()
};
let release_b = Release {
protocol: "Protocol B".to_owned(),
age: Number::from(2),
title: HorizontallyScrollableText::from("Title B"),
indexer: "Indexer B".to_owned(),
size: Number::from(2),
rejected: false,
seeders: Some(Number::from(2)),
languages: Some(vec![Language {
name: "Language B".to_owned(),
}]),
quality: QualityWrapper {
quality: Quality {
name: "Quality B".to_owned(),
},
},
..Release::default()
};
let release_c = Release {
protocol: "Protocol C".to_owned(),
age: Number::from(3),
title: HorizontallyScrollableText::from("Title C"),
indexer: "Indexer C".to_owned(),
size: Number::from(3),
rejected: false,
seeders: None,
languages: None,
quality: QualityWrapper {
quality: Quality {
name: "Quality C".to_owned(),
},
},
..Release::default()
};
vec![release_a, release_b, release_c]
}
#[test]
fn test_movie_details_handler_accepts() {
ActiveRadarrBlock::iter().for_each(|active_radarr_block| {
if MOVIE_DETAILS_BLOCKS.contains(&active_radarr_block) {
assert!(MovieDetailsHandler::accepts(&active_radarr_block));
} else {
assert!(!MovieDetailsHandler::accepts(&active_radarr_block));
}
});
}
}