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.

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

feat(derive): Specify defaults by native expressions #2635

Merged
merged 1 commit into from
Aug 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 18 additions & 16 deletions clap_derive/src/attrs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -339,35 +339,37 @@ impl Attrs {

VerbatimDocComment(ident) => self.verbatim_doc_comment = Some(ident),

DefaultValue(ident, lit) => {
let val = if let Some(lit) = lit {
quote!(#lit)
DefaultValueT(ident, expr) => {
let val = if let Some(expr) = expr {
quote!(#expr)
} else {
let ty = if let Some(ty) = self.ty.as_ref() {
ty
} else {
abort!(
ident,
"#[clap(default_value)] (without an argument) can be used \
"#[clap(default_value_t)] (without an argument) can be used \
only on field level";

note = "see \
https://docs.rs/structopt/0.3.5/structopt/#magical-methods")
};

quote_spanned!(ident.span()=> {
clap::lazy_static::lazy_static! {
static ref DEFAULT_VALUE: &'static str = {
let val = <#ty as ::std::default::Default>::default();
let s = ::std::string::ToString::to_string(&val);
::std::boxed::Box::leak(s.into_boxed_str())
};
}
*DEFAULT_VALUE
})
quote!(<#ty as ::std::default::Default>::default())
};

self.methods.push(Method::new(ident, val));
let val = quote_spanned!(ident.span()=> {
clap::lazy_static::lazy_static! {
static ref DEFAULT_VALUE: &'static str = {
let val = #val;
let s = ::std::string::ToString::to_string(&val);
::std::boxed::Box::leak(s.into_boxed_str())
};
}
*DEFAULT_VALUE
});

let raw_ident = Ident::new("default_value", ident.span());
self.methods.push(Method::new(raw_ident, val));
}

About(ident, about) => {
Expand Down
23 changes: 13 additions & 10 deletions clap_derive/src/parse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ pub enum ClapAttr {
About(Ident, Option<LitStr>),
Author(Ident, Option<LitStr>),
Version(Ident, Option<LitStr>),
DefaultValue(Ident, Option<LitStr>),

// ident = "string literal"
RenameAllEnv(Ident, LitStr),
Expand All @@ -41,6 +40,7 @@ pub enum ClapAttr {

// ident = arbitrary_expr
NameExpr(Ident, Expr),
DefaultValueT(Ident, Option<Expr>),

// ident(arbitrary_expr,*)
MethodCall(Ident, Vec<Expr>),
Expand Down Expand Up @@ -75,7 +75,6 @@ impl Parse for ClapAttr {
match &*name_str {
"rename_all" => Ok(RenameAll(name, lit)),
"rename_all_env" => Ok(RenameAllEnv(name, lit)),
"default_value" => Ok(DefaultValue(name, Some(lit))),

"version" => {
check_empty_lit("version");
Expand Down Expand Up @@ -105,13 +104,11 @@ impl Parse for ClapAttr {
}
} else {
match input.parse::<Expr>() {
Ok(expr) => {
if name_str == "skip" {
Ok(Skip(name, Some(expr)))
} else {
Ok(NameExpr(name, expr))
}
}
Ok(expr) => match &*name_str {
"skip" => Ok(Skip(name, Some(expr))),
"default_value_t" => Ok(DefaultValueT(name, Some(expr))),
_ => Ok(NameExpr(name, expr)),
},

Err(_) => abort! {
assign_token,
Expand Down Expand Up @@ -176,7 +173,13 @@ impl Parse for ClapAttr {
"external_subcommand" => Ok(ExternalSubcommand(name)),
"verbatim_doc_comment" => Ok(VerbatimDocComment(name)),

"default_value" => Ok(DefaultValue(name, None)),
"default_value" => {
abort!(name,
"`#[clap(default_value)` attribute (without a value) has been replaced by `#[clap(default_value_t)]`.";
help = "Change the attribute to `#[clap(default_value_t)]`";
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cargo-up should be able to handle this easily without us needing the abort. This should be deleted when I finish the structopt to clap upgrader then.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally would find this useful because I'm unlikely to download a special tool just to handle a library migration. The likelihood of downloading is proportionate to the number of CLIs I maintain.

}
"default_value_t" => Ok(DefaultValueT(name, None)),
"about" => (Ok(About(name, None))),
"author" => (Ok(Author(name, None))),
"version" => Ok(Version(name, None)),
Expand Down
2 changes: 1 addition & 1 deletion clap_derive/tests/arg_enum.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ fn default_value() {

#[derive(Clap, PartialEq, Debug)]
struct Opt {
#[clap(arg_enum, default_value)]
#[clap(arg_enum, default_value_t)]
arg: ArgChoice,
}

Expand Down
32 changes: 30 additions & 2 deletions clap_derive/tests/default_value.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,38 @@ mod utils;
use utils::*;

#[test]
fn auto_default_value() {
fn default_value() {
#[derive(Clap, PartialEq, Debug)]
struct Opt {
#[clap(default_value)]
#[clap(default_value = "3")]
arg: i32,
}
assert_eq!(Opt { arg: 3 }, Opt::parse_from(&["test"]));
assert_eq!(Opt { arg: 1 }, Opt::parse_from(&["test", "1"]));

let help = get_long_help::<Opt>();
assert!(help.contains("[default: 3]"));
}

#[test]
fn default_value_t() {
#[derive(Clap, PartialEq, Debug)]
struct Opt {
#[clap(default_value_t = 3)]
arg: i32,
}
assert_eq!(Opt { arg: 3 }, Opt::parse_from(&["test"]));
assert_eq!(Opt { arg: 1 }, Opt::parse_from(&["test", "1"]));

let help = get_long_help::<Opt>();
assert!(help.contains("[default: 3]"));
}

#[test]
fn auto_default_value_t() {
#[derive(Clap, PartialEq, Debug)]
struct Opt {
#[clap(default_value_t)]
arg: i32,
}
assert_eq!(Opt { arg: 0 }, Opt::parse_from(&["test"]));
Expand Down
21 changes: 21 additions & 0 deletions clap_derive/tests/ui/default_value_wo_value_removed.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright 2018 Guillaume Pinot (@TeXitoi) <texitoi@texitoi.eu>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use clap::Clap;

#[derive(Clap, Debug)]
#[clap(name = "basic")]
struct Opt {
#[clap(default_value)]
value: i32,
}

fn main() {
let opt = Opt::parse();
println!("{:?}", opt);
}
8 changes: 8 additions & 0 deletions clap_derive/tests/ui/default_value_wo_value_removed.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
error: `#[clap(default_value)` attribute (without a value) has been replaced by `#[clap(default_value_t)]`.

= help: Change the attribute to `#[clap(default_value_t)]`

--> $DIR/default_value_wo_value_removed.rs:14:12
|
14 | #[clap(default_value)]
| ^^^^^^^^^^^^^