(fa5662a) Write handler output through a caller-supplied sink, and bump to 0.32.13

This commit is contained in:
Ansho Rei
2026-08-27 08:13:32 +02:00
parent 8675f22209
commit 69bc2feef5
5 changed files with 407 additions and 168 deletions
+89 -15
View File
@@ -1,7 +1,7 @@
use anyhow::{Result, anyhow};
use chrono::NaiveDateTime;
use std::fs;
use std::io::IsTerminal;
use std::io::{IsTerminal, Write};
use std::path::Path;
use std::sync::OnceLock;
@@ -303,6 +303,80 @@ pub fn color_text(text: &str, color: Color) -> String {
paint(text, color, should_use_colors())
}
/// A destination for a command's output, chosen by the caller.
///
/// `main` hands a handler its own stdout and nothing about the CLI changes; the
/// board (or a test) hands it an in-memory buffer and reads back what the command
/// said. Threading the writer and the colour decision together means every print
/// site reaches both, and a handler never asks the process about its own stdout.
///
/// `use_color` is the sink's answer, not a read of [`should_use_colors`]: a process
/// whose stdout is a pipe still wants colour when the sink is a buffer a renderer
/// will colour itself, and the board wants plain text however the terminal answers.
pub struct Sink<'a> {
writer: Box<dyn Write + 'a>,
/// Whether the bytes this sink writes carry colour escapes.
pub use_color: bool,
}
impl<'a> Sink<'a> {
/// The process's stdout, coloured by what the terminal wants.
///
/// What `main` passes, so the CLI's output is byte identical to before: every
/// command wrote to stdout through `println!`, and this sink writes to the same
/// stdout through the same [`paint`].
pub fn std() -> Sink<'static> {
// Through `new` so the process's stdout is just another writer the sink wraps.
Sink::new(Box::new(std::io::stdout()), should_use_colors())
}
/// An in-memory buffer, plain, for a test or a caller that colours the text
/// itself.
#[allow(dead_code)]
pub fn buffer(target: &'a mut Vec<u8>) -> Sink<'a> {
Sink {
writer: Box::new(target),
use_color: false,
}
}
/// Any writer, with the colour decision given.
pub fn new(writer: Box<dyn Write + 'a>, use_color: bool) -> Sink<'a> {
Sink { writer, use_color }
}
/// The writer, for a caller that already knows how to fill it (the completions
/// generator).
pub fn as_write(&mut self) -> &mut dyn Write {
&mut *self.writer
}
/// Write `text` followed by a newline, the way `println!` did.
pub fn writeln(&mut self, text: &str) -> Result<()> {
self.writer.write_all(text.as_bytes())?;
self.writer.write_all(b"\n")?;
Ok(())
}
/// Write `text` with no terminator, the way `print!` did. The caller flushes
/// when it then waits on input.
pub fn write(&mut self, text: &str) -> Result<()> {
self.writer.write_all(text.as_bytes())?;
Ok(())
}
/// Flush the writer, so a prompt reaches the terminal before a read.
pub fn flush(&mut self) -> Result<()> {
self.writer.flush()?;
Ok(())
}
/// `text` wrapped in `color`'s escape when this sink is coloured.
pub fn color(&self, text: &str, color: Color) -> String {
paint(text, color, self.use_color)
}
}
/// What sits at a candidate `.worklane` path.
///
/// The distinction the walk turns on is between nothing there and something
@@ -738,10 +812,6 @@ pub struct Resolved {
pub campaign: Vec<Cell>,
}
pub fn content_trim_colored(content: &str, resolved: &Resolved) -> String {
content_trim(content, should_use_colors(), resolved)
}
/// A section heading, its rule, and the blank line the body opens under.
///
/// The rule is measured on the name as displayed, in characters. It used to span the
@@ -3314,8 +3384,8 @@ fn show_priority(priority: Priority, colored: bool) -> String {
paint(glyph, colour, colored)
}
pub fn display_ticket_items(items: &[TicketItem]) {
let colored = should_use_colors();
pub fn display_ticket_items(sink: &mut Sink, items: &[TicketItem]) -> Result<()> {
let colored = sink.use_color;
for item in items {
let id = paint(&item.id, Color::Red, colored);
@@ -3324,15 +3394,19 @@ pub fn display_ticket_items(items: &[TicketItem]) {
let priority = show_priority(item.priority, colored);
if item.created.is_empty() {
println!(" {} ({}) {} | Owner: {} | Due: {}", priority, id, item.title, owner, due);
sink.writeln(&format!(
" {} ({}) {} | Owner: {} | Due: {}",
priority, id, item.title, owner, due
))?;
} else {
let created = paint(&item.created, Color::Cyan, colored);
println!(
sink.writeln(&format!(
" {} {} ({}) {} | Owner: {} | Due: {}",
priority, created, id, item.title, owner, due
);
))?;
}
}
Ok(())
}
pub fn collect_ticket_items(status_path: impl AsRef<Path>) -> Result<Vec<TicketItem>> {
@@ -4714,7 +4788,7 @@ mod tests {
#[test]
fn a_section_rule_matches_the_width_of_its_name() {
let rendered = content_trim_colored("# T\n\n## Description\nbody\n", &Resolved::default());
let rendered = content_trim("# T\n\n## Description\nbody\n", false, &Resolved::default());
// Eleven characters, not fourteen: the rule used to span "## Description"
assert!(rendered.starts_with("Description\n───────────\n"), "{rendered:?}");
@@ -4722,7 +4796,7 @@ mod tests {
#[test]
fn a_non_ascii_section_name_is_not_over_drawn() {
let rendered = content_trim_colored("# T\n\n## Résumé\nbody\n", &Resolved::default());
let rendered = content_trim("# T\n\n## Résumé\nbody\n", false, &Resolved::default());
assert!(rendered.starts_with("Résumé\n──────\n"), "{rendered:?}");
}
@@ -4730,7 +4804,7 @@ mod tests {
#[test]
fn the_body_leaves_the_title_to_cmd_show() {
let rendered =
content_trim_colored("# Only Once\n\n## Description\nbody\n", &Resolved::default());
content_trim("# Only Once\n\n## Description\nbody\n", false, &Resolved::default());
assert!(!rendered.contains("Only Once"), "{rendered:?}");
// And no gap where it was
@@ -4740,7 +4814,7 @@ mod tests {
#[test]
fn the_metadata_section_renders_as_a_table_inside_the_body() {
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n- **Owner**: alice\n";
let rendered = content_trim_colored(content, &Resolved::default());
let rendered = content_trim(content, false, &Resolved::default());
assert_eq!(rendered, "Metadata\n────────\n\nID abc\nOwner alice\n");
}
@@ -4853,7 +4927,7 @@ Plain line with **bold** and a [link](http://x.test/a).
#[test]
fn a_section_after_metadata_still_renders() {
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n\n## Notes\n\nafter\n";
let rendered = content_trim_colored(content, &Resolved::default());
let rendered = content_trim(content, false, &Resolved::default());
assert!(rendered.contains("ID abc"), "{rendered:?}");
assert!(rendered.contains("Notes\n─────\n"), "{rendered:?}");