Compare commits

...
3 Commits
Author SHA1 Message Date
Ansho ReiandClaude Opus 5 ce32b42ae4 (dbf7b61) Guard the overlay's relation colours, and bump to 0.15.0
The mechanism arrived with 6ce2c47, as this ticket said it would: the block is
laid out once as cells, the id carries the red the guideline gives a uuid, and
the board turns the same cells into spans. So the id is red in the overlay
without anything here asking the terminal for a decision, and the three
criteria about what is drawn were true the moment ece201e landed.

What was left is the test the ticket was really about. The naive version of
this, passing true to the body renderers, puts escapes in the paragraph and
draws them as literal bytes, which is 6d327df, and the tests that pin that
assert on content_trim rather than on what detail_of builds.

the_relation_id_is_red_in_the_overlay_and_no_escape_reached_the_body asserts
the id span is red, that something on the row is coloured at all, and that the
body holds no escape byte. The middle one is the pair the Color and Output rule
demands: without it a version that dropped every colour to stay safe would
satisfy the absence. The one character version now fails this test and two
others, checked by making the change and running the suite.

a_missing_target_still_reads_as_missing_in_the_overlay is the same question
asked of a gap: _missing_ in grey, the id still red, and the mark ? in grey
rather than the status orange, so a target the board no longer holds cannot be
dressed up as one it does.

And the decision the ticket asked for, in AGENTS.md: the relations block is the
only coloured part of the overlay body, on purpose. The block earned it by
being where a reader compares several references at once, and by arriving as
rows rather than prose. The rest of the body is e4d0bb7, which is a larger
change than it looks, since every run content_parts paints has to become a cell
while show's output stays byte for byte what it prints today. One coloured
section reads as a decision; two would read as a bug.

The minor is 6ce2c47's, taken here because the pair is one body of work: show
now prints a status mark before each relation id.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 15:23:55 +02:00
Ansho ReiandClaude Opus 5 ece201e3ab (6ce2c47) Mark each relation with the status of the ticket it names
The Relations block named each target and said nothing about where it was, so
the question actually asked of it, whether a blocker is finished, meant closing
the overlay and going to find the other ticket. Each row now carries a mark for
its target's status, ahead of the id, where it describes the target rather than
the row.

A rising bar, U+2581 through U+2588 for backlog to done, and ? for a target the
board no longer holds. Not a circle: the cards spend those on the priority
meter two cells from nothing at all, and another circle would be read as a
level. The ramp is also the meaning, so the shape says which status it is.

The colour could not. Every colour in the guideline already means one thing and
the eight tag slots are reserved, so four status colours could only have come
out of something else's meaning. So the shape carries the status and the colour
says only that it is one: orange, which is what Status already means, and grey
on the missing mark, beside the _missing_ that grey already spells. An
unrecognised status reads as missing rather than as a fifth stage, and
every_status_has_a_mark pins the pairing against status_dirs so a status added
later fails a test instead of quietly reading as ?.

The plain text was the real cost. Detail.text was one String drawn by a
Paragraph, deliberately uncoloured because an escape sequence there is drawn as
literal bytes, which is 6d327df. So the block cannot arrive pre-painted.
Resolved.relations is now rows, content_parts returns the body as
BodyPart::Text and BodyPart::Relations with the text painted and the rows
untouched, and the two renderers take it from there: content_trim paints the
rows into escapes, and the board styles the same cells as spans.

One builder, two painters. relation_rows decides which edges there are, what
they are called and which direction leads; relation_cells decides the layout,
the mark and the colours; paint_cells and span_of are the only things that
differ. Cell is the unit both take, the same shape the palette uses to stop a
colour existing for one renderer and not the other. reference_cells is now the
one spelling of a cross reference, shared with the Campaign field.

Detail.body is a ratatui Text and is the only thing measured, so last_offset
and the Paragraph cannot wrap the body two ways. Detail::plain() flattens it
for the suite and is cfg(test): a second representation carried beside the
spans is a second thing to disagree.

show carries the same mark, decided here rather than discovered later. The rows
are one builder so it was free, and two views disagreeing about what a relation
shows is a difference nobody can explain afterwards. That is a change to what
the CLI prints, so the minor goes on the last commit of this pair.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 15:20:56 +02:00
Ansho ReiandClaude Opus 5 c437d87e9e (2f3796e) Add a --tag filter to worklane ls, and bump to 0.14.0
Tickets carry a Tags field, but ls could not select on it: finding what is
tagged bug meant reading the board. Step 1 of the plan was already done by
e41802b, which put tags: Vec<String> on TicketItem through parse_tags, so this
is the flag, the filter and the tests.

Whole values, not the field. parse_tags has already split and trimmed the
comma-separated field, so filter_by_tag compares against those values: --tag
bug is not answered by a ticket tagged bugfix, --tag "cli, filter" matches
nothing because the field as written is not itself a tag, and a ticket with no
tags matches none, however it spells it.

Case sensitive, which is the opinion the field already takes everywhere else.
tag_color draws Bug and bug in two colours because they are two tags to the
field, and a filter that folded them would list tickets carrying a tag nobody
asked for while hiding exactly the split a grooming sweep is looking for.

One tag per invocation. Several would have to decide between and and or, and
that decision is its own ticket, along with substring or regex matching and a
tag filter on the board.

A tag nothing carries lists nothing rather than being refused, deliberately
the opposite of --campaign. A campaign is an object that exists or does not,
so it is resolved before anything is read; a tag is free text with no
registry, and refusing an unknown one would mean maintaining a vocabulary the
format does not have. An emptied status keeps the message ls already gives
rather than one per filter naming what excluded them, which is what --priority
and --campaign already do.

The filter goes through filtered, the one call the three collect sites share,
so the counts are filtered by the same set as the rows. Every filter is an
Option and none asked for keeps everything, which is what makes them compose
in any combination. cmd_ls is now at four filters and the directory, two of
them adjacent &Option<String> parameters a caller can swap silently: left as
positionals rather than refactored mid-feature, with AGENTS.md recording that
the next filter takes an LsArgs struct the way add took AddArgs.

