use ratatui::Frame;
use ratatui::layout::Rect;
use ratatui::style::{Color, Modifier, Style};
use ratatui::text::Line;
use ratatui::widgets::{Block, Borders, Clear, Paragraph};
use crate::app::{Action, App};
use crate::keybindings::{EffectiveBindings, InputContext};
use crate::ui::planning::{PlanningRow, prompt_line, rows_lines};
pub const DISPLAY_ROWS: usize = 3;
pub const GENERAL_ROWS: usize = 2;
pub fn board_rows_len(board: &crate::config::BoardConfiguration) -> usize {
board.columns.len() + DISPLAY_ROWS + GENERAL_ROWS
}
pub const SECTION_RAIL_WIDTH: u16 = 18;
pub fn config_body_rect(area: Rect) -> Rect {
let rail = SECTION_RAIL_WIDTH.min(area.width);
Rect {
x: area.x + rail,
width: area.width - rail,
..area
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ConfigSection {
#[default]
Dashboards,
Cycles,
Milestones,
}
impl ConfigSection {
pub const ALL: [Self; 3] = [Self::Dashboards, Self::Cycles, Self::Milestones];
pub const fn label(self) -> &'static str {
match self {
Self::Dashboards => "Dashboards",
Self::Cycles => "Cycles",
Self::Milestones => "Milestones",
}
}
pub fn next(self) -> Self {
match self {
Self::Dashboards => Self::Cycles,
Self::Cycles => Self::Milestones,
Self::Milestones => Self::Dashboards,
}
}
pub fn prev(self) -> Self {
match self {
Self::Dashboards => Self::Milestones,
Self::Cycles => Self::Dashboards,
Self::Milestones => Self::Cycles,
}
}
pub const fn index(self) -> usize {
match self {
Self::Dashboards => 0,
Self::Cycles => 1,
Self::Milestones => 2,
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ConfigPane {
#[default]
Sections,
Body,
}
impl ConfigPane {
pub const fn index(self) -> usize {
match self {
Self::Sections => 0,
Self::Body => 1,
}
}
}
#[derive(Debug, Clone, Copy)]
pub struct DashboardView<'a> {
pub name: &'a str,
pub board: &'a crate::config::BoardConfiguration,
pub editor: Option<&'a str>,
pub viewer: &'a str,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SettingsPrompt {
AddColumn(String),
NewBoard(String),
RenameBoard {
old: String,
buffer: String,
},
ConfirmDeleteBoard {
name: String,
referencing: usize,
},
SetEditor(String),
SetViewer(String),
}
#[derive(Debug, Clone, Default)]
pub struct SettingsModal {
pub selected: usize,
pub prompt: Option<SettingsPrompt>,
pub section: ConfigSection,
pub pane: ConfigPane,
}
impl SettingsModal {
pub fn new() -> Self {
Self::default()
}
pub fn focus(&mut self, pane: ConfigPane) {
self.pane = pane;
}
pub fn move_pane(&mut self, delta: isize) {
let next = self.pane.index() as isize + delta;
self.pane = if next <= 0 {
ConfigPane::Sections
} else {
ConfigPane::Body
};
}
pub fn set_section(&mut self, section: ConfigSection) {
if self.section != section {
self.section = section;
self.selected = 0;
}
}
pub fn move_selected(&mut self, delta: isize, total_rows: usize) {
if total_rows == 0 {
self.selected = 0;
return;
}
let next = self.selected as isize + delta;
self.selected = next.clamp(0, total_rows as isize - 1) as usize;
}
pub fn move_selected_to(&mut self, row: usize, total_rows: usize) {
if total_rows == 0 {
self.selected = 0;
return;
}
self.selected = row.min(total_rows - 1);
}
pub fn render_body(
&self,
f: &mut Frame,
rect: Rect,
view: DashboardView<'_>,
bindings: &EffectiveBindings,
focused: bool,
) {
let DashboardView {
name: board_name,
board,
editor,
viewer,
} = view;
let context = InputContext::Settings;
let columns = &board.columns;
let hidden = &board.hidden_columns;
let wrap_titles = board.wrap_titles;
let title_lines = board.title_lines;
let order_by = board.order_by;
let mut rows: Vec<Line> = Vec::new();
for (i, col) in columns.iter().enumerate() {
let is_hidden = hidden.iter().any(|h| h == col);
let mark = if is_hidden { "[ ]" } else { "[x]" };
let cursor = if i == self.selected { "> " } else { " " };
let style = row_style(i == self.selected);
let hidden_suffix = if is_hidden { " (hidden)" } else { "" };
rows.push(Line::from(vec![
ratatui::text::Span::styled(cursor, style),
ratatui::text::Span::styled(format!("{mark} {col}{hidden_suffix}"), style),
]));
}
let display_texts = [
format!("Wrap titles: {}", if wrap_titles { "[x]" } else { "[ ]" }),
format!("Title lines: {title_lines}"),
format!("Order by: {}", order_by.as_str()),
format!("Editor: {}", editor.unwrap_or("(default)")),
format!("Viewer: {viewer}"),
];
for (row, text) in display_texts.into_iter().enumerate() {
let idx = columns.len() + row;
let style = row_style(idx == self.selected);
let cursor = if idx == self.selected { "> " } else { " " };
rows.push(Line::from(vec![
ratatui::text::Span::styled(cursor, style),
ratatui::text::Span::styled(text, style),
]));
}
if let Some(prompt) = &self.prompt {
rows.push(Line::from(""));
let line = match prompt {
SettingsPrompt::AddColumn(buffer) => format!("New column: {buffer}_"),
SettingsPrompt::NewBoard(buffer) => format!("New board: {buffer}_"),
SettingsPrompt::RenameBoard { buffer, .. } => {
format!("Rename board to: {buffer}_")
}
SettingsPrompt::ConfirmDeleteBoard { name, referencing } => format!(
"Delete board '{name}'? {referencing} {} reference it. [y/N]",
crate::ui::planning::issues_word(*referencing)
),
SettingsPrompt::SetEditor(buffer) => format!("Editor: {buffer}_"),
SettingsPrompt::SetViewer(buffer) => format!("Viewer: {buffer}_"),
};
rows.push(Line::from(ratatui::text::Span::styled(
line,
Style::default().fg(Color::Cyan),
)));
} else {
rows.push(Line::from(""));
rows.push(Line::from(ratatui::text::Span::styled(
format!(
"{}: toggle · {}: new column · {}: activate row · {}: new board · {}: rename board · {}: delete board · {}: switch board · {} / {}: pane · {}: close",
bindings.label(context, crate::keybindings::TuiAction::Toggle),
bindings.label(context, crate::keybindings::TuiAction::AddColumn),
bindings.label(context, crate::keybindings::TuiAction::Submit),
bindings.label(context, crate::keybindings::TuiAction::NewBoard),
bindings.label(context, crate::keybindings::TuiAction::EditPlanningItem),
bindings.label(context, crate::keybindings::TuiAction::Delete),
bindings.label(context, crate::keybindings::TuiAction::NextBoard),
bindings.label(context, crate::keybindings::TuiAction::MoveLeft),
bindings.label(context, crate::keybindings::TuiAction::MoveRight),
bindings.label(context, crate::keybindings::TuiAction::Close),
),
Style::default().fg(Color::DarkGray),
)));
}
let block = Block::default()
.borders(Borders::ALL)
.title(format!(" Dashboards — {board_name} "))
.style(pane_style(focused));
let para = Paragraph::new(rows).block(block).style(Style::default());
f.render_widget(Clear, rect);
f.render_widget(para, rect);
}
}
fn row_style(selected: bool) -> Style {
if selected {
Style::default()
.fg(Color::Yellow)
.add_modifier(Modifier::BOLD)
} else {
Style::default().fg(Color::White)
}
}
fn pane_style(focused: bool) -> Style {
if focused {
Style::default().fg(Color::Yellow)
} else {
Style::default().fg(Color::DarkGray)
}
}
pub fn render_config(
app: &App,
f: &mut Frame,
area: Rect,
view: DashboardView<'_>,
cycles: &[PlanningRow],
milestones: &[PlanningRow],
) {
let Some(modal) = app.settings.as_ref() else {
return;
};
let body_focused = modal.pane == ConfigPane::Body;
render_section_rail(
app,
f,
area,
modal.section,
modal.pane == ConfigPane::Sections,
);
let body = config_body_rect(area);
match modal.section {
ConfigSection::Dashboards => {
modal.render_body(f, body, view, &app.bindings, body_focused);
for row in 0..board_rows_len(view.board) {
app.record_region(body_row_rect(body, row), Action::SettingsRow(row));
}
}
ConfigSection::Cycles => {
render_planning_section(app, f, body, "Cycles", cycles, body_focused);
}
ConfigSection::Milestones => {
render_planning_section(app, f, body, "Milestones", milestones, body_focused);
}
}
}
fn body_row_rect(body: Rect, row: usize) -> Rect {
Rect {
x: body.x + 1,
y: body.y + 1 + row as u16,
width: body.width.saturating_sub(2),
height: 1,
}
}
fn render_section_rail(app: &App, f: &mut Frame, area: Rect, active: ConfigSection, focused: bool) {
let rail = Rect {
width: SECTION_RAIL_WIDTH.min(area.width),
..area
};
let mut lines: Vec<Line> = Vec::new();
for section in ConfigSection::ALL {
let style = if section == active {
row_style(true)
} else if app.is_hovered(&Action::ConfigSection(section)) {
Style::default()
.fg(Color::Black)
.bg(Color::DarkGray)
.add_modifier(Modifier::BOLD)
} else {
row_style(false)
};
let cursor = if section == active { "> " } else { " " };
lines.push(Line::from(vec![
ratatui::text::Span::styled(cursor, style),
ratatui::text::Span::styled(section.label(), style),
]));
}
let block = Block::default()
.borders(Borders::ALL)
.title(" Sections ")
.style(pane_style(focused));
f.render_widget(Paragraph::new(lines).block(block), rail);
for section in ConfigSection::ALL {
let hit = Rect {
x: rail.x + 1,
y: rail.y + 1 + section.index() as u16,
width: rail.width.saturating_sub(2),
height: 1,
};
app.record_region(hit, Action::ConfigSection(section));
}
}
fn render_planning_section(
app: &App,
f: &mut Frame,
body: Rect,
label: &str,
rows: &[PlanningRow],
focused: bool,
) {
let selected = app.planning.as_ref().map(|p| p.selected).unwrap_or(0);
let prompt = app.planning.as_ref().and_then(|p| p.prompt.as_ref());
let inner = body.height.saturating_sub(2) as usize;
let view_h = inner.saturating_sub(2);
let mut lines: Vec<Line> = Vec::new();
if rows.is_empty() {
if prompt.is_none() {
lines.push(Line::from(format!(
"No {} yet — press n to create one.",
label.to_lowercase()
)));
}
} else {
lines.extend(rows_lines(rows, selected, view_h));
}
lines.push(Line::from(""));
match prompt {
Some(prompt) => lines.push(prompt_line(prompt)),
None => lines.push(Line::from(ratatui::text::Span::styled(
format!(
"{}: new · {}: edit · {}: delete · {}: activate row · {} / {}: pane · {}: close",
app.bindings.label(
InputContext::Settings,
crate::keybindings::TuiAction::NewBoard
),
app.bindings.label(
InputContext::Settings,
crate::keybindings::TuiAction::EditPlanningItem
),
app.bindings.label(
InputContext::Settings,
crate::keybindings::TuiAction::Delete
),
app.bindings.label(
InputContext::Settings,
crate::keybindings::TuiAction::Submit
),
app.bindings.label(
InputContext::Settings,
crate::keybindings::TuiAction::MoveLeft
),
app.bindings.label(
InputContext::Settings,
crate::keybindings::TuiAction::MoveRight
),
app.bindings
.label(InputContext::Settings, crate::keybindings::TuiAction::Close),
),
Style::default().fg(Color::DarkGray),
))),
}
let block = Block::default()
.borders(Borders::ALL)
.title(format!(" {label} — {} items ", rows.len()))
.style(pane_style(focused));
f.render_widget(Paragraph::new(lines).block(block), body);
for i in 0..rows.len() {
app.record_region(body_row_rect(body, i), Action::ConfigPlanningRow(i));
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ui::modal::modal_rect;
use ratatui::Terminal;
use ratatui::backend::TestBackend;
fn draw(
modal: &SettingsModal,
board: &crate::config::BoardConfiguration,
w: u16,
h: u16,
) -> Terminal<TestBackend> {
draw_focused(modal, board, w, h, false)
}
fn draw_focused(
modal: &SettingsModal,
board: &crate::config::BoardConfiguration,
w: u16,
h: u16,
focused: bool,
) -> Terminal<TestBackend> {
let backend = TestBackend::new(w, h);
let mut terminal = Terminal::new(backend).unwrap();
let bindings =
crate::keybindings::KeyBindings::resolve(&crate::keybindings::KeyBindings::default())
.expect("built-in bindings are valid");
terminal
.draw(|f| {
modal.render_body(
f,
modal_rect(f.area()),
DashboardView {
name: "default",
board,
editor: None,
viewer: "mdterm (auto)",
},
&bindings,
focused,
);
})
.unwrap();
terminal
}
fn rows_of(terminal: &Terminal<TestBackend>) -> Vec<String> {
let buffer = terminal.backend().buffer();
(0..buffer.area().height)
.map(|y| {
(0..buffer.area().width)
.map(|x| buffer[(x, y)].symbol().chars().next().unwrap_or(' '))
.collect()
})
.collect()
}
fn test_board() -> crate::config::BoardConfiguration {
crate::config::BoardConfiguration {
columns: vec!["todo".to_string(), "done".to_string()],
hidden_columns: vec!["done".to_string()],
..Default::default()
}
}
fn render_smoke(prompt: Option<SettingsPrompt>, w: u16, h: u16) {
let modal = SettingsModal {
selected: 1,
prompt,
..SettingsModal::default()
};
let _ = draw(&modal, &test_board(), w, h);
}
#[test]
fn renders_display_rows_after_columns() {
let modal = SettingsModal {
selected: 2,
prompt: None,
..SettingsModal::default()
};
let board = crate::config::BoardConfiguration {
columns: vec!["todo".to_string(), "done".to_string()],
hidden_columns: vec![],
wrap_titles: false,
title_lines: 5,
order_by: crate::config::OrderBy::None,
..Default::default()
};
let terminal = draw(&modal, &board, 80, 24);
let buffer = terminal.backend().buffer();
let rows = rows_of(&terminal);
let row_of =
|needle: &str| -> Option<usize> { rows.iter().position(|r| r.contains(needle)) };
let wrap_row = row_of("Wrap titles: [ ]").expect("wrap row shows unchecked mark");
let lines_row = row_of("Title lines: 5").expect("line-limit row shows the value");
let order_row = row_of("Order by: none").expect("ordering row shows the value");
let editor_row = row_of("Editor: (default)").expect("general row shows the editor");
let viewer_row = row_of("Viewer: mdterm (auto)").expect("general row shows the viewer");
assert!(
wrap_row < lines_row
&& lines_row < order_row
&& order_row < editor_row
&& editor_row < viewer_row,
"display and general rows render beneath the columns in order"
);
assert!(
rows[wrap_row].contains('>'),
"selected display row shows the cursor: {:?}",
rows[wrap_row]
);
assert!(
!rows[lines_row].contains('>'),
"unselected display row has no cursor: {:?}",
rows[lines_row]
);
let selection_x = rows[wrap_row].find('>').expect("cursor sits in the row") as u16;
let selected = &buffer[(selection_x + 2, wrap_row as u16)];
assert_eq!(selected.fg, Color::Yellow, "selected row gets cursor style");
}
#[test]
fn renders_at_80x24() {
render_smoke(None, 80, 24);
}
#[test]
fn renders_prompt_at_80x24() {
render_smoke(Some(SettingsPrompt::AddColumn("".into())), 80, 24);
}
#[test]
fn renders_rename_and_delete_prompts_at_80x24() {
render_smoke(
Some(SettingsPrompt::RenameBoard {
old: "default".into(),
buffer: "ops".into(),
}),
80,
24,
);
render_smoke(
Some(SettingsPrompt::ConfirmDeleteBoard {
name: "default".into(),
referencing: 0,
}),
80,
24,
);
render_smoke(Some(SettingsPrompt::SetEditor("nvim".into())), 80, 24);
render_smoke(Some(SettingsPrompt::SetViewer("less".into())), 80, 24);
}
#[test]
fn renders_at_tiny_20x5() {
render_smoke(None, 20, 5);
}
#[test]
fn move_selected_clamps_within_columns() {
let mut modal = SettingsModal::new();
modal.move_selected(-1, 3);
assert_eq!(modal.selected, 0);
modal.move_selected(5, [0usize, 1, 2, 3].len());
assert_eq!(modal.selected, 3);
modal.move_selected(1, 0);
assert_eq!(modal.selected, 0);
}
#[test]
fn defaults_to_first_row() {
assert_eq!(SettingsModal::new().selected, 0);
assert_eq!(SettingsModal::new().prompt, None);
assert_eq!(SettingsModal::new().section, ConfigSection::Dashboards);
}
#[test]
fn sections_cycle_in_both_directions_and_wrap() {
assert_eq!(ConfigSection::Dashboards.next(), ConfigSection::Cycles);
assert_eq!(ConfigSection::Cycles.next(), ConfigSection::Milestones);
assert_eq!(ConfigSection::Milestones.next(), ConfigSection::Dashboards);
assert_eq!(ConfigSection::Dashboards.prev(), ConfigSection::Milestones);
assert_eq!(ConfigSection::ALL.len(), 3);
}
#[test]
fn set_section_resets_the_row_cursor_only_on_a_change() {
let mut modal = SettingsModal {
selected: 2,
..SettingsModal::default()
};
modal.set_section(ConfigSection::Cycles);
assert_eq!(modal.selected, 0);
modal.selected = 1;
modal.set_section(ConfigSection::Cycles);
assert_eq!(
modal.selected, 1,
"re-selecting the same section keeps the cursor"
);
}
#[test]
fn board_rows_len_counts_columns_display_and_general_rows() {
let board = crate::config::BoardConfiguration {
columns: vec!["todo".into(), "done".into()],
..Default::default()
};
assert_eq!(board_rows_len(&board), 2 + DISPLAY_ROWS + GENERAL_ROWS);
}
#[test]
fn pane_focus_defaults_to_the_section_rail() {
let modal = SettingsModal::new();
assert_eq!(modal.pane, ConfigPane::Sections);
assert_eq!(ConfigPane::Sections.index(), 0);
assert_eq!(ConfigPane::Body.index(), 1);
}
#[test]
fn move_pane_clamps_at_both_ends() {
let mut modal = SettingsModal::new();
modal.move_pane(1);
assert_eq!(modal.pane, ConfigPane::Body);
modal.move_pane(1);
assert_eq!(modal.pane, ConfigPane::Body, "the right end clamps");
modal.move_pane(-1);
assert_eq!(modal.pane, ConfigPane::Sections);
modal.move_pane(-1);
assert_eq!(modal.pane, ConfigPane::Sections, "the left end clamps");
modal.focus(ConfigPane::Body);
assert_eq!(modal.pane, ConfigPane::Body);
}
#[test]
fn focused_pane_border_is_rendered_distinctly() {
let board = test_board();
let modal = SettingsModal::new();
let focused = draw_focused(&modal, &board, 80, 24, true);
let unfocused = draw_focused(&modal, &board, 80, 24, false);
let rect = modal_rect(focused.backend().buffer().area);
let border = |term: &Terminal<TestBackend>| term.backend().buffer()[(rect.x, rect.y)].fg;
assert_eq!(
border(&focused),
Color::Yellow,
"the focused pane's border is accented"
);
assert_eq!(
border(&unfocused),
Color::DarkGray,
"the unfocused pane's border is dimmed"
);
assert_ne!(border(&focused), border(&unfocused));
}
}