diff options
Diffstat (limited to 'src/components/blame_file.rs')
| -rw-r--r-- | src/components/blame_file.rs | 978 |
1 files changed, 489 insertions, 489 deletions
diff --git a/src/components/blame_file.rs b/src/components/blame_file.rs index df69f4e9..be1a0151 100644 --- a/src/components/blame_file.rs +++ b/src/components/blame_file.rs @@ -1,42 +1,42 @@ use super::{ - utils, visibility_blocking, CommandBlocking, CommandInfo, - Component, DrawableComponent, EventState, + utils, visibility_blocking, CommandBlocking, CommandInfo, + Component, DrawableComponent, EventState, }; use crate::{ - components::{utils::string_width_align, ScrollType}, - keys::SharedKeyConfig, - queue::{InternalEvent, Queue}, - strings, - ui::{self, style::SharedTheme}, + components::{utils::string_width_align, ScrollType}, + keys::SharedKeyConfig, + queue::{InternalEvent, Queue}, + strings, + ui::{self, style::SharedTheme}, }; use anyhow::Result; use asyncgit::{ - sync::{BlameHunk, CommitId, FileBlame}, - AsyncBlame, AsyncGitNotification, BlameParams, + sync::{BlameHunk, CommitId, FileBlame}, + AsyncBlame, AsyncGitNotification, BlameParams, }; use crossbeam_channel::Sender; use crossterm::event::Event; use std::convert::TryInto; use tui::{ - backend::Backend, - layout::{Constraint, Rect}, - symbols::line::VERTICAL, - text::Span, - widgets::{Block, Borders, Cell, Clear, Row, Table, TableState}, - Frame, + backend::Backend, + layout::{Constraint, Rect}, + symbols::line::VERTICAL, + text::Span, + widgets::{Block, Borders, Cell, Clear, Row, Table, TableState}, + Frame, }; pub struct BlameFileComponent { - title: String, - theme: SharedTheme, - queue: Queue, - async_blame: AsyncBlame, - visible: bool, - file_path: Option<String>, - file_blame: Option<FileBlame>, - table_state: std::cell::Cell<TableState>, - key_config: SharedKeyConfig, - current_height: std::cell::Cell<usize>, + title: String, + theme: SharedTheme, + queue: Queue, + async_blame: AsyncBlame, + visible: bool, + file_path: Option<String>, + file_blame: Option<FileBlame>, + table_state: std::cell::Cell<TableState>, + key_config: SharedKeyConfig, + current_height: std::cell::Cell<usize>, } static NO_COMMIT_ID: &str = "0000000"; @@ -45,482 +45,482 @@ static MIN_AUTHOR_WIDTH: usize = 3; static MAX_AUTHOR_WIDTH: usize = 20; fn get_author_width(width: usize) -> usize { - (width.saturating_sub(19) / 3) - .clamp(MIN_AUTHOR_WIDTH, MAX_AUTHOR_WIDTH) + (width.saturating_sub(19) / 3) + .clamp(MIN_AUTHOR_WIDTH, MAX_AUTHOR_WIDTH) } const fn number_of_digits(number: usize) -> usize { - let mut rest = number; - let mut result = 0; + let mut rest = number; + let mut result = 0; - while rest > 0 { - rest /= 10; - result += 1; - } + while rest > 0 { + rest /= 10; + result += 1; + } - result + result } impl DrawableComponent for BlameFileComponent { - fn draw<B: Backend>( - &self, - f: &mut Frame<B>, - area: Rect, - ) -> Result<()> { - if self.is_visible() { - let title = self.get_title(); - - let rows = self.get_rows(area.width.into()); - let author_width = get_author_width(area.width.into()); - let constraints = [ - // commit id - Constraint::Length(7), - // commit date - Constraint::Length(10), - // commit author - Constraint::Length(author_width.try_into()?), - // line number and vertical bar - Constraint::Length( - (self.get_line_number_width().saturating_add(1)) - .try_into()?, - ), - // the source code line - Constraint::Percentage(100), - ]; - - let number_of_rows = rows.len(); - - let table = Table::new(rows) - .widths(&constraints) - .column_spacing(1) - .highlight_style(self.theme.text(true, true)) - .block( - Block::default() - .borders(Borders::ALL) - .title(Span::styled( - title, - self.theme.title(true), - )) - .border_style(self.theme.block(true)), - ); - - let mut table_state = self.table_state.take(); - - f.render_widget(Clear, area); - f.render_stateful_widget(table, area, &mut table_state); - - ui::draw_scrollbar( - f, - area, - &self.theme, - // April 2021: `draw_scrollbar` assumes that the last parameter - // is `scroll_top`. Therefore, it subtracts the area’s height - // before calculating the position of the scrollbar. To account - // for that, we add the current height. - number_of_rows + (area.height as usize), - // April 2021: we don’t have access to `table_state.offset` - // (it’s private), so we use `table_state.selected()` as a - // replacement. - // - // Other widgets, for example `BranchListComponent`, manage - // scroll state themselves and use `self.scroll_top` in this - // situation. - // - // There are plans to change `render_stateful_widgets`, so this - // might be acceptable as an interim solution. - // - // https://github.com/fdehau/tui-rs/issues/448 - table_state.selected().unwrap_or(0), - ); - - self.table_state.set(table_state); - self.current_height.set(area.height.into()); - } - - Ok(()) - } + fn draw<B: Backend>( + &self, + f: &mut Frame<B>, + area: Rect, + ) -> Result<()> { + if self.is_visible() { + let title = self.get_title(); + + let rows = self.get_rows(area.width.into()); + let author_width = get_author_width(area.width.into()); + let constraints = [ + // commit id + Constraint::Length(7), + // commit date + Constraint::Length(10), + // commit author + Constraint::Length(author_width.try_into()?), + // line number and vertical bar + Constraint::Length( + (self.get_line_number_width().saturating_add(1)) + .try_into()?, + ), + // the source code line + Constraint::Percentage(100), + ]; + + let number_of_rows = rows.len(); + + let table = Table::new(rows) + .widths(&constraints) + .column_spacing(1) + .highlight_style(self.theme.text(true, true)) + .block( + Block::default() + .borders(Borders::ALL) + .title(Span::styled( + title, + self.theme.title(true), + )) + .border_style(self.theme.block(true)), + ); + + let mut table_state = self.table_state.take(); + + f.render_widget(Clear, area); + f.render_stateful_widget(table, area, &mut table_state); + + ui::draw_scrollbar( + f, + area, + &self.theme, + // April 2021: `draw_scrollbar` assumes that the last parameter + // is `scroll_top`. Therefore, it subtracts the area’s height + // before calculating the position of the scrollbar. To account + // for that, we add the current height. + number_of_rows + (area.height as usize), + // April 2021: we don’t have access to `table_state.offset` + // (it’s private), so we use `table_state.selected()` as a + // replacement. + // + // Other widgets, for example `BranchListComponent`, manage + // scroll state themselves and use `self.scroll_top` in this + // situation. + // + // There are plans to change `render_stateful_widgets`, so this + // might be acceptable as an interim solution. + // + // https://github.com/fdehau/tui-rs/issues/448 + table_state.selected().unwrap_or(0), + ); + + self.table_state.set(table_state); + self.current_height.set(area.height.into()); + } + + Ok(()) + } } impl Component for BlameFileComponent { - fn commands( - &self, - out: &mut Vec<CommandInfo>, - force_all: bool, - ) -> CommandBlocking { - if self.is_visible() || force_all { - out.push( - CommandInfo::new( - strings::commands::close_popup(&self.key_config), - true, - true, - ) - .order(1), - ); - out.push( - CommandInfo::new( - strings::commands::scroll(&self.key_config), - true, - self.file_blame.is_some(), - ) - .order(1), - ); - out.push( - CommandInfo::new( - strings::commands::log_details_open( - &self.key_config, - ), - true, - self.file_blame.is_some(), - ) - .order(1), - ); - } - - visibility_blocking(self) - } - - fn event( - &mut self, - event: crossterm::event::Event, - ) -> Result<EventState> { - if self.is_visible() { - if let Event::Key(key) = event { - if key == self.key_config.exit_popup { - self.hide(); - } else if key == self.key_config.move_up { - self.move_selection(ScrollType::Up); - } else if key == self.key_config.move_down { - self.move_selection(ScrollType::Down); - } else if key == self.key_config.shift_up - || key == self.key_config.home - { - self.move_selection(ScrollType::Home); - } else if key == self.key_config.shift_down - || key == self.key_config.end - { - self.move_selection(ScrollType::End); - } else if key == self.key_config.page_down { - self.move_selection(ScrollType::PageDown); - } else if key == self.key_config.page_up { - self.move_selection(ScrollType::PageUp); - } else if key == self.key_config.focus_right { - self.hide(); - - return self.selected_commit().map_or( - Ok(EventState::NotConsumed), - |id| { - self.queue.push( - InternalEvent::InspectCommit( - id, None, - ), - ); - Ok(EventState::Consumed) - }, - ); - } - - return Ok(EventState::Consumed); - } - } - - Ok(EventState::NotConsumed) - } - - fn is_visible(&self) -> bool { - self.visible - } - - fn hide(&mut self) { - self.visible = false; - } - - fn show(&mut self) -> Result<()> { - self.visible = true; - - Ok(()) - } + fn commands( + &self, + out: &mut Vec<CommandInfo>, + force_all: bool, + ) -> CommandBlocking { + if self.is_visible() || force_all { + out.push( + CommandInfo::new( + strings::commands::close_popup(&self.key_config), + true, + true, + ) + .order(1), + ); + out.push( + CommandInfo::new( + strings::commands::scroll(&self.key_config), + true, + self.file_blame.is_some(), + ) + .order(1), + ); + out.push( + CommandInfo::new( + strings::commands::log_details_open( + &self.key_config, + ), + true, + self.file_blame.is_some(), + ) + .order(1), + ); + } + + visibility_blocking(self) + } + + fn event( + &mut self, + event: crossterm::event::Event, + ) -> Result<EventState> { + if self.is_visible() { + if let Event::Key(key) = event { + if key == self.key_config.exit_popup { + self.hide(); + } else if key == self.key_config.move_up { + self.move_selection(ScrollType::Up); + } else if key == self.key_config.move_down { + self.move_selection(ScrollType::Down); + } else if key == self.key_config.shift_up + || key == self.key_config.home + { + self.move_selection(ScrollType::Home); + } else if key == self.key_config.shift_down + || key == self.key_config.end + { + self.move_selection(ScrollType::End); + } else if key == self.key_config.page_down { + self.move_selection(ScrollType::PageDown); + } else if key == self.key_config.page_up { + self.move_selection(ScrollType::PageUp); + } else if key == self.key_config.focus_right { + self.hide(); + + return self.selected_commit().map_or( + Ok(EventState::NotConsumed), + |id| { + self.queue.push( + InternalEvent::InspectCommit( + id, None, + ), + ); + Ok(EventState::Consumed) + }, + ); + } + + return Ok(EventState::Consumed); + } + } + + Ok(EventState::NotConsumed) + } + + fn is_visible(&self) -> bool { + self.visible + } + + fn hide(&mut self) { + self.visible = false; + } + + fn show(&mut self) -> Result<()> { + self.visible = true; + + Ok(()) + } } impl BlameFileComponent { - /// - pub fn new( - queue: &Queue, - sender: &Sender<AsyncGitNotification>, - title: &str, - theme: SharedTheme, - key_config: SharedKeyConfig, - ) -> Self { - Self { - title: String::from(title), - theme, - async_blame: AsyncBlame::new(sender), - queue: queue.clone(), - visible: false, - file_path: None, - file_blame: None, - table_state: std::cell::Cell::new(TableState::default()), - key_config, - current_height: std::cell::Cell::new(0), - } - } - - /// - pub fn open(&mut self, file_path: &str) -> Result<()> { - self.file_path = Some(file_path.into()); - self.file_blame = None; - self.table_state.get_mut().select(Some(0)); - self.show()?; - - self.update()?; - - Ok(()) - } - - /// - pub fn any_work_pending(&self) -> bool { - self.async_blame.is_pending() - } - - /// - pub fn update_git( - &mut self, - event: AsyncGitNotification, - ) -> Result<()> { - if self.is_visible() { - if let AsyncGitNotification::Blame = event { - self.update()?; - } - } - - Ok(()) - } - - fn update(&mut self) -> Result<()> { - if self.is_visible() { - if let Some(file_path) = &self.file_path { - let blame_params = BlameParams { - file_path: file_path.into(), - }; - - if let Some(( - previous_blame_params, - last_file_blame, - )) = self.async_blame.last()? - { - if previous_blame_params == blame_params { - self.file_blame = Some(last_file_blame); - - return Ok(()); - } - } - - self.async_blame.request(blame_params)?; - } - } - - Ok(()) - } - - /// - fn get_title(&self) -> String { - match ( - self.any_work_pending(), - self.file_path.as_ref(), - self.file_blame.as_ref(), - ) { - (true, Some(file_path), _) => { - format!( - "{} -- {} -- <calculating.. (who is to blame?)>", - self.title, file_path - ) - } - (false, Some(file_path), Some(file_blame)) => { - format!( - "{} -- {} -- {}", - self.title, - file_path, - file_blame.commit_id.get_short_string() - ) - } - (false, Some(file_path), None) => { - format!( - "{} -- {} -- <no blame available>", - self.title, file_path - ) - } - _ => format!("{} -- <no blame available>", self.title), - } - } - - /// - fn get_rows(&self, width: usize) -> Vec<Row> { - if let Some(ref file_blame) = self.file_blame { - file_blame - .lines - .iter() - .enumerate() - .map(|(i, (blame_hunk, line))| { - self.get_line_blame( - width, - i, - (blame_hunk.as_ref(), line.as_ref()), - file_blame, - ) - }) - .collect() - } else { - vec![] - } - } - - fn get_line_blame( - &self, - width: usize, - line_number: usize, - hunk_and_line: (Option<&BlameHunk>, &str), - file_blame: &FileBlame, - ) -> Row { - let (hunk_for_line, line) = hunk_and_line; - - let show_metadata = if line_number == 0 { - true - } else { - let hunk_for_previous_line = - &file_blame.lines[line_number - 1]; - - match (hunk_for_previous_line, hunk_for_line) { - ((Some(previous), _), Some(current)) => { - previous.commit_id != current.commit_id - } - _ => true, - } - }; - - let mut cells = if show_metadata { - self.get_metadata_for_line_blame(width, hunk_for_line) - } else { - vec![Cell::from(""), Cell::from(""), Cell::from("")] - }; - - let line_number_width = self.get_line_number_width(); - cells.push( - Cell::from(format!( - "{:>line_number_width$}{}", - line_number, - VERTICAL, - line_number_width = line_number_width, - )) - .style(self.theme.text(true, false)), - ); - cells.push( - Cell::from(String::from(line)) - .style(self.theme.text(true, false)), - ); - - Row::new(cells) - } - - fn get_metadata_for_line_blame( - &self, - width: usize, - blame_hunk: Option<&BlameHunk>, - ) -> Vec<Cell> { - let commit_hash = blame_hunk.map_or_else( - || NO_COMMIT_ID.into(), - |hunk| hunk.commit_id.get_short_string(), - ); - let author_width = get_author_width(width); - let truncated_author: String = blame_hunk.map_or_else( - || NO_AUTHOR.into(), - |hunk| string_width_align(&hunk.author, author_width), - ); - let author = format!( - "{:author_width$}", - truncated_author, - author_width = MAX_AUTHOR_WIDTH - ); - let time = blame_hunk.map_or_else( - || "".into(), - |hunk| utils::time_to_string(hunk.time, true), - ); - - let is_blamed_commit = self - .file_blame - .as_ref() - .and_then(|file_blame| { - blame_hunk.map(|hunk| { - file_blame.commit_id == hunk.commit_id - }) - }) - .unwrap_or(false); - - vec![ - Cell::from(commit_hash).style( - self.theme.commit_hash_in_blame(is_blamed_commit), - ), - Cell::from(time).style(self.theme.commit_time(false)), - Cell::from(author).style(self.theme.commit_author(false)), - ] - } - - fn get_max_line_number(&self) -> usize { - self.file_blame - .as_ref() - .map_or(0, |file_blame| file_blame.lines.len() - 1) - } - - fn get_line_number_width(&self) -> usize { - let max_line_number = self.get_max_line_number(); - - number_of_digits(max_line_number) - } - - fn move_selection(&mut self, scroll_type: ScrollType) -> bool { - let mut table_state = self.table_state.take(); - - let old_selection = table_state.selected().unwrap_or(0); - let max_selection = self.get_max_line_number(); - - let new_selection = match scroll_type { - ScrollType::Up => old_selection.saturating_sub(1), - ScrollType::Down => { - old_selection.saturating_add(1).min(max_selection) - } - ScrollType::Home => 0, - ScrollType::End => max_selection, - ScrollType::PageUp => old_selection.saturating_sub( - self.current_height.get().saturating_sub(2), - ), - ScrollType::PageDown => old_selection - .saturating_add( - self.current_height.get().saturating_sub(2), - ) - .min(max_selection), - }; - - let needs_update = new_selection != old_selection; - - table_state.select(Some(new_selection)); - self.table_state.set(table_state); - - needs_update - } - - fn selected_commit(&self) -> Option<CommitId> { - self.file_blame.as_ref().and_then(|file_blame| { - let table_state = self.table_state.take(); - - let commit_id = - table_state.selected().and_then(|selected| { - file_blame.lines[selected] - .0 - .as_ref() - .map(|hunk| hunk.commit_id) - }); - - self.table_state.set(table_state); - - commit_id - }) - } + /// + pub fn new( + queue: &Queue, + sender: &Sender<AsyncGitNotification>, + title: &str, + theme: SharedTheme, + key_config: SharedKeyConfig, + ) -> Self { + Self { + title: String::from(title), + theme, + async_blame: AsyncBlame::new(sender), + queue: queue.clone(), + visible: false, + file_path: None, + file_blame: None, + table_state: std::cell::Cell::new(TableState::default()), + key_config, + current_height: std::cell::Cell::new(0), + } + } + + /// + pub fn open(&mut self, file_path: &str) -> Result<()> { + self.file_path = Some(file_path.into()); + self.file_blame = None; + self.table_state.get_mut().select(Some(0)); + self.show()?; + + self.update()?; + + Ok(()) + } + + /// + pub fn any_work_pending(&self) -> bool { + self.async_blame.is_pending() + } + + /// + pub fn update_git( + &mut self, + event: AsyncGitNotification, + ) -> Result<()> { + if self.is_visible() { + if let AsyncGitNotification::Blame = event { + self.update()?; + } + } + + Ok(()) + } + + fn update(&mut self) -> Result<()> { + if self.is_visible() { + if let Some(file_path) = &self.file_path { + let blame_params = BlameParams { + file_path: file_path.into(), + }; + + if let Some(( + previous_blame_params, + last_file_blame, + )) = self.async_blame.last()? + { + if previous_blame_params == blame_params { + self.file_blame = Some(last_file_blame); + + return Ok(()); + } + } + + self.async_blame.request(blame_params)?; + } + } + + Ok(()) + } + + /// + fn get_title(&self) -> String { + match ( + self.any_work_pending(), + self.file_path.as_ref(), + self.file_blame.as_ref(), + ) { + (true, Some(file_path), _) => { + format!( + "{} -- {} -- <calculating.. (who is to blame?)>", + self.title, file_path + ) + } + (false, Some(file_path), Some(file_blame)) => { + format!( + "{} -- {} -- {}", + self.title, + file_path, + file_blame.commit_id.get_short_string() + ) + } + (false, Some(file_path), None) => { + format!( + "{} -- {} -- <no blame available>", + self.title, file_path + ) + } + _ => format!("{} -- <no blame available>", self.title), + } + } + + /// + fn get_rows(&self, width: usize) -> Vec<Row> { + if let Some(ref file_blame) = self.file_blame { + file_blame + .lines + .iter() + .enumerate() + .map(|(i, (blame_hunk, line))| { + self.get_line_blame( + width, + i, + (blame_hunk.as_ref(), line.as_ref()), + file_blame, + ) + }) + .collect() + } else { + vec![] + } + } + + fn get_line_blame( + &self, + width: usize, + line_number: usize, + hunk_and_line: (Option<&BlameHunk>, &str), + file_blame: &FileBlame, + ) -> Row { + let (hunk_for_line, line) = hunk_and_line; + + let show_metadata = if line_number == 0 { + true + } else { + let hunk_for_previous_line = + &file_blame.lines[line_number - 1]; + + match (hunk_for_previous_line, hunk_for_line) { + ((Some(previous), _), Some(current)) => { + previous.commit_id != current.commit_id + } + _ => true, + } + }; + + let mut cells = if show_metadata { + self.get_metadata_for_line_blame(width, hunk_for_line) + } else { + vec![Cell::from(""), Cell::from(""), Cell::from("")] + }; + + let line_number_width = self.get_line_number_width(); + cells.push( + Cell::from(format!( + "{:>line_number_width$}{}", + line_number, + VERTICAL, + line_number_width = line_number_width, + )) + .style(self.theme.text(true, false)), + ); + cells.push( + Cell::from(String::from(line)) + .style(self.theme.text(true, false)), + ); + + Row::new(cells) + } + + fn get_metadata_for_line_blame( + &self, + width: usize, + blame_hunk: Option<&BlameHunk>, + ) -> Vec<Cell> { + let commit_hash = blame_hunk.map_or_else( + || NO_COMMIT_ID.into(), + |hunk| hunk.commit_id.get_short_string(), + ); + let author_width = get_author_width(width); + let truncated_author: String = blame_hunk.map_or_else( + || NO_AUTHOR.into(), + |hunk| string_width_align(&hunk.author, author_width), + ); + let author = format!( + "{:author_width$}", + truncated_author, + author_width = MAX_AUTHOR_WIDTH + ); + let time = blame_hunk.map_or_else( + || "".into(), + |hunk| utils::time_to_string(hunk.time, true), + ); + + let is_blamed_commit = self + .file_blame + .as_ref() + .and_then(|file_blame| { + blame_hunk.map(|hunk| { + file_blame.commit_id == hunk.commit_id + }) + }) + .unwrap_or(false); + + vec![ + Cell::from(commit_hash).style( + self.theme.commit_hash_in_blame(is_blamed_commit), + ), + Cell::from(time).style(self.theme.commit_time(false)), + Cell::from(author).style(self.theme.commit_author(false)), + ] + } + + fn get_max_line_number(&self) -> usize { + self.file_blame + .as_ref() + .map_or(0, |file_blame| file_blame.lines.len() - 1) + } + + fn get_line_number_width(&self) -> usize { + let max_line_number = self.get_max_line_number(); + + number_of_digits(max_line_number) + } + + fn move_selection(&mut self, scroll_type: ScrollType) -> bool { + let mut table_state = self.table_state.take(); + + let old_selection = table_state.selected().unwrap_or(0); + let max_selection = self.get_max_line_number(); + + let new_selection = match scroll_type { + ScrollType::Up => old_selection.saturating_sub(1), + ScrollType::Down => { + old_selection.saturating_add(1).min(max_selection) + } + ScrollType::Home => 0, + ScrollType::End => max_selection, + ScrollType::PageUp => old_selection.saturating_sub( + self.current_height.get().saturating_sub(2), + ), + ScrollType::PageDown => old_selection + .saturating_add( + self.current_height.get().saturating_sub(2), + ) + .min(max_selection), + }; + + let needs_update = new_selection != old_selection; + + table_state.select(Some(new_selection)); + self.table_state.set(table_state); + + needs_update + } + + fn selected_commit(&self) -> Option<CommitId> { + self.file_blame.as_ref().and_then(|file_blame| { + let table_state = self.table_state.take(); + + let commit_id = + table_state.selected().and_then(|selected| { + file_blame.lines[selected] + .0 + .as_ref() + .map(|hunk| hunk.commit_id) + }); + + self.table_state.set(table_state); + + commit_id + }) + } } |