Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Clarify Arg/ArgGroup id's role #3453

Merged
merged 1 commit into from
Feb 11, 2022
Merged

fix: Clarify Arg/ArgGroup id's role #3453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions clap_complete/src/shells/zsh.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@ fn write_flags_of(p: &App, p_global: Option<&App>) -> String {
let mut ret = vec![];

for f in utils::flags(p) {
debug!("write_flags_of:iter: f={}", f.get_name());
debug!("write_flags_of:iter: f={}", f.get_id());

let help = f.get_help().map_or(String::new(), escape_help);
let conflicts = arg_conflicts(p, &f, p_global);
Expand Down Expand Up @@ -639,7 +639,7 @@ fn write_positionals_of(p: &App) -> String {
let a = format!(
"'{cardinality}:{name}{help}:{value_completion}' \\",
cardinality = cardinality,
name = arg.get_name(),
name = arg.get_id(),
help = arg
.get_help()
.map_or("".to_owned(), |v| " -- ".to_owned() + v)
Expand Down
2 changes: 1 addition & 1 deletion clap_complete_fig/src/fig.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ fn gen_args(arg: &Arg, indent: usize) -> String {
buffer.push_str(&format!(
"{{\n{:indent$} name: \"{}\",\n",
"",
arg.get_name(),
arg.get_id(),
indent = indent
));

Expand Down
4 changes: 2 additions & 2 deletions clap_mangen/src/render.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ pub(crate) fn synopsis(roff: &mut Roff, app: &clap::App) {
for arg in app.get_positionals() {
let (lhs, rhs) = option_markers(arg);
line.push(roman(lhs));
line.push(italic(arg.get_name()));
line.push(italic(arg.get_id()));
line.push(roman(rhs));
line.push(roman(" "));
}
Expand Down Expand Up @@ -120,7 +120,7 @@ pub(crate) fn options(roff: &mut Roff, app: &clap::App) {

for pos in items.iter().filter(|a| a.is_positional()) {
let (lhs, rhs) = option_markers(pos);
let name = format!("{}{}{}", lhs, pos.get_name(), rhs);
let name = format!("{}{}{}", lhs, pos.get_id(), rhs);

let mut header = vec![bold(&name)];

Expand Down
16 changes: 14 additions & 2 deletions src/build/arg.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,19 @@ impl<'help> Arg<'help> {
///
/// See [`Arg::new`] for more details.
#[must_use]
pub fn name<S: Into<&'help str>>(mut self, n: S) -> Self {
pub fn id<S: Into<&'help str>>(mut self, n: S) -> Self {
let name = n.into();
self.id = Id::from(&*name);
self.name = name;
self
}

/// Deprecated, replaced with [`Arg::id`]
#[deprecated(since = "3.1.0", note = "Replaced with `Arg::id`")]
pub fn name<S: Into<&'help str>>(self, n: S) -> Self {
self.id(n)
}

/// Sets the short version of the argument without the preceding `-`.
///
/// By default `V` and `h` are used by the auto-generated `version` and `help` arguments,
Expand Down Expand Up @@ -4489,10 +4495,16 @@ impl<'help> Arg<'help> {
impl<'help> Arg<'help> {
/// Get the name of the argument
#[inline]
pub fn get_name(&self) -> &'help str {
pub fn get_id(&self) -> &'help str {
self.name
}

/// Deprecated, replaced with [`Arg::get_id`]
#[deprecated(since = "3.1.0", note = "Replaced with `Arg::get_id`")]
pub fn get_name(&self) -> &'help str {
self.get_id()
}

/// Get the help specified for this argument, if any
#[inline]
pub fn get_help(&self) -> Option<&'help str> {
Expand Down
12 changes: 9 additions & 3 deletions src/build/arg_group.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ impl<'help> ArgGroup<'help> {
/// # ;
/// ```
pub fn new<S: Into<&'help str>>(n: S) -> Self {
ArgGroup::default().name(n)
ArgGroup::default().id(n)
}

/// Sets the group name.
Expand All @@ -122,12 +122,18 @@ impl<'help> ArgGroup<'help> {
/// # ;
/// ```
#[must_use]
pub fn name<S: Into<&'help str>>(mut self, n: S) -> Self {
pub fn id<S: Into<&'help str>>(mut self, n: S) -> Self {
self.name = n.into();
self.id = Id::from(self.name);
self
}

/// Deprecated, replaced with [`ArgGroup::id`]
#[deprecated(since = "3.1.0", note = "Replaced with `ArgGroup::id`")]
pub fn name<S: Into<&'help str>>(self, n: S) -> Self {
self.id(n)
}

/// Adds an [argument] to this group by name
///
/// # Examples
Expand Down Expand Up @@ -495,7 +501,7 @@ impl<'help> From<&'help Yaml> for ArgGroup<'help> {
"conflicts_with" => yaml_vec_or_str!(a, v, conflicts_with),
"name" => {
if let Some(ys) = v.as_str() {
a = a.name(ys);
a = a.id(ys);
}
a
}
Expand Down
2 changes: 1 addition & 1 deletion src/build/debug_asserts.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -648,7 +648,7 @@ fn assert_arg_flags(arg: &Arg) {
)+

if !s.is_empty() {
panic!("Argument {:?}\n{}", arg.get_name(), s)
panic!("Argument {:?}\n{}", arg.get_id(), s)
}
}
}
Expand Down
18 changes: 9 additions & 9 deletions src/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,8 +382,8 @@ macro_rules! arg_impl {

let mut arg = $arg;
let long = $crate::arg_impl! { @string $long };
if arg.get_name().is_empty() {
arg = arg.name(long);
if arg.get_id().is_empty() {
arg = arg.id(long);
}
arg.long(long)
})
Expand All @@ -404,8 +404,8 @@ macro_rules! arg_impl {

let mut arg = $arg;
let long = $crate::arg_impl! { @string $long };
if arg.get_name().is_empty() {
arg = arg.name(long);
if arg.get_id().is_empty() {
arg = arg.id(long);
}
arg.long(long)
})
Expand Down Expand Up @@ -466,8 +466,8 @@ macro_rules! arg_impl {
arg = arg.takes_value(true);

let value_name = $crate::arg_impl! { @string $value_name };
if arg.get_name().is_empty() {
arg = arg.name(value_name);
if arg.get_id().is_empty() {
arg = arg.id(value_name);
}
arg.value_name(value_name)
})
Expand Down Expand Up @@ -496,8 +496,8 @@ macro_rules! arg_impl {
arg = arg.takes_value(true);

let value_name = $crate::arg_impl! { @string $value_name };
if arg.get_name().is_empty() {
arg = arg.name(value_name);
if arg.get_id().is_empty() {
arg = arg.id(value_name);
}
arg.value_name(value_name)
})
Expand Down Expand Up @@ -622,7 +622,7 @@ macro_rules! arg {
let arg = $crate::arg_impl! {
@arg ($crate::Arg::default()) $($tail)+
};
debug_assert!(!arg.get_name().is_empty(), "Without a value or long flag, the `name:` prefix is required");
debug_assert!(!arg.get_id().is_empty(), "Without a value or long flag, the `name:` prefix is required");
arg
}};
}
Expand Down
7 changes: 2 additions & 5 deletions tests/builder/help.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2727,7 +2727,7 @@ fn disable_help_flag_affects_help_subcommand() {
.find_subcommand("help")
.unwrap()
.get_arguments()
.map(|a| a.get_name())
.map(|a| a.get_id())
.collect::<Vec<_>>();
assert!(
!args.contains(&"help"),
Expand Down Expand Up @@ -2768,10 +2768,7 @@ fn help_without_short() {
.arg(arg!(--help));

app._build_all();
let help = app
.get_arguments()
.find(|a| a.get_name() == "help")
.unwrap();
let help = app.get_arguments().find(|a| a.get_id() == "help").unwrap();
assert_eq!(help.get_short(), None);

let m = app.try_get_matches_from(["test", "-h", "0x100"]).unwrap();
Expand Down
2 changes: 1 addition & 1 deletion tests/builder/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ fn mut_arg_all() {
let mut app = utils::complex_app();
let arg_names = app
.get_arguments()
.map(|a| a.get_name())
.map(|a| a.get_id())
.filter(|a| *a != "version" && *a != "help")
.collect::<Vec<_>>();

Expand Down
22 changes: 11 additions & 11 deletions tests/derive/help.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ fn arg_help_heading_applied() {

let should_be_in_section_a = app
.get_arguments()
.find(|a| a.get_name() == "should-be-in-section-a")
.find(|a| a.get_id() == "should-be-in-section-a")
.unwrap();
assert_eq!(should_be_in_section_a.get_help_heading(), Some("HEADING A"));

let should_be_in_section_b = app
.get_arguments()
.find(|a| a.get_name() == "no-section")
.find(|a| a.get_id() == "no-section")
.unwrap();
assert_eq!(should_be_in_section_b.get_help_heading(), None);
}
Expand All @@ -44,13 +44,13 @@ fn app_help_heading_applied() {

let should_be_in_section_a = app
.get_arguments()
.find(|a| a.get_name() == "should-be-in-section-a")
.find(|a| a.get_id() == "should-be-in-section-a")
.unwrap();
assert_eq!(should_be_in_section_a.get_help_heading(), Some("HEADING A"));

let should_be_in_default_section = app
.get_arguments()
.find(|a| a.get_name() == "should-be-in-default-section")
.find(|a| a.get_id() == "should-be-in-default-section")
.unwrap();
assert_eq!(
should_be_in_default_section.get_help_heading(),
Expand Down Expand Up @@ -121,35 +121,35 @@ fn app_help_heading_flattened() {

let should_be_in_section_a = app
.get_arguments()
.find(|a| a.get_name() == "should-be-in-section-a")
.find(|a| a.get_id() == "should-be-in-section-a")
.unwrap();
assert_eq!(should_be_in_section_a.get_help_heading(), Some("HEADING A"));

let should_be_in_section_b = app
.get_arguments()
.find(|a| a.get_name() == "should-be-in-section-b")
.find(|a| a.get_id() == "should-be-in-section-b")
.unwrap();
assert_eq!(should_be_in_section_b.get_help_heading(), Some("HEADING B"));

let should_be_in_default_section = app
.get_arguments()
.find(|a| a.get_name() == "should-be-in-default-section")
.find(|a| a.get_id() == "should-be-in-default-section")
.unwrap();
assert_eq!(should_be_in_default_section.get_help_heading(), None);

let sub_a_two = app.find_subcommand("sub-a-two").unwrap();

let should_be_in_sub_a = sub_a_two
.get_arguments()
.find(|a| a.get_name() == "should-be-in-sub-a")
.find(|a| a.get_id() == "should-be-in-sub-a")
.unwrap();
assert_eq!(should_be_in_sub_a.get_help_heading(), Some("SUB A"));

let sub_b_one = app.find_subcommand("sub-b-one").unwrap();

let should_be_in_sub_b = sub_b_one
.get_arguments()
.find(|a| a.get_name() == "should-be-in-sub-b")
.find(|a| a.get_id() == "should-be-in-sub-b")
.unwrap();
assert_eq!(should_be_in_sub_b.get_help_heading(), Some("SUB B"));

Expand All @@ -158,7 +158,7 @@ fn app_help_heading_flattened() {

let should_be_in_sub_c = sub_c_one
.get_arguments()
.find(|a| a.get_name() == "should-be-in-sub-c")
.find(|a| a.get_id() == "should-be-in-sub-c")
.unwrap();
assert_eq!(should_be_in_sub_c.get_help_heading(), Some("SUB C"));
}
Expand All @@ -182,7 +182,7 @@ fn flatten_field_with_help_heading() {

let should_be_in_section_a = app
.get_arguments()
.find(|a| a.get_name() == "should-be-in-section-a")
.find(|a| a.get_id() == "should-be-in-section-a")
.unwrap();
assert_eq!(should_be_in_section_a.get_help_heading(), Some("HEADING A"));
}
Expand Down