Merge pull request #4001 from epage/num_vals

fix!: Simplify min_values/max_values into number_of_values (per occurrence)
clap-rs · Jul 29, 2022 · ddef1cb · ddef1cb
2 parents 81faa8b + eee31e2
commit ddef1cb
Show file tree

Hide file tree

Showing 22 changed files with 709 additions and 343 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,8 +20,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - `arg!` now sets `ArgAction::SetTrue`, `ArgAction::Count`, `ArgAction::Set`, or `ArgAction::Append` as appropriate (#3795)
 - Default actions are now `Set` and `SetTrue`
 - Removed `PartialEq` and `Eq` from `Command`
+- `Arg::number_of_values` now applies per occurrence rather than the average across all occurrences
 - `number_of_values(0)` no longer implies `takes_value(true).multiple_values(true)`
 - `number_of_values(1)` no longer implies `multiple_values(true)`
+- Remove `Arg::min_values` (across all occurrences) with `Arg::number_of_values(N..)` (per occurrence)
+- Remove `Arg::max_values` (across all occurrences) with `Arg::number_of_values(1..=M)` (per occurrence)
 - `ArgAction::SetTrue` and `ArgAction::SetFalse` now prioritize `Arg::default_missing_value` over their standard behavior
 - *(help)* Make `DeriveDisplayOrder` the default and removed the setting.  To sort help, set `next_display_order(None)` (#2808)
 - *(help)* Subcommand display order respects `Command::next_display_order` instead of `DeriveDisplayOrder` and using its own initial display order value (#2808)
@@ -31,6 +34,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Features
 
+- `Arg::number_of_values` now accepts ranges, allowing setting both the minimum and maximum number of values per occurrence
 - *(help)* Show `PossibleValue::help` in long help (`--help`) (#3312)
 
 ### Fixes
@@ -41,6 +45,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Replaced `cmd.allow_invalid_for_utf8_external_subcommands` with `cmd.external_subcommand_value_parser` (#3733)
 - Changed the default type of `allow_external_subcommands` from `String` to `OsString`
 - `Arg::default_missing_value` now applies per occurrence rather than if a value is missing across all occurrences
+- `arg!(--long [value])` to accept `0..=1` per occurrence rather than across all occurrences, making it safe to use with `ArgAction::Append`
 - *(assert)* Always enforce that version is specified when the `ArgAction::Version` is used
 - *(assert)* Add missing `#[track_caller]`s to make it easier to debug asserts
 - *(assert)* Ensure `overrides_with` IDs are valid

diff --git a/clap_bench/benches/03_complex.rs b/clap_bench/benches/03_complex.rs
@@ -31,8 +31,8 @@ macro_rules! create_app {
                 arg!(
                     --multvalsmo <s> "Tests multiple values, not mult occs"
                 ).multiple_values(true).required(false).value_names(&["one", "two"]),
-                arg!(--minvals2 <minvals> ... "Tests 2 min vals").min_values(2).multiple_values(true).required(false),
-                arg!(--maxvals3 <maxvals> ... "Tests 3 max vals").max_values(3).multiple_values(true).required(false),
+                arg!(--minvals2 <minvals> ... "Tests 2 min vals").number_of_values(2..).multiple_values(true).required(false),
+                arg!(--maxvals3 <maxvals> ... "Tests 3 max vals").number_of_values(1..=3).multiple_values(true).required(false),
             ])
             .subcommand(
                 Command::new("subcmd")
@@ -124,15 +124,15 @@ pub fn build_from_builder(c: &mut Criterion) {
                         .multiple_values(true)
                         .action(ArgAction::Append)
                         .help("Tests 2 min vals")
-                        .min_values(2),
+                        .number_of_values(2..),
                 )
                 .arg(
                     Arg::new("maxvals")
                         .long("maxvals3")
                         .multiple_values(true)
                         .action(ArgAction::Append)
                         .help("Tests 3 max vals")
-                        .max_values(3),
+                        .number_of_values(1..=3),
                 )
                 .subcommand(
                     Command::new("subcmd")

diff --git a/clap_complete/src/shells/zsh.rs b/clap_complete/src/shells/zsh.rs
@@ -462,7 +462,7 @@ fn write_opts_of(p: &Command, p_global: Option<&Command>) -> String {
             None => format!(":{}: ", vn),
         };
         let vc = match o.get_num_vals() {
-            Some(num_vals) => vc.repeat(num_vals),
+            Some(num_vals) => vc.repeat(num_vals.min_values()),
             None => vc,
         };
 

diff --git a/clap_derive/src/derives/args.rs b/clap_derive/src/derives/args.rs
@@ -258,9 +258,7 @@ pub fn gen_augment(
 
                     Ty::OptionOption => quote_spanned! { ty.span()=>
                         .value_name(#value_name)
-                        .min_values(0)
-                        .max_values(1)
-                        .multiple_values(false)
+                        .number_of_values(0..=1)
                         #value_parser
                         #action
                     },