Skip to content

Commit

Permalink
Add skip attribute support for enum variants (#494)
Browse files Browse the repository at this point in the history
  • Loading branch information
@chipsenkbeil
chipsenkbeil authored Aug 30, 2021
1 parent 7fef417 commit 6d922d1
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 47 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

* Update minimal rust version to 1.46 because of bitflags 1.3
* Fixed [a bug that occurs when the type of `map` becomes ambiguous](https://github.com/TeXitoi/structopt/issues/490).
* Add support for [skip for enum variant subcommands](https://github.com/TeXitoi/structopt/issues/493)

# v0.3.22 (2021-07-04)

Expand Down
7 changes: 5 additions & 2 deletions structopt-derive/src/attrs.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,7 @@ impl Attrs {
parent_attrs: Option<&Attrs>,
argument_casing: Sp<CasingStyle>,
env_casing: Sp<CasingStyle>,
allow_skip: bool,
) -> Self {
let mut res = Self::new(span, name, parent_attrs, None, argument_casing, env_casing);
res.push_attrs(attrs);
Expand All @@ -418,8 +419,10 @@ impl Attrs {
}
match &*res.kind {
Kind::Subcommand(_) => abort!(res.kind.span(), "subcommand is only allowed on fields"),
Kind::Skip(_) => abort!(res.kind.span(), "skip is only allowed on fields"),
Kind::Arg(_) | Kind::ExternalSubcommand | Kind::Flatten => res,
Kind::Skip(_) if !allow_skip => {
abort!(res.kind.span(), "skip is only allowed on fields")
}
Kind::Arg(_) | Kind::ExternalSubcommand | Kind::Flatten | Kind::Skip(_) => res,
}
}

Expand Down
97 changes: 52 additions & 45 deletions structopt-derive/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,7 @@ fn gen_clap(attrs: &[Attribute]) -> GenOutput {
None,
Sp::call_site(DEFAULT_CASING),
Sp::call_site(DEFAULT_ENV_CASING),
false,
);
let tokens = {
let name = attrs.cased_name();
Expand Down Expand Up @@ -478,34 +479,37 @@ fn gen_augment_clap_enum(
) -> TokenStream {
use syn::Fields::*;

let subcommands = variants.iter().map(|variant| {
let subcommands = variants.iter().filter_map(|variant| {
let attrs = Attrs::from_struct(
variant.span(),
&variant.attrs,
Name::Derived(variant.ident.clone()),
Some(parent_attribute),
parent_attribute.casing(),
parent_attribute.env_casing(),
true,
);

let kind = attrs.kind();
match &*kind {
Kind::Skip(_) => None,

Kind::ExternalSubcommand => {
let app_var = Ident::new("app", Span::call_site());
quote_spanned! { attrs.kind().span()=>
Some(quote_spanned! { attrs.kind().span()=>
let #app_var = #app_var.setting(
::structopt::clap::AppSettings::AllowExternalSubcommands
);
}
})
},

Kind::Flatten => {
match variant.fields {
Unnamed(FieldsUnnamed { ref unnamed, .. }) if unnamed.len() == 1 => {
let ty = &unnamed[0];
quote! {
Some(quote! {
let app = <#ty as ::structopt::StructOptInternal>::augment_clap(app);
}
})
},
_ => abort!(
variant,
Expand Down Expand Up @@ -542,13 +546,13 @@ fn gen_augment_clap_enum(
let name = attrs.cased_name();
let from_attrs = attrs.top_level_methods();
let version = attrs.version();
quote! {
Some(quote! {
let app = app.subcommand({
let #app_var = ::structopt::clap::SubCommand::with_name(#name);
let #app_var = #arg_block;
#app_var#from_attrs#version
});
}
})
},
}
});
Expand Down Expand Up @@ -595,58 +599,61 @@ fn gen_from_subcommand(
Some(parent_attribute),
parent_attribute.casing(),
parent_attribute.env_casing(),
true,
);

let variant_name = &variant.ident;

if let Kind::ExternalSubcommand = *attrs.kind() {
if ext_subcmd.is_some() {
abort!(
attrs.kind().span(),
"Only one variant can be marked with `external_subcommand`, \
match *attrs.kind() {
Kind::ExternalSubcommand => {
if ext_subcmd.is_some() {
abort!(
attrs.kind().span(),
"Only one variant can be marked with `external_subcommand`, \
this is the second"
);
}
);
}

let ty = match variant.fields {
Unnamed(ref fields) if fields.unnamed.len() == 1 => &fields.unnamed[0].ty,
let ty = match variant.fields {
Unnamed(ref fields) if fields.unnamed.len() == 1 => &fields.unnamed[0].ty,

_ => abort!(
variant,
"The enum variant marked with `external_attribute` must be \
_ => abort!(
variant,
"The enum variant marked with `external_attribute` must be \
a single-typed tuple, and the type must be either `Vec<String>` \
or `Vec<OsString>`."
),
};
),
};

let (span, str_ty, values_of) = match subty_if_name(ty, "Vec") {
Some(subty) => {
if is_simple_ty(subty, "String") {
(
subty.span(),
quote!(::std::string::String),
quote!(values_of),
)
} else {
(
subty.span(),
quote!(::std::ffi::OsString),
quote!(values_of_os),
)
let (span, str_ty, values_of) = match subty_if_name(ty, "Vec") {
Some(subty) => {
if is_simple_ty(subty, "String") {
(
subty.span(),
quote!(::std::string::String),
quote!(values_of),
)
} else {
(
subty.span(),
quote!(::std::ffi::OsString),
quote!(values_of_os),
)
}
}
}

None => abort!(
ty,
"The type must be either `Vec<String>` or `Vec<OsString>` \
None => abort!(
ty,
"The type must be either `Vec<String>` or `Vec<OsString>` \
to be used with `external_subcommand`."
),
};
),
};

ext_subcmd = Some((span, variant_name, str_ty, values_of));
None
} else {
Some((variant, attrs))
ext_subcmd = Some((span, variant_name, str_ty, values_of));
None
}
Kind::Skip(_) => None,
_ => Some((variant, attrs)),
}
})
.partition(|(_, attrs)| match &*attrs.kind() {
Expand Down
46 changes: 46 additions & 0 deletions tests/subcommands.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -301,3 +301,49 @@ fn external_subcommand_optional() {

assert_eq!(Opt::from_iter(&["test"]), Opt { sub: None });
}

#[test]
fn skip_subcommand() {
#[derive(Debug, PartialEq, StructOpt)]
struct Opt {
#[structopt(subcommand)]
sub: Subcommands,
}

#[derive(Debug, PartialEq, StructOpt)]
enum Subcommands {
Add,
Remove,

#[allow(dead_code)]
#[structopt(skip)]
Skip,
}

assert_eq!(
Opt::from_iter(&["test", "add"]),
Opt {
sub: Subcommands::Add
}
);

assert_eq!(
Opt::from_iter(&["test", "remove"]),
Opt {
sub: Subcommands::Remove
}
);

let res = Opt::from_iter_safe(&["test", "skip"]);
assert!(
matches!(
res,
Err(clap::Error {
kind: clap::ErrorKind::UnknownArgument,
..
})
),
"Unexpected result: {:?}",
res
);
}

0 comments on commit 6d922d1

Please sign in to comment.