assets/PLAN.md said in as many words that there was no tag filter yet, so it
would have been actively wrong. It now says what --tag can and cannot answer:
it finds what is tagged bug, it does not enumerate the vocabulary, which is
the question a grooming sweep starts from. The README's ls row also gained
--campaign, which had never been documented there.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 14:54:50 +02:00
14 changed files with 999 additions and 118 deletions
+24
View File
@@ -64,6 +64,15 @@ and this file is for what someone changing worklane's own code needs.
- **A paragraph break in a description is an empty `--description` value.** `cmd_add` joins the values with a single newline, so `-d "First." -d "" -d "Second."` writes the blank line. `trim_blank_ends()` drops blank values at either end, so a break never lands against a section heading, and an all-blank description reads as no description. Interior runs are kept verbatim rather than collapsed
- `--acceptance` and `--plan` are lists, one criterium or step per value, so a blank there is spacing rather than content and the opencode wrapper drops it. Only `--description` preserves blanks
### Filtering the Listing
- **The filters are one call, `filtered`,** because `ls` collects a column in three places (a named status, the counts, and the grouped listing) and three call sites are three chances to apply a different set. Every filter is an `Option` and none asked for keeps everything, which is what makes them compose in any combination without a rule per pair
- **`--tag` matches whole values, not the field.** `parse_tags` has already split the comma-separated field, so the filter compares against those trimmed values: `--tag bug` is not answered by a ticket tagged `bugfix`, and `--tag "cli, filter"` matches nothing, because the field as written is not itself a tag. A ticket with no tags matches none
- **Case sensitive**, the opinion the field already takes: `tag_color` draws `Bug` and `bug` in two colours because they are two tags. A filter that folded them would list tickets carrying a tag nobody asked for, and would hide exactly the split a grooming sweep is looking for
- **One tag per invocation.** Several would have to decide between and and or, and neither reading is obviously right for a board this size. That decision is its own ticket, along with a substring or regex match and a tag filter on the tui
- **A tag nothing carries lists nothing rather than being refused**, which is the opposite of `--campaign`. A campaign is an object that either exists or does not, so it is resolved before anything is read and an unknown one is an error. A tag is free text with no registry: there is nothing to resolve against, and refusing an unknown one would mean maintaining a vocabulary the format deliberately does not have. `assets/PLAN.md` tells the agent to check the spelling when a listing comes back empty, since that is the failure this trades for
- An emptied status keeps the message `ls` already gives, `No tickets in '<status>' status.`, rather than one per filter naming what excluded them. That is pre-existing behaviour for `--priority` and `--campaign`, and one message for every filter is the consistent half of it. If it should name the filter, that is a change to what the CLI prints for three flags at once and belongs in its own ticket
- **`cmd_ls` is now at the boundary the Rust Style rule names:** four filters and the directory. Two of them are adjacent `&Option<String>` parameters, which a caller can swap silently, so the next filter added here takes an `LsArgs` struct the way `add` took `AddArgs`, rather than a fifth positional
### Editing a Ticket
- `set` replaces a field, `append` adds to a section. The verb carries the meaning, so no flag needs a replace-or-append prefix, and `append` only offers the sections that hold multiple lines
- **One field, one writer.** `set` has no `--owner` (that is `chown`'s) and no `--status` (that is `mv`'s). Do not add either
@@ -192,6 +201,20 @@ and this file is for what someone changing worklane's own code needs.
- **It takes the whole footer row**, on a weaker reason than the prompt's: every key still works while a notice is up. It is that a message squeezed in beside the key list would move every key in it, and the row is the only part of the board that is not a ticket. Drawn after the prompt, which is an input and cannot be covered
- **The notice is cleared by the next keypress, not by a timer.** No clock on the board and no wakeup in the loop, and the moment the reader does anything else the message has been read or was never going to be. Doing nothing leaves it up, which is the one state where it is still worth reading. `Board::clear_notice` runs ahead of `search_key` as well as the arms, since a key typed into a query is still a key, and it must never move into `tick`: the board redraws four times a second and a notice cleared there would never be read
### The Relations Block
- **One builder, two painters.** `relation_rows` decides which edges there are, what they are called and which direction comes first; `relation_cells` decides the layout, the mark and the colours; `paint_cells` turns cells into escapes for the CLI and `span_of` turns the same cells into ratatui spans for the board. Two builders producing one block in two shapes is a pair free to disagree about ordering or padding, which is what this shape exists to prevent
- **`Cell` is the unit both renderers take**: a run of text and the colour it is drawn in, `None` for the default foreground. The same trick as the palette itself, where `Color::ansi()` and `From<Color> for ratatui::style::Color` keep one colour from existing for one renderer and not the other
- **`reference_cells` is the one spelling of a cross reference**, and `reference_cell` is it painted. The relations block and the Campaign field both go through it, so a dangling reference reads the same way wherever it is shown
- **The status mark is a rising bar, `▁▄▆█`, and `?` for a target the board does not hold.** Not a circle: the cards spend `●◐○·` on the priority meter and another circle would be read as a level. The ramp is also the meaning, backlog through done, so the shape says which status it is. Block Elements are the same bet every heading rule and every border on the board already makes
- **The mark goes ahead of the id**, where it describes the target rather than the row. Every row carries one, so nothing is pushed out of line the way the card's blocked mark would have been, which is why that one sits after the id and this one before it
- **An unrecognised status reads as missing, not as a stage of the flow.** The value comes from the directory the ticket was found in, so it is one of the four; guessing at a fifth would put a mark on a status nothing can act on. `every_status_has_a_mark` pins the pairing against `status_dirs`, so a status added later fails a test instead of silently reading as `?`
- **`show` and the board carry the same mark**, decided here rather than left to be discovered: the rows are one builder, so giving the CLI the mark cost nothing, and two views disagreeing about what a relation shows would be the kind of difference nobody can explain later. That makes it a change to what the CLI prints, so it is a minor
- **`Resolved.relations` is rows, not a rendered block.** That is what lets the board style them: an escape sequence in a ratatui paragraph is drawn as literal bytes (6d327df), so the block cannot arrive pre-painted. `content_parts` hands the text through already painted and the rows through untouched, which is the asymmetry the two renderers need
- **`BodyPart` splits the body rather than building it twice.** Everything outside the relations block is rendered once, by `content_parts`; `content_trim` is that with the rows painted, and the board is that with the rows styled. `Body` is the accumulator, so a caller pushes text and rows without tracking which it pushed last
- **`Detail.body` is a `Text`, and it is the only thing measured.** `last_offset` and the `Paragraph` both take it, so the clamp cannot wrap the body differently from the draw. `Detail::plain()` flattens it for the suite and is `#[cfg(test)]`: a second representation carried alongside the spans is a second thing to disagree
- `detail_body` closes a line only where the text says, so a part that does not end on a newline runs on into the next one. The seam between text and rows is wherever the body put it rather than wherever a part happened to end
- **The relations block is the only coloured part of the overlay body, and that is a decision, not an oversight.** The headings, the plan numbers, the criteria marks, the bold runs and the grey unset values are all painted by `show` and all flat on the board. The block earned its colour because it is where a reader compares several references at once, and because it was already data rather than prose: it arrives as rows for the status mark, so styling it cost nothing extra. Colouring the rest means giving every painted run in `content_parts` the `Cell` treatment, which is a much larger change with no reader's question behind it, and it is its own ticket. Do not paint one more section here without taking that on: two coloured sections and five plain ones reads as a bug, where one clearly does not
### Monitoring Several Boards
- `worklane tui <path>...` takes any number of paths, each resolved through `find_worklane_dir` the way the working directory is: the first `.worklane` at or above it. No path is the working directory, so a bare `worklane` and `worklane tui` are unchanged
- The failure **names the path** that had no board, since with several arguments "No .worklane directory found" does not say which one was wrong. Only when a path was given: a bare `worklane` has no path to name and keeps the message every other command gives, which is what its integration test asserts
@@ -243,6 +266,7 @@ and this file is for what someone changing worklane's own code needs.
- Title → green (32)
- Unknown values (`_None_`, `_Not set_`) → grey (38;5;8)
- Priority ramp → brightred (1), red (2), orange (3), cyan (4), grey (5). Green is deliberately absent: it means title
- Relation status mark → orange for all four statuses, grey for a target the board does not hold. **The shape carries which status it is and the colour only says that it is one**, because there is no colour left to spend: red is a uuid, green a title, cyan a timestamp, grey an unset value, and orange is what Status already means. Four new meanings would have had to come out of `TAG_COLORS`, which is reserved. Grey on the missing mark is the meaning grey already has, beside the `_missing_` it sits next to
- **The palette splits in two: seven colours that each mean one thing, and `TAG_COLORS`, the eight a tag may be drawn in.** A tag in red would read as a uuid, in green as a title, in grey as an unset value, so the tag slots are reserved as a list rather than picked at the call site. Do not assign a new meaning to a colour in `TAG_COLORS`, and do not draw a tag in one outside it
- `tag_color()` is a pure function of the tag string, so the same tag is the same colour on every card, in every view and on every board, with nothing stored. Case sensitive, because `Bug` and `bug` are two different tags to the field and to every search
- **The hash is FNV-1a written out here, not `DefaultHasher`.** std does not promise its output is stable across releases, and a board that repaints itself on a toolchain upgrade has lost the only property the mapping is for. `the_tag_mapping_is_pinned` fails on any change to it, so a repaint is a decision rather than a surprise
Generated
+1 -1
View File
@@ -1494,7 +1494,7 @@ dependencies = [
[[package]]
name = "worklane"
version = "0.13.7"
version = "0.15.0"
dependencies = [
"anyhow",
"assert_cmd",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "worklane"
version = "0.13.7"
version = "0.15.0"
edition = "2024"
[dependencies]
+1 -1
View File
@@ -8,7 +8,7 @@ Worklane is a local Kanban flow for agentic software development.
| `worklane` or `worklane tui [path...]` | Opens the board: four status columns, redrawn when the tree changes. Read only. Opens on backlog, committed and reviewing; `d` shows or hides done, whose count stays in the footer either way. Arrows or `hjkl` to move, `enter` for detail, `pgup`/`pgdn` to scroll an open ticket, `/` to jump to the first ticket whose id or title matches, `y` to copy the selected ticket's short id to the clipboard, `q` to quit. Each path opens the first `.worklane` at or above it, the working directory by default. Several paths are monitored together, as a tab per project plus an `all` tab that merges them, with `tab` and `shift+tab` between them |
| `worklane init` | Creates `.worklane/` with backlog, committed, reviewing, done directories |
| `worklane add` | Creates a ticket in backlog with `--title`, `--description`, `--acceptance`, `--plan`, `--tags`, `--due`, `--owner`, `--priority` flags. `--due` takes `YYYY-MM-DD` and refuses anything else at parse time |
| `worklane ls [status]` | Lists tickets, sorted by priority then title. Optional positional status, and `--priority <1-5>` |
| `worklane ls [status]` | Lists tickets, sorted by priority then title. Optional positional status, and `--priority <1-5>`, `--tag <tag>` and `--campaign <campaign>`, which compose in any combination. `--tag` matches a whole value of the comma-separated Tags field, case sensitively, so `--tag bug` does not list a ticket tagged `bugfix` or one tagged `Bug` |
| `worklane show <id>` | Shows ticket by UUID prefix (4+ chars), title substring, or filename substring |
| `worklane mv <id> --status <target> [-f]` | Moves ticket between statuses. Default: forward only, one stage at a time. `-f` bypasses both restrictions |
| `worklane set <ticket>` | Replaces fields with `--title`, `--description`, `--acceptance`, `--plan`, `--tags`, `--due`, `--priority`. At least one required. Changing the title renames the file, keeping the UUID |
+7 -4
View File
@@ -56,14 +56,17 @@ The last two rows are in the table to be recognised, not used. See the closing s
worklane ls # every status, counts then tickets
worklane ls backlog # one status
worklane ls --priority 1 # the top of the pile
worklane ls --tag bug # one tag's worth of the board
worklane show 1b78a24 # one ticket, with its relations and comments
worklane campaign ls # the goals that already exist
```
`ls` prints the mark, the id, the title, the owner and the due date. It does **not**
print tags, and there is no tag filter yet, so any judgement about tags means reading the
tickets themselves. On a board of a few dozen that is a `show` per ticket and is worth
doing rather than guessing from titles.
print tags, so the vocabulary itself still has to be read off the tickets: `--tag` answers
"what is tagged `bug`" and cannot answer "what tags exist", which is the question a
grooming sweep starts from. Count the vocabulary with a `show` per ticket, then use
`--tag` to check each candidate, and remember that `--tag` matches whole values case
sensitively: `bug` and `Bug` are two answers, which is exactly the split worth reporting.
Read `done` too when the question is about what to do next. What was finished last is the
best evidence of what this board actually moves at, and a plan that ignores it is a wish.
@@ -137,7 +140,7 @@ what is actually used, and show the count before proposing anything. What to rep
that will disagree with it. This board already made that mistake once with priority and
undid it deliberately.
- **An untagged ticket** in a board where everything else is tagged. It is invisible to
every question asked by tag.
every question asked by tag, `worklane ls --tag` included.
Tags are for kind, not for state and not for goal. State is the status directory and the
fields; a goal is a campaign.
+13
View File
@@ -41,11 +41,19 @@ A move is also refused while the ticket is blocked by one that is not done yet,
worklane ls # every status, counts then tickets
worklane ls backlog # one status
worklane ls --priority 1 # only the most urgent
worklane ls --tag bug # only the tickets carrying that tag
worklane show 1b78a24 # one ticket, body and comments
```
`ls` prints a seven-character id per ticket. That is what you address it by.
The filters compose in any combination, with each other and with the status positional:
`worklane ls backlog --tag bug --priority 1`. `--tag` takes one tag and matches it
against the whole values of the comma-separated `Tags` field, case sensitively, so
`--tag bug` finds neither a ticket tagged `bugfix` nor one tagged `Bug`. A ticket with no
tags matches none. A tag nothing carries lists nothing rather than failing, so when a
listing comes back empty check the spelling against a ticket you know is tagged.
## Working a ticket
```
@@ -133,6 +141,11 @@ Recording a relation the ticket already holds reports no change. A ticket cannot
to itself, and a target that later disappears shows as `_missing_` rather than silently
going away.
`show` marks each target with the status of the ticket it names, a rising bar from
backlog to done: `▁` backlog, `▄` committed, `▆` reviewing, `█` done, and `?` for a target the
board no longer holds. So whether a blocker is finished is readable off the row without a
second `show`. The board draws the same block.
## Campaigns
A campaign groups the tickets that have to be finished together: a release, a migration,
+1 -1
View File
@@ -179,7 +179,7 @@ pub fn campaign_cell(content: &str, index: &CampaignIndex, colored: bool) -> Str
/// rather than at each call site.
pub fn resolved_for(content: &str, worklane_dir: &Path, colored: bool) -> Result<Resolved> {
Ok(Resolved {
relations: relations_block(content, worklane_dir, colored)?,
relations: relations_for(content, worklane_dir)?,
campaign: campaign_cell(content, &CampaignIndex::load(worklane_dir)?, colored),
})
}
+4
View File
@@ -120,6 +120,10 @@ pub enum Command {
#[arg(long, value_parser = priority_level)]
priority: Option<u8>,
/// Only show tickets carrying this tag, matched whole
#[arg(long, value_parser = non_empty)]
tag: Option<String>,
/// Only show the members of this campaign, by UUID or title
#[arg(long, value_parser = non_empty)]
campaign: Option<String>,
+37 -5
View File
@@ -40,6 +40,7 @@ pub fn cmd_init(start: &Path) -> Result<()> {
pub fn cmd_ls(
status_filter: &Option<String>,
priority_filter: Option<u8>,
tag_filter: &Option<String>,
campaign_filter: &Option<String>,
worklane_dir: &Path,
) -> Result<()> {
@@ -50,6 +51,7 @@ pub fn cmd_ls(
None => None,
};
let uuid = campaign.as_ref().map(|campaign| campaign.uuid.as_str());
let tag = tag_filter.as_deref();
if let Some(campaign) = &campaign {
println!(
@@ -68,7 +70,7 @@ pub fn cmd_ls(
));
}
let items = filtered(collect_ticket_items(&status_path)?, priority_filter, uuid);
let items = filtered(collect_ticket_items(&status_path)?, priority_filter, uuid, tag);
if items.is_empty() {
println!("No tickets in '{}' status.", status);
@@ -86,7 +88,7 @@ pub fn cmd_ls(
if !status_path.exists() {
continue;
}
let items = filtered(collect_ticket_items(&status_path)?, priority_filter, uuid);
let items = filtered(collect_ticket_items(&status_path)?, priority_filter, uuid, tag);
let count = items.len();
let label = if count == 1 { "ticket" } else { "tickets" };
println!(" [{}] {} {}", status.to_uppercase(), count, label);
@@ -102,7 +104,7 @@ pub fn cmd_ls(
continue;
}
let items = match collect_ticket_items(&status_path) {
Ok(items) => filtered(items, priority_filter, uuid),
Ok(items) => filtered(items, priority_filter, uuid, tag),
Err(_) => continue,
};
if items.is_empty() {
@@ -119,8 +121,38 @@ pub fn cmd_ls(
/// The listing filters in one call, so the three places `ls` collects a column cannot
/// end up applying a different set of them.
fn filtered(items: Vec<TicketItem>, level: Option<u8>, campaign: Option<&str>) -> Vec<TicketItem> {
filter_by_campaign(filter_by_priority(items, level), campaign)
///
/// Every filter is `Option`, and none asked for is everything kept, which is what makes
/// them compose in any combination without a rule per pair.
fn filtered(
items: Vec<TicketItem>,
level: Option<u8>,
campaign: Option<&str>,
tag: Option<&str>,
) -> Vec<TicketItem> {
filter_by_tag(
filter_by_campaign(filter_by_priority(items, level), campaign),
tag,
)
}
/// Keep only the tickets carrying `tag`, or everything when none was asked for.
///
/// Matched against the whole values `parse_tags` split out of the field rather than as a
/// substring of it, so `--tag bug` is not answered by a ticket tagged `bugfix`, and a
/// ticket with no tags matches nothing at all.
///
/// Case sensitive, the opinion the field already takes everywhere else: `tag_color`
/// draws `Bug` and `bug` in two colours because they are two tags, and a filter that
/// folded them would list tickets carrying a tag nobody asked for.
fn filter_by_tag(items: Vec<TicketItem>, tag: Option<&str>) -> Vec<TicketItem> {
match tag {
Some(tag) => items
.into_iter()
.filter(|item| item.tags.iter().any(|carried| carried == tag))
.collect(),
None => items,
}
}
/// Keep only the members of `campaign`, or everything when none was asked for.
+2 -1
View File
@@ -49,10 +49,11 @@ fn main() -> Result<()> {
Some(Command::Ls {
status,
priority,
tag,
campaign,
}) => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_ls(&status, priority, &campaign, &worklane_dir)
cmd_ls(&status, priority, &tag, &campaign, &worklane_dir)
}
Some(Command::Show { id }) => {
let worklane_dir = find_worklane_dir(&start)?;
+348 -34
View File
@@ -16,7 +16,7 @@ use anyhow::{Context, Result};
use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
use ratatui::layout::{Constraint, Direction, Layout, Margin, Rect, Size};
use ratatui::style::{Modifier, Style};
use ratatui::text::{Line, Span};
use ratatui::text::{Line, Span, Text};
use ratatui::widgets::{Block, Borders, Clear, Paragraph, Tabs, Wrap};
use ratatui::Frame;
@@ -202,7 +202,35 @@ pub struct Detail {
/// card that said so, and the id alone is not an address across several boards:
/// acting on the ticket means knowing which project to run the command in.
pub project: Option<String>,
pub text: String,
/// The body as the overlay draws it: lines of styled spans, not a string.
///
/// Styled here rather than painted into the text, because ratatui draws an escape
/// sequence in a paragraph as literal bytes, which is 6d327df. It is also the one
/// value the clamp and the draw both measure, so neither can wrap it differently
/// from the other.
pub body: Text<'static>,
}
impl Detail {
/// The body as plain text, one line per drawn line.
///
/// Only the suite asks: it is what an assertion about the body reads, and what shows
/// that no escape sequence reached it. Nothing in the draw path needs it, so it is
/// not carried alongside the spans where the two could disagree.
#[cfg(test)]
pub fn plain(&self) -> String {
self.body
.lines
.iter()
.map(|line| {
line.spans
.iter()
.map(|span| span.content.as_ref())
.collect::<String>()
})
.collect::<Vec<String>>()
.join("\n")
}
}
/// The open search prompt: what has been typed, and whether the last enter missed.
@@ -702,7 +730,7 @@ impl Board {
let text = detail_text_area(Rect::new(0, 0, screen.width, screen.height));
// A screenful less a line, so the eye has something to land on after the jump.
let step = text.height.saturating_sub(1).max(1) as isize;
let last = last_offset(&detail.text, text) as isize;
let last = last_offset(&detail.body, text) as isize;
self.offset = (self.offset as isize + pages.saturating_mul(step)).clamp(0, last) as u16;
}
@@ -744,15 +772,73 @@ fn detail_of(card: &Card) -> Detail {
None => Vec::new(),
};
let mut out = content_trim(&content, false, &resolved);
// Colour off for the text, which is what keeps escapes out of the paragraph, and the
// relations arrive as rows so the board can style them itself.
let mut parts = content_parts(&content, false, &resolved);
parts.push(BodyPart::Text(format!(
"\n{}",
format_comments_with(&comments, false)
)));
out.push('\n');
out.push_str(&format_comments_with(&comments, false));
Detail {
title: ticket.title.clone(),
id: ticket.id.clone(),
project: card.project.clone(),
text: out,
body: detail_body(&parts),
}
}
/// The rendered body as lines of spans: the text split where it says, and each relation
/// row styled from the cells the CLI paints.
///
/// A part that does not end on a newline runs on into the next one rather than closing a
/// line, so the seam between text and relations is wherever the body actually put it and
/// not wherever a part happened to end.
fn detail_body(parts: &[BodyPart]) -> Text<'static> {
let mut lines: Vec<Line<'static>> = Vec::new();
let mut open: Vec<Span<'static>> = Vec::new();
for part in parts {
match part {
BodyPart::Text(text) => {
let mut rest = text.as_str();
while let Some((line, tail)) = rest.split_once('\n') {
if !line.is_empty() {
open.push(Span::raw(line.to_string()));
}
lines.push(Line::from(std::mem::take(&mut open)));
rest = tail;
}
if !rest.is_empty() {
open.push(Span::raw(rest.to_string()));
}
}
// One line each, from the same cells `render_relations` paints, so the block
// cannot read differently here than it does in `show`.
BodyPart::Relations(rows) => {
for row in relation_cells(rows) {
open.extend(row.into_iter().map(span_of));
lines.push(Line::from(std::mem::take(&mut open)));
}
}
}
}
if !open.is_empty() {
lines.push(Line::from(open));
}
Text::from(lines)
}
/// A cell as the board draws it: the same text in the same colour, as a span.
///
/// The other half of `paint_cells`, which is the CLI's. `From<Color>` is what makes the
/// two agree about what the colour is.
fn span_of(cell: Cell) -> Span<'static> {
match cell.color {
Some(color) => Span::styled(cell.text, Style::default().fg(color.into())),
None => Span::raw(cell.text),
}
}
@@ -1571,8 +1657,8 @@ fn detail_text_area(area: Rect) -> Rect {
/// Measured by the widget rather than counted by hand, since it wraps on words. A clamp
/// on the raw lines would stop short of the end on a wrapped ticket, and one that
/// ignored the wrapping the other way would scroll past it into blank space.
fn last_offset(detail: &str, text: Rect) -> u16 {
let wrapped = Paragraph::new(detail)
fn last_offset(detail: &Text<'static>, text: Rect) -> u16 {
let wrapped = Paragraph::new(detail.clone())
.wrap(Wrap { trim: false })
.line_count(text.width);
@@ -1586,7 +1672,7 @@ fn draw_detail(frame: &mut Frame, detail: &Detail, offset: u16, area: Rect) {
// Clamped here as well as on the keypress: the terminal may have been resized since,
// and a ticket read to its end can grow shorter under a tick.
let offset = offset.min(last_offset(&detail.text, detail_text_area(area)));
let offset = offset.min(last_offset(&detail.body, detail_text_area(area)));
let block = Block::default()
.borders(Borders::ALL)
@@ -1598,7 +1684,7 @@ fn draw_detail(frame: &mut Frame, detail: &Detail, offset: u16, area: Rect) {
frame.render_widget(Clear, overlay);
frame.render_widget(
Paragraph::new(detail.text.to_string())
Paragraph::new(detail.body.clone())
.block(block)
.wrap(Wrap { trim: false })
.scroll((offset, 0)),
@@ -2571,16 +2657,16 @@ mod tests {
board.toggle_detail();
let detail = board.detail.as_ref().expect("no detail");
assert!(detail.text.contains("A description."), "{}", detail.text);
assert!(detail.text.contains("Crit one"), "{}", detail.text);
assert!(detail.text.contains("A note from elsewhere."), "{}", detail.text);
assert!(detail.text.contains("bob"), "{}", detail.text);
assert!(detail.plain().contains("A description."), "{}", detail.plain());
assert!(detail.plain().contains("Crit one"), "{}", detail.plain());
assert!(detail.plain().contains("A note from elsewhere."), "{}", detail.plain());
assert!(detail.plain().contains("bob"), "{}", detail.plain());
// Plain text, since ratatui would print an escape as literal bytes
assert!(
!detail.text.contains('\x1b'),
!detail.plain().contains('\x1b'),
"escapes reached the detail view: {:?}",
detail.text
detail.plain()
);
board.toggle_detail();
@@ -2605,7 +2691,7 @@ mod tests {
// The heading stays out of the text: `show` prints it and here the border
// carries it, so it is on screen once rather than twice.
assert!(
!board.detail.as_ref().unwrap().text.contains("First one"),
!board.detail.as_ref().unwrap().plain().contains("First one"),
"{:?}",
board.detail
);
@@ -2670,7 +2756,7 @@ mod tests {
let mut board = one_board(&dir);
board.toggle_detail();
assert!(!board.detail.as_ref().unwrap().text.contains("A late note."));
assert!(!board.detail.as_ref().unwrap().plain().contains("A late note."));
let comments = dir.join("comments").join(uuid);
std::fs::create_dir_all(&comments).unwrap();
@@ -2682,7 +2768,7 @@ mod tests {
assert!(board.tick().unwrap(), "the tick saw no change");
assert!(
board.detail.as_ref().unwrap().text.contains("A late note."),
board.detail.as_ref().unwrap().plain().contains("A late note."),
"{:?}",
board.detail
);
@@ -2809,7 +2895,7 @@ mod tests {
// By id in the text: the heading is stripped from the body, and the title
// travels beside it for the block title instead.
assert!(
board.detail.as_ref().unwrap().text.contains("11111111"),
board.detail.as_ref().unwrap().plain().contains("11111111"),
"{:?}",
board.detail
);
@@ -2817,7 +2903,7 @@ mod tests {
board.select_card(1, SCREEN);
assert_eq!(selected_title(&board), Some("Beta".to_string()));
assert!(
board.detail.as_ref().unwrap().text.contains("22222222"),
board.detail.as_ref().unwrap().plain().contains("22222222"),
"{:?}",
board.detail
);
@@ -3299,7 +3385,7 @@ mod tests {
let mut board = one_board(&dir);
board.toggle_detail();
assert!(
board.detail.as_ref().unwrap().text.contains("11111111"),
board.detail.as_ref().unwrap().plain().contains("11111111"),
"{:?}",
board.detail
);
@@ -3310,7 +3396,7 @@ mod tests {
let detail = board.detail.as_ref().expect("the overlay closed on a jump");
assert_eq!(detail.title, "Gamma third");
assert!(detail.text.contains("33333333"), "{detail:?}");
assert!(detail.plain().contains("33333333"), "{detail:?}");
}
/// With no prompt open the keyboard belongs to the action arms, so `search_key` has
@@ -4007,9 +4093,9 @@ mod tests {
_ => "22222222",
};
assert!(
detail.text.contains(uuid),
detail.plain().contains(uuid),
"the overlay opened another project's ticket: {project} {:?}",
detail.text
detail.plain()
);
let screen = render(&board, SCREEN.width, SCREEN.height);
@@ -4020,7 +4106,7 @@ mod tests {
board.select_card(1, SCREEN);
let moved = board.detail.as_ref().expect("no detail");
assert_ne!(moved.project, Some(project), "the modal stayed on one project");
assert!(!moved.text.contains(uuid), "{:?}", moved.text);
assert!(!moved.plain().contains(uuid), "{:?}", moved.plain());
}
/// The board and the listing draw from the same palette, so a colour cannot exist
@@ -4037,6 +4123,233 @@ mod tests {
/// The style of the first cell drawing `symbol`, so a test can ask what colour a
/// glyph actually reached the screen in rather than trusting the span it was built
/// from.
fn drawn_color(
board: &Board,
width: u16,
height: u16,
symbol: char,
) -> Option<ratatui::style::Color> {
let mut terminal = Terminal::new(TestBackend::new(width, height)).unwrap();
terminal.draw(|frame| draw(frame, board)).unwrap();
let buffer = terminal.backend().buffer().clone();
(0..buffer.area.height)
.flat_map(|y| (0..buffer.area.width).map(move |x| (x, y)))
.find(|(x, y)| buffer[(*x, *y)].symbol() == symbol.to_string())
.map(|(x, y)| buffer[(x, y)].fg)
}
/// A board holding one relation, so the tests below have a block to look at.
///
/// The section goes where `relate` writes it, ahead of the metadata, rather than in
/// `write_ticket`'s trailer: the block has to be on screen for a test to read the
/// colour off the drawn buffer.
fn related_board() -> PathBuf {
let dir = board_dir();
let holder = "11111111-0000-4000-8000-000000000000";
let target = "22222222-0000-4000-8000-000000000000";
std::fs::write(
dir.join("backlog").join(format!("{holder}_a-holder.md")),
format!(
"# A holder\n\n## Description\nA description.\n\n## Relations\n\
- blocked by {target}\n\n## Metadata\n\n- **ID**: {holder}\n\
- **Priority**: 2\n- **Status**: backlog\n"
),
)
.unwrap();
write_ticket(&dir, "reviewing", target, "The target", "");
dir
}
/// The mark is a ratatui style, not an escape sequence in the body. Passing `true`
/// to the body renderers would put `\x1b[33m` in the paragraph and draw it as literal
/// bytes, which is 6d327df; this asserts the colour arrived and the escape did not.
#[test]
fn the_relation_mark_is_drawn_as_a_style_and_not_as_an_escape() {
let dir = related_board();
let mut board = one_board(&dir);
board.toggle_detail();
let (mark, colour) = status_mark(Some("reviewing"));
let detail = board.detail.as_ref().expect("no detail");
assert!(
detail.plain().contains(mark),
"the target's mark is not in the body: {:?}",
detail.plain()
);
assert!(
!detail.plain().contains('\x1b'),
"an escape reached the body: {:?}",
detail.plain()
);
assert_eq!(
drawn_color(&board, SCREEN.width, SCREEN.height, mark),
Some(colour.into()),
"the mark was drawn without its colour"
);
}
/// One layout, two painters. The overlay draws the block from the same cells the CLI
/// paints, so the two views cannot come to list different edges in a different order
/// or pad them differently.
#[test]
fn the_overlay_and_the_listing_draw_the_same_block() {
let dir = related_board();
let mut board = one_board(&dir);
board.toggle_detail();
let content = std::fs::read_to_string(
board.selected().expect("no selection").ticket.path.clone(),
)
.unwrap();
let rows = relations_for(&content, &dir).unwrap();
let printed = render_relations(&rows, false);
assert!(!printed.is_empty(), "the fixture has no relations");
assert!(
board.detail.as_ref().unwrap().plain().contains(printed.trim_end()),
"the overlay drew a different block than the listing prints: {printed:?}"
);
}
/// The body is no longer one string, so the clamp and the draw could measure two
/// different things. They take the same `Text`, and this is what says so: a ticket
/// whose relations run past the overlay scrolls to its last row.
#[test]
fn the_scroll_measures_the_relations_block_with_the_rest_of_the_body() {
let dir = board_dir();
let holder = "11111111-0000-4000-8000-000000000000";
let mut relations = String::from("\n## Relations\n");
for n in 0..20 {
let target = format!("2222222{n:x}-0000-4000-8000-000000000000");
relations.push_str(&format!("- blocked by {target}\n"));
write_ticket(&dir, "done", &target, &format!("Target {n:02}"), "");
}
write_ticket(&dir, "backlog", holder, "A holder", &relations);
let mut board = one_board(&dir);
board.toggle_detail();
let area = detail_text_area(Rect::new(0, 0, SCREEN.width, SCREEN.height));
let last = last_offset(&board.detail.as_ref().unwrap().body, area);
assert!(last > 0, "the fixture fits on one screen, so nothing is measured");
// Far past the end, so the clamp is what stops it.
for _ in 0..20 {
board.scroll_detail(1, SCREEN);
}
assert_eq!(board.offset, last, "the clamp and the body disagree");
// The relations sit at the end of this fixture, so the last row and the comments
// line are what the last screenful has to hold.
let screen = render(&board, SCREEN.width, SCREEN.height).join("\n");
assert!(
screen.contains("Target 19"),
"the last relation is not on screen:\n{screen}"
);
assert!(
screen.contains("No comments yet."),
"the body ends past the last screenful:\n{screen}"
);
}
/// The line of the body carrying `needle`, so a test can ask what colour a run of it
/// is drawn in rather than reading the flattened text.
fn body_line(detail: &Detail, needle: &str) -> Line<'static> {
detail
.body
.lines
.iter()
.find(|line| {
line.spans
.iter()
.map(|span| span.content.as_ref())
.collect::<String>()
.contains(needle)
})
.cloned()
.unwrap_or_else(|| panic!("no line holding {needle:?} in:\n{}", detail.plain()))
}
/// The colour of the span whose whole content is `text`, on that line.
fn span_color(line: &Line<'static>, text: &str) -> Option<ratatui::style::Color> {
line.spans
.iter()
.find(|span| span.content.as_ref() == text)
.map(|span| span.style.fg)
.unwrap_or_else(|| panic!("no span {text:?} in {line:?}"))
}
/// A short id is red everywhere the CLI prints one, and the overlay was the one place
/// it was not: the body arrived as flat text because a paragraph is no place for an
/// escape. It is styled now, so the guideline holds in both views.
///
/// Paired the way the guideline demands. The absence, no escape byte in the body,
/// cannot pass on its own: a version that dropped every colour to stay safe would
/// satisfy it, so the presence is asserted beside it. And the one character version
/// of this, passing `true` to the body renderers, fails the absence.
#[test]
fn the_relation_id_is_red_in_the_overlay_and_no_escape_reached_the_body() {
let dir = related_board();
let mut board = one_board(&dir);
board.toggle_detail();
let detail = board.detail.as_ref().expect("no detail");
let row = body_line(detail, "blocked by");
assert_eq!(
span_color(&row, "2222222"),
Some(Color::Red.into()),
"the target's id is not red: {row:?}"
);
// The pair: colour arrived, and it arrived as a style rather than as bytes.
assert!(
row.spans.iter().any(|span| span.style.fg.is_some()),
"nothing on the row is coloured at all, so the guard below is vacuous"
);
assert!(
!detail.plain().contains('\x1b'),
"escapes reached the body: {:?}",
detail.plain()
);
}
/// A target the board no longer holds keeps the id, which is the only thing left to
/// go looking for, and says `_missing_` in the grey that means an unset value. The
/// colour must not turn a gap into something that reads like a real target.
#[test]
fn a_missing_target_still_reads_as_missing_in_the_overlay() {
let dir = board_dir();
let holder = "11111111-0000-4000-8000-000000000000";
std::fs::write(
dir.join("backlog").join(format!("{holder}_a-holder.md")),
format!(
"# A holder\n\n## Relations\n- blocked by 99999999-0000-4000-8000-000000000000\n\
\n## Metadata\n\n- **ID**: {holder}\n- **Status**: backlog\n"
),
)
.unwrap();
let mut board = one_board(&dir);
board.toggle_detail();
let detail = board.detail.as_ref().expect("no detail");
let row = body_line(detail, "blocked by");
assert_eq!(span_color(&row, "_missing_"), Some(Color::Grey.into()));
assert_eq!(
span_color(&row, "9999999"),
Some(Color::Red.into()),
"the id went with the title it could not find"
);
// `?` rather than a stage of the flow, in grey rather than the status orange.
assert_eq!(span_color(&row, "?"), Some(Color::Grey.into()));
}
/// The detail view is the second renderer of a ticket body, so it resolves a
/// relation the way `show` does rather than printing the uuid the file stores.
///
@@ -4058,8 +4371,9 @@ mod tests {
let mut board = one_board(&dir);
board.toggle_detail();
let text = &board.detail.as_ref().expect("no detail").text;
assert!(text.contains("blocked by (2222222) The target"), "{text:?}");
let text = &board.detail.as_ref().expect("no detail").plain();
// Marked with the target's status, backlog, and the mark sits ahead of the id.
assert!(text.contains("blocked by \u{2581} (2222222) The target"), "{text:?}");
assert!(!text.contains(target), "the bare uuid was drawn: {text:?}");
}
@@ -4082,8 +4396,8 @@ mod tests {
board.select_card(1, SCREEN);
board.toggle_detail();
let text = &board.detail.as_ref().expect("no detail").text;
assert!(text.contains("blocks (1111111) A holder"), "{text:?}");
let text = &board.detail.as_ref().expect("no detail").plain();
assert!(text.contains("blocks \u{2581} (1111111) A holder"), "{text:?}");
}
/// The detail view resolves the Campaign field the way `show` does. The field stores
@@ -4109,7 +4423,7 @@ mod tests {
let mut board = one_board(&dir);
board.toggle_detail();
let text = &board.detail.as_ref().expect("no detail").text;
let text = &board.detail.as_ref().expect("no detail").plain();
assert!(text.contains("(ccccccc) v1 release"), "{text:?}");
assert!(!text.contains(campaign), "the bare uuid reached the screen: {text:?}");
}
@@ -4130,7 +4444,7 @@ mod tests {
let mut board = one_board(&dir);
board.toggle_detail();
let text = &board.detail.as_ref().expect("no detail").text;
let text = &board.detail.as_ref().expect("no detail").plain();
assert!(text.contains("A description."), "the body was lost: {text:?}");
// No campaigns to resolve against, so the reference reads as gone.
assert!(text.contains("_missing_"), "{text:?}");
@@ -4152,7 +4466,7 @@ mod tests {
let mut board = one_board(&dir);
board.toggle_detail();
let text = &board.detail.as_ref().expect("no detail").text;
let text = &board.detail.as_ref().expect("no detail").plain();
assert!(text.contains("A description."), "the body was lost: {text:?}");
}
}
+354 -66
View File
@@ -539,8 +539,12 @@ pub fn format_comments_with(
/// an edit at every call site.
#[derive(Default)]
pub struct Resolved {
/// The block [`render_relations`] built, or empty for a ticket with no relations.
pub relations: String,
/// The relations of the ticket, both directions, from [`relations_for`]. Empty for a
/// ticket with none at either end.
///
/// Rows rather than the rendered block: the CLI paints them into escapes and the
/// board styles the same rows itself, since a paragraph is no place for an escape.
pub relations: Vec<RelationRow>,
/// The Campaign value as it reads, from [`reference_cell`]. Empty leaves the stored
/// value to render as it sits, which is what a ticket in no campaign wants.
pub campaign: String,
@@ -555,7 +559,7 @@ pub fn content_trim_colored(content: &str, resolved: &Resolved) -> String {
/// The rule is measured on the name as displayed, in characters. It used to span the
/// raw line, so it ran three past the heading for the `## `, and byte length over-drew
/// anything non-ASCII.
fn push_heading(out: &mut String, heading: &str, colored: bool) {
fn push_heading(out: &mut Body, heading: &str, colored: bool) {
let name = heading.strip_prefix("## ").unwrap_or(heading);
out.push_str(&paint(name, Color::Orange, colored));
@@ -572,10 +576,70 @@ fn push_heading(out: &mut String, heading: &str, colored: bool) {
///
/// [`Resolved`] carries the parts that come from elsewhere on the board, since the
/// body alone cannot render them.
/// One piece of the rendered body: text as it prints, or relations still as rows.
///
/// The body is one string to the CLI and a run of styled lines to the board, and the
/// only part that differs is the relations block. Splitting the body here rather than
/// building it twice is what keeps the two views from drifting: everything outside the
/// block is rendered once, by [`content_parts`], and the rows are handed on unpainted.
pub enum BodyPart {
Text(String),
Relations(Vec<RelationRow>),
}
/// The body under construction. Text accumulates into the trailing run, and a relations
/// block closes it, so a caller pushes text and rows without tracking which it pushed
/// last.
#[derive(Default)]
struct Body {
parts: Vec<BodyPart>,
}
impl Body {
fn push_str(&mut self, text: &str) {
match self.parts.last_mut() {
Some(BodyPart::Text(run)) => run.push_str(text),
_ => self.parts.push(BodyPart::Text(text.to_string())),
}
}
fn push(&mut self, c: char) {
match self.parts.last_mut() {
Some(BodyPart::Text(run)) => run.push(c),
_ => self.parts.push(BodyPart::Text(c.to_string())),
}
}
fn push_relations(&mut self, rows: &[RelationRow]) {
self.parts.push(BodyPart::Relations(rows.to_vec()));
}
/// Whether the text written so far ends with `suffix`. A relations block never does,
/// since it is not text yet.
fn ends_with(&self, suffix: &str) -> bool {
match self.parts.last() {
Some(BodyPart::Text(run)) => run.ends_with(suffix),
_ => false,
}
}
}
pub fn content_trim(content: &str, colored: bool, resolved: &Resolved) -> String {
let relations = resolved.relations.as_str();
content_parts(content, colored, resolved)
.iter()
.map(|part| match part {
BodyPart::Text(text) => text.clone(),
BodyPart::Relations(rows) => render_relations(rows, colored),
})
.collect()
}
/// The body rendered into its parts, with the colour decision already applied to the
/// text and deliberately not to the relations.
pub fn content_parts(content: &str, colored: bool, resolved: &Resolved) -> Vec<BodyPart> {
let relations = resolved.relations.as_slice();
let lines: Vec<&str> = content.trim().lines().collect();
let mut result = String::new();
let mut result = Body::default();
let mut current_section = "";
let mut criterion = 0;
let mut i = 0;
@@ -598,7 +662,7 @@ pub fn content_trim(content: &str, colored: bool, resolved: &Resolved) -> String
// after everything.
if is_metadata_heading(line) && !stores_relations && !relations.is_empty() {
push_heading(&mut result, RELATIONS.heading, colored);
result.push_str(relations);
result.push_relations(relations);
result.push('\n');
shown_relations = true;
}
@@ -622,7 +686,7 @@ pub fn content_trim(content: &str, colored: bool, resolved: &Resolved) -> String
// holds the same edges resolved to a title, and the inverses with them.
if line.trim_end() == RELATIONS.heading && !relations.is_empty() {
let end = section_end(&lines, i);
result.push_str(relations);
result.push_relations(relations);
// The blank line the skipped body ended with, before the next heading.
if end < lines.len() {
result.push('\n');
@@ -705,10 +769,10 @@ pub fn content_trim(content: &str, colored: bool, resolved: &Resolved) -> String
result.push('\n');
}
push_heading(&mut result, RELATIONS.heading, colored);
result.push_str(relations);
result.push_relations(relations);
}
result
result.parts
}
/// Colour the `1.` at the head of a numbered line, leaving the rest alone.
@@ -1640,86 +1704,222 @@ impl RelationIndex {
/// relations block and the Campaign field, so a dangling reference is spelled one way
/// wherever it is shown.
pub fn reference_cell(uuid: &str, name: Option<&str>, colored: bool) -> String {
let id = paint(short_id(uuid), Color::Red, colored);
paint_cells(&reference_cells(uuid, name), colored)
}
/// The same cross reference in cells, for a renderer that is not writing escapes.
///
/// The one spelling of a reference, so the relations block and the Campaign field cannot
/// come to say a dangling one differently, and the board draws the id in the colour the
/// guideline gives it rather than dropping every colour to stay safe.
pub fn reference_cells(uuid: &str, name: Option<&str>) -> Vec<Cell> {
let mut cells = vec![
Cell::plain("("),
Cell::colored(short_id(uuid), Color::Red),
Cell::plain(") "),
];
match name {
Some(name) => format!("({}) {}", id, name),
None => format!("({}) {}", id, paint("_missing_", Color::Grey, colored)),
Some(name) => cells.push(Cell::plain(name)),
None => cells.push(Cell::colored("_missing_", Color::Grey)),
}
cells
}
/// Cells as the CLI prints them: each one painted, or carried through as it stands.
pub fn paint_cells(cells: &[Cell], colored: bool) -> String {
cells
.iter()
.map(|cell| match cell.color {
Some(color) => paint(&cell.text, color, colored),
None => cell.text.clone(),
})
.collect()
}
/// The glyph and colour for the status of a relation's target.
///
/// A rising bar rather than a circle: the cards spend `\u{25cf}`, `\u{25d0}`, `\u{25cb}` and `\u{b7}` on the
/// priority meter, and another circle here would be read as one of those. The ramp is
/// also the meaning, backlog through done, so the shape says which status it is and the
/// colour only says that it is one. Block Elements are the same bet every heading rule
/// and every border on the board already makes.
///
/// One colour for all four, because the palette has none to spare: red is a uuid, green
/// a title, cyan a timestamp, grey an unset value, and orange is what Status already
/// means. Grey and `?` for a target the board does not hold, beside the `_missing_` that
/// grey already spells.
const STATUS_MARKS: [(&str, char); 4] = [
("backlog", '\u{2581}'),
("committed", '\u{2584}'),
("reviewing", '\u{2586}'),
("done", '\u{2588}'),
];
/// The mark for a status, or the missing mark for a target the board no longer holds.
///
/// An unrecognised status reads as missing rather than as a stage of the flow: the value
/// comes from the directory the ticket was found in, so it is one of the four, and
/// guessing at a fifth would put a mark on a status nothing can act on.
/// `every_status_has_a_mark` pins the pairing against `status_dirs`.
pub fn status_mark(status: Option<&str>) -> (char, Color) {
let found = status.and_then(|status| {
STATUS_MARKS
.iter()
.find(|(name, _)| *name == status)
.map(|(_, mark)| *mark)
});
match found {
Some(mark) => (mark, Color::Orange),
None => ('?', Color::Grey),
}
}
/// A relation's target as it reads.
fn target_cell(target: Option<&RelatedTicket>, uuid: &str, colored: bool) -> String {
reference_cell(uuid, target.map(|ticket| ticket.title.as_str()), colored)
/// One row of the Relations block: which relation, and what it points at.
///
/// The target is `None` for a uuid the board no longer holds, which is the one case that
/// has neither a title nor a status to show.
#[derive(Clone, Debug)]
pub struct RelationRow {
pub label: &'static str,
pub uuid: String,
pub target: Option<RelationTarget>,
}
/// The Relations section as it is shown, or empty when there is nothing to show.
/// What a relation points at, once the board has been read for it.
#[derive(Clone, Debug)]
pub struct RelationTarget {
pub title: String,
pub status: String,
}
/// A run of text and the colour it is drawn in, or `None` for the default foreground.
///
/// Both directions, stored first: the relations the ticket holds, then the ones held
/// against it, named from this end. Rendered from the index rather than from the body
/// alone, because a bare uuid says nothing and half the relations are not in the file.
pub fn render_relations(
stored: &[Relation],
index: &RelationIndex,
uuid: &str,
colored: bool,
) -> String {
let mut rows: Vec<(&'static str, String)> = stored
/// The unit both renderers take: [`paint`] turns one into an escape sequence for the
/// CLI, and the board turns the same one into a ratatui `Span`. A block laid out once
/// and painted twice cannot draw two different blocks.
#[derive(Clone, Debug)]
pub struct Cell {
pub text: String,
pub color: Option<Color>,
}
impl Cell {
fn plain(text: impl Into<String>) -> Self {
Cell {
text: text.into(),
color: None,
}
}
fn colored(text: impl Into<String>, color: Color) -> Self {
Cell {
text: text.into(),
color: Some(color),
}
}
}
/// The relations of one ticket, both directions, in the order they are shown.
///
/// Stored first: the relations the ticket holds, then the ones held against it, named
/// from this end. Read from the index rather than from the body alone, because a bare
/// uuid says nothing and half the relations are not in the file.
///
/// The single builder. Everything that shows a relation goes through these rows, so the
/// CLI and the board cannot disagree about which edges there are, what they are called
/// or which direction comes first.
pub fn relation_rows(stored: &[Relation], index: &RelationIndex, uuid: &str) -> Vec<RelationRow> {
let target_of = |ticket: Option<&RelatedTicket>| {
ticket.map(|ticket| RelationTarget {
title: ticket.title.clone(),
status: ticket.status.clone(),
})
};
let mut rows: Vec<RelationRow> = stored
.iter()
.map(|relation| {
(
relation.kind.label(),
target_cell(index.get(&relation.target), &relation.target, colored),
)
.map(|relation| RelationRow {
label: relation.kind.label(),
uuid: relation.target.clone(),
target: target_of(index.get(&relation.target)),
})
.collect();
rows.extend(index.inbound(uuid).into_iter().map(|(kind, holder)| {
(
kind.inverse_label(),
target_cell(Some(holder), &holder.uuid, colored),
)
RelationRow {
label: kind.inverse_label(),
uuid: holder.uuid.clone(),
target: target_of(Some(holder)),
}
}));
if rows.is_empty() {
return String::new();
}
rows
}
// Measured on the labels, which carry no colour, and padded before the target cell
// is joined on, for the reason the metadata table is: an escape sequence counted
// towards a width tilts the column the moment colour is on.
/// The Relations block laid out: one row of cells per relation, or nothing to show.
///
/// The layout lives here rather than in each renderer, so the mark, the padding and the
/// gutter are decided once. The labels are measured with no colour on them and padded
/// before the target is joined, for the reason the metadata table is: an escape sequence
/// counted towards a width tilts the column the moment colour is on.
pub fn relation_cells(rows: &[RelationRow]) -> Vec<Vec<Cell>> {
let width = rows
.iter()
.map(|(label, _)| label.chars().count())
.map(|row| row.label.chars().count())
.max()
.unwrap_or(0);
rows.iter()
.map(|row| {
let (mark, colour) = status_mark(row.target.as_ref().map(|target| target.status.as_str()));
let padding = " ".repeat(width - row.label.chars().count());
// The mark goes ahead of the id, where it describes the target rather than
// the row: every row carries one, so nothing is pushed out of line the way
// the card's blocked mark would have been.
let mut cells = vec![
Cell::plain(format!("{}{}{}", row.label, padding, COLUMN_GUTTER)),
Cell::colored(mark.to_string(), colour),
Cell::plain(" "),
];
cells.extend(reference_cells(
&row.uuid,
row.target.as_ref().map(|target| target.title.as_str()),
));
cells
})
.collect()
}
/// The Relations section as the CLI prints it, or empty when there is nothing to show.
pub fn render_relations(rows: &[RelationRow], colored: bool) -> String {
let mut out = String::new();
for (label, cell) in &rows {
out.push_str(label);
out.push_str(&" ".repeat(width - label.chars().count()));
out.push_str(COLUMN_GUTTER);
out.push_str(cell);
for row in relation_cells(rows) {
out.push_str(&paint_cells(&row, colored));
out.push('\n');
}
out
}
/// The rendered Relations block for one ticket, reading the board for the rest of it.
/// The relations of the ticket in `content`, read against the board around it.
///
/// The colour decision is passed in rather than asked for, like everything else the
/// body renders: the board draws the same text with colour off.
pub fn relations_block(content: &str, worklane_dir: &Path, colored: bool) -> Result<String> {
/// Rows rather than a rendered block: the board styles them itself, since an escape
/// sequence in a ratatui paragraph is drawn as literal bytes.
pub fn relations_for(content: &str, worklane_dir: &Path) -> Result<Vec<RelationRow>> {
let title = heading_title(content);
let stored = parse_relations(content, &title)?;
let index = RelationIndex::load(worklane_dir)?;
Ok(render_relations(
Ok(relation_rows(
&stored,
&index,
&parse_ticket_field(content, "ID"),
colored,
))
}
@@ -3202,6 +3402,19 @@ mod tests {
}
// --------------------------------------------------------------- relations --
/// One row as the block shows it, for a test about where the block goes rather than
/// about how it was derived.
fn row(label: &'static str, uuid: &str, title: &str, status: &str) -> RelationRow {
RelationRow {
label,
uuid: uuid.to_string(),
target: Some(RelationTarget {
title: title.to_string(),
status: status.to_string(),
}),
}
}
const TARGET: &str = "b1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d";
const SELF: &str = "641e3d5c-1b0e-4d2f-9a7e-3c8b5f0a2d61";
@@ -3327,30 +3540,105 @@ mod tests {
]);
let stored = vec![relation(RelationKind::RegressionOf, TARGET)];
// Each target marked with the status of the ticket it names: backlog for the
// blocker, reviewing for the other one.
assert_eq!(
render_relations(&stored, &index, SELF, false),
"regression of (b1b2c3d) The blocker\n\
blocks (ccccccc) The other one\n\
relates to (ccccccc) The other one\n"
render_relations(&relation_rows(&stored, &index, SELF), false),
"regression of \u{2581} (b1b2c3d) The blocker\n\
blocks \u{2586} (ccccccc) The other one\n\
relates to \u{2586} (ccccccc) The other one\n"
);
}
/// Every status the board holds has a mark of its own, and no two share one. Pinned
/// against `status_dirs` rather than the four names written out here, so a status
/// added later fails this instead of silently reading as missing.
#[test]
fn every_status_has_a_mark() {
let mut seen = std::collections::HashSet::new();
for status in status_dirs() {
let (mark, colour) = status_mark(Some(status));
assert_ne!(mark, '?', "{status} has no mark of its own");
assert_eq!(colour, Color::Orange, "{status} is not drawn as a status");
assert!(seen.insert(mark), "{status} shares its mark with another status");
}
assert_eq!(seen.len(), 4, "{seen:?}");
}
/// A target the board does not hold has no status to show, and a value that is not
/// one of the four is the same answer: `?` in grey, beside the grey `_missing_`.
#[test]
fn a_status_the_board_does_not_use_reads_as_missing() {
assert_eq!(status_mark(None), ('?', Color::Grey));
assert_eq!(status_mark(Some("elsewhere")), ('?', Color::Grey));
assert_eq!(status_mark(Some("")), ('?', Color::Grey));
}
/// The cards spend the circles on priority, two cells away from nothing at all, so a
/// status drawn as one would be read as a level.
#[test]
fn no_status_mark_is_a_priority_glyph() {
let levels = [1, 2, 3, 4, 5].map(|level| priority_mark(Priority::Level(level)).0);
let priority: String = levels
.iter()
.copied()
.chain([priority_mark(Priority::Unset).0])
.collect();
for status in status_dirs() {
let (mark, _) = status_mark(Some(status));
assert!(
!priority.contains(mark),
"{status} is drawn with {mark:?}, which the priority meter uses"
);
}
}
/// The mark on each row is the status of the ticket that row names, not of the ticket
/// being shown, so four relations in four statuses read four ways.
#[test]
fn the_block_marks_each_target_with_its_own_status() {
let rows: Vec<RelationRow> = status_dirs()
.into_iter()
.map(|status| row("relates to", TARGET, status, status))
.collect();
let rendered = render_relations(&rows, false);
for status in status_dirs() {
let (mark, _) = status_mark(Some(status));
assert!(
rendered.contains(&format!("{mark} (b1b2c3d) {status}")),
"no {status} row marked {mark:?}:\n{rendered}"
);
}
}
/// The id is kept, since it is the only thing left to go looking for, and the title
/// is `_missing_` rather than a bare uuid pretending to be one.
#[test]
fn a_target_the_board_does_not_have_renders_as_missing() {
let stored = vec![relation(RelationKind::BlockedBy, TARGET)];
// `?` rather than a stage of the flow: there is no status to show, and the mark
// has to say that as plainly as `_missing_` says the title does not exist.
assert_eq!(
render_relations(&stored, &RelationIndex::new(Vec::new()), SELF, false),
"blocked by (b1b2c3d) _missing_\n"
render_relations(
&relation_rows(&stored, &RelationIndex::new(Vec::new()), SELF),
false
),
"blocked by ? (b1b2c3d) _missing_\n"
);
}
#[test]
fn a_ticket_with_no_relations_at_either_end_renders_no_block() {
let index = RelationIndex::new(vec![related(TARGET, "Elsewhere", "backlog", Vec::new())]);
assert_eq!(render_relations(&[], &index, SELF, false), "");
assert_eq!(
render_relations(&relation_rows(&[], &index, SELF), false),
""
);
}
/// Without the guard every ticket with no ID field relates to every other one that
@@ -3376,10 +3664,10 @@ mod tests {
"# T\n\n## Relations\n- blocked by {}\n\n## Metadata\n\n- **ID**: {}\n",
TARGET, SELF
);
let rendered = content_trim(&content, false, &Resolved { relations: "blocked by (b1b2c3d) The blocker\n".to_string(), ..Default::default() });
let rendered = content_trim(&content, false, &Resolved { relations: vec![row("blocked by", TARGET, "The blocker", "backlog")], ..Default::default() });
assert!(
rendered.contains("Relations\n─────────\n\nblocked by (b1b2c3d) The blocker\n\nMetadata"),
rendered.contains("Relations\n─────────\n\nblocked by \u{2581} (b1b2c3d) The blocker\n\nMetadata"),
"{rendered:?}"
);
assert!(!rendered.contains(TARGET), "the bare uuid was printed: {rendered:?}");
@@ -3391,10 +3679,10 @@ mod tests {
#[test]
fn the_body_injects_the_block_when_the_file_has_no_section() {
let content = format!("# T\n\n## Description\nBody.\n\n## Metadata\n\n- **ID**: {}\n", SELF);
let rendered = content_trim(&content, false, &Resolved { relations: "blocks (641e3d5) The gated one\n".to_string(), ..Default::default() });
let rendered = content_trim(&content, false, &Resolved { relations: vec![row("blocks", SELF, "The gated one", "committed")], ..Default::default() });
assert!(
rendered.contains("Body.\n\nRelations\n─────────\n\nblocks (641e3d5) The gated one\n\nMetadata"),
rendered.contains("Body.\n\nRelations\n─────────\n\nblocks \u{2584} (641e3d5) The gated one\n\nMetadata"),
"{rendered:?}"
);
}
@@ -3403,9 +3691,9 @@ mod tests {
/// worth more at the end than dropped.
#[test]
fn the_body_appends_the_block_when_there_is_no_metadata() {
let rendered = content_trim("# T\n\n## Description\nBody.\n", false, &Resolved { relations: "blocks (641e3d5) X\n".to_string(), ..Default::default() });
let rendered = content_trim("# T\n\n## Description\nBody.\n", false, &Resolved { relations: vec![row("blocks", SELF, "X", "done")], ..Default::default() });
assert!(rendered.ends_with("Relations\n─────────\n\nblocks (641e3d5) X\n"), "{rendered:?}");
assert!(rendered.ends_with("Relations\n─────────\n\nblocks \u{2588} (641e3d5) X\n"), "{rendered:?}");
}
/// No block and a section holding only its placeholder: the section renders as it
+174
View File
@@ -296,3 +296,177 @@ fn ls_shows_a_mark_for_the_level() {
// The raw number is not what the listing shows
assert!(!stdout.contains(" 1 "), "the digit leaked into the row");
}
/// A ticket whose Tags field is whatever the test needs it to be, written verbatim so a
/// missing field, an unset one and a real list are all reachable.
fn create_ticket_with_tags(
worklane_dir: &std::path::Path,
status: &str,
title: &str,
tags: &str,
priority: &str,
) {
let slug: String = title.to_lowercase().replace(' ', "-");
let body = format!(
"# {title}\n\n## Metadata\n\n - **ID**: 00000000-0000-0000-0000-000000000001\n - **Priority**: {priority}\n{tags} - **Due**: _Not set_\n- **Owner**: alice\n- **Status**: {status}\n"
);
fs::write(
worklane_dir
.join(status)
.join(format!("00000000-0000-0000-0000-000000000001_{slug}.md")),
body,
)
.unwrap();
}
/// The Tags line as a ticket carries it, for the common case of a real list.
fn tags(list: &str) -> String {
format!("- **Tags**: {list}\n")
}
#[test]
fn ls_filters_by_tag_and_composes_with_status_and_priority() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
create_ticket_with_tags(&worklane, "backlog", "Tagged bug", &tags("bug,cli"), "1");
create_ticket_with_tags(&worklane, "backlog", "Tagged feature", &tags("feature"), "1");
create_ticket_with_tags(&worklane, "backlog", "Lower bug", &tags("bug"), "3");
create_ticket_with_tags(&worklane, "committed", "Started bug", &tags("bug"), "1");
// Alone, through the grouped listing: every status, only the tagged tickets.
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path()).args(["ls", "--tag", "bug"]);
let stdout = get_stdout(&mut cmd);
assert!(stdout.contains("Tagged bug"), "{stdout}");
assert!(stdout.contains("Lower bug"), "{stdout}");
assert!(stdout.contains("Started bug"), "a tagged ticket in another status was dropped");
assert!(!stdout.contains("Tagged feature"), "an untagged ticket came through");
// The counts are filtered too, since they are the same collect.
assert!(stdout.contains("[BACKLOG] 2 tickets"), "{stdout}");
assert!(stdout.contains("[COMMITTED] 1 ticket"), "{stdout}");
// With the status positional.
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "bug"]);
let stdout = get_stdout(&mut cmd);
assert!(stdout.contains("Tagged bug"));
assert!(stdout.contains("Lower bug"));
assert!(!stdout.contains("Started bug"), "the status was ignored");
// With --priority, and with both: none asked for is everything kept, so the three
// compose without a rule per pair.
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "--tag", "bug", "--priority", "1"]);
let stdout = get_stdout(&mut cmd);
assert!(stdout.contains("Tagged bug"));
assert!(stdout.contains("Started bug"));
assert!(!stdout.contains("Lower bug"), "the priority was ignored");
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "bug", "--priority", "1"]);
let stdout = get_stdout(&mut cmd);
assert!(stdout.contains("Tagged bug"));
assert!(!stdout.contains("Lower bug"), "the priority was ignored");
assert!(!stdout.contains("Started bug"), "the status was ignored");
assert!(!stdout.contains("Tagged feature"), "the tag was ignored");
}
/// The field is a list of whole values, not a string to search: a ticket tagged `bugfix`
/// is not a ticket tagged `bug`, and neither is one tagged `Bug`. Case sensitive is the
/// opinion the field already takes, since `tag_color` draws those two differently.
#[test]
fn ls_matches_a_whole_tag_value_and_not_a_substring_or_another_case() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
create_ticket_with_tags(&worklane, "backlog", "Real bug", &tags("bug"), "2");
create_ticket_with_tags(&worklane, "backlog", "Only bugfix", &tags("bugfix"), "2");
create_ticket_with_tags(&worklane, "backlog", "Capital Bug", &tags("Bug"), "2");
// A value that only appears with its neighbours around it, so a match on the raw
// field would find it and a match on the split values cannot.
create_ticket_with_tags(&worklane, "backlog", "Spaced list", &tags("cli, filter"), "2");
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "bug"]);
let stdout = get_stdout(&mut cmd);
assert!(stdout.contains("Real bug"), "{stdout}");
assert!(!stdout.contains("Only bugfix"), "bug matched bugfix");
assert!(!stdout.contains("Capital Bug"), "bug matched Bug");
// Trimmed on the way in, so the space after the comma is not part of the tag.
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "filter"]);
assert!(get_stdout(&mut cmd).contains("Spaced list"));
// And the field as written is not itself a tag.
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "cli, filter"]);
let stdout = get_stdout(&mut cmd);
assert!(!stdout.contains("Spaced list"), "the whole field matched as one tag");
}
/// No tags is no match, however the ticket spells it: the field absent, unset, or empty.
#[test]
fn ls_never_matches_a_ticket_carrying_no_tags() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
create_ticket_with_tags(&worklane, "backlog", "Has one", &tags("bug"), "2");
create_ticket_with_tags(&worklane, "backlog", "Field unset", &tags("_None_"), "2");
create_ticket_with_tags(&worklane, "backlog", "Field empty", "- **Tags**:\n", "2");
create_ticket_with_tags(&worklane, "backlog", "Field missing", "", "2");
create_ticket_with_tags(&worklane, "backlog", "Only commas", &tags(", ,"), "2");
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "bug"]);
let stdout = get_stdout(&mut cmd);
assert!(stdout.contains("Has one"), "{stdout}");
for absent in ["Field unset", "Field empty", "Field missing", "Only commas"] {
assert!(!stdout.contains(absent), "{absent} matched a tag it does not carry");
}
// Nor does an empty tag reach the filter: the value parser refuses it, so nothing is
// listed rather than everything.
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", ""]);
cmd.assert().failure().code(2);
}
/// A tag nothing carries lists nothing and still succeeds. The message is the one `ls`
/// already gives for a filter that empties a status, rather than a second one invented
/// here for tags alone.
#[test]
fn ls_with_a_tag_nothing_carries_lists_nothing() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
create_ticket_with_tags(&worklane, "backlog", "Tagged bug", &tags("bug"), "2");
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "frontend"]);
cmd.assert().success();
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path())
.args(["ls", "backlog", "--tag", "frontend"]);
let stdout = get_stdout(&mut cmd);
assert!(!stdout.contains("Tagged bug"), "{stdout}");
assert!(stdout.contains("No tickets in 'backlog' status."), "{stdout}");
// Through the grouped listing the counts go to zero and no section is drawn.
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
cmd.current_dir(temp.path()).args(["ls", "--tag", "frontend"]);
let stdout = get_stdout(&mut cmd);
assert!(stdout.contains("[BACKLOG] 0 tickets"), "{stdout}");
assert!(!stdout.contains("Tagged bug"), "{stdout}");
}
+32 -4
View File
@@ -289,6 +289,13 @@ fn relate_leaves_everything_it_was_not_asked_about_alone() {
assert!(content.contains("- **Owner**: alice"), "{content}");
}
/// The mark each status prints before the id, a rising bar from backlog to done. Written
/// out rather than imported: these tests drive the binary, so they see only its output.
const BACKLOG_MARK: &str = "\u{2581}";
const DONE_MARK: &str = "\u{2588}";
/// What a target the board no longer holds prints instead, since it has no status.
const MISSING_MARK: &str = "?";
/// The kind, the short id and the title, so the section reads without a second lookup.
#[test]
fn show_renders_the_kind_the_short_id_and_the_title() {
@@ -299,7 +306,10 @@ fn show_renders_the_kind_the_short_id_and_the_title() {
let shown = stdout(&run(&temp, &["show", GATED]));
assert!(shown.contains("Relations"), "{shown}");
assert!(shown.contains("blocked by (b1b2c3d) The blocker"), "{shown}");
assert!(
shown.contains(&format!("blocked by {BACKLOG_MARK} (b1b2c3d) The blocker")),
"{shown}"
);
// Never the stored line: a bare uuid says nothing about what it points at.
assert!(!shown.contains(BLOCKER), "{shown}");
}
@@ -314,12 +324,27 @@ fn show_lists_the_relation_the_other_ticket_holds() {
run(&temp, &["relate", GATED, "--relates-to", FIXED]);
let shown = stdout(&run(&temp, &["show", BLOCKER]));
assert!(shown.contains("blocks (641e3d5) The gated one"), "{shown}");
assert!(
shown.contains(&format!("blocks {BACKLOG_MARK} (641e3d5) The gated one")),
"{shown}"
);
assert!(!ticket(&worklane, BLOCKER).contains("Relations"));
// The mark is the target's status, not the shown ticket's: this row points at the
// one ticket in done, from a ticket in backlog, which is the question the mark is
// there to answer.
let shown = stdout(&run(&temp, &["show", GATED]));
assert!(
shown.contains(&format!("relates to {DONE_MARK} (f1f2f3f) The old fix")),
"{shown}"
);
// `relates to` is symmetric, so it reads the same way from either end.
let shown = stdout(&run(&temp, &["show", FIXED]));
assert!(shown.contains("relates to (641e3d5) The gated one"), "{shown}");
assert!(
shown.contains(&format!("relates to {BACKLOG_MARK} (641e3d5) The gated one")),
"{shown}"
);
}
#[test]
@@ -331,7 +356,10 @@ fn a_target_that_no_longer_exists_renders_as_missing() {
fs::remove_file(find(&worklane, BLOCKER)).unwrap();
let shown = stdout(&run(&temp, &["show", GATED]));
assert!(shown.contains("blocked by (b1b2c3d) _missing_"), "{shown}");
assert!(
shown.contains(&format!("blocked by {MISSING_MARK} (b1b2c3d) _missing_")),
"{shown}"
);
}
/// The section is the one part of a ticket read back by machine, so a line nobody can