timr-tui/src/widgets/event.rs
Jens Krause 95d914c757
feat(event) make date_time + title editable (#130)
* wip: editable events

* make it work

* fix: scroll position, title validation, underline

inputs to visualize edit mode

* show error

* prefix datetime

* refactor rendering inputs

* compact `EditMode`

* update footer to include `event` keybindings

* update README
2025-10-15 16:49:17 +02:00

528 lines
18 KiB
Rust

use color_eyre::{Report, eyre::eyre};
use crossterm::event::{Event as CrosstermEvent, KeyCode, KeyModifiers};
use ratatui::{
buffer::Buffer,
layout::{Constraint, Layout, Position, Rect},
style::{Color, Modifier, Style},
text::Line,
widgets::{Paragraph, StatefulWidget, Widget},
};
use time::{OffsetDateTime, macros::format_description};
use tui_input::Input;
use tui_input::backend::crossterm::EventHandler;
use crate::{
common::{AppTime, ClockTypeId, Style as DigitStyle},
duration::CalendarDuration,
event::Event,
events::{AppEvent, AppEventTx, TuiEvent, TuiEventHandler},
utils::center,
widgets::{clock, clock_elements::DIGIT_HEIGHT},
};
use std::{cmp::max, time::Duration};
#[derive(Clone, Copy, Default)]
enum Editable {
#[default]
DateTime,
Title,
}
impl Editable {
pub fn next(&self) -> Self {
match self {
Editable::DateTime => Editable::Title,
Editable::Title => Editable::DateTime,
}
}
pub fn prev(&self) -> Self {
match self {
Editable::DateTime => Editable::Title,
Editable::Title => Editable::DateTime,
}
}
}
#[derive(Clone, Copy)]
enum EditMode {
None,
Editing(Editable),
}
impl EditMode {
fn is_editable(&self) -> bool {
match self {
EditMode::None => false,
EditMode::Editing(_) => true,
}
}
}
/// State for `EventWidget`
pub struct EventState {
title: Option<String>,
event_time: OffsetDateTime,
app_time: OffsetDateTime,
start_time: OffsetDateTime,
with_decis: bool,
/// counter to simulate `DONE` state
/// Default value: `None`
done_count: Option<u64>,
app_tx: AppEventTx,
// inputs
input_datetime: Input,
input_datetime_error: Option<Report>,
input_title: Input,
input_title_error: Option<Report>,
edit_mode: EditMode,
last_editable: Editable,
}
pub struct EventStateArgs {
pub app_time: AppTime,
pub event: Event,
pub with_decis: bool,
pub app_tx: AppEventTx,
}
impl EventState {
pub fn new(args: EventStateArgs) -> Self {
let EventStateArgs {
app_time,
event,
with_decis,
app_tx,
} = args;
let app_datetime = OffsetDateTime::from(app_time);
// assume event has as same `offset` as `app_time`
let event_offset = event.date_time.assume_offset(app_datetime.offset());
let input_datetime_value = format_offsetdatetime(&event_offset);
let input_title_value = event.title.clone().unwrap_or("".into());
Self {
title: event.title.clone(),
event_time: event_offset,
app_time: app_datetime,
start_time: app_datetime,
with_decis,
done_count: None,
app_tx,
input_datetime: Input::default().with_value(input_datetime_value),
input_datetime_error: None,
input_title: Input::default().with_value(input_title_value),
input_title_error: None,
edit_mode: EditMode::None,
last_editable: Editable::default(),
}
}
// Sets `app_time`
pub fn set_app_time(&mut self, app_time: AppTime) {
let app_datetime = OffsetDateTime::from(app_time);
self.app_time = app_datetime;
// Since updating `app_time` is like a `Tick`, we check `done` state here
self.check_done();
}
pub fn set_with_decis(&mut self, with_decis: bool) {
self.with_decis = with_decis;
}
pub fn get_event(&self) -> Event {
Event {
title: self.title.clone(),
date_time: time::PrimitiveDateTime::new(self.event_time.date(), self.event_time.time()),
}
}
pub fn get_percentage_done(&self) -> u16 {
get_percentage(self.start_time, self.event_time, self.app_time)
}
pub fn get_duration(&mut self) -> CalendarDuration {
CalendarDuration::from_start_end_times(self.event_time, self.app_time)
}
fn check_done(&mut self) {
let clock_duration = self.get_duration();
if clock_duration.is_since() {
let duration: Duration = clock_duration.into();
// give some offset to make sure we are around `Duration::ZERO`
// Without that we might miss it, because the app runs on its own FPS
if duration < Duration::from_millis(100) {
// reset `done_count`
self.done_count = Some(clock::MAX_DONE_COUNT);
// send notification
_ = self.app_tx.send(AppEvent::ClockDone(
ClockTypeId::Event,
self.title.clone().unwrap_or("".into()),
));
}
// count (possible) `done`
self.done_count = clock::count_clock_done(self.done_count);
}
}
fn reset_cursor(&mut self) {
_ = self.app_tx.send(AppEvent::SetCursor(None));
}
pub fn is_edit_mode(&self) -> bool {
self.edit_mode.is_editable()
}
fn reset_edit_mode(&mut self) {
self.edit_mode = EditMode::None;
}
fn reset_input_datetime(&mut self) {
self.input_datetime = Input::default().with_value(format_offsetdatetime(&self.event_time));
self.input_datetime_error = None;
}
fn reset_input_title(&mut self) {
self.input_title = Input::default().with_value(self.title.clone().unwrap_or_default());
self.input_title_error = None;
}
}
fn validate_datetime(value: &str) -> Result<time::PrimitiveDateTime, Report> {
time::PrimitiveDateTime::parse(
value,
format_description!("[year]-[month]-[day] [hour]:[minute]:[second]"),
)
.map_err(|_| eyre!("Expected format 'YYYY-MM-DD HH:MM:SS'"))
}
const MAX_LABEL_WIDTH: usize = 60;
fn validate_title(value: &str) -> Result<&str, Report> {
if value.len() > MAX_LABEL_WIDTH {
return Err(eyre!("Max. {} chars", MAX_LABEL_WIDTH));
}
Ok(value)
}
impl TuiEventHandler for EventState {
fn update(&mut self, event: TuiEvent) -> Option<TuiEvent> {
let editable = self.edit_mode.is_editable();
match event {
// EDIT mode
TuiEvent::Crossterm(crossterm_event @ CrosstermEvent::Key(key)) if editable => {
match key.code {
// Skip changes
KeyCode::Esc => {
// reset inputs
self.reset_input_datetime();
self.reset_input_title();
self.reset_edit_mode();
self.reset_cursor();
}
KeyCode::Tab if key.modifiers.contains(KeyModifiers::SHIFT) => {
if let EditMode::Editing(e) = self.edit_mode {
self.last_editable = e.prev();
self.edit_mode = EditMode::Editing(self.last_editable)
}
}
KeyCode::Tab => {
if let EditMode::Editing(e) = self.edit_mode {
self.last_editable = e.next();
self.edit_mode = EditMode::Editing(self.last_editable)
}
}
KeyCode::Enter => match self.edit_mode {
EditMode::Editing(Editable::DateTime) => {
// validate
if let Ok(date_time) = validate_datetime(self.input_datetime.value()) {
// apply offset
self.event_time = date_time.assume_offset(self.app_time.offset());
} else {
// reset
self.reset_input_datetime();
}
self.reset_edit_mode();
self.reset_cursor();
}
EditMode::Editing(Editable::Title) => {
self.title = validate_title(self.input_title.value())
.ok()
.filter(|v| !v.is_empty())
.map(str::to_string);
self.reset_edit_mode();
self.reset_cursor();
}
EditMode::None => {}
},
_ => match self.edit_mode {
EditMode::Editing(Editable::DateTime) => {
self.input_datetime.handle_event(&crossterm_event);
if let Err(e) = validate_datetime(self.input_datetime.value()) {
self.input_datetime_error = Some(e);
} else {
self.input_datetime_error = None;
}
}
EditMode::Editing(Editable::Title) => {
self.input_title.handle_event(&crossterm_event);
if let Err(e) = validate_title(self.input_title.value()) {
self.input_title_error = Some(e);
} else {
self.input_title_error = None;
}
}
EditMode::None => {}
},
}
}
// default mode
TuiEvent::Crossterm(CrosstermEvent::Key(key)) => match key.code {
// Enter edit mode
KeyCode::Char('e') => {
self.edit_mode = EditMode::Editing(self.last_editable);
}
_ => return Some(event),
},
_ => return Some(event),
}
None
}
}
fn get_percentage(start: OffsetDateTime, end: OffsetDateTime, current: OffsetDateTime) -> u16 {
let total_millis = (end - start).whole_milliseconds();
if total_millis <= 0 {
return 100;
}
let elapsed_millis = (current - start).whole_milliseconds();
if elapsed_millis <= 0 {
return 0;
}
let percentage = (elapsed_millis * 100 / total_millis).min(100);
percentage as u16
}
fn format_offsetdatetime(dt: &OffsetDateTime) -> String {
dt.format(&format_description!(
"[year]-[month]-[day] [hour]:[minute]:[second]"
))
.unwrap_or_else(|e| format!("time format error: {}", e))
}
#[derive(Debug)]
pub struct EventWidget {
pub style: DigitStyle,
pub blink: bool,
}
impl StatefulWidget for EventWidget {
type State = EventState;
fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
let with_decis = state.with_decis;
let clock_duration = state.get_duration();
let clock_format = clock::format_by_duration(&clock_duration);
let clock_widths = clock::clock_horizontal_lengths(&clock_format, with_decis);
let clock_width = clock_widths.iter().sum();
let area = center(
area,
Constraint::Length(max(clock_width, MAX_LABEL_WIDTH as u16)),
Constraint::Length(
DIGIT_HEIGHT + 7, /* height of all labels + empty lines */
),
);
let [_, v1, v2, v3, _, v4] = Layout::vertical(Constraint::from_lengths([
3, // empty (offset) to keep everything centered vertically comparing to "clock" widgets with one label only
DIGIT_HEIGHT,
1, // label: event date
1, // label: event title
1, // empty
1, // label: error
]))
.areas(area);
// To simulate a blink effect, just use an "empty" symbol (string)
// It's "empty" all digits and creates an "empty" render area
let symbol = if self.blink && clock::should_blink(state.done_count) {
" "
} else {
self.style.get_digit_symbol()
};
let render_clock_state = clock::RenderClockState {
with_decis,
duration: clock_duration.clone(),
editable_time: None,
format: clock_format,
symbol,
widths: clock_widths,
};
clock::render_clock(v1, buf, render_clock_state);
// Helper to calculate centered area, cursor x position, and scroll
let calc_editable_input_positions = |input: &Input, area: Rect| -> (Rect, u16, usize) {
// Calculate scroll position to keep cursor visible
let input_scroll = input.visual_scroll(area.width as usize);
// Get correct visual width (handles unicode properly)
let text_width = Line::raw(input.value()).width() as u16;
// Calculate visible text width after scrolling
let visible_text_width = text_width
.saturating_sub(input_scroll as u16)
.min(area.width);
// Center the visible portion
let offset_x = (area.width.saturating_sub(visible_text_width)) / 2;
let centered_area = Rect {
x: area.x + offset_x,
y: area.y,
width: visible_text_width,
height: area.height,
};
// Cursor position relative to the visible scrolled text
let cursor_offset = input.visual_cursor().saturating_sub(input_scroll);
let cursor_x = area.x + offset_x + cursor_offset as u16;
(centered_area, cursor_x, input_scroll)
};
fn input_edit_style(with_error: bool) -> Style {
if with_error {
Style::default()
.add_modifier(Modifier::UNDERLINED)
.fg(Color::Red)
} else {
Style::default().add_modifier(Modifier::UNDERLINED)
}
}
// Render date time input
match state.edit_mode {
// EDIT
EditMode::Editing(Editable::DateTime) => {
let (datetime_area, datetime_cursor_x, datetime_scroll) =
calc_editable_input_positions(&state.input_datetime, v2);
Paragraph::new(state.input_datetime.value())
.style(input_edit_style(state.input_datetime_error.is_some()))
.scroll((0, datetime_scroll as u16))
.render(datetime_area, buf);
// Update cursor
let cp = Position::new(datetime_cursor_x, v2.y);
let _ = state.app_tx.send(AppEvent::SetCursor(Some(cp)));
}
// NORMAL
_ => {
let mut prefix = "Until";
if clock_duration.is_since() {
let duration: Duration = clock_duration.clone().into();
// Show `done` for a short of time (1 sec)
prefix = if duration < Duration::from_secs(1) {
"Done"
} else {
"Since"
};
};
Paragraph::new(format!(
"{} {}",
prefix.to_uppercase(),
state.input_datetime.value()
))
.centered()
.render(v2, buf);
}
};
// Render title input
match state.edit_mode {
// EDIT
EditMode::Editing(Editable::Title) => {
let (title_area, title_cursor_x, title_scroll) =
calc_editable_input_positions(&state.input_title, v3);
Paragraph::new(state.input_title.value().to_uppercase())
.style(input_edit_style(state.input_title_error.is_some()))
.scroll((0, title_scroll as u16))
.render(title_area, buf);
// Update cursor
let cp = Position::new(title_cursor_x, v3.y);
let _ = state.app_tx.send(AppEvent::SetCursor(Some(cp)));
}
// NORMAL
_ => {
Paragraph::new(state.input_title.value().to_uppercase())
.centered()
.render(v3, buf);
}
};
// Render error
let error_txt: String = match (&state.input_datetime_error, &state.input_title_error) {
(Some(e), _) => e.to_string(),
(_, Some(e)) => e.to_string(),
_ => "".into(),
};
Paragraph::new(error_txt.to_lowercase())
.style(Style::default().add_modifier(Modifier::ITALIC))
.centered()
.render(v4, buf);
}
}
#[cfg(test)]
mod tests {
use super::*;
use time::macros::datetime;
#[test]
fn test_get_percentage() {
let start = datetime!(2024-01-01 10:00:00 UTC);
let end = datetime!(2024-01-01 20:00:00 UTC);
// current == start: 0%
assert_eq!(get_percentage(start, end, start), 0);
// current == end: 100%
assert_eq!(get_percentage(start, end, end), 100);
// current halfway: 50%
let halfway = datetime!(2024-01-01 15:00:00 UTC);
assert_eq!(get_percentage(start, end, halfway), 50);
// current 25%
let quarter = datetime!(2024-01-01 12:30:00 UTC);
assert_eq!(get_percentage(start, end, quarter), 25);
// current 75%
let three_quarters = datetime!(2024-01-01 17:30:00 UTC);
assert_eq!(get_percentage(start, end, three_quarters), 75);
// current > end: clamped to 100%
let after = datetime!(2024-01-01 22:00:00 UTC);
assert_eq!(get_percentage(start, end, after), 100);
// current < start: 0%
let before = datetime!(2024-01-01 08:00:00 UTC);
assert_eq!(get_percentage(start, end, before), 0);
// end <= start: 100%
assert_eq!(get_percentage(end, start, halfway), 100);
assert_eq!(get_percentage(start, start, start), 100);
}
}