(ca2a124) Add --actor-from-git beside every --actor, and bump to 0.32.8
This commit is contained in:
+87
-20
@@ -199,6 +199,13 @@ fn annotation_line(raw: &str) -> Result<String, String> {
|
||||
/// command reads as five flags.
|
||||
const ACTOR_HELP: &str = "Who the entry is attributed to, overriding WORKLANE_ACTOR and the git user. Free text, checked against nothing";
|
||||
|
||||
/// What `--actor-from-git` says on every command that writes a history entry.
|
||||
///
|
||||
/// The counterpart to [`ACTOR_HELP`]: where that one names somebody specific, this one
|
||||
/// says attribute it to the human whose checkout this is, without knowing how they spell
|
||||
/// themselves.
|
||||
const ACTOR_FROM_GIT_HELP: &str = "Attribute the entry to the detected git user instead of WORKLANE_ACTOR, for acting on the person's behalf. Cannot be combined with --actor";
|
||||
|
||||
/// Arguments that carry prose, and therefore have to accept a value starting with
|
||||
/// a hyphen.
|
||||
///
|
||||
@@ -229,26 +236,7 @@ pub enum Command {
|
||||
},
|
||||
|
||||
/// Move a ticket to a different status
|
||||
Mv {
|
||||
/// Ticket UUID or title
|
||||
ticket: String,
|
||||
|
||||
/// Target status
|
||||
#[arg(short, long)]
|
||||
status: Status,
|
||||
|
||||
/// Force move (allows backward or non-sequential moves)
|
||||
#[arg(short, long)]
|
||||
force: bool,
|
||||
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
actor: Option<String>,
|
||||
|
||||
/// Why the ticket moved, recorded in the history entry beside the transition
|
||||
/// it explains. Prose, so it takes a leading hyphen
|
||||
#[arg(long, allow_hyphen_values = PROSE)]
|
||||
reason: Option<String>,
|
||||
},
|
||||
Mv(MvArgs),
|
||||
|
||||
/// Replace fields on an existing ticket
|
||||
Set(SetArgs),
|
||||
@@ -298,6 +286,9 @@ pub enum Command {
|
||||
/// is `chown`'s. It was `--owner`, which said the wrong one of the two.
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
actor_from_git: bool,
|
||||
},
|
||||
|
||||
/// Group tickets that have to be finished together
|
||||
@@ -323,6 +314,9 @@ pub enum Command {
|
||||
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
actor_from_git: bool,
|
||||
},
|
||||
|
||||
/// The tag vocabulary: what the board carries, and what each tag means
|
||||
@@ -700,6 +694,33 @@ pub struct AddArgs {
|
||||
pub priority: Option<u8>,
|
||||
}
|
||||
|
||||
/// `mv` grew past a handful of parameters when `--actor-from-git` arrived, so it is a
|
||||
/// struct like `set` and `append` rather than an inline variant.
|
||||
#[derive(clap::Args)]
|
||||
pub struct MvArgs {
|
||||
/// Ticket UUID or title
|
||||
pub ticket: String,
|
||||
|
||||
/// Target status
|
||||
#[arg(short, long)]
|
||||
pub status: Status,
|
||||
|
||||
/// Force move (allows backward or non-sequential moves)
|
||||
#[arg(short, long)]
|
||||
pub force: bool,
|
||||
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
pub actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
pub actor_from_git: bool,
|
||||
|
||||
/// Why the ticket moved, recorded in the history entry beside the transition
|
||||
/// it explains. Prose, so it takes a leading hyphen
|
||||
#[arg(long, allow_hyphen_values = PROSE)]
|
||||
pub reason: Option<String>,
|
||||
}
|
||||
|
||||
/// `set` replaces a field outright. Owner is deliberately absent: `chown` owns that
|
||||
/// field, and status is `mv`'s, so no field has two writers.
|
||||
///
|
||||
@@ -764,6 +785,9 @@ pub struct SetArgs {
|
||||
/// command's that is logged
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
pub actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
pub actor_from_git: bool,
|
||||
}
|
||||
|
||||
impl SetArgs {
|
||||
@@ -814,6 +838,9 @@ pub struct ChownArgs {
|
||||
/// change. Both are on this command because it writes both.
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
pub actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
pub actor_from_git: bool,
|
||||
}
|
||||
|
||||
impl ChownArgs {
|
||||
@@ -1015,4 +1042,44 @@ mod tests {
|
||||
for two minor versions."
|
||||
);
|
||||
}
|
||||
|
||||
/// `--actor` and `--actor-from-git` are one pair that has to travel together: every
|
||||
/// command that takes one takes the other, documented by the same string, because
|
||||
/// the second is the first's spelling for "the human whose checkout this is".
|
||||
///
|
||||
/// A walker rather than five named commands, so a sixth entry-writing command fails
|
||||
/// this on its own `--actor` instead of being forgotten here too.
|
||||
#[test]
|
||||
fn every_actor_command_takes_actor_from_git() {
|
||||
let cli = Cli::command();
|
||||
let mut seen = 0;
|
||||
|
||||
for sub in cli.get_subcommands() {
|
||||
if sub.get_name() == "help" {
|
||||
continue;
|
||||
}
|
||||
|
||||
if !sub.get_arguments().any(|arg| arg.get_id().as_str() == "actor") {
|
||||
continue;
|
||||
}
|
||||
|
||||
seen += 1;
|
||||
let from_git = sub
|
||||
.get_arguments()
|
||||
.find(|arg| arg.get_id().as_str() == "actor_from_git")
|
||||
.unwrap_or_else(|| {
|
||||
panic!("`{}` takes --actor but not --actor-from-git", sub.get_name())
|
||||
});
|
||||
assert_eq!(
|
||||
from_git.get_help().map(|help| help.to_string()),
|
||||
Some(ACTOR_FROM_GIT_HELP.to_string()),
|
||||
"`{}` documents --actor-from-git differently",
|
||||
sub.get_name()
|
||||
);
|
||||
}
|
||||
|
||||
// A guard on the walker itself: if it stopped finding commands, every assertion
|
||||
// above would pass by never running.
|
||||
assert_eq!(seen, 5, "expected comment, mv, chown, set and assign to carry --actor");
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user