Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f0f88025f3 | ||
|
|
00a64adca8 | ||
|
|
0f0767ac00 |
@@ -171,9 +171,21 @@ and this file is for what someone changing worklane's own code needs.
|
||||
### Relating Tickets
|
||||
|
||||
- **The Relations section is `relate`'s alone.** `RELATIONS` is in the section table but deliberately out of `section_args`, so `set` and `append` cannot reach it: a relation names a target that has to be resolved to a uuid first, and a prose flag would let an unresolvable line into the one section that is read back by machine. Same rule as Owner and Status, one field one writer
|
||||
- **`relate --clear <kind> <target>` is the removal, and it is on `relate` rather than on `set`** for the same reason the section is absent from `section_args`: one writer owns both directions, the way `chown` owns setting an owner and clearing one. It names the target and not just the kind, because a ticket can hold several relations of one kind and emptying all of them is not what anybody is asking for. That is also why it is not spelled like `set --clear`, which names a field and empties the whole of it
|
||||
- **The two values are one flag, so clap cannot type them apart.** `num_args = 2` is per occurrence, which is what makes an odd number a usage error and every chunk a full pair; `RelateArgs::cleared` splits the pairs and parses the kind, so a bad kind is refused before the ticket is resolved. It exits 1 rather than clap's 2, which is the price of a two-value flag and the reason `RelationKind::parse_value` names the three in its message
|
||||
- **Both spellings of the kind are accepted**, `blocked-by` from the flag and `blocked by` from the label. Both are in front of the reader: the flag is what recorded the relation and the label is what `show` prints and what the file stores, so refusing the printed form would be a trap for anyone clearing a row they just read. `RelationKind::flag` is a match rather than `label().replace(' ', "-")`, so the flag, the `--clear` value and the completion list cannot drift apart
|
||||
- **`find_relation` searches the ticket's own edges before the board, and that order is the feature.** A dangling edge is the case most likely to need clearing, and no search of the board can reach a target whose ticket is gone, so the id-prefix tier over the stored targets is the only one that finds it. `MIN_ID_SEARCH` is the floor `resolve_in` puts under its own id tier and the comparison is case insensitive for the same reason. Two stored targets under one prefix name the candidates rather than guessing, which is what an ambiguous ticket search already does
|
||||
- **An edge the ticket does not hold reports no change; a target naming nothing at all is an error.** The two are different facts: the first is the state the caller asked for, and the second is a typo that reporting no change would swallow. The resolver's own reason is carried through, so an ambiguous search says so instead of being reported as nothing found
|
||||
- **Recording and clearing the same relation in one call is refused, and the check runs on what was *asked* for.** `items` drops the additions already in the file, so comparing against that would let `--blocked-by X --clear blocked-by X` quietly remove an existing X. `requested` is the full list for exactly that reason. The refusal is `set --clear`'s: nothing is written rather than one direction silently winning
|
||||
- **Removals rewrite the section and additions are appended to the result, in that order.** Two passes rather than one rebuild, so a call with no `--clear` takes exactly the path it always took and `append_section_body` goes on deciding where a new line lands. Rewriting from the parsed relations is lossless because a line that is not a relation is already an error. The last edge leaves `clear_section_body`'s placeholder, which is the line `append` treats as no content, so the next `relate` replaces it instead of writing under it
|
||||
- **A relation is not logged, either direction.** `relate` writes no history entry and neither does `--clear`, which keeps the two consistent; per the history rule, an edge that matters enough to explain gets a comment. Do not add an entry for the removal alone: a log that recorded only the destructive half would read as though the additions had never happened
|
||||
- **`add` does not write the section.** The plan on 4179958 asked for it in the ticket writer; it is out on purpose. A `_No relations._` block in every new ticket is noise in every `show`, and the insertion path has to exist regardless for every ticket written before the section did, so leaving it out means one path that is always exercised rather than two
|
||||
- **The full uuid is stored, not the seven characters `ls` prints.** It resolves without a scan and cannot turn ambiguous as the board grows. `show` renders the short id and the target's title instead: the file is the machine's copy, the output is the reader's
|
||||
- **One direction is stored and the inverse is derived.** `blocked by` goes on the gated ticket rather than `blocks` on the blocker, because the gated ticket is the one whose move is refused and whose author knows about the dependency. `relates to` is symmetric and is written once, on whichever end the caller ran it from. `RelationIndex::inbound` finds the far end by scanning, which is what keeps `relate` a single-file write
|
||||
- **A derived row that reads exactly like a stored one is dropped, and the stored one is kept.** Both ends of a symmetric relation could hold a line, since nothing stopped it until 03bdc76, and the block then drew the same neighbour twice under the same label. The stored row survives because it is the line `relate --clear` can address; the derived one is on a file this ticket does not own
|
||||
- **The dedupe keys on the label and the target, not the kind and the target.** Two tickets each blocking the other is two facts and the block says both, `blocked by` from this end and `blocks` from the other; keying on the kind would fold them into one row and lose half of what the ticket says. Only a symmetric kind can collide with its own stored line, and `RelationKind::is_symmetric` derives that from `label() == inverse_label()` rather than naming `RelatesTo`, so a kind added later answers by construction
|
||||
- **`relate` also refuses to store the mirror, which is the other half of the same fix.** The dedupe repairs a board that already holds both directions; the refusal stops it recurring. `mirrored` in `cmd_relate` reads the target's own relations and reports no change, gated on `is_symmetric` because a target holding `blocked by <this>` is a cycle rather than a duplicate. 4179958 decided `relates to` is written once and not onto both files; for six months nothing enforced it
|
||||
- **A symmetric edge is cleared from the end that stores it.** With both ends holding a line, `--clear` on one leaves the other's, which then draws as the derived row: correct, since the far end still asserts the relation, and the reason the dedupe keeps the stored row rather than the derived one
|
||||
- **A line in the section that is not a relation is an error naming the ticket**, not a line quietly dropped. Nothing but `relate` writes there, so a bad line means a hand-edited file. The TUI is the deliberate exception: `detail_of` falls back to no block, since one corrupt ticket must not take the whole board down
|
||||
- **The block is built outside `content_trim` and passed in.** Half of it comes from other tickets and `content_trim` has only the body. It is spliced over the stored lines where the file has the section, and injected ahead of the metadata where it does not, because a ticket that is only pointed at has no section of its own and still has relations to show
|
||||
- `ensure_section` inserts against `SECTION_ORDER`, before the first following section that is actually in the file, and adds no blank line that was not already there. A handwritten `## Notes` between the plan and the metadata therefore keeps its place, and Metadata is in that list as an anchor rather than as something anything appends to
|
||||
@@ -235,9 +247,12 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- The draw aligns the focused column again on its own geometry, so a resize between keypress and frame cannot hide the selection, and caps every column against blank space past its last card. The stored value may go stale after a tick shrinks the column; that is fine, because what is drawn is corrected immediately and the next navigation writes the correction back
|
||||
- Entering another column follows the selection rather than resetting to its top. The card index carries across columns, so a reset would open the column with the highlight below the fold whenever it was — the opposite of the detail view's reset-on-selection-move, where each ticket genuinely starts at its own top. The index is shared and clamps permanently when a shorter column pulls it down, so a column you return to follows the selection to where it now sits rather than holding your old place
|
||||
- **The footer names only keys that work.** It read `↑↓ scroll` when nothing scrolled at all, which sends the reader looking for their own mistake. A UI that misdescribes itself is worse than one that is merely incomplete
|
||||
- **A hint is a key and what pressing it does, and `key_hint` is the only thing that draws one.** The key is cyan and bold, the description takes the terminal's default foreground, and the row keeps its three-space gaps. Everything that names a key goes through it: the three footer states, the prompt's two keys, the picker's row and the `q board` on the frame's border, so a reader learns the shape once. Same division in frig and pantop, each in its own accent colour, cyan here and magenta there — the three tools are read side by side and used to look like three programs
|
||||
- **A key that is its description's first letter is merged into it**, so the board draws `quit`, `campaign` and `tag` with the letter coloured and no letter in front, while `y copy id`, `ctrl-c quit`, `d show done (2)` and every arrow row stay split. Two cells back on a row already at its width naming eight keys, and the coloured letter *is* the key either way. The prefix test in `key_hint` is case sensitive for exactly that reason: a row naming both `r` and `R` would otherwise draw one word for the two of them, and the merged form can only say which key it is while the letter on screen is that key. It also means the row carries both forms at once, which is the cost of the two cells
|
||||
- **What the row is cannot be read off its text any more, so the tests read its cells.** `footer_cells`, `footer_at`, `keys_on` and `footer_style` in the test module: `keys_on(.., "quit")` is `Some(1)` where `q` quits and `Some(0)` on a row whose only `quit` is the tail of `ctrl-c quit`. A `contains("q quit")` cannot tell those apart, and three of the guards that keep 1b78a24 out were written that way
|
||||
- **`q` and `esc` are one key: close what is open, quit when there is nothing left to close.** `q` used to set `should_quit` outright, so a reader who pressed it to put a ticket away lost the board instead, which is not what `q` does anywhere else that lays a document over a list. One match arm in `main.rs`, not two: two arms carrying one rule is how a later edit changes it for one key and not the other
|
||||
- **The rule is `Board::dismiss`, not the match arm.** The dispatch in `main.rs` is not reachable from a test, so anything decided there is undecidable by the suite. The arm is the line that names the keys and nothing else. `the_dispatch_gives_q_and_esc_one_arm_and_leaves_ctrl_c_quitting` scans `main.rs` for what the arm cannot say for itself, over whitespace-collapsed source so rustfmt cannot fail it
|
||||
- **The footer's last slot always answers how to get out**, and with a ticket open the honest answer is `ctrl-c`, the only key left that quits in one press. Going on saying `q quit` there would be 1b78a24 in the other direction: a footer describing a key by what it used to do
|
||||
- **The footer's last slot always answers how to get out**, and with a ticket open the honest answer is `ctrl-c`, the only key left that quits in one press. Going on drawing the merged `quit` there would be 1b78a24 in the other direction: a footer describing a key by what it used to do. `ctrl-c quit` is split by the same rule that merges the other, being no word's first letter
|
||||
- **The overlay names its ticket on the border, not at the head of the paragraph.** `Board::detail` is a `Detail` carrying the title, the id and the text, because the name has to travel beside the body rather than inside it: `content_trim` drops the `# ` heading on purpose, since `cmd_show` prints it, and anything in the paragraph scrolls away
|
||||
- `detail_title` cuts the string itself instead of leaving it to ratatui, which truncates an overlong block title at whatever cell it reaches and would take the id with it. Cut against the inner width, so the id survives whole and the name ends in an ellipsis. The id goes first because that is how every other view addresses a ticket
|
||||
- The detail view renders from cells, never from painted strings: ratatui draws styled spans, so an escape sequence in a paragraph would be printed as literal bytes. `content_trim` and `format_history_with` take the colour decision for the CLI's side of the same layouts
|
||||
@@ -274,9 +289,9 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **The toggle re-clamps the frame offset, through `scroll_frame(0, screen)`.** A taller viewport has a smaller last offset than a shorter one, so where the reader was can end up past the end of the frame they just asked for. The draw clamps on its own geometry either way, but the stored value has to be clamped too or the next `pgup` counts down from a number the frame never showed. A scroll of no pages is that clamp and nothing else, which keeps it in the one place it lives
|
||||
- **The frame is out of reach from under an open ticket.** With the overlay open, up and down step through the tickets and it follows, so a selection that reached the frame would have to either close it on an arrow key or leave it showing a ticket nothing is selecting. `an_open_ticket_keeps_the_scroll_keys_from_the_frame` builds that state by hand for exactly this reason: the precedence has to hold whether or not a keypress can reach it
|
||||
- **The standing comes from the columns, not from a walk of the tree.** While a campaign is selected the columns *are* its members, done included, so `Tab::standing` counts what is already in hand rather than paying what `campaign ls` pays per campaign. Counted over every column, drawn or not: hiding done is a change to what is drawn and never to what is counted
|
||||
- **The way out is on the frame's own border, not in the footer.** `q board` sits on the thing it takes away, and the footer row was already at its width naming eight keys. Dropped whole when it and the standing would meet, the rule the page indicator follows
|
||||
- **The way out is on the frame's own border, not in the footer.** `q board` sits on the thing it takes away, and the footer row was already at its width naming eight keys. Dropped whole when it and the standing would meet, the rule the page indicator follows, and measured over its spans rather than one string since it is a key hint like any other. Drawn through `key_hint` and not as grey chrome: it is the one key on the board named anywhere but the footer, and a reader who has learnt to look for the cyan letter should not need a second convention to find it. The indicator beside it stays grey, having no key in it
|
||||
- **`c` and `t` are named in the footer only on a closed board with nothing filtered**, which is where a reader has to find them. Over an open ticket and on a filtered board they are left out: the frame's border then says how to put the filter away, and the row has no cells to spare. The tag used to be drawn on that row in its own colour, for want of a frame to draw it in, and 2a83bd4 took that away rather than saying it twice. Incomplete rather than wrong, which is the trade this row is allowed to make — what it must never do is name a key by what it used to do
|
||||
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `enter expand` or `enter collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `enter` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
|
||||
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `↵ expand` or `↵ collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `↵` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
|
||||
- **`picker: Option<Picker>` is the whole mode**, the shape `search` and `detail` use, and `Board::picker_key` runs beside `search_key` ahead of the action arms for the same reason: an open list owns the keyboard, so `d` must not toggle done and `q` must not quit while a campaign is being chosen. `ctrl-c` is the one key it declines and every other control combination is swallowed, or `ctrl-d` would reach the arm bound to `d`
|
||||
- **The picker's rows are `Tab::campaigns`, not a copy taken when it opened**, so a campaign filed elsewhere appears in an open picker on the next tick. It opens on the campaign already selected, so `c` on a filtered board says where you are as well as offering somewhere to go, and a board with no campaigns gets a `Notice` rather than an empty box that has to be dismissed to learn it was empty
|
||||
- **A picker row draws a real codename only.** The row opens with the short id, so the card's `~<id>` fallback would print it twice and say nothing the second time
|
||||
@@ -321,7 +336,7 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- Id and title only, per 3b16540, both lowercased. The title has to be case insensitive to be worth typing, and giving the id the same treatment lets a pasted id match whatever case it was copied in. An empty or all-space query matches **nothing** rather than everything
|
||||
- **The jump goes through `select_at`, the tail `select_card` already used.** `follow_selection` scrolls the column the card is in, and the offsets are per column and on the `Tab`, so a jump across columns moves the right one; `refresh_detail` keeps an open overlay on the ticket the selection names. A second version of either is how a jump comes to scroll differently from the arrow keys
|
||||
- **A hit closes the prompt and a miss keeps it open**, marked, with the selection untouched. The query can then be corrected in place instead of retyped from `/`. Doing nothing visible is what makes a reader retype a query that was already right
|
||||
- **The prompt takes the whole footer row**, because the key list it replaces describes nothing that currently works while every key is going into the buffer. The typed query is drawn in the default foreground and the keys in grey: one is content, the other is chrome. `no match` is brightred beside the query it is about, since grey chrome is what a reader skips
|
||||
- **The prompt takes the whole footer row**, because the key list it replaces describes nothing that currently works while every key is going into the buffer. Its two keys are drawn as every other key is, cyan on the key and the default foreground on the word. That the query then sits in the same foreground as the descriptions is what the house style costs on this row, and the cursor is what says which half is an input — which it does in a terminal with no colour at all. `no match` stays brightred beside the query it is about, being the one thing on the row that is neither a key nor what was typed
|
||||
- **The real terminal cursor goes after the query**, not a glyph standing in for one. ratatui shows the cursor only for a frame that asked for it, so `set_cursor_position` is also what says "you are typing" while the query is still empty. Clamped to the row, so a query longer than the terminal leaves it on the last cell
|
||||
- Both closed footers name `/`, since the jump works with a ticket open as well: it moves the selection and the overlay follows
|
||||
- Out of scope on purpose, each its own ticket once the input mode exists: `n` and `N` for the next and previous match, searching the description, tags or owner, regex, and filtering the board down to matches rather than selecting one
|
||||
@@ -468,7 +483,8 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **Relation row to a discarded target → struck through, the whole row.** The one thing in the palette that is not a colour, and it is here because the status mark cannot carry it: that mark is one cell in a column of five states, so a row pointing at abandoned work reads as a live dependency, which is exactly what it is not. The strike says the relation no longer stands for anything while the row stays on the ticket, for completeness and for the case the target is moved back out of discarded. Only discarded: a done target still stands for the fact that it was a blocker, and a `_missing_` one says something different again, that the row cannot be resolved at all. Gutter and padding included, so the line runs unbroken from the label to the end of the title, and every cell opens its own SGR 9 since each is closed by its own `RESET`
|
||||
- **The strike is under the colour flag, like every other escape.** A piped `show` carries none of it, the same bargain committed and reviewing already take for being told apart by colour alone, and the board draws it as a style instead. Do not answer the pipe by changing the glyph in the mark column: the pair there has to stay unique, and `every_status_has_a_mark` is what says so
|
||||
- Markdown link → cyan, markers and url kept. Not a new meaning for the colour: the plan numbers, the criterion numbers and the `relates to` mark are already cyan inside a rendered body, and a link is the same kind of thing, a pointer the reader may follow rather than a value. The url is not hidden behind the text the way a renderer would hide it, because `show` prints to a terminal worklane cannot assume will make it clickable, and a link whose target cannot be read is worse than a long line
|
||||
- Chrome → grey. The footer's key names, a rendered `[ ]`, and the overlay's page indicator. Not a new slot: grey already means "what a reader skips", which is the other half of the unset-value meaning, and none of these is a value. The indicator in orange would read as the title it faces across the overlay, in cyan as a timestamp, and in the priority ramp's colours as a level
|
||||
- Chrome → grey. A rendered `[ ]`, the overlay's page indicator and the frame's. Not a new slot: grey already means "what a reader skips", which is the other half of the unset-value meaning, and none of these is a value. The indicator in orange would read as the title it faces across the overlay, in cyan as a timestamp, and in the priority ramp's colours as a level
|
||||
- **A key name → cyan, and bold; what pressing it does → the default foreground.** The one place the palette spends a colour on something that is not a value: a key is what a reader is hunting for on a row they otherwise skip, and with the key merged into its description the colour is the only thing saying which letter to press. Not a second meaning for the timestamp's cyan in any place the two could be confused — nothing on the footer, the prompt or a border hint holds a value at all — and it is the accent frig draws the same row in, which is the point. Grey stays on the chrome around it: the page indicator, and the row's gaps
|
||||
- Chrome → grey, in the history block too: the kind label at the head of a mechanical row, and the `From` on a comment's author line. Both name their row rather than holding a value, which is what grey already says. The label was orange, which means Status everywhere else, so an `owner` or `tags` label claimed a meaning belonging to the value beside it
|
||||
- **A value in the history block takes the colour it has in the metadata table three lines above.** A status is orange, a tags entry goes through the same `tag_cells` the Tags field does, a campaign codename takes `tag_color` bare the way `Codename` does, and `_Not set_`, `_None_` and `_missing_` are grey. An owner stays plain: a person's name is the one value the palette has no meaning for, and spending a colour on the field that needs it least is how a colour stops meaning anything. The block's job is to be scanned, and it is not worth scanning if it has a palette of its own to learn first
|
||||
- History actor → its name through `tag_color`, the way a campaign codename is. Not a new meaning for a reserved colour but the existing use of the tag slots, a name that groups rows: one writer is one colour in every entry it wrote, so a reader sees who has been working a ticket without reading the same name four times. `claude`, `opencode` and a person each get their own
|
||||
|
||||
Generated
+1
-1
@@ -1503,7 +1503,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "worklane"
|
||||
version = "0.31.5"
|
||||
version = "0.32.2"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"assert_cmd",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "worklane"
|
||||
version = "0.31.5"
|
||||
version = "0.32.2"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
|
||||
@@ -13,7 +13,7 @@ Worklane is a local Kanban flow for agentic software development.
|
||||
| `worklane mv <id> --status <target> [-f]` | Moves ticket between statuses. Default: forward only, one stage at a time. `-f` bypasses both restrictions. `--status discarded` is exempt and reachable from anywhere, for a ticket that will not be done; leaving `discarded` is a backward move and needs `-f`. Discarding is refused while open tickets are blocked by the ticket, `-f` overrides. Records a `status` entry in the ticket's history, after the move: a refused or no-op move records nothing. `--actor` names the writer of that entry |
|
||||
| `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. `--clear <field>` returns a field to unset instead, repeatable, taking `due`, `tags`, `priority`, `description`, `acceptance` or `plan`, and writing back exactly what `add` writes for a field it was never given. No `title`, which addresses the ticket, and no `owner`, which is `chown`'s. Replacing and clearing the same field in one call is refused. `--tags` records a `tags` entry in the ticket's history, with the tags before and after, and it is the only field of this command's that is logged; `--actor` names the writer of that entry |
|
||||
| `worklane append <ticket>` | Adds to a section with `--description`, `--acceptance`, `--plan`. At least one required. The description gains a paragraph; list items go on the end, steps numbered on from the last |
|
||||
| `worklane relate <ticket>` | Records an edge to another ticket with `--blocked-by`, `--regression-of` or `--relates-to`, each repeatable. At least one required. Only the ticket named is written; `show` derives the other end by scanning. `mv` refuses to move a ticket blocked by one that is not done, unless `-f` |
|
||||
| `worklane relate <ticket>` | Records an edge to another ticket with `--blocked-by`, `--regression-of` or `--relates-to`, each repeatable. At least one required. Only the ticket named is written; `show` derives the other end by scanning, and a derived row that reads exactly like a stored one is drawn once. `relates to` on a ticket whose target already stores it reports no change, since it is the same edge; `blocked by` and `regression of` read differently from the far end, so a mutual pair is two rows. `mv` refuses to move a ticket blocked by one that is not done, unless `-f`. `--clear <kind> <target>` takes an edge off instead, repeatable, the kind spelled either way, `blocked-by` or `blocked by`. The target resolves against the edges the ticket holds first, by id prefix, which is the only way to reach one whose ticket has been deleted, then as an ordinary ticket search. An edge the ticket does not hold reports no change; a target naming nothing at all is an error. Recording and clearing the same edge in one call is refused |
|
||||
| `worklane chown <user> <ticket>` | Sets the Owner field, the only command that writes it. Free text, checked against nothing. User first and ticket second, after Unix `chown`. `worklane chown --clear <ticket>` returns the field to unset, taking the ticket in the flag since there is no user to give, and not to the git user `add` falls back to. Records an `owner` entry in the ticket's history, with the owner before and after; `--actor` names who made the change, which is not the same as the user argument |
|
||||
| `worklane check <ticket> [criteria...]` | Ticks acceptance criteria, each by number as shown by `show` or by a substring. Several in one call, or `all` for every one of them. Prompts with the numbered list if none is given, or errors with it when there is no terminal |
|
||||
| `worklane uncheck <ticket> [criteria...]` | Unticks acceptance criteria, addressed the same way |
|
||||
@@ -55,6 +55,7 @@ worklane mv <TAB> the same, then --status <TAB> for the five
|
||||
worklane chown alice <TAB> the ticket, which is the second argument here
|
||||
worklane chown --clear <TAB> the ticket, which the flag carries here
|
||||
worklane relate x --blocked-by <TAB>
|
||||
worklane relate x --clear <TAB> the three kinds, not a ticket: the kind comes first
|
||||
worklane campaign show <TAB> the campaigns, from `campaign ls --ids`
|
||||
worklane assign <TAB> the same, since a campaign comes first here
|
||||
worklane ls --campaign <TAB> and again
|
||||
|
||||
+26
-1
@@ -201,13 +201,38 @@ directory beside them, for a repo that has no board yet.
|
||||
worklane relate 1b78a24 --blocked-by 4179958 # this one waits on that one
|
||||
worklane relate 1b78a24 --regression-of 6d327df # this one broke that one's fix
|
||||
worklane relate 1b78a24 --relates-to 7bfb9fc # neighbours, no dependency
|
||||
worklane relate 1b78a24 --clear blocked-by 4179958 # take that edge off again
|
||||
```
|
||||
|
||||
One flag per kind, and each repeats. The ticket comes first and the flag says what it is
|
||||
to the target, so read the call as a sentence: `relate A --blocked-by B` means A waits
|
||||
on B. **Only one side is stored**, on the ticket you name, and `show` derives the other
|
||||
on B.
|
||||
|
||||
**`--clear` is how an edge comes off, and it names the kind and the target**, because a
|
||||
ticket can hold several relations of one kind and emptying all of them is rarely what is
|
||||
wanted. Repeat the flag for more. The kind is spelled either way, `blocked-by` as the flag
|
||||
records it or `blocked by` as `show` prints it. `set --clear` does not reach relations:
|
||||
`relate` is the only writer of the section, so it owns both directions.
|
||||
|
||||
The target is resolved against the edges the ticket already holds first, by id prefix,
|
||||
and only then as an ordinary ticket search. That order is what lets you clear an edge
|
||||
whose target has been **deleted**, which is the case most likely to need it: `show` draws
|
||||
it as `_missing_` with a `?` mark and `mv` warns about it on every move, and no search of
|
||||
the board can reach a ticket that is gone.
|
||||
|
||||
An edge the ticket does not hold reports no change. A target that names nothing at all is
|
||||
an error rather than a no-op, so a mistyped id does not read as success. Recording and
|
||||
clearing the same edge in one call is refused outright, the way `set` refuses a field it
|
||||
is also replacing, and nothing is written. **Only one side is stored**, on the ticket you name, and `show` derives the other
|
||||
end for the ticket at the far side, so never record both directions.
|
||||
|
||||
`relates to` reads the same from both ends, so recording it on the second ticket is
|
||||
refused as no change: the edge is already there, from the far side. `blocked by` and
|
||||
`regression of` are different: the far end reads as `blocks` and `regressed by`, so two
|
||||
tickets each blocking the other is two facts and the block shows both. A symmetric edge
|
||||
comes off with `--clear` at the end that stores it, since that is the only end holding a
|
||||
line to remove.
|
||||
|
||||
`--blocked-by` is enforced: `mv` refuses to move a ticket while a ticket it is blocked by
|
||||
is not in `done` or `discarded`, whichever move it is, and names every open blocker. `-f`
|
||||
moves it anyway, beside the backward and skipping moves it already allows. It is enforced
|
||||
|
||||
+30
-1
@@ -852,12 +852,17 @@ pub struct AppendArgs {
|
||||
/// Each flag repeats, so several relations of one kind land in a single call. The
|
||||
/// targets are ticket searches, resolved by the same three tiers every other ticket
|
||||
/// argument is, and stored as the target's uuid.
|
||||
///
|
||||
/// `--clear` is the other direction, and it is here rather than on `set` for the reason
|
||||
/// Relations is absent from `section_args`: a relation names a target that has to be
|
||||
/// resolved first, so its one writer owns both adding and removing, the way `chown` owns
|
||||
/// both setting an owner and clearing one.
|
||||
#[derive(clap::Args)]
|
||||
#[command(group(
|
||||
clap::ArgGroup::new("relation_kinds")
|
||||
.required(true)
|
||||
.multiple(true)
|
||||
.args(["blocked_by", "regression_of", "relates_to"])
|
||||
.args(["blocked_by", "regression_of", "relates_to", "clear"])
|
||||
))]
|
||||
pub struct RelateArgs {
|
||||
/// Ticket UUID or title
|
||||
@@ -874,6 +879,18 @@ pub struct RelateArgs {
|
||||
/// Ticket this one is merely related to. Symmetric, so it is recorded once
|
||||
#[arg(long, value_parser = non_empty)]
|
||||
pub relates_to: Vec<String>,
|
||||
|
||||
/// Take a relation off: the kind, then the ticket it points at. Repeat the flag
|
||||
///
|
||||
/// Two values rather than one, because a ticket can hold several relations of one
|
||||
/// kind and emptying every `blocked by` on it is not usually what is wanted. That is
|
||||
/// also why this is not `set --clear`, which names a field and empties the whole of
|
||||
/// it: the "value" here is one edge among several, so the target has to be named too.
|
||||
///
|
||||
/// A `Vec<String>` because clap cannot type the two values of one flag apart.
|
||||
/// [`RelateArgs::cleared`] is where the pairs are split and the kind is parsed.
|
||||
#[arg(long, num_args = 2, value_names = ["KIND", "TARGET"], value_parser = non_empty)]
|
||||
pub clear: Vec<String>,
|
||||
}
|
||||
|
||||
impl RelateArgs {
|
||||
@@ -886,6 +903,18 @@ impl RelateArgs {
|
||||
(RelationKind::RelatesTo, &self.relates_to),
|
||||
]
|
||||
}
|
||||
|
||||
/// The relations asked to be taken off, as a kind and the search naming the target.
|
||||
///
|
||||
/// `num_args = 2` is per occurrence, so clap has already refused an odd number of
|
||||
/// values and every chunk is a full pair. A kind that is not one of the three is
|
||||
/// refused here, before the ticket is resolved and long before anything is written.
|
||||
pub fn cleared(&self) -> anyhow::Result<Vec<(RelationKind, &str)>> {
|
||||
self.clear
|
||||
.chunks(2)
|
||||
.map(|pair| Ok((RelationKind::parse_value(&pair[0])?, pair[1].as_str())))
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
/// `check` and `uncheck` are separate commands rather than one verb with a flag,
|
||||
|
||||
+55
-13
@@ -22,7 +22,7 @@ use clap::{CommandFactory, ValueEnum};
|
||||
use clap_complete::Shell;
|
||||
|
||||
use crate::install::SKILLS;
|
||||
use crate::util::Status;
|
||||
use crate::util::{RelationKind, Status};
|
||||
|
||||
/// Subcommands whose first positional is a ticket.
|
||||
///
|
||||
@@ -98,6 +98,11 @@ fn fish_dynamic() -> String {
|
||||
let ticket_commands = TICKET_COMMANDS.join(" ");
|
||||
let ticket_second_commands = TICKET_SECOND_COMMANDS.join(" ");
|
||||
let ticket_flags = flag_list(&TICKET_FLAGS);
|
||||
let relation_kinds = RelationKind::ALL
|
||||
.iter()
|
||||
.map(|kind| kind.flag())
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ");
|
||||
let campaign_commands = CAMPAIGN_COMMANDS.join(" ");
|
||||
let campaign_nested = CAMPAIGN_NESTED_COMMANDS
|
||||
.iter()
|
||||
@@ -188,6 +193,14 @@ complete -c worklane \
|
||||
complete -c worklane -n '__worklane_command_is relate' {ticket_flags} \
|
||||
-x -a '(worklane ls --ids)'
|
||||
|
||||
# `--clear` is the one flag here whose first value is not a ticket, so it is not in
|
||||
# `TICKET_FLAGS`: it takes the kind and then the target, and offering a board listing where
|
||||
# the kind goes would be offering values it refuses. The kinds come from `RelationKind`
|
||||
# rather than being spelled again. The target gets no rule at all, deliberately: fish
|
||||
# completes the value after the flag, and the case this flag exists for is a target whose
|
||||
# ticket is gone, which no listing of the board can offer.
|
||||
complete -c worklane -n '__worklane_command_is relate' -l clear -x -a '{relation_kinds}'
|
||||
|
||||
# Campaigns, from `campaign ls --ids`, in the three places one is named: `assign`'s first
|
||||
# argument, `campaign show`'s only one, and `ls --campaign`.
|
||||
complete -c worklane \
|
||||
@@ -464,22 +477,51 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
/// `chown --clear` takes a ticket, so it is completed like one, and only under
|
||||
/// `chown`: `set --clear` is the same flag name carrying a field.
|
||||
/// Three commands carry a `--clear` and each one takes something different: `chown`
|
||||
/// takes the ticket, `relate` takes the kind and then the target, and `set` takes a
|
||||
/// field name clap already offers. So each rule is scoped to its own command, and a
|
||||
/// bare search for `-l clear` cannot tell them apart, which is what this used to do.
|
||||
#[test]
|
||||
fn chowns_clear_is_completed_with_tickets_and_sets_is_not() {
|
||||
fn each_clear_flag_is_completed_for_its_own_command() {
|
||||
let script = fish_dynamic();
|
||||
let rule = script
|
||||
.lines()
|
||||
.find(|line| line.starts_with("complete") && line.contains("-l clear"))
|
||||
.expect("chown --clear has a rule of its own");
|
||||
assert!(rule.contains("__worklane_command_is chown"), "{rule}");
|
||||
assert!(rule.contains("worklane ls --ids"), "{rule}");
|
||||
let chown = command().find_subcommand("chown").expect("chown exists").clone();
|
||||
let cli = command();
|
||||
|
||||
let rule_for = |name: &str| {
|
||||
let scope = format!("__worklane_command_is {name}");
|
||||
script
|
||||
.lines()
|
||||
.find(|line| {
|
||||
line.starts_with("complete")
|
||||
&& line.contains("-l clear")
|
||||
&& line.contains(&scope)
|
||||
})
|
||||
.unwrap_or_else(|| panic!("no --clear rule for {name}:\n{script}"))
|
||||
};
|
||||
|
||||
let has_clear = |name: &str| {
|
||||
cli.find_subcommand(name)
|
||||
.unwrap_or_else(|| panic!("no such subcommand: {name}"))
|
||||
.get_arguments()
|
||||
.any(|arg| arg.get_long() == Some("clear"))
|
||||
};
|
||||
|
||||
// `chown --clear` names the ticket in the flag, so the flag completes tickets.
|
||||
assert!(has_clear("chown"), "`chown` has no --clear for the rule to complete");
|
||||
assert!(rule_for("chown").contains("worklane ls --ids"), "{}", rule_for("chown"));
|
||||
|
||||
// `relate --clear` takes the kind first, so it offers the kinds and not a board
|
||||
// listing: tickets there would be candidates the flag refuses. The target, the
|
||||
// second value, is deliberately left uncompleted.
|
||||
assert!(has_clear("relate"), "`relate` has no --clear for the rule to complete");
|
||||
let relate = rule_for("relate");
|
||||
for kind in RelationKind::ALL {
|
||||
assert!(relate.contains(kind.flag()), "{kind:?} is not offered: {relate}");
|
||||
}
|
||||
assert!(
|
||||
chown.get_arguments().any(|arg| arg.get_long() == Some("clear")),
|
||||
"`chown` has no --clear for the rule to complete"
|
||||
!relate.contains("worklane ls --ids"),
|
||||
"tickets offered where the kind goes: {relate}"
|
||||
);
|
||||
|
||||
assert!(
|
||||
!TICKET_FLAGS.contains(&"clear"),
|
||||
"--clear in TICKET_FLAGS would offer tickets to `set --clear`, which takes a field"
|
||||
|
||||
+159
-8
@@ -1105,16 +1105,97 @@ pub fn cmd_append(args: &AppendArgs, start: &Path) -> Result<()> {
|
||||
/// The kinds are a flag each rather than a `--kind` value, so an unknown kind is a
|
||||
/// usage error at the door instead of a line written into the file and refused on the
|
||||
/// way back out.
|
||||
/// The stored relation a `--clear` names, or `None` when the ticket does not hold it.
|
||||
///
|
||||
/// Two tiers, in this order. A uuid prefix against the targets this ticket already
|
||||
/// stores, which is the only tier that can reach a dangling edge: the target's ticket is
|
||||
/// gone, so no search of the board resolves it, and that is the case most likely to need
|
||||
/// clearing. Then the ordinary ticket search, so a title or a prefix of a live ticket
|
||||
/// works here the way it does in every other argument.
|
||||
///
|
||||
/// The prefix tier is the ticket's own relations and not the board, so it stays cheap and
|
||||
/// cannot be made ambiguous by a ticket somewhere else. `MIN_ID_SEARCH` is the same floor
|
||||
/// `resolve_in` puts under its id tier, and the comparison is case insensitive for the
|
||||
/// same reason: an id typed back off a listing has to resolve in whatever case it was
|
||||
/// read.
|
||||
///
|
||||
/// A search that reaches neither tier is an error, not a no-op. A relation the ticket does
|
||||
/// not hold reports no change, which is what the caller asked for either way, but a search
|
||||
/// naming nothing at all is a typo and reporting no change for it would swallow it.
|
||||
fn find_relation(
|
||||
existing: &[Relation],
|
||||
kind: RelationKind,
|
||||
search: &str,
|
||||
title: &str,
|
||||
worklane_dir: &Path,
|
||||
) -> Result<Option<Relation>> {
|
||||
let held: Vec<&Relation> = existing.iter().filter(|held| held.kind == kind).collect();
|
||||
let wanted = search.to_lowercase();
|
||||
|
||||
let by_prefix: Vec<&Relation> = held
|
||||
.iter()
|
||||
.copied()
|
||||
.filter(|held| {
|
||||
search.chars().count() >= MIN_ID_SEARCH
|
||||
&& held.target.to_lowercase().starts_with(&wanted)
|
||||
})
|
||||
.collect();
|
||||
|
||||
match by_prefix.as_slice() {
|
||||
[only] => return Ok(Some((*only).clone())),
|
||||
// Named rather than guessed at, the way an ambiguous ticket search is: the
|
||||
// candidates are printed and nothing is written.
|
||||
[_, _, ..] => {
|
||||
return Err(anyhow!(
|
||||
"'{}' matches {} '{}' relations on '{}': {}. Name more of the id",
|
||||
search,
|
||||
by_prefix.len(),
|
||||
kind.label(),
|
||||
title,
|
||||
by_prefix
|
||||
.iter()
|
||||
.map(|held| short_id(&held.target))
|
||||
.collect::<Vec<_>>()
|
||||
.join(", ")
|
||||
));
|
||||
}
|
||||
[] => {}
|
||||
}
|
||||
|
||||
match resolve_ticket(search, worklane_dir) {
|
||||
Ok((_status, _target_title, target)) => {
|
||||
let target_uuid = parse_ticket_field(&target, "ID");
|
||||
Ok(held.into_iter().find(|held| held.target == target_uuid).cloned())
|
||||
}
|
||||
// The resolver's own reason is carried through, so an ambiguous search says it is
|
||||
// ambiguous rather than being reported as nothing at all.
|
||||
Err(reason) => Err(anyhow!(
|
||||
"No '{}' relation on '{}' matches '{}': {}",
|
||||
kind.label(),
|
||||
title,
|
||||
search,
|
||||
reason
|
||||
)),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn cmd_relate(args: &RelateArgs, start: &Path) -> Result<()> {
|
||||
let worklane_dir = find_worklane_dir(start)?;
|
||||
let (status, title, original) = resolve_ticket(&args.ticket, &worklane_dir)?;
|
||||
let uuid = parse_ticket_field(&original, "ID");
|
||||
let existing = parse_relations(&original, &title)?;
|
||||
|
||||
// Every target resolved and every refusal raised before a byte is written, so a
|
||||
// call naming one good ticket and one bad one records neither.
|
||||
// Every target resolved, every kind parsed and every refusal raised before a byte is
|
||||
// written, so a call naming one good ticket and one bad one records neither.
|
||||
let asked = args.cleared()?;
|
||||
|
||||
let mut items: Vec<String> = Vec::new();
|
||||
let mut changed: Vec<&str> = Vec::new();
|
||||
// Every addition the call asked for, whether or not it is one to write. `items` drops
|
||||
// the ones already held, and a contradiction has to be caught on what was *asked*: a
|
||||
// relation already in the file is not in `items`, so comparing against that would let
|
||||
// `--blocked-by X --clear blocked-by X` quietly remove it.
|
||||
let mut requested: Vec<Relation> = Vec::new();
|
||||
|
||||
for (kind, targets) in args.requested() {
|
||||
for search in targets {
|
||||
@@ -1136,10 +1217,21 @@ pub fn cmd_relate(args: &RelateArgs, start: &Path) -> Result<()> {
|
||||
}
|
||||
|
||||
let relation = Relation { kind, target: target_uuid };
|
||||
requested.push(relation.clone());
|
||||
|
||||
// Already held, either in the file or earlier in this call. Recording it
|
||||
// twice would read as two dependencies on one ticket.
|
||||
if existing.contains(&relation) || items.contains(&relation.item()) {
|
||||
// A symmetric relation the target already stores is already recorded, from
|
||||
// the other end: `show` derives it onto this ticket by scanning, so a line
|
||||
// here would be the same edge stored twice. 4179958 decided `relates to` is
|
||||
// written once and not onto both files, and nothing enforced it until
|
||||
// 03bdc76. Only the symmetric kind, since the target holding
|
||||
// `blocked by <this>` is a cycle rather than a duplicate.
|
||||
let mirrored = kind.is_symmetric()
|
||||
&& parse_relations(&target, &target_title)?
|
||||
.contains(&Relation { kind, target: uuid.clone() });
|
||||
|
||||
// Already held, either in the file, at the far end, or earlier in this call.
|
||||
// Recording it twice would read as two dependencies on one ticket.
|
||||
if existing.contains(&relation) || items.contains(&relation.item()) || mirrored {
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -1150,15 +1242,74 @@ pub fn cmd_relate(args: &RelateArgs, start: &Path) -> Result<()> {
|
||||
}
|
||||
}
|
||||
|
||||
if items.is_empty() {
|
||||
let mut dropped: Vec<Relation> = Vec::new();
|
||||
let mut cleared: Vec<&str> = Vec::new();
|
||||
|
||||
for (kind, search) in asked {
|
||||
let Some(relation) = find_relation(&existing, kind, search, &title, &worklane_dir)? else {
|
||||
continue;
|
||||
};
|
||||
|
||||
// Both directions in one call, the way `set --clear` refuses a field it is also
|
||||
// replacing: nothing is written rather than one of the two silently winning.
|
||||
if requested.contains(&relation) {
|
||||
return Err(anyhow!(
|
||||
"--{} and --clear {} name the same relation to '{}', so nothing was written",
|
||||
kind.flag(),
|
||||
kind.flag(),
|
||||
short_id(&relation.target)
|
||||
));
|
||||
}
|
||||
|
||||
if dropped.contains(&relation) {
|
||||
continue;
|
||||
}
|
||||
|
||||
dropped.push(relation);
|
||||
if !cleared.contains(&kind.label()) {
|
||||
cleared.push(kind.label());
|
||||
}
|
||||
}
|
||||
|
||||
if items.is_empty() && dropped.is_empty() {
|
||||
report(&[], &title, "Recorded");
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
let content = append_section_body(&ensure_section(&original, &RELATIONS), &RELATIONS, &items)?;
|
||||
// Removals first, by rewriting the section from what is left, then additions appended
|
||||
// to that. Two passes rather than one rebuild of the whole section: a call with no
|
||||
// `--clear` then takes exactly the path it always took, and `append_section_body` goes
|
||||
// on deciding where a new line lands.
|
||||
let mut content = original.clone();
|
||||
|
||||
if !dropped.is_empty() {
|
||||
let kept: Vec<String> = existing
|
||||
.iter()
|
||||
.filter(|held| !dropped.contains(held))
|
||||
.map(|held| held.item())
|
||||
.collect();
|
||||
|
||||
// The placeholder rather than an empty body when the last edge goes, which is the
|
||||
// line `add` writes and the line `append` treats as no content, so the section can
|
||||
// be written to again without it being left above what follows.
|
||||
content = match kept.is_empty() {
|
||||
true => clear_section_body(&content, &RELATIONS)?,
|
||||
false => set_section_body(&content, &RELATIONS, &kept)?,
|
||||
};
|
||||
}
|
||||
|
||||
if !items.is_empty() {
|
||||
content = append_section_body(&ensure_section(&content, &RELATIONS), &RELATIONS, &items)?;
|
||||
}
|
||||
|
||||
save_ticket(&worklane_dir, &status, &uuid, &title, None, &content)?;
|
||||
|
||||
report(&changed, &title, "Recorded");
|
||||
if !changed.is_empty() {
|
||||
report(&changed, &title, "Recorded");
|
||||
}
|
||||
if !cleared.is_empty() {
|
||||
report(&cleared, &title, "Cleared");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
||||
+374
-97
@@ -2682,31 +2682,43 @@ fn draw_frame(frame: &mut Frame, tab: &Tab, area: Rect) {
|
||||
|
||||
// The way out, on the border of the thing it undoes rather than in the footer. The
|
||||
// footer row is already at its width naming eight keys, and this belongs beside the
|
||||
// frame anyway: it is what takes the frame away. Grey because it is chrome, the colour
|
||||
// the footer's own key names and the overlay's page indicator take.
|
||||
// frame anyway: it is what takes the frame away. Drawn as a key hint and not as grey
|
||||
// chrome, because that is what it is, and it is the one key on the board named anywhere
|
||||
// but the footer: a reader who has learnt where the cyan letter is should not have to
|
||||
// learn a second convention to find this one. The indicator beside it keeps the chrome
|
||||
// colour, having no key in it.
|
||||
//
|
||||
// The page indicator follows it on the same border rather than going up beside the
|
||||
// title where the overlay's sits. The title is cut against the border it is on, so an
|
||||
// indicator up there would shorten a long campaign name the moment its description grew
|
||||
// past three rows, and the bottom right is the standing's — which is what the frame is
|
||||
// about, where this is only where the reader has got to in it.
|
||||
let hint = " q board ";
|
||||
let mut hint = vec![Span::raw(" ")];
|
||||
hint.extend(key_hint("q", "board"));
|
||||
hint.push(Span::raw(" "));
|
||||
|
||||
let indicator = page_indicator(offset, last, text.height, area.width).unwrap_or_default();
|
||||
let room = area.width.saturating_sub(2) as usize;
|
||||
let taken = spans_width(&content.standing);
|
||||
let hint_width = spans_width(&hint);
|
||||
let indicator_width = indicator.chars().count();
|
||||
|
||||
// Dropped whole rather than cut, the rule the indicator follows on the overlay: half of
|
||||
// either reads as something else. The indicator goes first when the two cannot both fit,
|
||||
// because with a filter on the footer's last slot names `ctrl-c quit` and this is the
|
||||
// only place on the board that says `q` gives it back.
|
||||
let both = format!("{hint}{indicator}");
|
||||
let left = [both.as_str(), hint, ""]
|
||||
.into_iter()
|
||||
.find(|left| left.chars().count() + taken <= room)
|
||||
.unwrap_or_default();
|
||||
// only place on the board that says `q` gives it back. Measured over the spans rather
|
||||
// than over one string, since the hint is three of them now.
|
||||
let left = match (hint_width + indicator_width + taken <= room, hint_width + taken <= room) {
|
||||
(true, _) => {
|
||||
let mut both = hint;
|
||||
both.push(Span::styled(indicator, Style::default().fg(Color::Grey.into())));
|
||||
both
|
||||
}
|
||||
(false, true) => hint,
|
||||
(false, false) => Vec::new(),
|
||||
};
|
||||
if !left.is_empty() {
|
||||
block = block
|
||||
.title_bottom(Line::from(Span::styled(left, Style::default().fg(Color::Grey.into()))));
|
||||
block = block.title_bottom(Line::from(left));
|
||||
}
|
||||
|
||||
block = block.title_bottom(Line::from(content.standing).right_aligned());
|
||||
@@ -3379,6 +3391,56 @@ fn with_ellipsis(row: &str, width: usize) -> String {
|
||||
cut
|
||||
}
|
||||
|
||||
/// The gap between two hints on a row of keys.
|
||||
const KEY_GAP: &str = " ";
|
||||
|
||||
/// One key hint: the key, and what pressing it does.
|
||||
///
|
||||
/// Two spans either way, the key and the rest of it. The key is cyan and bold and the
|
||||
/// description takes the terminal's default foreground, which is the row frig and pantop
|
||||
/// draw with the same division — one accent colour per tool, cyan here and magenta there.
|
||||
/// The row as a whole is still chrome, but a key nobody can pick out of it is chrome that
|
||||
/// has to be read word by word to be used.
|
||||
///
|
||||
/// **The key is merged into the description when it is the description's first letter**, so
|
||||
/// `quit` is drawn with a cyan `q` and nothing in front of it while `y copy id` keeps both
|
||||
/// halves. Two cells back on a row already at its width naming eight keys, and the letter
|
||||
/// on screen is the key either way. The prefix test is case sensitive for that reason: a
|
||||
/// board naming both `r` and `R` would draw one word for the two of them otherwise, and the
|
||||
/// merged form can only say which key it is while the letter it colours *is* that key.
|
||||
fn key_hint(key: &str, description: &str) -> [Span<'static>; 2] {
|
||||
let rest = match description.strip_prefix(key) {
|
||||
Some(rest) => rest.to_string(),
|
||||
None => format!(" {description}"),
|
||||
};
|
||||
|
||||
[
|
||||
Span::styled(
|
||||
key.to_string(),
|
||||
Style::default()
|
||||
.fg(Color::Cyan.into())
|
||||
.add_modifier(Modifier::BOLD),
|
||||
),
|
||||
Span::raw(rest),
|
||||
]
|
||||
}
|
||||
|
||||
/// A run of hints, gap separated, closed by the space every row ends on.
|
||||
///
|
||||
/// The opening space is the caller's: the footer starts on one, and the prompt and the
|
||||
/// picker's query row put what was typed there instead.
|
||||
fn key_hints(hints: &[(&str, &str)]) -> Vec<Span<'static>> {
|
||||
let mut spans = Vec::new();
|
||||
for (key, description) in hints {
|
||||
if !spans.is_empty() {
|
||||
spans.push(Span::raw(KEY_GAP));
|
||||
}
|
||||
spans.extend(key_hint(key, description));
|
||||
}
|
||||
spans.push(Span::raw(" "));
|
||||
spans
|
||||
}
|
||||
|
||||
fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
|
||||
// The prompt takes the whole row while it is open. The footer is one line and
|
||||
// already says what the state allows, and with every key going into the buffer the
|
||||
@@ -3410,24 +3472,19 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
|
||||
// version of the summary line `ls` prints above a listing that leaves the terminal
|
||||
// statuses out.
|
||||
let d = match board.visibility.next_reveal() {
|
||||
Some(status) => format!("d show {} ({})", status, column_count(board, status)),
|
||||
None => "d hide both".to_string(),
|
||||
};
|
||||
|
||||
// Only when there is a tab to move to, since the footer names keys that work.
|
||||
let tabs = match board.tabbed() {
|
||||
true => "tab project ",
|
||||
false => "",
|
||||
Some(status) => format!("show {} ({})", status, column_count(board, status)),
|
||||
None => "hide both".to_string(),
|
||||
};
|
||||
|
||||
// The last slot answers the same question in every state: how to get out of here. `q`
|
||||
// takes off whatever is on top, so with a ticket open or a filter on the honest answer
|
||||
// is `ctrl-c`, the only key left that quits in one press. Naming `q quit` over either
|
||||
// would be the fault 1b78a24 was, a footer describing a key by what it used to do — and
|
||||
// with a filter on, the frame names what that press actually does instead.
|
||||
// is `ctrl-c`, the only key left that quits in one press. Going on drawing the merged
|
||||
// `quit` there would be the fault 1b78a24 was, a footer describing a key by what it
|
||||
// used to do — and with a filter on, the frame names what that press actually does
|
||||
// instead. Split either way once the key is `ctrl-c`, which is no word's first letter.
|
||||
let quit = match board.detail.is_some() || !board.current().filter.is_whole() {
|
||||
true => "ctrl-c quit",
|
||||
false => "q quit",
|
||||
true => ("ctrl-c", "quit"),
|
||||
false => ("q", "quit"),
|
||||
};
|
||||
|
||||
// `c` and `t` are named where a reader has to find them: on the board, with nothing
|
||||
@@ -3436,53 +3493,74 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
|
||||
// so the row is not at its width naming nine keys to repeat what is already on screen.
|
||||
// The tag used to be drawn here for want of a frame to draw it in, which is the one
|
||||
// thing 2a83bd4 took away.
|
||||
let filter = match board.current().filter {
|
||||
Filter::Whole => "c campaign t tag ",
|
||||
_ => "",
|
||||
let filter: &[(&str, &str)] = match board.current().filter {
|
||||
Filter::Whole => &[("c", "campaign"), ("t", "tag")],
|
||||
_ => &[],
|
||||
};
|
||||
|
||||
// Which way `↵` will go, since the key is a toggle and the frame is already at one of
|
||||
// its two heights. Naming it `expand` while it collapses would be the fault 1b78a24
|
||||
// was, a footer describing a key by what it used to do.
|
||||
let height = match board.current().expanded {
|
||||
true => "collapse",
|
||||
false => "expand",
|
||||
};
|
||||
|
||||
// What `y` copies where the selection is. A tag is its own id, so naming it one would
|
||||
// send the reader looking for seven characters on a border that prints a word.
|
||||
let copied = match board.current().filter {
|
||||
Filter::Tag(_) => "copy tag",
|
||||
_ => "copy id",
|
||||
};
|
||||
|
||||
let mut hints: Vec<(&str, &str)> = Vec::new();
|
||||
|
||||
// Only when there is a tab to move to, since the footer names keys that work.
|
||||
if board.tabbed() {
|
||||
hints.push(("tab", "project"));
|
||||
}
|
||||
|
||||
// Three states, because the frame is a third place the selection can be and the row
|
||||
// must describe the keys that work where it is. An open ticket wins over both, which is
|
||||
// what owning `pgup` and `pgdn` means.
|
||||
//
|
||||
// On the frame, `↓` is the way back to the cards and the two scroll keys are the
|
||||
// frame's; `y` is named because it still copies what the frame names. `enter` and `←→`
|
||||
// frame's; `y` is named because it still copies what the frame names. `↵` and `←→`
|
||||
// are left out because they do nothing there. Incomplete rather than wrong, the trade
|
||||
// this row is allowed to make — what it must never do is name a key by what it used to
|
||||
// do. `↑ frame` is not named on the board for the same reason `c` is dropped from a
|
||||
// filtered board: the frame is drawn right above the columns and up is the key that
|
||||
// reaches it, and the row has no cells to spend saying so.
|
||||
// Which way `enter` will go, since the key is a toggle and the frame is already at one
|
||||
// of its two heights. Naming it `enter expand` while it collapses would be the fault
|
||||
// 1b78a24 was, a footer describing a key by what it used to do.
|
||||
let height = match board.current().expanded {
|
||||
true => "enter collapse",
|
||||
false => "enter expand",
|
||||
};
|
||||
match (board.detail.is_some(), board.current().focus) {
|
||||
(true, _) => hints.extend([
|
||||
("←→↑↓", "select"),
|
||||
("pgup/pgdn", "scroll"),
|
||||
("/", "search"),
|
||||
("y", "copy id"),
|
||||
("↵/q", "close"),
|
||||
]),
|
||||
(false, Focus::Frame) => hints.extend([
|
||||
("↓", "board"),
|
||||
("↵", height),
|
||||
("pgup/pgdn", "scroll"),
|
||||
("/", "search"),
|
||||
("y", copied),
|
||||
]),
|
||||
(false, Focus::Cards) => {
|
||||
hints.extend([("←→", "column"), ("↑↓", "card"), ("/", "search")]);
|
||||
hints.extend_from_slice(filter);
|
||||
hints.extend([("y", "copy id"), ("↵", "detail")]);
|
||||
}
|
||||
}
|
||||
|
||||
// What `y` copies where the selection is. A tag is its own id, so naming it one would
|
||||
// send the reader looking for seven characters on a border that prints a word.
|
||||
let copied = match board.current().filter {
|
||||
Filter::Tag(_) => "y copy tag",
|
||||
_ => "y copy id",
|
||||
};
|
||||
hints.push(("d", d.as_str()));
|
||||
hints.push(quit);
|
||||
|
||||
let keys = match (board.detail.is_some(), board.current().focus) {
|
||||
(true, _) => format!(
|
||||
" {tabs}←→↑↓ select pgup/pgdn scroll / search y copy id enter/q close {d} {quit} "
|
||||
),
|
||||
(false, Focus::Frame) => format!(
|
||||
" {tabs}↓ board {height} pgup/pgdn scroll / search {copied} {d} {quit} "
|
||||
),
|
||||
(false, Focus::Cards) => format!(
|
||||
" {tabs}←→ column ↑↓ card / search {filter}y copy id enter detail {d} {quit} "
|
||||
),
|
||||
};
|
||||
|
||||
frame.render_widget(
|
||||
Paragraph::new(Span::styled(keys, Style::default().fg(Color::Grey.into()))),
|
||||
area,
|
||||
);
|
||||
// The leading space is the row's own, the way every other row of the board opens on
|
||||
// one; `key_hints` closes it.
|
||||
let mut spans = vec![Span::raw(" ")];
|
||||
spans.extend(key_hints(&hints));
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
}
|
||||
|
||||
/// What the last keypress did, where the keys would otherwise be.
|
||||
@@ -3505,10 +3583,13 @@ fn draw_notice(frame: &mut Frame, notice: &Notice, area: Rect) {
|
||||
/// one: ratatui shows the cursor only for a frame that asked for it, and that is also
|
||||
/// what tells the reader they are in an input while the query is still empty.
|
||||
///
|
||||
/// What was typed is drawn in the default foreground and the keys in grey, because one
|
||||
/// of them is content and the other is chrome. A miss is said beside the query it is
|
||||
/// about, in brightred, since grey chrome is exactly what a reader skips. Colour
|
||||
/// accentuates here as it does on a card; the words carry the meaning either way.
|
||||
/// The two keys are drawn the way every other row draws them, cyan on the key and the
|
||||
/// default foreground on the word, so they are findable on a row whose other half is an
|
||||
/// input. That the query sits in the same foreground as the descriptions is what the
|
||||
/// house style costs here, and the cursor is what says which of the two is being typed
|
||||
/// into — which it does in a terminal with no colour at all. A miss stays brightred
|
||||
/// beside the query it is about, being the one thing on the row that is neither a key nor
|
||||
/// what was typed.
|
||||
fn draw_search(frame: &mut Frame, search: &Search, area: Rect) {
|
||||
let prompt = format!(" /{}", search.query);
|
||||
let mut spans = vec![Span::raw(prompt.clone())];
|
||||
@@ -3516,10 +3597,8 @@ fn draw_search(frame: &mut Frame, search: &Search, area: Rect) {
|
||||
if search.missed {
|
||||
spans.push(Span::styled(" no match", Style::default().fg(Color::BrightRed.into())));
|
||||
}
|
||||
spans.push(Span::styled(
|
||||
" enter jump esc cancel ",
|
||||
Style::default().fg(Color::Grey.into()),
|
||||
));
|
||||
spans.push(Span::raw(KEY_GAP));
|
||||
spans.extend(key_hints(&[("↵", "jump"), ("esc", "cancel")]));
|
||||
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
|
||||
@@ -3536,21 +3615,21 @@ fn draw_search(frame: &mut Frame, search: &Search, area: Rect) {
|
||||
/// is named only on the closed query, where it is the key to press, and the query's own row
|
||||
/// names what `esc` does to it rather than what it does to the picker.
|
||||
fn draw_picker_row(frame: &mut Frame, picker: &Picker, area: Rect) {
|
||||
let grey = Style::default().fg(Color::Grey.into());
|
||||
|
||||
let Some(query) = &picker.query else {
|
||||
frame.render_widget(
|
||||
Paragraph::new(Span::styled(" ↑↓ select enter view / search esc cancel ", grey)),
|
||||
area,
|
||||
);
|
||||
let mut spans = vec![Span::raw(" ")];
|
||||
spans.extend(key_hints(&[
|
||||
("↑↓", "select"),
|
||||
("↵", "view"),
|
||||
("/", "search"),
|
||||
("esc", "cancel"),
|
||||
]));
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
return;
|
||||
};
|
||||
|
||||
let prompt = format!(" /{query}");
|
||||
let spans = vec![
|
||||
Span::raw(prompt.clone()),
|
||||
Span::styled(" ↑↓ select enter view esc clear ", grey),
|
||||
];
|
||||
let mut spans = vec![Span::raw(prompt.clone()), Span::raw(KEY_GAP)];
|
||||
spans.extend(key_hints(&[("↑↓", "select"), ("↵", "view"), ("esc", "clear")]));
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
|
||||
// Held on the row, the way the search prompt's cursor is, so a query longer than the
|
||||
@@ -4142,6 +4221,77 @@ mod tests {
|
||||
render(board, width, height).pop().expect("no rows rendered")
|
||||
}
|
||||
|
||||
/// The cells of the footer row, as symbol, colour and modifier.
|
||||
///
|
||||
/// The row is the only place on the board where what a thing *is* is carried by its
|
||||
/// colour alone: the key merged into its description is one letter of a word, so the
|
||||
/// flattened row cannot say whether `quit` is a key or the tail of `ctrl-c quit`.
|
||||
fn footer_cells(
|
||||
board: &Board,
|
||||
width: u16,
|
||||
height: u16,
|
||||
) -> Vec<(String, ratatui::style::Color, Modifier)> {
|
||||
let mut terminal = Terminal::new(TestBackend::new(width, height)).unwrap();
|
||||
terminal.draw(|frame| draw(frame, board)).unwrap();
|
||||
let buffer = terminal.backend().buffer().clone();
|
||||
|
||||
let row = buffer.area.height - 1;
|
||||
(0..buffer.area.width)
|
||||
.map(|x| {
|
||||
let cell = &buffer[(x, row)];
|
||||
(cell.symbol().to_string(), cell.fg, cell.modifier)
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Where `text` starts on the footer, in cells.
|
||||
fn footer_at(cells: &[(String, ratatui::style::Color, Modifier)], text: &str) -> Option<usize> {
|
||||
let wanted: Vec<String> = text.chars().map(|c| c.to_string()).collect();
|
||||
|
||||
(0..=cells.len().saturating_sub(wanted.len())).find(|&at| {
|
||||
cells[at..at + wanted.len()]
|
||||
.iter()
|
||||
.zip(&wanted)
|
||||
.all(|((symbol, ..), c)| symbol == c)
|
||||
})
|
||||
}
|
||||
|
||||
/// How many cells the first `text` on the footer opens with in the key colour, and
|
||||
/// `None` when the row does not hold it at all.
|
||||
///
|
||||
/// One number answers both forms the row draws. Merged, `quit` is `Some(1)`: the `q`
|
||||
/// alone is a key and the rest of the word is description. Split, `ctrl-c quit` is
|
||||
/// `Some(6)`, and asking about `quit` on that row is `Some(0)` — the word is there and
|
||||
/// no part of it is a key. The flattened row cannot tell those two apart, since the
|
||||
/// split form contains the merged one, and which key quits from where is exactly what
|
||||
/// the tests below are about.
|
||||
fn keys_on(board: &Board, width: u16, height: u16, text: &str) -> Option<usize> {
|
||||
let cells = footer_cells(board, width, height);
|
||||
let at = footer_at(&cells, text)?;
|
||||
let key: ratatui::style::Color = Color::Cyan.into();
|
||||
|
||||
Some(
|
||||
cells[at..at + text.chars().count()]
|
||||
.iter()
|
||||
.take_while(|(_, colour, _)| *colour == key)
|
||||
.count(),
|
||||
)
|
||||
}
|
||||
|
||||
/// The colour and modifier the first cell of `text` reached the screen in.
|
||||
fn footer_style(
|
||||
board: &Board,
|
||||
width: u16,
|
||||
height: u16,
|
||||
text: &str,
|
||||
) -> (ratatui::style::Color, Modifier) {
|
||||
let cells = footer_cells(board, width, height);
|
||||
let at = footer_at(&cells, text).unwrap_or_else(|| panic!("no `{text}` on the footer"));
|
||||
let (_, colour, modifier) = cells[at].clone();
|
||||
|
||||
(colour, modifier)
|
||||
}
|
||||
|
||||
/// The overlay's top border row, where the block title sits.
|
||||
///
|
||||
/// Counted in characters rather than bytes: the rows carry multi-byte glyphs.
|
||||
@@ -5768,16 +5918,21 @@ mod tests {
|
||||
|
||||
let closed = render(&board, SCREEN.width, SCREEN.height).join("\n");
|
||||
assert!(closed.contains("↑↓ card"), "{closed}");
|
||||
assert!(closed.contains("enter detail"), "{closed}");
|
||||
assert!(closed.contains("↵ detail"), "{closed}");
|
||||
assert!(!closed.contains("scroll"), "a scroll offered with nothing open:\n{closed}");
|
||||
|
||||
assert!(closed.contains("q quit"), "nothing says how to leave:\n{closed}");
|
||||
// The merged form: the word alone, with `q` the only cell of it drawn as a key.
|
||||
assert_eq!(
|
||||
keys_on(&board, SCREEN.width, SCREEN.height, "quit"),
|
||||
Some(1),
|
||||
"nothing says how to leave:\n{closed}"
|
||||
);
|
||||
|
||||
board.toggle_detail();
|
||||
let open = render(&board, SCREEN.width, SCREEN.height).join("\n");
|
||||
assert!(open.contains("pgup/pgdn scroll"), "{open}");
|
||||
assert!(open.contains("select"), "{open}");
|
||||
assert!(open.contains("enter/q close"), "{open}");
|
||||
assert!(open.contains("↵/q close"), "{open}");
|
||||
}
|
||||
|
||||
/// The other half of giving `q` a second meaning. A footer that goes on saying
|
||||
@@ -5792,11 +5947,80 @@ mod tests {
|
||||
board.toggle_detail();
|
||||
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("enter/q close"), "q is not named as the close key:\n{row}");
|
||||
assert!(!row.contains("q quit"), "q still offered as the quit key:\n{row}");
|
||||
assert!(row.contains("↵/q close"), "q is not named as the close key:\n{row}");
|
||||
// Nothing on the row is drawn as `q` quitting. Asked of the flattened row this is
|
||||
// unanswerable now: `ctrl-c quit` holds the word the merged form is.
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "quit"),
|
||||
Some(0),
|
||||
"q still offered as the quit key:\n{row}"
|
||||
);
|
||||
// And the last slot still answers how to get out, which from here is the one
|
||||
// key that does it in a single press.
|
||||
assert!(row.contains("ctrl-c quit"), "nothing says what quits from here:\n{row}");
|
||||
// key that does it in a single press, split because `ctrl-c` is no word's letter.
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "ctrl-c quit"),
|
||||
Some(6),
|
||||
"nothing says what quits from here:\n{row}"
|
||||
);
|
||||
}
|
||||
|
||||
/// The division the row is drawn on: the key carries the accent colour and the words
|
||||
/// beside it carry none. Everything else about which key is named where is text, and
|
||||
/// this is the one thing that is not.
|
||||
#[test]
|
||||
fn a_key_is_the_accent_colour_and_its_description_is_the_default_foreground() {
|
||||
let dir = board_dir();
|
||||
write_ticket(&dir, "backlog", "11111111-0000-4000-8000-000000000000", "First one", "");
|
||||
|
||||
let board = one_board(&dir);
|
||||
let key: ratatui::style::Color = Color::Cyan.into();
|
||||
|
||||
// Merged: the `q` of `quit` is the key and the rest of the word is not.
|
||||
let (colour, modifier) = footer_style(&board, 120, 20, "quit");
|
||||
assert_eq!(colour, key, "the key did not reach the screen as one");
|
||||
assert!(modifier.contains(Modifier::BOLD), "the key is not bold: {modifier:?}");
|
||||
|
||||
let (colour, modifier) = footer_style(&board, 120, 20, "uit");
|
||||
assert_eq!(
|
||||
colour,
|
||||
ratatui::style::Color::Reset,
|
||||
"the description took the key's colour"
|
||||
);
|
||||
assert!(!modifier.contains(Modifier::BOLD), "the description is bold: {modifier:?}");
|
||||
|
||||
// Split: the same division across two words instead of inside one.
|
||||
assert_eq!(footer_style(&board, 120, 20, "y copy id").0, key);
|
||||
assert_eq!(footer_style(&board, 120, 20, "copy id").0, ratatui::style::Color::Reset);
|
||||
}
|
||||
|
||||
/// The prompt and the picker take the row from the footer, and draw the keys they leave
|
||||
/// on it the way the footer does: a reader who has learnt where the coloured letter is
|
||||
/// does not learn it again per row.
|
||||
#[test]
|
||||
fn the_prompt_and_the_picker_draw_their_keys_as_the_footer_does() {
|
||||
let dir = board_dir();
|
||||
write_campaign(&dir, V1, "First public release", "v1", "For a public tag.");
|
||||
write_ticket(&dir, "backlog", "11111111-0000-4000-8000-000000000000", "First one", "");
|
||||
|
||||
let mut board = one_board(&dir);
|
||||
let key: ratatui::style::Color = Color::Cyan.into();
|
||||
|
||||
board.open_search();
|
||||
assert_eq!(footer_style(&board, 120, 20, "↵ jump").0, key, "the prompt's key");
|
||||
assert_eq!(
|
||||
footer_style(&board, 120, 20, "jump").0,
|
||||
ratatui::style::Color::Reset,
|
||||
"the prompt's description"
|
||||
);
|
||||
|
||||
board.search_key(typed(KeyCode::Esc), SCREEN);
|
||||
board.open_picker(PickerKind::Campaign, SCREEN);
|
||||
assert_eq!(footer_style(&board, 120, 20, "↵ view").0, key, "the picker's key");
|
||||
assert_eq!(
|
||||
footer_style(&board, 120, 20, "view").0,
|
||||
ratatui::style::Color::Reset,
|
||||
"the picker's description"
|
||||
);
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------- searching --
|
||||
@@ -5843,9 +6067,9 @@ mod tests {
|
||||
let screen = render(&board, SCREEN.width, SCREEN.height);
|
||||
let row = screen.last().expect("no rows rendered");
|
||||
|
||||
assert!(row.contains("enter jump"), "{row}");
|
||||
assert!(row.contains("↵ jump"), "{row}");
|
||||
assert!(row.contains("esc cancel"), "{row}");
|
||||
assert!(!row.contains("q quit"), "the key list survived the prompt:\n{row}");
|
||||
assert!(!row.contains("quit"), "the key list survived the prompt:\n{row}");
|
||||
assert!(
|
||||
screen.join("\n").contains("Alpha first"),
|
||||
"the board went away behind the prompt"
|
||||
@@ -6285,7 +6509,11 @@ mod tests {
|
||||
assert!(board.notice.is_none(), "the message outlived its keypress");
|
||||
// And the keys are back, rather than the row staying spent on a read message.
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("q quit"), "the key list did not come back: {row}");
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "quit"),
|
||||
Some(1),
|
||||
"the key list did not come back: {row}"
|
||||
);
|
||||
}
|
||||
|
||||
/// Both footers name it, since the key works with a ticket open as well.
|
||||
@@ -7099,6 +7327,46 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
/// One builder behind both views, so the dedupe 03bdc76 added lands on the board
|
||||
/// without the overlay knowing about it. Criterion 2 names the board as well as
|
||||
/// `show`, and this is the half that says so.
|
||||
#[test]
|
||||
fn a_relates_to_stored_at_both_ends_is_drawn_once_in_the_overlay() {
|
||||
let dir = board_dir();
|
||||
let holder = "11111111-0000-4000-8000-000000000000";
|
||||
let target = "22222222-0000-4000-8000-000000000000";
|
||||
|
||||
// Both lines, which is the state a board recorded before `relate` refused the
|
||||
// mirror. The section goes ahead of the metadata on the holder, where `relate`
|
||||
// writes it and where the overlay has it on screen.
|
||||
std::fs::write(
|
||||
dir.join("backlog").join(format!("{holder}_a-holder.md")),
|
||||
format!(
|
||||
"# A holder\n\n## Description\nA description.\n\n## Relations\n\
|
||||
- relates to {target}\n\n## Metadata\n\n- **ID**: {holder}\n\
|
||||
- **Priority**: 2\n- **Status**: backlog\n"
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
write_ticket(
|
||||
&dir,
|
||||
"reviewing",
|
||||
target,
|
||||
"The target",
|
||||
&format!("\n## Relations\n- relates to {holder}\n"),
|
||||
);
|
||||
|
||||
let mut board = one_board(&dir);
|
||||
board.toggle_detail();
|
||||
let body = board.detail.as_ref().expect("no detail").plain();
|
||||
|
||||
assert_eq!(
|
||||
body.matches("relates to").count(),
|
||||
1,
|
||||
"the same edge is drawn twice in the overlay:\n{body}"
|
||||
);
|
||||
}
|
||||
|
||||
/// 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.
|
||||
@@ -8176,14 +8444,23 @@ mod tests {
|
||||
let dir = board_dir();
|
||||
let mut board = tag_board(&dir);
|
||||
|
||||
// Both merged, being their own words' first letters.
|
||||
let plain = footer(&board, 120, 20);
|
||||
assert!(plain.contains("t tag"), "the tag key is not named: {plain}");
|
||||
assert!(plain.contains("c campaign"), "{plain}");
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "tag"),
|
||||
Some(1),
|
||||
"the tag key is not named: {plain}"
|
||||
);
|
||||
assert_eq!(keys_on(&board, 120, 20, "campaign"), Some(1), "{plain}");
|
||||
|
||||
board.select_filter(Filter::Tag("bug".to_string()), SCREEN);
|
||||
let filtered = footer(&board, 120, 20);
|
||||
assert!(!filtered.contains("q board"), "the row repeated the frame: {filtered}");
|
||||
assert!(!filtered.contains("t tag"), "a key that filters again: {filtered}");
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "tag"),
|
||||
None,
|
||||
"a key that filters again: {filtered}"
|
||||
);
|
||||
assert!(filtered.contains("ctrl-c quit"), "{filtered}");
|
||||
}
|
||||
|
||||
@@ -9156,7 +9433,7 @@ mod tests {
|
||||
assert!(row.contains("pgup/pgdn scroll"), "the scroll keys are not named:\n{row}");
|
||||
assert!(row.contains("y copy id"), "the copy key is not named:\n{row}");
|
||||
// Both do nothing here, so neither is offered.
|
||||
assert!(!row.contains("enter detail"), "enter is named and does nothing:\n{row}");
|
||||
assert!(!row.contains("↵ detail"), "↵ is named and does nothing:\n{row}");
|
||||
assert!(
|
||||
!row.contains("←→ column"),
|
||||
"the column keys are named and do nothing:\n{row}"
|
||||
@@ -9573,12 +9850,12 @@ mod tests {
|
||||
board.select_card(-1, SCREEN);
|
||||
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("enter expand"), "enter is not named on the frame:\n{row}");
|
||||
assert!(row.contains("↵ expand"), "↵ is not named on the frame:\n{row}");
|
||||
|
||||
board.toggle_focused(SCREEN);
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("enter collapse"), "enter still offered as expand:\n{row}");
|
||||
assert!(!row.contains("enter expand"), "the row names it both ways:\n{row}");
|
||||
assert!(row.contains("↵ collapse"), "↵ still offered as expand:\n{row}");
|
||||
assert!(!row.contains("↵ expand"), "the row names it both ways:\n{row}");
|
||||
}
|
||||
|
||||
/// Expanding and collapsing leave the reader where they were rather than at the top. The
|
||||
@@ -9849,7 +10126,7 @@ mod tests {
|
||||
assert!(row.contains("Move the store off one disk."), "{row:?}");
|
||||
// And the footer is the picker's while it is open, for the reason the prompt takes
|
||||
// it: the board's key list describes nothing that currently works.
|
||||
assert!(footer(&board, 100, 24).contains("enter view"), "the footer is the board's");
|
||||
assert!(footer(&board, 100, 24).contains("↵ view"), "the footer is the board's");
|
||||
}
|
||||
|
||||
/// A campaign with no codename shows the id once, not twice: the row already opens
|
||||
@@ -10338,12 +10615,12 @@ mod tests {
|
||||
let dir = board_dir();
|
||||
let mut board = campaign_board(&dir);
|
||||
|
||||
assert!(footer(&board, 120, 24).contains("c campaign"), "the key is unfindable");
|
||||
assert_eq!(keys_on(&board, 120, 24, "campaign"), Some(1), "the key is unfindable");
|
||||
|
||||
board.select_filter(Filter::Campaign(V1.to_string()), SCREEN);
|
||||
let footer = footer(&board, 120, 24);
|
||||
assert!(footer.contains("ctrl-c quit"), "q still claims to quit: {footer:?}");
|
||||
assert!(!footer.contains("q quit"), "{footer:?}");
|
||||
let row = footer(&board, 120, 24);
|
||||
assert!(row.contains("ctrl-c quit"), "q still claims to quit: {row:?}");
|
||||
assert_eq!(keys_on(&board, 120, 24, "quit"), Some(0), "{row:?}");
|
||||
}
|
||||
|
||||
/// The filter belongs to the tab, not the board: a campaign is resolved inside one
|
||||
|
||||
+197
@@ -2123,12 +2123,61 @@ impl RelationKind {
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether the kind reads the same from both ends, which is `relates to` alone.
|
||||
///
|
||||
/// Derived from the two labels rather than listed, so a kind added later answers this
|
||||
/// by construction. A symmetric kind is the only one whose derived row can collide
|
||||
/// with its own stored line: `blocked by` from one end reads as `blocks` from the
|
||||
/// other, and those are two different things to say about one pair of tickets.
|
||||
pub fn is_symmetric(self) -> bool {
|
||||
self.label() == self.inverse_label()
|
||||
}
|
||||
|
||||
/// Every kind, so a caller can walk them without listing them a second time.
|
||||
pub const ALL: [RelationKind; 3] = [
|
||||
RelationKind::BlockedBy,
|
||||
RelationKind::RegressionOf,
|
||||
RelationKind::RelatesTo,
|
||||
];
|
||||
|
||||
/// How the kind is spelled at the command line: the flag that records it, without
|
||||
/// the leading hyphens.
|
||||
///
|
||||
/// A match rather than `label().replace(' ', "-")`, so the pairing is pinned and the
|
||||
/// completion list, the `--clear` value and the flag cannot drift apart.
|
||||
pub fn flag(self) -> &'static str {
|
||||
match self {
|
||||
RelationKind::BlockedBy => "blocked-by",
|
||||
RelationKind::RegressionOf => "regression-of",
|
||||
RelationKind::RelatesTo => "relates-to",
|
||||
}
|
||||
}
|
||||
|
||||
/// One kind from the value `relate --clear` names, or an error listing the three.
|
||||
///
|
||||
/// Both spellings are accepted, the flag's `blocked-by` and the label's `blocked by`,
|
||||
/// because both are in front of the reader: the flag is what recorded the relation and
|
||||
/// the label is what `show` prints in the block and what the file stores. Refusing the
|
||||
/// form the tool itself prints would be a trap for anyone clearing a row they just
|
||||
/// read. Case insensitive, the bargain the id and codename tiers already take.
|
||||
pub fn parse_value(value: &str) -> Result<Self> {
|
||||
let wanted = value.trim().to_lowercase().replace('-', " ");
|
||||
|
||||
RelationKind::ALL
|
||||
.into_iter()
|
||||
.find(|kind| kind.label() == wanted)
|
||||
.ok_or_else(|| {
|
||||
anyhow!(
|
||||
"'{}' is not a relation kind. The kinds are {}",
|
||||
value,
|
||||
RelationKind::ALL
|
||||
.iter()
|
||||
.map(|kind| kind.flag())
|
||||
.collect::<Vec<_>>()
|
||||
.join(", ")
|
||||
)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// One stored edge: a kind, and the full uuid of the ticket it points at.
|
||||
@@ -2530,10 +2579,30 @@ pub fn relation_rows(stored: &[Relation], index: &RelationIndex, uuid: &str) ->
|
||||
})
|
||||
.collect();
|
||||
|
||||
// How each stored row reads, which is what a derived row is checked against below.
|
||||
// Collected first because the check cannot borrow `rows` while extending it.
|
||||
let drawn: Vec<(&'static str, String)> =
|
||||
rows.iter().map(|row| (row.label, row.uuid.clone())).collect();
|
||||
|
||||
rows.extend(
|
||||
index
|
||||
.inbound(uuid)
|
||||
// A derived row that reads exactly like a stored one is not a second fact.
|
||||
// Both ends of a symmetric relation can hold a line, since nothing stopped
|
||||
// that until 03bdc76, and the block drew the same neighbour twice under the
|
||||
// same label. The stored row is the one kept: it is the line `--clear` can
|
||||
// address, where the derived one is on a file this ticket does not own.
|
||||
//
|
||||
// Keyed on the label and the target rather than the kind and the target,
|
||||
// which is what keeps a mutual block as two rows: `blocked by` and `blocks`
|
||||
// are different things to say about one pair, and only a symmetric kind,
|
||||
// whose inverse label is its own, can collide with itself.
|
||||
.into_iter()
|
||||
.filter(|(kind, holder)| {
|
||||
!drawn
|
||||
.iter()
|
||||
.any(|(label, target)| *label == kind.inverse_label() && *target == holder.uuid)
|
||||
})
|
||||
.map(|(kind, holder)| RelationRow {
|
||||
kind,
|
||||
label: kind.inverse_label(),
|
||||
@@ -5579,6 +5648,134 @@ Plain line with **bold** and a [link](http://x.test/a).
|
||||
assert_eq!(seen.len(), 3, "{seen:?}");
|
||||
}
|
||||
|
||||
/// Every kind is reachable by the flag that records it and by the label `show` prints,
|
||||
/// in any case, and every kind has a flag of its own. Over `RelationKind::ALL` rather
|
||||
/// than the three names, so a kind added later has to be spellable too.
|
||||
#[test]
|
||||
fn a_kind_parses_from_the_flag_spelling_and_the_label_spelling() {
|
||||
let mut flags = std::collections::HashSet::new();
|
||||
|
||||
for kind in RelationKind::ALL {
|
||||
assert!(flags.insert(kind.flag()), "{kind:?} shares its flag with another kind");
|
||||
assert_eq!(kind.flag(), kind.label().replace(' ', "-"), "{kind:?}");
|
||||
|
||||
for spelling in [kind.flag().to_string(), kind.label().to_string()] {
|
||||
for cased in [spelling.to_lowercase(), spelling.to_uppercase()] {
|
||||
assert_eq!(
|
||||
RelationKind::parse_value(&cased).unwrap(),
|
||||
kind,
|
||||
"{cased:?} does not parse as {kind:?}"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A value that is not a kind names the three, in the spelling the flags and the
|
||||
/// completions use rather than the spelling the file stores: a reader who has just
|
||||
/// been refused is about to retype the flag.
|
||||
#[test]
|
||||
fn a_value_that_is_not_a_kind_names_the_three() {
|
||||
let refused = RelationKind::parse_value("depends-on").expect_err("accepted");
|
||||
let message = refused.to_string();
|
||||
|
||||
assert!(message.contains("not a relation kind"), "{message}");
|
||||
for kind in RelationKind::ALL {
|
||||
assert!(message.contains(kind.flag()), "{kind:?} is not named: {message}");
|
||||
}
|
||||
}
|
||||
|
||||
/// `relates to` alone reads the same from both ends, and it is derived from the two
|
||||
/// labels rather than listed, so a kind added later answers by construction.
|
||||
#[test]
|
||||
fn only_relates_to_is_symmetric() {
|
||||
for kind in RelationKind::ALL {
|
||||
assert_eq!(
|
||||
kind.is_symmetric(),
|
||||
kind == RelationKind::RelatesTo,
|
||||
"{kind:?} claims symmetry it does not have, or has one it does not claim"
|
||||
);
|
||||
assert_eq!(kind.is_symmetric(), kind.label() == kind.inverse_label(), "{kind:?}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Both ends of a symmetric relation can hold a line, since nothing stopped that
|
||||
/// until 03bdc76, and the block drew the same neighbour twice under the same label.
|
||||
/// The derived row goes and the stored one stays: it is the line `--clear` can
|
||||
/// address, where the derived one lives on a file this ticket does not own.
|
||||
#[test]
|
||||
fn a_derived_row_that_reads_like_a_stored_one_is_drawn_once() {
|
||||
let index = RelationIndex::new(vec![related(
|
||||
TARGET,
|
||||
"The neighbour",
|
||||
"backlog",
|
||||
vec![relation(RelationKind::RelatesTo, SELF)],
|
||||
)]);
|
||||
let stored = vec![relation(RelationKind::RelatesTo, TARGET)];
|
||||
|
||||
let rows = relation_rows(&stored, &index, SELF);
|
||||
assert_eq!(rows.len(), 1, "the same edge is drawn twice: {rows:?}");
|
||||
assert_eq!(rows[0].label, "relates to");
|
||||
assert_eq!(rows[0].uuid, TARGET);
|
||||
|
||||
// The stored one, which is what `--clear` addresses. Both ends carry the same
|
||||
// label here, so the label cannot say which survived: the count is what does.
|
||||
assert_eq!(
|
||||
render_relations(&rows, false),
|
||||
format!("relates to {RELATES_MARK} {} (b1b2c3d) The neighbour\n", smark("backlog"))
|
||||
);
|
||||
}
|
||||
|
||||
/// Only where the row would read the same. A pair of tickets each blocking the other
|
||||
/// is two facts, and the block says both: `blocked by` from this end and `blocks`
|
||||
/// from the other. Deduping on the kind rather than on the label would have folded
|
||||
/// them into one and lost half of what the ticket says.
|
||||
#[test]
|
||||
fn a_mutual_relation_of_an_asymmetric_kind_keeps_both_rows() {
|
||||
for kind in RelationKind::ALL.into_iter().filter(|kind| !kind.is_symmetric()) {
|
||||
let index = RelationIndex::new(vec![related(
|
||||
TARGET,
|
||||
"The other one",
|
||||
"backlog",
|
||||
vec![relation(kind, SELF)],
|
||||
)]);
|
||||
let stored = vec![relation(kind, TARGET)];
|
||||
|
||||
let rows = relation_rows(&stored, &index, SELF);
|
||||
assert_eq!(rows.len(), 2, "{kind:?} lost a row: {rows:?}");
|
||||
assert_eq!(rows[0].label, kind.label(), "{kind:?}");
|
||||
assert_eq!(rows[1].label, kind.inverse_label(), "{kind:?}");
|
||||
}
|
||||
}
|
||||
|
||||
/// The dedupe is per target, not per kind: a second neighbour holding its own
|
||||
/// `relates to` is a different edge and keeps its row.
|
||||
#[test]
|
||||
fn a_second_neighbours_derived_row_survives_the_dedupe() {
|
||||
const OTHER: &str = "cccccccc-1111-4222-8333-444444444444";
|
||||
|
||||
let index = RelationIndex::new(vec![
|
||||
related(
|
||||
TARGET,
|
||||
"The neighbour",
|
||||
"backlog",
|
||||
vec![relation(RelationKind::RelatesTo, SELF)],
|
||||
),
|
||||
related(
|
||||
OTHER,
|
||||
"Another one",
|
||||
"backlog",
|
||||
vec![relation(RelationKind::RelatesTo, SELF)],
|
||||
),
|
||||
]);
|
||||
let stored = vec![relation(RelationKind::RelatesTo, TARGET)];
|
||||
|
||||
let rows = relation_rows(&stored, &index, SELF);
|
||||
assert_eq!(rows.len(), 2, "{rows:?}");
|
||||
assert_eq!(rows[0].uuid, TARGET, "the stored row is not first: {rows:?}");
|
||||
assert_eq!(rows[1].uuid, OTHER, "the other neighbour was dropped: {rows:?}");
|
||||
}
|
||||
|
||||
/// Both directions of one kind carry the same mark, since the kind is what the mark
|
||||
/// says and the label is what says which way it points.
|
||||
#[test]
|
||||
|
||||
@@ -388,3 +388,415 @@ fn a_line_that_is_not_a_relation_is_an_error() {
|
||||
assert!(stderr.contains("is not a relation"), "{stderr}");
|
||||
assert!(stderr.contains("The gated one"), "{stderr}");
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------- clearing --
|
||||
|
||||
/// Two blockers, one taken off by name. The other survives, which is the whole reason
|
||||
/// `--clear` names the target and not just the kind: a ticket can hold several of one
|
||||
/// kind, and emptying all of them is not usually what is wanted.
|
||||
#[test]
|
||||
fn a_relation_is_taken_off_by_its_kind_and_its_target() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
|
||||
run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--blocked-by",
|
||||
BLOCKER,
|
||||
"--blocked-by",
|
||||
FIXED,
|
||||
],
|
||||
);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(stdout(&out).contains("Cleared blocked by"), "{}", stdout(&out));
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(
|
||||
!content.contains(BLOCKER),
|
||||
"the cleared relation is still there: {content}"
|
||||
);
|
||||
assert!(
|
||||
content.contains(&format!("- blocked by {}", FIXED)),
|
||||
"the other one went too: {content}"
|
||||
);
|
||||
}
|
||||
|
||||
/// Both spellings of the kind, because both are in front of the reader: `blocked-by` is
|
||||
/// the flag that recorded it and `blocked by` is what `show` prints and what the file
|
||||
/// stores. Refusing the form the tool itself prints would be a trap.
|
||||
#[test]
|
||||
fn the_kind_takes_the_flag_spelling_and_the_label_spelling() {
|
||||
for kind in ["blocked-by", "blocked by", "Blocked-By"] {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", kind, BLOCKER]);
|
||||
assert!(out.status.success(), "{kind}: {}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(!ticket(&worklane, GATED).contains(BLOCKER), "{kind} did not clear it");
|
||||
}
|
||||
}
|
||||
|
||||
/// The target is a ticket argument like any other, so it resolves by title too.
|
||||
#[test]
|
||||
fn a_cleared_target_resolves_by_title() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", "blocker"]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(!ticket(&worklane, GATED).contains(BLOCKER));
|
||||
}
|
||||
|
||||
/// A relation the ticket does not hold is the state the caller asked for, so it reports
|
||||
/// no change rather than failing. The target resolves; the edge is simply not there.
|
||||
#[test]
|
||||
fn clearing_a_relation_the_ticket_does_not_hold_reports_no_change() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
// A kind it does not hold at all, and a target it holds under another kind.
|
||||
for args in [["relates-to", BLOCKER], ["blocked-by", FIXED]] {
|
||||
let out = run(&temp, &["relate", GATED, "--clear", args[0], args[1]]);
|
||||
assert!(out.status.success(), "{args:?}: {}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(stdout(&out).contains("No changes"), "{args:?}: {}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before, "{args:?} wrote something");
|
||||
}
|
||||
}
|
||||
|
||||
/// A search naming nothing at all is a typo, not a state to report. Reporting no change
|
||||
/// for it would swallow it, which is the one thing the no-change rule must not do.
|
||||
#[test]
|
||||
fn clearing_a_target_that_names_nothing_is_an_error() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", "9999zzzz"]);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// The inverse is derived by a scan rather than stored, so taking the stored line off is
|
||||
/// what takes it off both ends. The other ticket's own file was never touched either way.
|
||||
#[test]
|
||||
fn the_derived_inverse_goes_with_the_stored_line() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
let untouched = ticket(&worklane, BLOCKER);
|
||||
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let shown = stdout(&run(&temp, &["show", BLOCKER]));
|
||||
assert!(shown.contains("blocks"), "the inverse was never derived: {shown}");
|
||||
|
||||
run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
let after = stdout(&run(&temp, &["show", BLOCKER]));
|
||||
assert!(!after.contains("blocks"), "the inverse outlived the stored line: {after}");
|
||||
assert_eq!(ticket(&worklane, BLOCKER), untouched, "the other ticket was written to");
|
||||
}
|
||||
|
||||
/// The case most likely to need clearing, and the only one no search of the board can
|
||||
/// reach: the target's ticket is gone, so the prefix tier over the stored targets is what
|
||||
/// finds it. `show` renders it as `_missing_` until it is cleared, and `mv` warns about it
|
||||
/// on every move.
|
||||
#[test]
|
||||
fn a_dangling_relation_can_be_cleared() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
fs::remove_file(find(&worklane, BLOCKER)).unwrap();
|
||||
assert!(
|
||||
stdout(&run(&temp, &["show", GATED])).contains("_missing_"),
|
||||
"the fixture is not dangling"
|
||||
);
|
||||
|
||||
// By the short id, which is all a reader has once the title is gone.
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", &BLOCKER[..7]]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(!ticket(&worklane, GATED).contains(BLOCKER), "{}", ticket(&worklane, GATED));
|
||||
assert!(!stdout(&run(&temp, &["show", GATED])).contains("_missing_"));
|
||||
}
|
||||
|
||||
/// A prefix short enough to reach two stored targets names the candidates rather than
|
||||
/// guessing, the way an ambiguous ticket search does, and writes nothing.
|
||||
#[test]
|
||||
fn an_ambiguous_prefix_over_the_stored_targets_names_the_candidates() {
|
||||
const ONE: &str = "aaaa1111-0000-4000-8000-000000000000";
|
||||
const TWO: &str = "aaaa2222-0000-4000-8000-000000000000";
|
||||
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
create_ticket(&worklane, "backlog", "Twin one", ONE);
|
||||
create_ticket(&worklane, "backlog", "Twin two", TWO);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", ONE, "--blocked-by", TWO]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", "aaaa"]);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
|
||||
// The stored-target tier and not the board search, which would find the same two
|
||||
// tickets by their own uuid prefix and report them the same way. The wording is what
|
||||
// tells the two apart, so it is what this asserts.
|
||||
let reason = String::from_utf8_lossy(&out.stderr);
|
||||
assert!(
|
||||
reason.contains("'blocked by' relations on"),
|
||||
"the board answered instead: {reason}"
|
||||
);
|
||||
assert!(reason.contains(&ONE[..7]) && reason.contains(&TWO[..7]), "{reason}");
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// The last edge leaves the placeholder `add` writes, not an empty body, so the section
|
||||
/// can be written to again without the placeholder ending up above what follows it.
|
||||
#[test]
|
||||
fn clearing_the_last_relation_leaves_the_placeholder() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(
|
||||
content.contains(
|
||||
"## Relations
|
||||
_No relations._
|
||||
"
|
||||
),
|
||||
"{content}"
|
||||
);
|
||||
|
||||
// And it is written to again without the placeholder being left behind.
|
||||
run(&temp, &["relate", GATED, "--relates-to", FIXED]);
|
||||
let again = ticket(&worklane, GATED);
|
||||
assert!(again.contains(&format!("- relates to {}", FIXED)), "{again}");
|
||||
assert!(
|
||||
!again.contains("_No relations._"),
|
||||
"the placeholder outlived the edge: {again}"
|
||||
);
|
||||
}
|
||||
|
||||
/// The same file surgery `relate` already does, so the tick, the handwritten section and
|
||||
/// the prose survive a clear the way they survive a record.
|
||||
#[test]
|
||||
fn clearing_leaves_everything_it_was_not_asked_about_alone() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--blocked-by",
|
||||
BLOCKER,
|
||||
"--relates-to",
|
||||
FIXED,
|
||||
],
|
||||
);
|
||||
run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(content.contains("- [x] Crit one"), "the tick was lost: {content}");
|
||||
assert!(
|
||||
content.contains("## Notes\nA handwritten note the tool knows nothing about.\n"),
|
||||
"the unknown section was lost: {content}"
|
||||
);
|
||||
assert!(content.contains("1. Step one"), "{content}");
|
||||
assert!(content.contains("- **Owner**: alice"), "{content}");
|
||||
assert!(content.contains("- **Status**: backlog"), "{content}");
|
||||
}
|
||||
|
||||
/// One call does both, and each half reports itself in its own words.
|
||||
#[test]
|
||||
fn one_call_records_and_clears_different_relations() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
let out = run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--clear",
|
||||
"blocked-by",
|
||||
BLOCKER,
|
||||
"--relates-to",
|
||||
FIXED,
|
||||
],
|
||||
);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
|
||||
let reported = stdout(&out);
|
||||
assert!(reported.contains("Recorded relates to"), "{reported}");
|
||||
assert!(reported.contains("Cleared blocked by"), "{reported}");
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(!content.contains(BLOCKER), "{content}");
|
||||
assert!(content.contains(&format!("- relates to {}", FIXED)), "{content}");
|
||||
}
|
||||
|
||||
/// Recording and clearing the same relation in one call is refused outright, the way
|
||||
/// `set` refuses a field it is also replacing: nothing is written rather than one of the
|
||||
/// two silently winning.
|
||||
///
|
||||
/// It has to be caught on what the call *asked* for and not on what it would write. A
|
||||
/// relation already in the file is not among the additions, so comparing against those
|
||||
/// would let this call quietly remove one.
|
||||
#[test]
|
||||
fn recording_and_clearing_the_same_relation_is_refused() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--blocked-by",
|
||||
BLOCKER,
|
||||
"--clear",
|
||||
"blocked-by",
|
||||
BLOCKER,
|
||||
],
|
||||
);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
assert!(
|
||||
String::from_utf8_lossy(&out.stderr).contains("nothing was written"),
|
||||
"{}",
|
||||
String::from_utf8_lossy(&out.stderr)
|
||||
);
|
||||
assert_eq!(ticket(&worklane, GATED), before, "the relation was removed anyway");
|
||||
}
|
||||
|
||||
/// A kind that is not one of the three is refused before the ticket is resolved, so
|
||||
/// nothing is written. Exit 1 rather than clap's 2: the value is one of a pair clap
|
||||
/// cannot type apart, so the kind is parsed by `RelateArgs::cleared`.
|
||||
#[test]
|
||||
fn an_unknown_kind_in_a_clear_is_refused() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "depends-on", BLOCKER]);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
|
||||
let reason = String::from_utf8_lossy(&out.stderr);
|
||||
assert!(reason.contains("not a relation kind"), "{reason}");
|
||||
// The message names the three, in the spelling the flags and the completions use.
|
||||
for kind in ["blocked-by", "regression-of", "relates-to"] {
|
||||
assert!(reason.contains(kind), "{reason}");
|
||||
}
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// `--clear` takes exactly two values per occurrence, so clap refuses an odd number with
|
||||
/// a usage error and nothing reaches the handler.
|
||||
#[test]
|
||||
fn a_clear_with_one_value_is_a_usage_error() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by"]);
|
||||
assert_eq!(out.status.code(), Some(2), "{}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// The far end already stores it, so the edge is already recorded: `show` derives it onto
|
||||
/// this ticket by scanning. A line here would be the same edge on two files, which
|
||||
/// 4179958 decided against and nothing enforced until 03bdc76.
|
||||
#[test]
|
||||
fn a_relates_to_the_target_already_stores_is_not_stored_again() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
|
||||
run(&temp, &["relate", BLOCKER, "--relates-to", GATED]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--relates-to", BLOCKER]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(stdout(&out).contains("No changes"), "{}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before, "the mirror was stored anyway");
|
||||
|
||||
// Still shown, since it was recorded at the other end.
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert_eq!(shown.matches("relates to").count(), 1, "{shown}");
|
||||
}
|
||||
|
||||
/// A board that already holds both directions draws the edge once. The refusal above
|
||||
/// stops it recurring; this is what repairs a ticket that already has it, without an edit.
|
||||
#[test]
|
||||
fn a_relates_to_stored_at_both_ends_is_drawn_once() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
|
||||
// Both lines written directly, which is the state a board recorded before the refusal
|
||||
// is in. The CLI will not produce it any more, so nothing else can set this up.
|
||||
for (holder, target) in [(GATED, BLOCKER), (BLOCKER, GATED)] {
|
||||
let path = find(&worklane, holder);
|
||||
let content = fs::read_to_string(&path).unwrap().replace(
|
||||
"## Metadata",
|
||||
&format!("## Relations\n- relates to {target}\n\n## Metadata"),
|
||||
);
|
||||
fs::write(&path, content).unwrap();
|
||||
}
|
||||
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert_eq!(shown.matches("relates to").count(), 1, "the edge is drawn twice:\n{shown}");
|
||||
assert_eq!(shown.matches(&BLOCKER[..7]).count(), 1, "{shown}");
|
||||
|
||||
// And from the other end, which stores its own line and derives this one.
|
||||
let far = stdout(&run(&temp, &["show", BLOCKER]));
|
||||
assert_eq!(far.matches("relates to").count(), 1, "{far}");
|
||||
}
|
||||
|
||||
/// Only where the row reads the same. Two tickets each blocking the other is two facts,
|
||||
/// and the block says both: `blocked by` from this end, `blocks` from the other.
|
||||
#[test]
|
||||
fn a_mutual_block_is_still_drawn_from_both_ends() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
board(&temp);
|
||||
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let out = run(&temp, &["relate", BLOCKER, "--blocked-by", GATED]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(
|
||||
!stdout(&out).contains("No changes"),
|
||||
"the second was refused: {}",
|
||||
stdout(&out)
|
||||
);
|
||||
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert!(shown.contains("blocked by"), "{shown}");
|
||||
assert!(shown.contains("blocks"), "the derived direction was dropped:\n{shown}");
|
||||
}
|
||||
|
||||
/// The same for the other asymmetric kind, whose inverse label also differs from its own.
|
||||
#[test]
|
||||
fn a_mutual_regression_is_still_drawn_from_both_ends() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
board(&temp);
|
||||
|
||||
run(&temp, &["relate", GATED, "--regression-of", BLOCKER]);
|
||||
run(&temp, &["relate", BLOCKER, "--regression-of", GATED]);
|
||||
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert!(shown.contains("regression of"), "{shown}");
|
||||
assert!(
|
||||
shown.contains("regressed by"),
|
||||
"the derived direction was dropped:\n{shown}"
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user