(8020e48) Quote a comment behind a gutter bar that survives wrapping, and bump to 0.32.4
This commit is contained in:
+126
-83
@@ -24,8 +24,8 @@ use anyhow::{Result, anyhow};
|
||||
use chrono::Local;
|
||||
|
||||
use crate::util::{
|
||||
Cell, Color, MISSING, TIMESTAMP_FORMAT, is_unknown_value, paint_cells, should_use_colors,
|
||||
tag_cells, tag_color,
|
||||
Cell, Color, MISSING, TIMESTAMP_FORMAT, is_unknown_value, paint_cells, quoted_cells,
|
||||
should_use_colors, tag_cells, tag_color,
|
||||
};
|
||||
|
||||
/// Where a ticket's history lives, under the board.
|
||||
@@ -405,53 +405,6 @@ pub fn format_history_with(entries: &[Entry], colored: bool) -> String {
|
||||
paint_cells(&history_cells(entries, colored), colored)
|
||||
}
|
||||
|
||||
/// The bar every line of a comment and of a reason draws behind, the way quoted text is
|
||||
/// drawn.
|
||||
///
|
||||
/// Box-drawing vertical, the family the rule under HISTORY is already rendered from, so
|
||||
/// it shows wherever that does. One cell wide, grey, and clear of the two vocabularies
|
||||
/// it sits among: the priority meter owns the circles and the dot and the relation rows
|
||||
/// own the cross and the arrows, so nothing here may read as a level or as an edge.
|
||||
/// Grey is the colour the kind label carries, which names its row rather than holding a
|
||||
/// value — what a quote bar does. `the_quote_bar_claims_no_glyph_another_column_means`
|
||||
/// pins all three properties against the marks actually defined.
|
||||
const QUOTE_BAR: &str = "\u{2502}";
|
||||
|
||||
/// One run of text behind [`QUOTE_BAR`], every line of it.
|
||||
///
|
||||
/// The bar spans the whole run rather than prefixing its first line, which is the
|
||||
/// difference between a quote and an indentation: a multi-paragraph comment reads as one
|
||||
/// voice start to finish, paragraph breaks included, instead of resuming halfway through
|
||||
/// at column 0 — the column a line of values owns, which a single prefix handed back on
|
||||
/// every line after the first. With colour off the glyph goes but the width it occupied
|
||||
/// stays, as plain spaces derived from the drawn form rather than spelled beside it, so
|
||||
/// a piped `show` keeps every line at the same column without carrying an escape byte.
|
||||
/// One builder for both renderers, the board passing `true`: neither can draw a block
|
||||
/// the other does not.
|
||||
fn quoted_cells(body: &str, colored: bool) -> Vec<Cell> {
|
||||
let bar = format!("{QUOTE_BAR} ");
|
||||
let indent = " ".repeat(bar.chars().count());
|
||||
|
||||
let mut cells = Vec::new();
|
||||
for (at, line) in body.split('\n').enumerate() {
|
||||
if at > 0 {
|
||||
cells.push(Cell::plain("\n"));
|
||||
}
|
||||
match (colored, line.is_empty()) {
|
||||
// A paragraph break draws the bar alone rather than carrying a gap into
|
||||
// nothing, which is what keeps it visibly inside the run.
|
||||
(true, true) => cells.push(Cell::colored(QUOTE_BAR, Color::Grey)),
|
||||
(true, false) => {
|
||||
cells.push(Cell::colored(&bar, Color::Grey));
|
||||
cells.push(Cell::plain(line));
|
||||
}
|
||||
(false, false) => cells.push(Cell::plain(format!("{indent}{line}"))),
|
||||
(false, true) => {}
|
||||
}
|
||||
}
|
||||
cells
|
||||
}
|
||||
|
||||
/// The cells one value in a mechanical body is drawn as, per the Color Guideline.
|
||||
///
|
||||
/// Keyed on the kind, because the kind is what says which field the value came from: the
|
||||
@@ -498,39 +451,60 @@ fn stamp_cells(entry: &Entry) -> Vec<Cell> {
|
||||
]
|
||||
}
|
||||
|
||||
/// The block laid out once, as [`Cell`]s: the CLI paints them and the board turns the
|
||||
/// same ones into styled spans, so the two views cannot draw two different blocks.
|
||||
/// One segment of the history block: what it is, and how a renderer lays it out.
|
||||
///
|
||||
/// The colour decision rides in because the quote bar is a coloured decoration: with it
|
||||
/// off the cells carry the indent the bar would have provided, and no renderer has to
|
||||
/// guess at that. `format_history_with` passes the CLI's decision and the board passes
|
||||
/// `true`.
|
||||
pub fn history_cells(entries: &[Entry], colored: bool) -> Vec<Cell> {
|
||||
/// [`history_cells`] flattens these into the cells the CLI paints, and the board turns
|
||||
/// each segment into its own stretch of the overlay instead: the flow runs full width
|
||||
/// while a quoted run becomes a gutter column with the bar in it and the body beside it,
|
||||
/// so a row the body wraps keeps the mark. One segmentation, two shapes — neither
|
||||
/// renderer re-decides which runs are somebody's words.
|
||||
#[derive(Debug)]
|
||||
pub enum HistoryPart {
|
||||
/// Headers, mechanical rows and the blank lines between entries, as they stand.
|
||||
Flow(Vec<Cell>),
|
||||
/// A comment's body or a move's reason: plain text, every line of it quoted, in
|
||||
/// whatever shape the renderer quotes with.
|
||||
Quoted(String),
|
||||
}
|
||||
|
||||
/// The block as segments, one walk over the entries.
|
||||
///
|
||||
/// The order is the entries' own, oldest first, and a quoted run always sits between two
|
||||
/// flow runs — the header or mechanical row before it and the blank line after it — so a
|
||||
/// renderer can treat each segment as one unbroken stretch of rows.
|
||||
pub fn history_parts(entries: &[Entry]) -> Vec<HistoryPart> {
|
||||
let mut parts = Vec::new();
|
||||
// The flow accumulating until the next quote closes it, which is why the trailing
|
||||
// newline of every entry lands in the segment *after* a quote rather than being
|
||||
// dropped: flattened, the parts are byte for byte the block [`history_cells`] has
|
||||
// always built, which is what the CLI's pins hold it to.
|
||||
let mut flow: Vec<Cell> = Vec::new();
|
||||
|
||||
if entries.is_empty() {
|
||||
return vec![Cell::colored("No history yet.", Color::Grey)];
|
||||
flow.push(Cell::colored("No history yet.", Color::Grey));
|
||||
parts.push(HistoryPart::Flow(flow));
|
||||
return parts;
|
||||
}
|
||||
|
||||
let mut cells = Vec::new();
|
||||
cells.push(Cell::plain("\n"));
|
||||
cells.push(Cell::colored("HISTORY", Color::Orange));
|
||||
cells.push(Cell::plain(format!("\n{}\n", "─".repeat(20))));
|
||||
flow.push(Cell::plain("\n"));
|
||||
flow.push(Cell::colored("HISTORY", Color::Orange));
|
||||
flow.push(Cell::plain(format!("\n{}\n", "─".repeat(20))));
|
||||
|
||||
for entry in entries {
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::plain("\n"));
|
||||
|
||||
match entry.kind {
|
||||
// As it has always read: a header naming who said it, then the text.
|
||||
Kind::Comment => {
|
||||
// Grey on the word, for the reason the kind label is grey: `From` names
|
||||
// the line, it is not a value in it.
|
||||
cells.push(Cell::colored("From", Color::Grey));
|
||||
cells.push(Cell::plain(" "));
|
||||
cells.extend(stamp_cells(entry));
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::colored("From", Color::Grey));
|
||||
flow.push(Cell::plain(" "));
|
||||
flow.extend(stamp_cells(entry));
|
||||
flow.push(Cell::plain("\n"));
|
||||
if !entry.body.is_empty() {
|
||||
cells.extend(quoted_cells(&entry.body, colored));
|
||||
parts.push(HistoryPart::Flow(std::mem::take(&mut flow)));
|
||||
parts.push(HistoryPart::Quoted(entry.body.clone()));
|
||||
}
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::plain("\n"));
|
||||
}
|
||||
// One line: a field change is one fact and a paragraph for it would bury the
|
||||
// comments it sits between. A reason draws behind the same bar the comments
|
||||
@@ -542,33 +516,60 @@ pub fn history_cells(entries: &[Entry], colored: bool) -> Vec<Cell> {
|
||||
// an `owner` or `tags` label claimed a meaning belonging to the value
|
||||
// beside it. The label is not a value at all: it names the row, which is
|
||||
// what grey already says.
|
||||
cells.push(Cell::colored(entry.kind.slug(), Color::Grey));
|
||||
flow.push(Cell::colored(entry.kind.slug(), Color::Grey));
|
||||
// Measured on the unpainted label and carried in a cell of its own, the
|
||||
// rule the metadata table follows: measuring a painted string counts its
|
||||
// escapes towards its width, which tilts the column when colour is on and
|
||||
// not when it is off.
|
||||
cells.push(Cell::plain(format!("{} ", " ".repeat(padding))));
|
||||
flow.push(Cell::plain(format!("{} ", " ".repeat(padding))));
|
||||
|
||||
match split_change(&entry.body) {
|
||||
Some((before, after)) => {
|
||||
cells.extend(value_cells(entry.kind, before));
|
||||
cells.push(Cell::plain(CHANGE_SEPARATOR));
|
||||
cells.extend(value_cells(entry.kind, after));
|
||||
flow.extend(value_cells(entry.kind, before));
|
||||
flow.push(Cell::plain(CHANGE_SEPARATOR));
|
||||
flow.extend(value_cells(entry.kind, after));
|
||||
}
|
||||
None => cells.extend(value_cells(entry.kind, &entry.body)),
|
||||
None => flow.extend(value_cells(entry.kind, &entry.body)),
|
||||
}
|
||||
|
||||
cells.push(Cell::plain(" "));
|
||||
cells.extend(stamp_cells(entry));
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::plain(" "));
|
||||
flow.extend(stamp_cells(entry));
|
||||
flow.push(Cell::plain("\n"));
|
||||
// The newline is the quote's terminator, so it exists only when there is
|
||||
// one: a reasoned row draws the reason under itself and this closes it.
|
||||
if !entry.reason.is_empty() {
|
||||
cells.extend(quoted_cells(&entry.reason, colored));
|
||||
cells.push(Cell::plain("\n"));
|
||||
parts.push(HistoryPart::Flow(std::mem::take(&mut flow)));
|
||||
parts.push(HistoryPart::Quoted(entry.reason.clone()));
|
||||
flow.push(Cell::plain("\n"));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if !flow.is_empty() {
|
||||
parts.push(HistoryPart::Flow(flow));
|
||||
}
|
||||
|
||||
parts
|
||||
}
|
||||
|
||||
/// The block laid out once, as [`Cell`]s: the CLI paints them and the board turns the
|
||||
/// same ones into styled spans, so the two views cannot draw two different blocks.
|
||||
///
|
||||
/// The flatten of [`history_parts`], which is what makes the CLI's bytes a property of
|
||||
/// the segmentation rather than a second walk that can drift from it: the pins over this
|
||||
/// function's output are pins over the parts too. The colour decision rides in because
|
||||
/// the quote bar is a coloured decoration; with it off the cells carry the indent the
|
||||
/// bar would have provided. The board does not come through here — it lays each part in
|
||||
/// the shape the section builder gives it — but it reads the same parts.
|
||||
pub fn history_cells(entries: &[Entry], colored: bool) -> Vec<Cell> {
|
||||
let mut cells = Vec::new();
|
||||
for part in history_parts(entries) {
|
||||
match part {
|
||||
HistoryPart::Flow(run) => cells.extend(run),
|
||||
HistoryPart::Quoted(body) => cells.extend(quoted_cells(&body, colored)),
|
||||
}
|
||||
}
|
||||
cells
|
||||
}
|
||||
|
||||
@@ -576,8 +577,8 @@ pub fn history_cells(entries: &[Entry], colored: bool) -> Vec<Cell> {
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::util::{
|
||||
BLOCKED_MARK, Fixture, NOT_SET, PRIORITY_RANGE, Priority, REGRESSION_MARK, RELATES_MARK,
|
||||
paint, priority_mark, status_dirs, status_mark,
|
||||
BLOCKED_MARK, Fixture, NOT_SET, PRIORITY_RANGE, Priority, QUOTE_BAR, REGRESSION_MARK,
|
||||
RELATES_MARK, paint, priority_mark, status_dirs, status_mark,
|
||||
};
|
||||
|
||||
/// One entry, spelled the way a file on the board holds it.
|
||||
@@ -1090,4 +1091,46 @@ mod tests {
|
||||
fn nothing_recorded_says_so() {
|
||||
assert_eq!(format_history_with(&[], false), "No history yet.");
|
||||
}
|
||||
|
||||
/// The block as segments: the rows drawn as they stand are flow, a comment's body
|
||||
/// and a move's reason are quoted, and each quote sits between two flow runs — the
|
||||
/// row or header before it and the blank after it. This is the one segmentation both
|
||||
/// renderers read, so it is pinned here rather than left to be discovered on the
|
||||
/// board; the CLI's byte pins above hold its flatten to what it has always printed.
|
||||
#[test]
|
||||
fn the_block_splits_into_flow_and_quoted_parts() {
|
||||
let entries = vec![
|
||||
entry("status", "committed → reviewing", "claude", "2026-08-24 12:00:00"),
|
||||
entry("comment", "First line.\n\nSecond.", "Ansho Rei", "2026-08-24 12:00:01"),
|
||||
entry("status", "reviewing → backlog", "claude", "2026-08-24 12:00:02"),
|
||||
]
|
||||
.into_iter()
|
||||
.enumerate()
|
||||
.map(|(at, mut entry)| {
|
||||
if at == 2 {
|
||||
entry.reason = "sent back".to_string();
|
||||
}
|
||||
entry
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
let parts = history_parts(&entries);
|
||||
let shapes: Vec<&str> = parts
|
||||
.iter()
|
||||
.map(|part| match part {
|
||||
HistoryPart::Flow(_) => "flow",
|
||||
HistoryPart::Quoted(_) => "quote",
|
||||
})
|
||||
.collect();
|
||||
assert_eq!(shapes, ["flow", "quote", "flow", "quote", "flow"], "{parts:?}");
|
||||
|
||||
// The quotes carry the bare words, newlines included; laying them out is the
|
||||
// renderer's decision.
|
||||
for part in &parts {
|
||||
if let HistoryPart::Quoted(body) = part {
|
||||
assert!(!body.contains(QUOTE_BAR), "{body:?}");
|
||||
}
|
||||
}
|
||||
assert_eq!(parts.len(), 5);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user