mecomp_tui/ui/components/content_view/

mod.rs

//! The content view displays the contents of the current view (e.g. the songs in a playlist, the search results, etc.).

pub mod views;

use crossterm::event::{MouseButton, MouseEventKind};
use mecomp_storage::db::schemas::{album, artist, collection, playlist, song, Id, Thing};
use ratatui::layout::Position;
use tokio::sync::mpsc::UnboundedSender;
use views::{
    album::{AlbumView, LibraryAlbumsView},
    artist::{ArtistView, LibraryArtistsView},
    collection::{CollectionView, LibraryCollectionsView},
    none::NoneView,
    playlist::{LibraryPlaylistsView, PlaylistView},
    radio::RadioView,
    search::SearchView,
    song::{LibrarySongsView, SongView},
};

use crate::{
    state::{
        action::{Action, ComponentAction},
        component::ActiveComponent,
    },
    ui::AppState,
};

use super::{Component, ComponentRender, RenderProps};

pub struct ContentView {
    pub(crate) props: Props,
    //
    pub(crate) none_view: NoneView,
    pub(crate) search_view: SearchView,
    pub(crate) songs_view: LibrarySongsView,
    pub(crate) song_view: SongView,
    pub(crate) albums_view: LibraryAlbumsView,
    pub(crate) album_view: AlbumView,
    pub(crate) artists_view: LibraryArtistsView,
    pub(crate) artist_view: ArtistView,
    pub(crate) playlists_view: LibraryPlaylistsView,
    pub(crate) playlist_view: PlaylistView,
    pub(crate) collections_view: LibraryCollectionsView,
    pub(crate) collection_view: CollectionView,
    pub(crate) radio_view: RadioView,
    //
    pub(crate) action_tx: UnboundedSender<Action>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Props {
    pub(crate) active_view: ActiveView,
}

impl From<&AppState> for Props {
    fn from(value: &AppState) -> Self {
        Self {
            active_view: value.active_view.clone(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub enum ActiveView {
    /// Blank view.
    #[default]
    None,
    /// A view with a search bar and search results.
    Search,
    /// A view with all the songs in the users library.
    Songs,
    /// A view of a specific song.
    Song(Id),
    /// A view with all the albums in the users library.
    Albums,
    /// A view of a specific album.
    Album(Id),
    /// A view with all the artists in the users library.
    Artists,
    /// A view of a specific artist.
    Artist(Id),
    /// A view with all the playlists in the users library.
    Playlists,
    /// A view of a specific playlist.
    Playlist(Id),
    /// A view with all the collections in the users library.
    Collections,
    /// A view of a specific collection.
    Collection(Id),
    /// A view of a radio
    Radio(Vec<Thing>, u32),
    // TODO: views for genres, settings, etc.
}

impl From<Thing> for ActiveView {
    fn from(value: Thing) -> Self {
        match value.tb.as_str() {
            album::TABLE_NAME => Self::Album(value.id),
            artist::TABLE_NAME => Self::Artist(value.id),
            collection::TABLE_NAME => Self::Collection(value.id),
            playlist::TABLE_NAME => Self::Playlist(value.id),
            song::TABLE_NAME => Self::Song(value.id),
            _ => Self::None,
        }
    }
}

impl ContentView {
    fn get_active_view_component(&self) -> &dyn Component {
        match &self.props.active_view {
            ActiveView::None => &self.none_view,
            ActiveView::Search => &self.search_view,
            ActiveView::Songs => &self.songs_view,
            ActiveView::Song(_) => &self.song_view,
            ActiveView::Albums => &self.albums_view,
            ActiveView::Album(_) => &self.album_view,
            ActiveView::Artists => &self.artists_view,
            ActiveView::Artist(_) => &self.artist_view,
            ActiveView::Playlists => &self.playlists_view,
            ActiveView::Playlist(_) => &self.playlist_view,
            ActiveView::Collections => &self.collections_view,
            ActiveView::Collection(_) => &self.collection_view,
            ActiveView::Radio(_, _) => &self.radio_view,
        }
    }

    fn get_active_view_component_mut(&mut self) -> &mut dyn Component {
        match &self.props.active_view {
            ActiveView::None => &mut self.none_view,
            ActiveView::Search => &mut self.search_view,
            ActiveView::Songs => &mut self.songs_view,
            ActiveView::Song(_) => &mut self.song_view,
            ActiveView::Albums => &mut self.albums_view,
            ActiveView::Album(_) => &mut self.album_view,
            ActiveView::Artists => &mut self.artists_view,
            ActiveView::Artist(_) => &mut self.artist_view,
            ActiveView::Playlists => &mut self.playlists_view,
            ActiveView::Playlist(_) => &mut self.playlist_view,
            ActiveView::Collections => &mut self.collections_view,
            ActiveView::Collection(_) => &mut self.collection_view,
            ActiveView::Radio(_, _) => &mut self.radio_view,
        }
    }
}

impl Component for ContentView {
    fn new(state: &AppState, action_tx: UnboundedSender<Action>) -> Self
    where
        Self: Sized,
    {
        Self {
            props: Props::from(state),
            none_view: NoneView::new(state, action_tx.clone()),
            search_view: SearchView::new(state, action_tx.clone()),
            songs_view: LibrarySongsView::new(state, action_tx.clone()),
            song_view: SongView::new(state, action_tx.clone()),
            albums_view: LibraryAlbumsView::new(state, action_tx.clone()),
            album_view: AlbumView::new(state, action_tx.clone()),
            artists_view: LibraryArtistsView::new(state, action_tx.clone()),
            artist_view: ArtistView::new(state, action_tx.clone()),
            playlists_view: LibraryPlaylistsView::new(state, action_tx.clone()),
            playlist_view: PlaylistView::new(state, action_tx.clone()),
            collections_view: LibraryCollectionsView::new(state, action_tx.clone()),
            collection_view: CollectionView::new(state, action_tx.clone()),
            radio_view: RadioView::new(state, action_tx.clone()),
            action_tx,
        }
        .move_with_state(state)
    }

    fn move_with_state(self, state: &AppState) -> Self
    where
        Self: Sized,
    {
        Self {
            props: Props::from(state),
            none_view: self.none_view.move_with_state(state),
            search_view: self.search_view.move_with_state(state),
            songs_view: self.songs_view.move_with_state(state),
            song_view: self.song_view.move_with_state(state),
            albums_view: self.albums_view.move_with_state(state),
            album_view: self.album_view.move_with_state(state),
            artists_view: self.artists_view.move_with_state(state),
            artist_view: self.artist_view.move_with_state(state),
            playlists_view: self.playlists_view.move_with_state(state),
            playlist_view: self.playlist_view.move_with_state(state),
            collections_view: self.collections_view.move_with_state(state),
            collection_view: self.collection_view.move_with_state(state),
            radio_view: self.radio_view.move_with_state(state),
            action_tx: self.action_tx,
        }
    }

    fn name(&self) -> &str {
        self.get_active_view_component().name()
    }

    fn handle_key_event(&mut self, key: crossterm::event::KeyEvent) {
        self.get_active_view_component_mut().handle_key_event(key);
    }

    fn handle_mouse_event(
        &mut self,
        mouse: crossterm::event::MouseEvent,
        area: ratatui::prelude::Rect,
    ) {
        if mouse.kind == MouseEventKind::Down(MouseButton::Left)
            && area.contains(Position::new(mouse.column, mouse.row))
        {
            self.action_tx
                .send(Action::ActiveComponent(ComponentAction::Set(
                    ActiveComponent::ContentView,
                )))
                .unwrap();
        }

        // defer to active view
        self.get_active_view_component_mut()
            .handle_mouse_event(mouse, area);
    }
}

impl ComponentRender<RenderProps> for ContentView {
    /// we defer all border rendering to the active view
    fn render_border(&self, _: &mut ratatui::Frame, props: RenderProps) -> RenderProps {
        props
    }

    fn render_content(&self, frame: &mut ratatui::Frame, props: RenderProps) {
        match &self.props.active_view {
            ActiveView::None => self.none_view.render(frame, props),
            ActiveView::Search => self.search_view.render(frame, props),
            ActiveView::Songs => self.songs_view.render(frame, props),
            ActiveView::Song(_) => self.song_view.render(frame, props),
            ActiveView::Albums => self.albums_view.render(frame, props),
            ActiveView::Album(_) => self.album_view.render(frame, props),
            ActiveView::Artists => self.artists_view.render(frame, props),
            ActiveView::Artist(_) => self.artist_view.render(frame, props),
            ActiveView::Playlists => self.playlists_view.render(frame, props),
            ActiveView::Playlist(_) => self.playlist_view.render(frame, props),
            ActiveView::Collections => self.collections_view.render(frame, props),
            ActiveView::Collection(_) => self.collection_view.render(frame, props),
            ActiveView::Radio(_, _) => self.radio_view.render(frame, props),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_utils::{item_id, setup_test_terminal, state_with_everything};
    use anyhow::Result;
    use pretty_assertions::assert_eq;
    use rstest::rstest;

    #[rstest]
    #[case(ActiveView::None)]
    #[case(ActiveView::Search)]
    #[case(ActiveView::Songs)]
    #[case(ActiveView::Song(item_id()))]
    #[case(ActiveView::Albums)]
    #[case(ActiveView::Album(item_id()))]
    #[case(ActiveView::Artists)]
    #[case(ActiveView::Artist(item_id()))]
    #[case(ActiveView::Playlists)]
    #[case(ActiveView::Playlist(item_id()))]
    #[case(ActiveView::Collections)]
    #[case(ActiveView::Collection(item_id()))]
    #[case(ActiveView::Radio(vec![Thing::from(("song", item_id()))], 1))]
    fn smoke_render(
        #[case] active_view: ActiveView,
        #[values(true, false)] is_focused: bool,
    ) -> Result<()> {
        let (tx, _) = tokio::sync::mpsc::unbounded_channel();
        let content_view = ContentView::new(&AppState::default(), tx).move_with_state(&AppState {
            active_view,
            ..state_with_everything()
        });

        let (mut terminal, area) = setup_test_terminal(100, 100);
        let completed_frame =
            terminal.draw(|frame| content_view.render(frame, RenderProps { area, is_focused }));

        assert!(completed_frame.is_ok());

        Ok(())
    }

    #[rstest]
    #[case(ActiveView::None)]
    #[case(ActiveView::Search)]
    #[case(ActiveView::Songs)]
    #[case(ActiveView::Song(item_id()))]
    #[case(ActiveView::Albums)]
    #[case(ActiveView::Album(item_id()))]
    #[case(ActiveView::Artists)]
    #[case(ActiveView::Artist(item_id()))]
    #[case(ActiveView::Playlists)]
    #[case(ActiveView::Playlist(item_id()))]
    #[case(ActiveView::Collections)]
    #[case(ActiveView::Collection(item_id()))]
    #[case(ActiveView::Radio(vec![Thing::from(("song", item_id()))], 1))]
    fn test_get_active_view_component(#[case] active_view: ActiveView) {
        let (tx, _) = tokio::sync::mpsc::unbounded_channel();
        let state = AppState {
            active_view: active_view.clone(),
            ..state_with_everything()
        };
        let content_view = ContentView::new(&state, tx.clone());

        let view = content_view.get_active_view_component();

        match active_view {
            ActiveView::None => assert_eq!(view.name(), "None"),
            ActiveView::Search => assert_eq!(view.name(), "Search"),
            ActiveView::Songs => assert_eq!(view.name(), "Library Songs View"),
            ActiveView::Song(_) => assert_eq!(view.name(), "Song View"),
            ActiveView::Albums => assert_eq!(view.name(), "Library Albums View"),
            ActiveView::Album(_) => assert_eq!(view.name(), "Album View"),
            ActiveView::Artists => assert_eq!(view.name(), "Library Artists View"),
            ActiveView::Artist(_) => assert_eq!(view.name(), "Artist View"),
            ActiveView::Playlists => assert_eq!(view.name(), "Library Playlists View"),
            ActiveView::Playlist(_) => assert_eq!(view.name(), "Playlist View"),
            ActiveView::Collections => assert_eq!(view.name(), "Library Collections View"),
            ActiveView::Collection(_) => assert_eq!(view.name(), "Collection View"),
            ActiveView::Radio(_, _) => assert_eq!(view.name(), "Radio"),
        }

        // assert that the two "get_active_view_component" methods return the same component
        assert_eq!(
            view.name(),
            ContentView::new(&state, tx,)
                .get_active_view_component_mut()
                .name()
        );
    }
}