(1f1b321) Record a move's reason in its history entry, and bump to 0.31.2
This commit is contained in:
+118
-16
@@ -123,6 +123,10 @@ pub struct Entry {
|
||||
pub time: String,
|
||||
/// A comment's text, or the before and after of the field a mechanical entry names.
|
||||
pub body: String,
|
||||
/// Why a mechanical entry happened, as `mv --reason` gave it. Empty for every entry
|
||||
/// that carries no such field, which is all of them but a reasoned move — including
|
||||
/// every entry written before reasons existed.
|
||||
pub reason: String,
|
||||
}
|
||||
|
||||
/// Rename an old `comments` directory to `history`, before anything reads or writes it.
|
||||
@@ -187,12 +191,23 @@ fn parse_entry(filename: &str, content: &str) -> Entry {
|
||||
})
|
||||
.unwrap_or("");
|
||||
|
||||
// A missing reason is legitimate rather than unreadable, which is why this does not
|
||||
// share the `unknown` fallback the two fields above carry: every entry written
|
||||
// before `mv --reason` existed has none.
|
||||
let reason = content
|
||||
.lines()
|
||||
.find_map(|line| line.strip_prefix("**Reason**:"))
|
||||
.map(str::trim)
|
||||
.unwrap_or_default()
|
||||
.to_string();
|
||||
|
||||
Entry {
|
||||
filename: filename.to_string(),
|
||||
kind,
|
||||
author: field("Author"),
|
||||
time: field("Time"),
|
||||
body: body.to_string(),
|
||||
reason,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -267,19 +282,27 @@ pub fn count_comments(board: &Path, uuid: &str) -> usize {
|
||||
///
|
||||
/// A comment's file is byte for byte what `comment` wrote before the kinds existed, so
|
||||
/// nothing has to be rewritten and a board can be read by either version.
|
||||
fn entry_content(kind: Kind, body: &str, author: &str, time: &str) -> String {
|
||||
format!(
|
||||
///
|
||||
/// The optional reason rides after **Time**, so the two fields every entry has always
|
||||
/// carried keep their places and an older binary reading this file finds its body and
|
||||
/// fields exactly where they were. Empty writes no line, which is what keeps a reasoned
|
||||
/// entry and one without reading as the same shape minus the field.
|
||||
fn entry_content(kind: Kind, body: &str, author: &str, time: &str, reason: &str) -> String {
|
||||
let mut content = format!(
|
||||
"{}\n\
|
||||
{}\n\
|
||||
\n\
|
||||
**Author**: {}\n\
|
||||
**Time**: {}\n\
|
||||
",
|
||||
{}\n\
|
||||
\n\
|
||||
**Author**: {}\n\
|
||||
**Time**: {}\n",
|
||||
kind.marker(),
|
||||
body,
|
||||
author,
|
||||
time
|
||||
)
|
||||
);
|
||||
if !reason.is_empty() {
|
||||
content.push_str(&format!("**Reason**: {}\n", reason));
|
||||
}
|
||||
content
|
||||
}
|
||||
|
||||
/// Write an entry under the first free name derived from the stamp.
|
||||
@@ -318,12 +341,16 @@ fn write_new(dir: &Path, stem: &str, content: &str) -> Result<String> {
|
||||
/// move that was refused would be a log of things that did not happen. The cost of that
|
||||
/// order is that a failed write here leaves the edit in place and reports the failure,
|
||||
/// which is the right way round — the ticket is the record and this is the story of it.
|
||||
///
|
||||
/// `reason` is the why [`Kind::Status`] can carry, from `mv --reason`; every other kind
|
||||
/// passes the empty slice and gets no field written.
|
||||
pub fn write_entry(
|
||||
board: &Path,
|
||||
uuid: &str,
|
||||
kind: Kind,
|
||||
body: &str,
|
||||
author: &str,
|
||||
reason: &str,
|
||||
) -> Result<String> {
|
||||
adopt_comments(board)?;
|
||||
|
||||
@@ -332,7 +359,8 @@ pub fn write_entry(
|
||||
|
||||
let now = Local::now();
|
||||
let stem = format!("{}_{}", now.format(ENTRY_FILE_FORMAT), kind.slug());
|
||||
let content = entry_content(kind, body, author, &now.format(TIMESTAMP_FORMAT).to_string());
|
||||
let content =
|
||||
entry_content(kind, body, author, &now.format(TIMESTAMP_FORMAT).to_string(), reason);
|
||||
|
||||
write_new(&dir, &stem, &content)
|
||||
}
|
||||
@@ -382,7 +410,9 @@ pub fn history_cells(entries: &[Entry]) -> Vec<Cell> {
|
||||
cells.push(Cell::plain("\n"));
|
||||
}
|
||||
// One line: a field change is one fact and a paragraph for it would bury the
|
||||
// comments it sits between.
|
||||
// comments it sits between. A reason grows an indented line under the row,
|
||||
// the way a comment's text sits under its From header, so it reads as
|
||||
// attached to the transition it explains rather than as the next entry.
|
||||
_ => {
|
||||
let padding = Kind::LABEL_WIDTH.saturating_sub(entry.kind.slug().chars().count());
|
||||
cells.push(Cell::colored(entry.kind.slug(), Color::Orange));
|
||||
@@ -391,6 +421,10 @@ pub fn history_cells(entries: &[Entry]) -> Vec<Cell> {
|
||||
cells.push(Cell::plain(" "));
|
||||
cells.push(Cell::colored(stamp, Color::Cyan));
|
||||
cells.push(Cell::plain("\n"));
|
||||
if !entry.reason.is_empty() {
|
||||
cells.push(Cell::plain(format!(" {}", entry.reason)));
|
||||
cells.push(Cell::plain("\n"));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -411,7 +445,8 @@ mod tests {
|
||||
fn an_entry_names_its_kind_in_the_file_and_in_the_filename() {
|
||||
let board = board();
|
||||
let filename =
|
||||
write_entry(&board, "uuid", Kind::Status, "committed → reviewing", "claude").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Status, "committed → reviewing", "claude", "")
|
||||
.unwrap();
|
||||
|
||||
assert!(filename.ends_with("_status.md"), "was {filename}");
|
||||
|
||||
@@ -420,6 +455,37 @@ mod tests {
|
||||
assert_eq!(entries[0].kind, Kind::Status);
|
||||
assert_eq!(entries[0].body, "committed → reviewing");
|
||||
assert_eq!(entries[0].author, "claude");
|
||||
assert_eq!(entries[0].reason, "");
|
||||
}
|
||||
|
||||
/// One file, one event, its explanation: the reason rides in the entry that records
|
||||
/// the transition it explains, as a field after **Time**, and round-trips.
|
||||
#[test]
|
||||
fn a_reason_is_recorded_in_the_file_and_read_back() {
|
||||
let board = board();
|
||||
let filename = write_entry(
|
||||
&board,
|
||||
"uuid",
|
||||
Kind::Status,
|
||||
"reviewing → backlog",
|
||||
"claude",
|
||||
"sent back: the first plan was wrong",
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
let content = fs::read_to_string(history_dir(&board, "uuid").join(filename)).unwrap();
|
||||
assert!(
|
||||
content.ends_with("**Reason**: sent back: the first plan was wrong\n"),
|
||||
"{content}"
|
||||
);
|
||||
// The fields every reader keys off keep their places above it
|
||||
assert!(content.contains("**Time**:"), "{content}");
|
||||
assert!(content.find("**Author**").unwrap() < content.find("**Reason**").unwrap());
|
||||
|
||||
let entries = read_history(&board, "uuid").unwrap();
|
||||
assert_eq!(entries.len(), 1);
|
||||
assert_eq!(entries[0].body, "reviewing → backlog");
|
||||
assert_eq!(entries[0].reason, "sent back: the first plan was wrong");
|
||||
}
|
||||
|
||||
/// The stamp leads the name and is fixed width, so the kind that follows it cannot
|
||||
@@ -464,7 +530,7 @@ mod tests {
|
||||
/// is what lets an old board be read without a migration.
|
||||
#[test]
|
||||
fn a_comment_file_is_shaped_as_it_always_was() {
|
||||
let content = entry_content(Kind::Comment, "A body", "claude", "2026-08-24 12:00:00");
|
||||
let content = entry_content(Kind::Comment, "A body", "claude", "2026-08-24 12:00:00", "");
|
||||
assert_eq!(
|
||||
content,
|
||||
"**Comment**\nA body\n\n**Author**: claude\n**Time**: 2026-08-24 12:00:00\n"
|
||||
@@ -535,10 +601,10 @@ mod tests {
|
||||
#[test]
|
||||
fn only_comments_are_counted() {
|
||||
let board = board();
|
||||
write_entry(&board, "uuid", Kind::Comment, "said", "claude").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Status, "backlog → committed", "claude").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Owner, "_Not set_ → alice", "claude").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Tags, "bug → bug, cli", "claude").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Comment, "said", "claude", "").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Status, "backlog → committed", "claude", "").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Owner, "_Not set_ → alice", "claude", "").unwrap();
|
||||
write_entry(&board, "uuid", Kind::Tags, "bug → bug, cli", "claude", "").unwrap();
|
||||
|
||||
assert_eq!(read_history(&board, "uuid").unwrap().len(), 4);
|
||||
assert_eq!(count_comments(&board, "uuid"), 1);
|
||||
@@ -618,6 +684,42 @@ mod tests {
|
||||
assert_eq!(format_history_with(&[], true), paint("No history yet.", Color::Grey, true));
|
||||
}
|
||||
|
||||
/// The reason is the row's, so it renders indented under the row it explains and
|
||||
/// before whatever entry follows, in both renderers — this is the one layout they
|
||||
/// share. Paired with the pin above: an entry without a reason renders exactly as
|
||||
/// it always did.
|
||||
#[test]
|
||||
fn a_reason_renders_indented_under_its_row() {
|
||||
let entries = vec![
|
||||
parse_entry(
|
||||
"20260824_120000_000000_status",
|
||||
"**Status**\nreviewing → backlog\n\n**Author**: claude\n**Time**: 2026-08-24 \
|
||||
12:00:00\n**Reason**: sent back, the first plan was wrong\n",
|
||||
),
|
||||
parse_entry(
|
||||
"20260824_120001_000000_comment",
|
||||
"**Comment**\nAnd why.\n\n**Author**: Ansho Rei\n**Time**: 2026-08-24 12:00:01\n",
|
||||
),
|
||||
];
|
||||
|
||||
let expected = format!(
|
||||
"\n{}\n{}\n\n{} reviewing → backlog {}\n sent back, the first plan was wrong\n\n{}\n And why.\n",
|
||||
paint("HISTORY", Color::Orange, true),
|
||||
"─".repeat(20),
|
||||
paint("status", Color::Orange, true),
|
||||
paint("claude (2026-08-24 12:00:00)", Color::Cyan, true),
|
||||
paint("From Ansho Rei (2026-08-24 12:00:01)", Color::Cyan, true),
|
||||
);
|
||||
|
||||
assert_eq!(format_history_with(&entries, true), expected);
|
||||
assert!(
|
||||
format_history_with(&entries, false)
|
||||
.contains("claude (2026-08-24 12:00:00)\n sent back, the first plan was wrong"),
|
||||
"colour off lost the reason: {}",
|
||||
format_history_with(&entries, false)
|
||||
);
|
||||
}
|
||||
|
||||
/// Padded to the longest of the four, so every body starts in the same column
|
||||
/// however short the label above it is.
|
||||
#[test]
|
||||
|
||||
Reference in New Issue
Block a user