Add a sort option popup to branch list view

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 * provide nightly builds (see [NIGHTLIES.md](./NIGHTLIES.md)) ([#2083](https://github.com/extrawurst/gitui/issues/2083))
 * sign commits using openpgp [[@hendrikmaus](https://github.com/hendrikmaus)] ([#97](https://github.com/extrawurst/gitui/issues/97))
+* add sort_by popup to branchlist [[@UUGTech](https://github.com/UUGTech)]([#2146](https://github.com/extrawurst/gitui/issues/2146))
 * support `core.commitChar` filtering [[@concelare](https://github.com/concelare)] ([#2136](https://github.com/extrawurst/gitui/issues/2136))
 * more version info in `gitui -V` and `help popup` (including git hash)
 

Cargo.toml

@@ -49,6 +49,8 @@ serde = "1.0"
 shellexpand = "3.1"
 simplelog = { version = "0.12", default-features = false }
 struct-patch = "0.4"
+strum = "0.25"
+strum_macros = "0.25"
 syntect = { version = "5.2", default-features = false, features = [
     "parsing",
     "default-syntaxes",

asyncgit/src/sync/branch/mod.rs

@@ -11,7 +11,10 @@ use super::{
 };
 use crate::{
 	error::{Error, Result},
-	sync::{repository::repo, utils::get_head_repo, CommitId},
+	sync::{
+		repository::repo, utils::get_head_repo, CommitId,
+		CommitSignature,
+	},
 };
 use git2::{Branch, BranchType, Repository};
 use scopetime::scope_time;
@@ -92,6 +95,10 @@ pub struct BranchInfo {
 	///
 	pub top_commit: CommitId,
 	///
+	pub top_commit_time: i64,
+	///
+	pub top_commit_author: String,
+	///
 	pub details: BranchDetails,
 }
 
@@ -181,13 +188,17 @@ pub fn get_branches_info(
 				})
 			};
 
+			let author = CommitSignature::from(&top_commit.author());
+
 			Ok(BranchInfo {
 				name: bytes2string(name_bytes)?,
 				reference,
 				top_commit_message: bytes2string(
 					top_commit.summary_bytes().unwrap_or_default(),
 				)?,
 				top_commit: top_commit.id().into(),
+				top_commit_time: top_commit.time().seconds(),
+				top_commit_author: author.name,
 				details,
 			})
 		})

src/app.rs

@@ -10,14 +10,15 @@ use crate::{
 	options::{Options, SharedOptions},
 	popup_stack::PopupStack,
 	popups::{
-		AppOption, BlameFilePopup, BranchListPopup, CommitPopup,
-		CompareCommitsPopup, ConfirmPopup, CreateBranchPopup,
-		ExternalEditorPopup, FetchPopup, FileRevlogPopup,
-		FuzzyFindPopup, HelpPopup, InspectCommitPopup,
-		LogSearchPopupPopup, MsgPopup, OptionsPopup, PullPopup,
-		PushPopup, PushTagsPopup, RenameBranchPopup, ResetPopup,
-		RevisionFilesPopup, StashMsgPopup, SubmodulesListPopup,
-		TagCommitPopup, TagListPopup,
+		AppOption, BlameFilePopup, BranchListPopup, BranchSortPopup,
+		CommitPopup, CompareCommitsPopup, ConfirmPopup,
+		CreateBranchPopup, ExternalEditorPopup, FetchPopup,
+		FileRevlogPopup, FuzzyFindPopup, HelpPopup,
+		InspectCommitPopup, LogSearchPopupPopup, MsgPopup,
+		OptionsPopup, PullPopup, PushPopup, PushTagsPopup,
+		RenameBranchPopup, ResetPopup, RevisionFilesPopup,
+		StashMsgPopup, SubmodulesListPopup, TagCommitPopup,
+		TagListPopup,
 	},
 	queue::{
 		Action, AppTabs, InternalEvent, NeedsUpdate, Queue,
@@ -88,6 +89,7 @@ pub struct App {
 	create_branch_popup: CreateBranchPopup,
 	rename_branch_popup: RenameBranchPopup,
 	select_branch_popup: BranchListPopup,
+	sort_branch_popup: BranchSortPopup,
 	options_popup: OptionsPopup,
 	submodule_popup: SubmodulesListPopup,
 	tags_popup: TagListPopup,
@@ -196,6 +198,7 @@ impl App {
 			submodule_popup: SubmodulesListPopup::new(&env),
 			log_search_popup: LogSearchPopupPopup::new(&env),
 			fuzzy_find_popup: FuzzyFindPopup::new(&env),
+			sort_branch_popup: BranchSortPopup::new(&env),
 			do_quit: QuitState::None,
 			cmdbar: RefCell::new(CommandBar::new(
 				env.theme.clone(),
@@ -468,6 +471,7 @@ impl App {
 		[
 			log_search_popup,
 			fuzzy_find_popup,
+			sort_branch_popup,
 			msg_popup,
 			confirm_popup,
 			commit_popup,
@@ -517,6 +521,7 @@ impl App {
 			reset_popup,
 			create_branch_popup,
 			rename_branch_popup,
+			sort_branch_popup,
 			revision_files_popup,
 			fuzzy_find_popup,
 			log_search_popup,
@@ -803,6 +808,16 @@ impl App {
 				flags
 					.insert(NeedsUpdate::ALL | NeedsUpdate::COMMANDS);
 			}
+			InternalEvent::OpenBranchSortPopup(sort_by) => {
+				self.sort_branch_popup.open(sort_by)?;
+				flags
+					.insert(NeedsUpdate::ALL | NeedsUpdate::COMMANDS);
+			}
+			InternalEvent::BranchListSort(sort_by) => {
+				self.select_branch_popup.sort(sort_by)?;
+				flags
+					.insert(NeedsUpdate::ALL | NeedsUpdate::COMMANDS);
+			}
 			InternalEvent::OptionSwitched(o) => {
 				match o {
 					AppOption::StatusShowUntracked => {

src/components/mod.rs

@@ -18,6 +18,8 @@ pub use commitlist::CommitList;
 pub use cred::CredComponent;
 pub use diff::DiffComponent;
 pub use revision_files::RevisionFilesComponent;
+use strum::EnumIter;
+use strum_macros::{EnumCount, EnumIs};
 pub use syntax_text::SyntaxTextComponent;
 pub use textinput::{InputType, TextInputComponent};
 pub use utils::{
@@ -191,6 +193,16 @@ pub enum FuzzyFinderTarget {
 	Files,
 }
 
+#[derive(Copy, Clone, EnumCount, EnumIs, EnumIter)]
+pub enum BranchListSortBy {
+	BranchNameAsc,
+	BranchNameDesc,
+	LastCommitTimeDesc,
+	LastCommitTimeAsc,
+	LastCommitAuthorAsc,
+	LastCommitAuthorDesc,
+}
+
 impl EventState {
 	pub fn is_consumed(&self) -> bool {
 		*self == Self::Consumed

src/keys/key_list.rs

@@ -107,6 +107,7 @@ pub struct KeysList {
 	pub open_file_tree: GituiKeyEvent,
 	pub file_find: GituiKeyEvent,
 	pub branch_find: GituiKeyEvent,
+	pub branch_sort: GituiKeyEvent,
 	pub force_push: GituiKeyEvent,
 	pub fetch: GituiKeyEvent,
 	pub pull: GituiKeyEvent,
@@ -203,6 +204,7 @@ impl Default for KeysList {
 			open_file_tree: GituiKeyEvent::new(KeyCode::Char('F'),  KeyModifiers::SHIFT),
 			file_find: GituiKeyEvent::new(KeyCode::Char('f'),  KeyModifiers::empty()),
 			branch_find: GituiKeyEvent::new(KeyCode::Char('f'),  KeyModifiers::empty()),
+			branch_sort: GituiKeyEvent::new(KeyCode::Char('s'),  KeyModifiers::empty()),
 			diff_hunk_next: GituiKeyEvent::new(KeyCode::Char('n'),  KeyModifiers::empty()),
 			diff_hunk_prev: GituiKeyEvent::new(KeyCode::Char('p'),  KeyModifiers::empty()),
 			stage_unstage_item: GituiKeyEvent::new(KeyCode::Enter,  KeyModifiers::empty()),

src/popups/branch_sort.rs

@@ -0,0 +1,205 @@
+use anyhow::Result;
+use crossterm::event::Event;
+use ratatui::{
+	layout::{Alignment, Margin, Rect},
+	text::{Line, Span},
+	widgets::{Block, Borders, Clear, Paragraph},
+	Frame,
+};
+use strum::{EnumCount, IntoEnumIterator};
+
+use crate::{
+	app::Environment,
+	components::{
+		visibility_blocking, BranchListSortBy, CommandBlocking,
+		CommandInfo, Component, DrawableComponent, EventState,
+	},
+	keys::{key_match, SharedKeyConfig},
+	queue::{InternalEvent, Queue},
+	strings,
+	ui::{self, style::SharedTheme},
+};
+
+pub struct BranchSortPopup {
+	queue: Queue,
+	visible: bool,
+	selection: BranchListSortBy,
+	key_config: SharedKeyConfig,
+	theme: SharedTheme,
+}
+
+impl BranchSortPopup {
+	///
+	pub fn new(env: &Environment) -> Self {
+		Self {
+			queue: env.queue.clone(),
+			visible: false,
+			selection: BranchListSortBy::BranchNameAsc,
+			key_config: env.key_config.clone(),
+			theme: env.theme.clone(),
+		}
+	}
+
+	pub fn open(&mut self, sort_by: BranchListSortBy) -> Result<()> {
+		self.show()?;
+		self.update_sort_key(sort_by);
+		Ok(())
+	}
+
+	fn update_sort_key(&mut self, sort_by: BranchListSortBy) {
+		self.queue.push(InternalEvent::BranchListSort(sort_by));
+	}
+
+	fn move_selection(&mut self, up: bool) {
+		let diff = if up {
+			BranchListSortBy::COUNT.saturating_sub(1)
+		} else {
+			1
+		};
+		let new_selection = (self.selection as usize)
+			.saturating_add(diff)
+			.rem_euclid(BranchListSortBy::COUNT);
+		self.selection = BranchListSortBy::iter()
+			.collect::<Vec<BranchListSortBy>>()[new_selection];
+	}
+
+	fn get_sort_key_lines(&self) -> Vec<Line> {
+		let texts = [
+			strings::sort_branch_by_name_msg(
+				self.selection.is_branch_name_asc(),
+			),
+			strings::sort_branch_by_name_rev_msg(
+				self.selection.is_branch_name_desc(),
+			),
+			strings::sort_branch_by_time_msg(
+				self.selection.is_last_commit_time_desc(),
+			),
+			strings::sort_branch_by_time_rev_msg(
+				self.selection.is_last_commit_time_asc(),
+			),
+			strings::sort_branch_by_author_msg(
+				self.selection.is_last_commit_author_asc(),
+			),
+			strings::sort_branch_by_author_rev_msg(
+				self.selection.is_last_commit_author_desc(),
+			),
+		];
+		texts
+			.iter()
+			.map(|t| {
+				Line::from(vec![Span::styled(
+					t.clone(),
+					self.theme.text(true, t.starts_with("[X]")),
+				)])
+			})
+			.collect()
+	}
+}
+
+impl DrawableComponent for BranchSortPopup {
+	fn draw(&self, f: &mut Frame, area: Rect) -> Result<()> {
+		if self.is_visible() {
+			let height = u16::try_from(BranchListSortBy::COUNT)?
+				.saturating_add(2);
+			let max_size: (u16, u16) = (50, height);
+
+			let mut area = ui::centered_rect_absolute(
+				max_size.0, max_size.1, area,
+			);
+
+			f.render_widget(Clear, area);
+			f.render_widget(
+				Block::default()
+					.borders(Borders::all())
+					.style(self.theme.title(true))
+					.title(Span::styled(
+						strings::POPUP_TITLE_BRANCH_SORT,
+						self.theme.title(true),
+					)),
+				area,
+			);
+
+			area = area.inner(&Margin {
+				horizontal: 1,
+				vertical: 1,
+			});
+			f.render_widget(
+				Paragraph::new(self.get_sort_key_lines())
+					.block(
+						Block::default()
+							.borders(Borders::NONE)
+							.border_style(self.theme.block(true)),
+					)
+					.alignment(Alignment::Left),
+				area,
+			);
+		}
+		Ok(())
+	}
+}
+
+impl Component for BranchSortPopup {
+	fn commands(
+		&self,
+		out: &mut Vec<CommandInfo>,
+		force_all: bool,
+	) -> CommandBlocking {
+		if self.is_visible() || force_all {
+			out.push(CommandInfo::new(
+				strings::commands::close_branch_sort_popup(
+					&self.key_config,
+				),
+				true,
+				true,
+			));
+			out.push(CommandInfo::new(
+				strings::commands::scroll(&self.key_config),
+				true,
+				true,
+			));
+		}
+
+		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_match(key, self.key_config.keys.exit_popup)
+					|| key_match(key, self.key_config.keys.enter)
+				{
+					self.hide();
+				} else if key_match(key, self.key_config.keys.move_up)
+				{
+					self.move_selection(true);
+					self.update_sort_key(self.selection);
+				} else if key_match(
+					key,
+					self.key_config.keys.move_down,
+				) {
+					self.move_selection(false);
+					self.update_sort_key(self.selection);
+				}
+			}
+			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(())
+	}
+}