feat(readarr): add the root folders handler

This commit is contained in:
Dark-Alex-17 committed 2026-09-04 12:11:00 -06:00
1 parent ee07a0289f
commit a4a3c77586
4 files changed
+731

No files matched your search

+6
View File
@@ -3,6 +3,7 @@ use crate::handlers::readarr_handlers::blocklist::BlocklistHandler;
use crate::handlers::readarr_handlers::downloads::DownloadsHandler; use crate::handlers::readarr_handlers::downloads::DownloadsHandler;
use crate::handlers::readarr_handlers::history::HistoryHandler; use crate::handlers::readarr_handlers::history::HistoryHandler;
use crate::handlers::readarr_handlers::library::LibraryHandler; use crate::handlers::readarr_handlers::library::LibraryHandler;
use crate::handlers::readarr_handlers::root_folders::RootFoldersHandler;
use crate::models::Route; use crate::models::Route;
use crate::{ use crate::{
app::App, event::Key, matches_key, app::App, event::Key, matches_key,
@@ -13,6 +14,7 @@ mod blocklist;
mod downloads; mod downloads;
mod history; mod history;
mod library; mod library;
mod root_folders;
#[cfg(test)] #[cfg(test)]
#[path = "readarr_handler_tests.rs"] #[path = "readarr_handler_tests.rs"]
@@ -40,6 +42,10 @@ impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveReadarrBlock> for ReadarrHandler<'a,
_ if HistoryHandler::accepts(self.active_readarr_block) => { _ if HistoryHandler::accepts(self.active_readarr_block) => {
HistoryHandler::new(self.key, self.app, self.active_readarr_block, self.context).handle(); HistoryHandler::new(self.key, self.app, self.active_readarr_block, self.context).handle();
} }
_ if RootFoldersHandler::accepts(self.active_readarr_block) => {
RootFoldersHandler::new(self.key, self.app, self.active_readarr_block, self.context)
.handle();
}
_ => self.handle_key_event(), _ => self.handle_key_event(),
} }
} }
@@ -230,4 +230,19 @@ mod tests {
active_readarr_block active_readarr_block
); );
} }
#[rstest]
fn test_delegates_root_folders_blocks_to_root_folders_handler(
#[values(
ActiveReadarrBlock::RootFolders,
ActiveReadarrBlock::DeleteRootFolderPrompt
)]
active_readarr_block: ActiveReadarrBlock,
) {
test_handler_delegation!(
ReadarrHandler,
ActiveReadarrBlock::RootFolders,
active_readarr_block
);
}
} }
@@ -0,0 +1,166 @@
use crate::app::App;
use crate::event::Key;
use crate::handlers::readarr_handlers::handle_change_tab_left_right_keys;
use crate::handlers::table_handler::{TableHandlingConfig, handle_table};
use crate::handlers::{KeyEventHandler, handle_clear_errors, handle_prompt_toggle};
use crate::matches_key;
use crate::models::servarr_data::readarr::modals::AddReadarrRootFolderModal;
use crate::models::servarr_data::readarr::readarr_data::{
ADD_ROOT_FOLDER_BLOCKS, ADD_ROOT_FOLDER_SELECTION_BLOCKS, ActiveReadarrBlock, ROOT_FOLDERS_BLOCKS,
};
use crate::models::{BlockSelectionState, Route};
use crate::network::readarr_network::ReadarrEvent;
#[cfg(test)]
#[path = "root_folders_handler_tests.rs"]
mod root_folders_handler_tests;
pub(super) struct RootFoldersHandler<'a, 'b> {
key: Key,
app: &'a mut App<'b>,
active_readarr_block: ActiveReadarrBlock,
_context: Option<ActiveReadarrBlock>,
}
impl RootFoldersHandler<'_, '_> {
fn extract_root_folder_id(&self) -> i64 {
self
.app
.data
.readarr_data
.root_folders
.current_selection()
.id
}
}
impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveReadarrBlock> for RootFoldersHandler<'a, 'b> {
fn handle(&mut self) {
let root_folders_table_handling_config =
TableHandlingConfig::new(ActiveReadarrBlock::RootFolders.into());
if !handle_table(
self,
|app| &mut app.data.readarr_data.root_folders,
root_folders_table_handling_config,
) {
self.handle_key_event();
}
}
fn accepts(active_block: ActiveReadarrBlock) -> bool {
ROOT_FOLDERS_BLOCKS.contains(&active_block) || ADD_ROOT_FOLDER_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: ActiveReadarrBlock,
_context: Option<ActiveReadarrBlock>,
) -> RootFoldersHandler<'a, 'b> {
RootFoldersHandler {
key,
app,
active_readarr_block: active_block,
_context,
}
}
fn get_key(&self) -> Key {
self.key
}
fn is_ready(&self) -> bool {
!self.app.is_loading && !self.app.data.readarr_data.root_folders.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) {
if self.active_readarr_block == ActiveReadarrBlock::RootFolders {
self
.app
.push_navigation_stack(ActiveReadarrBlock::DeleteRootFolderPrompt.into())
}
}
fn handle_left_right_action(&mut self) {
match self.active_readarr_block {
ActiveReadarrBlock::RootFolders => handle_change_tab_left_right_keys(self.app, self.key),
ActiveReadarrBlock::DeleteRootFolderPrompt => handle_prompt_toggle(self.app, self.key),
_ => (),
}
}
fn handle_submit(&mut self) {
if self.active_readarr_block == ActiveReadarrBlock::DeleteRootFolderPrompt {
if self.app.data.readarr_data.prompt_confirm {
self.app.data.readarr_data.prompt_confirm_action = Some(ReadarrEvent::DeleteRootFolder(
self.extract_root_folder_id(),
));
}
self.app.pop_navigation_stack();
}
}
fn handle_esc(&mut self) {
match self.active_readarr_block {
ActiveReadarrBlock::DeleteRootFolderPrompt => {
self.app.pop_navigation_stack();
self.app.data.readarr_data.prompt_confirm = false;
}
_ => handle_clear_errors(self.app),
}
}
fn handle_char_key_event(&mut self) {
let key = self.key;
match self.active_readarr_block {
ActiveReadarrBlock::RootFolders => match self.key {
_ if matches_key!(refresh, key) => {
self.app.should_refresh = true;
}
_ if matches_key!(add, key) => {
self.app.data.readarr_data.add_root_folder_modal =
Some(AddReadarrRootFolderModal::from(&self.app.data.readarr_data));
self.app.data.readarr_data.selected_block =
BlockSelectionState::new(ADD_ROOT_FOLDER_SELECTION_BLOCKS);
self
.app
.push_navigation_stack(ActiveReadarrBlock::AddRootFolderPrompt.into());
}
_ => (),
},
ActiveReadarrBlock::DeleteRootFolderPrompt => {
if matches_key!(confirm, key) {
self.app.data.readarr_data.prompt_confirm = true;
self.app.data.readarr_data.prompt_confirm_action = Some(ReadarrEvent::DeleteRootFolder(
self.extract_root_folder_id(),
));
self.app.pop_navigation_stack();
}
}
_ => (),
}
}
fn app_mut(&mut self) -> &mut App<'b> {
self.app
}
fn current_route(&self) -> Route {
self.app.get_current_route()
}
}
@@ -0,0 +1,544 @@
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use rstest::rstest;
use strum::IntoEnumIterator;
use crate::app::App;
use crate::app::key_binding::DEFAULT_KEYBINDINGS;
use crate::assert_modal_present;
use crate::assert_navigation_pushed;
use crate::event::Key;
use crate::handlers::KeyEventHandler;
use crate::handlers::readarr_handlers::root_folders::RootFoldersHandler;
use crate::models::servarr_data::readarr::readarr_data::{
ADD_ROOT_FOLDER_BLOCKS, ActiveReadarrBlock, ROOT_FOLDERS_BLOCKS,
};
use crate::models::servarr_models::RootFolder;
mod test_handle_delete {
use pretty_assertions::assert_eq;
use super::*;
const DELETE_KEY: Key = DEFAULT_KEYBINDINGS.delete.key;
#[test]
fn test_delete_root_folder_prompt() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
RootFoldersHandler::new(DELETE_KEY, &mut app, ActiveReadarrBlock::RootFolders, None).handle();
assert_navigation_pushed!(app, ActiveReadarrBlock::DeleteRootFolderPrompt.into());
}
#[test]
fn test_delete_root_folder_prompt_no_op_when_not_ready() {
let mut app = App::test_default();
app.is_loading = true;
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
RootFoldersHandler::new(DELETE_KEY, &mut app, ActiveReadarrBlock::RootFolders, None).handle();
assert_eq!(
app.get_current_route(),
ActiveReadarrBlock::RootFolders.into()
);
}
}
mod test_handle_left_right_action {
use pretty_assertions::assert_eq;
use rstest::rstest;
use super::*;
use crate::assert_navigation_pushed;
#[rstest]
fn test_root_folders_tab_left(#[values(true, false)] is_ready: bool) {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.is_loading = is_ready;
app.data.readarr_data.main_tabs.set_index(4);
RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.left.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
)
.handle();
assert_eq!(
app.data.readarr_data.main_tabs.get_active_route(),
ActiveReadarrBlock::History.into()
);
assert_navigation_pushed!(app, ActiveReadarrBlock::History.into());
}
#[rstest]
fn test_root_folders_tab_right(#[values(true, false)] is_ready: bool) {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.is_loading = is_ready;
app.data.readarr_data.main_tabs.set_index(4);
RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.right.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
)
.handle();
assert_eq!(
app.data.readarr_data.main_tabs.get_active_route(),
ActiveReadarrBlock::Indexers.into()
);
assert_navigation_pushed!(app, ActiveReadarrBlock::Indexers.into());
}
#[rstest]
fn test_left_right_delete_root_folder_prompt_toggle(
#[values(DEFAULT_KEYBINDINGS.left.key, DEFAULT_KEYBINDINGS.right.key)] key: Key,
) {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
RootFoldersHandler::new(
key,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.handle();
assert!(app.data.readarr_data.prompt_confirm);
RootFoldersHandler::new(
key,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.handle();
assert!(!app.data.readarr_data.prompt_confirm);
}
}
mod test_handle_submit {
use pretty_assertions::assert_eq;
use super::*;
use crate::assert_navigation_popped;
use crate::network::readarr_network::ReadarrEvent;
const SUBMIT_KEY: Key = DEFAULT_KEYBINDINGS.submit.key;
#[test]
fn test_delete_root_folder_prompt_confirm_submit() {
let mut app = App::test_default();
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
app.data.readarr_data.root_folders.select_index(Some(1));
app.data.readarr_data.prompt_confirm = true;
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.push_navigation_stack(ActiveReadarrBlock::DeleteRootFolderPrompt.into());
RootFoldersHandler::new(
SUBMIT_KEY,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.handle();
assert!(app.data.readarr_data.prompt_confirm);
assert_some_eq_x!(
&app.data.readarr_data.prompt_confirm_action,
&ReadarrEvent::DeleteRootFolder(2)
);
assert_navigation_popped!(app, ActiveReadarrBlock::RootFolders.into());
}
#[test]
fn test_delete_root_folder_prompt_decline_submit() {
let mut app = App::test_default();
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.push_navigation_stack(ActiveReadarrBlock::DeleteRootFolderPrompt.into());
RootFoldersHandler::new(
SUBMIT_KEY,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.handle();
assert!(!app.data.readarr_data.prompt_confirm);
assert_none!(app.data.readarr_data.prompt_confirm_action);
assert_navigation_popped!(app, ActiveReadarrBlock::RootFolders.into());
}
#[test]
fn test_delete_root_folder_prompt_submit_no_op_when_not_ready() {
let mut app = App::test_default();
app.is_loading = true;
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
app.data.readarr_data.prompt_confirm = true;
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.push_navigation_stack(ActiveReadarrBlock::DeleteRootFolderPrompt.into());
RootFoldersHandler::new(
SUBMIT_KEY,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.handle();
assert_eq!(
app.get_current_route(),
ActiveReadarrBlock::DeleteRootFolderPrompt.into()
);
assert_none!(app.data.readarr_data.prompt_confirm_action);
}
}
mod test_handle_esc {
use super::*;
use crate::assert_navigation_popped;
use rstest::rstest;
const ESC_KEY: Key = DEFAULT_KEYBINDINGS.esc.key;
#[test]
fn test_delete_root_folder_prompt_block_esc() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.push_navigation_stack(ActiveReadarrBlock::DeleteRootFolderPrompt.into());
app.data.readarr_data.prompt_confirm = true;
RootFoldersHandler::new(
ESC_KEY,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.handle();
assert_navigation_popped!(app, ActiveReadarrBlock::RootFolders.into());
assert!(!app.data.readarr_data.prompt_confirm);
}
#[rstest]
fn test_default_esc(#[values(true, false)] is_ready: bool) {
let mut app = App::test_default();
app.is_loading = is_ready;
app.error = "test error".to_owned().into();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
RootFoldersHandler::new(ESC_KEY, &mut app, ActiveReadarrBlock::RootFolders, None).handle();
assert_navigation_popped!(app, ActiveReadarrBlock::RootFolders.into());
assert_is_empty!(app.error.text);
}
}
mod test_handle_key_char {
use pretty_assertions::assert_eq;
use super::*;
use crate::assert_navigation_popped;
use crate::network::readarr_network::ReadarrEvent;
#[test]
fn test_root_folder_add() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.add.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
)
.handle();
assert_navigation_pushed!(app, ActiveReadarrBlock::AddRootFolderPrompt.into());
assert_modal_present!(app.data.readarr_data.add_root_folder_modal);
assert_eq!(
app.data.readarr_data.selected_block.get_active_block(),
ActiveReadarrBlock::AddRootFolderNameInput
);
}
#[test]
fn test_root_folder_add_no_op_when_not_ready() {
let mut app = App::test_default();
app.is_loading = true;
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.add.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
)
.handle();
assert_eq!(
app.get_current_route(),
ActiveReadarrBlock::RootFolders.into()
);
assert_none!(app.data.readarr_data.add_root_folder_modal);
}
#[test]
fn test_refresh_root_folders_key() {
let mut app = App::test_default();
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.refresh.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
)
.handle();
assert_navigation_pushed!(app, ActiveReadarrBlock::RootFolders.into());
assert!(app.should_refresh);
}
#[test]
fn test_refresh_root_folders_key_no_op_when_not_ready() {
let mut app = App::test_default();
app.is_loading = true;
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.refresh.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
)
.handle();
assert_eq!(
app.get_current_route(),
ActiveReadarrBlock::RootFolders.into()
);
assert!(!app.should_refresh);
}
#[test]
fn test_delete_root_folder_prompt_confirm() {
let mut app = App::test_default();
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
app.data.readarr_data.root_folders.select_index(Some(1));
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.push_navigation_stack(ActiveReadarrBlock::DeleteRootFolderPrompt.into());
RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.confirm.key,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.handle();
assert!(app.data.readarr_data.prompt_confirm);
assert_some_eq_x!(
&app.data.readarr_data.prompt_confirm_action,
&ReadarrEvent::DeleteRootFolder(2)
);
assert_navigation_popped!(app, ActiveReadarrBlock::RootFolders.into());
}
}
#[test]
fn test_root_folders_handler_accepts() {
ActiveReadarrBlock::iter().for_each(|active_readarr_block| {
if ROOT_FOLDERS_BLOCKS.contains(&active_readarr_block)
|| ADD_ROOT_FOLDER_BLOCKS.contains(&active_readarr_block)
{
assert!(
RootFoldersHandler::accepts(active_readarr_block),
"{active_readarr_block} is not accepted by the RootFoldersHandler"
);
} else {
assert!(
!RootFoldersHandler::accepts(active_readarr_block),
"{active_readarr_block} is accepted by the RootFoldersHandler"
);
}
})
}
#[rstest]
fn test_root_folders_handler_ignore_special_keys(
#[values(true, false)] ignore_special_keys_for_textbox_input: bool,
) {
let mut app = App::test_default();
app.ignore_special_keys_for_textbox_input = ignore_special_keys_for_textbox_input;
let handler = RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveReadarrBlock::default(),
None,
);
assert_eq!(
handler.ignore_special_keys(),
ignore_special_keys_for_textbox_input
);
}
#[test]
fn test_extract_root_folder_id() {
let mut app = App::test_default();
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
app.data.readarr_data.root_folders.select_index(Some(1));
let root_folder_id = RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveReadarrBlock::DeleteRootFolderPrompt,
None,
)
.extract_root_folder_id();
assert_eq!(root_folder_id, 2);
}
#[test]
fn test_root_folders_handler_not_ready_when_loading() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.is_loading = true;
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
let handler = RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
);
assert!(!handler.is_ready());
}
#[test]
fn test_root_folders_handler_not_ready_when_root_folders_is_empty() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.is_loading = false;
let handler = RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
);
assert!(!handler.is_ready());
}
#[test]
fn test_root_folders_handler_ready_when_not_loading_and_root_folders_is_not_empty() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveReadarrBlock::RootFolders.into());
app.is_loading = false;
app
.data
.readarr_data
.root_folders
.set_items(root_folders_vec());
let handler = RootFoldersHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveReadarrBlock::RootFolders,
None,
);
assert!(handler.is_ready());
}
fn root_folders_vec() -> Vec<RootFolder> {
vec![
RootFolder {
id: 1,
path: "/nfs/books".to_owned(),
accessible: true,
free_space: 219902325555200,
unmapped_folders: None,
},
RootFolder {
id: 2,
path: "/nfs/audiobooks".to_owned(),
accessible: false,
free_space: 1024,
unmapped_folders: None,
},
]
}
}