From e43620b1365cb01be40887459c9f16e755ca9ca2 Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Mon, 3 Oct 2022 05:40:21 +0100 Subject: [PATCH 1/6] feat: Expose is_multiple API for ArgGroup --- src/builder/arg_group.rs | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src/builder/arg_group.rs b/src/builder/arg_group.rs index 459cc7f5337..9242c7f1ec5 100644 --- a/src/builder/arg_group.rs +++ b/src/builder/arg_group.rs @@ -240,6 +240,21 @@ impl ArgGroup { self } + /// Return true if the group allows more than one of the arguments + /// in this group to be used. (Default: `false`) + /// + /// ```rust + /// # use clap::{ArgGroup}; + /// let mut group = ArgGroup::new("myprog") + /// .args(["f", "c"]) + /// .multiple(true); + /// + /// assert!(group.is_multiple()); + /// ``` + pub fn is_multiple(&mut self) -> bool { + self.multiple + } + /// Require an argument from the group to be present when parsing. /// /// This is unless conflicting with another argument. A required group will be displayed in @@ -538,4 +553,15 @@ mod test { fn foo(_: T) {} foo(ArgGroup::new("test")) } + + #[test] + fn arg_group_expose_is_multiple_helper() { + let args: Vec = vec!["a1".into(), "a4".into()]; + + let mut grp_multiple = ArgGroup::new("test_multiple").args(&args).multiple(true); + assert!(grp_multiple.is_multiple()); + + let mut grp_not_multiple = ArgGroup::new("test_multiple").args(&args).multiple(false); + assert!(!grp_not_multiple.is_multiple()); + } } From 169efae1919551a24c6fab70ce3994bcc74a179d Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Mon, 3 Oct 2022 07:26:21 +0100 Subject: [PATCH 2/6] feat: Expose get_args for ArgGroup --- src/builder/arg_group.rs | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/builder/arg_group.rs b/src/builder/arg_group.rs index 9242c7f1ec5..6221ea5cb29 100644 --- a/src/builder/arg_group.rs +++ b/src/builder/arg_group.rs @@ -188,6 +188,21 @@ impl ArgGroup { self } + /// Getters for all args. It will return a vector of `Id` + /// + /// Example + /// + /// ```rust + /// # use clap::{ArgGroup}; + /// let group = ArgGroup::new("myprog") + /// .args(["f", "c"]); + /// + /// assert_eq!(group.get_args(), ["f", "c"]); + /// ``` + pub fn get_args(self) -> Vec { + self.args + } + /// Allows more than one of the [`Arg`]s in this group to be used. (Default: `false`) /// /// # Examples @@ -243,6 +258,8 @@ impl ArgGroup { /// Return true if the group allows more than one of the arguments /// in this group to be used. (Default: `false`) /// + /// Example + /// /// ```rust /// # use clap::{ArgGroup}; /// let mut group = ArgGroup::new("myprog") @@ -564,4 +581,12 @@ mod test { let mut grp_not_multiple = ArgGroup::new("test_multiple").args(&args).multiple(false); assert!(!grp_not_multiple.is_multiple()); } + + #[test] + fn arg_group_expose_get_args_helper() { + let args: Vec = vec!["a1".into(), "a4".into()]; + let grp = ArgGroup::new("program").args(&args); + + assert_eq!(grp.get_args(), args); + } } From 4d4126ae3a2a0eaf42053aca1b79f25d7cc05593 Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Mon, 3 Oct 2022 20:39:42 +0200 Subject: [PATCH 3/6] chore: Nitpick in doc --- src/builder/arg_group.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/builder/arg_group.rs b/src/builder/arg_group.rs index 6221ea5cb29..2caa213233f 100644 --- a/src/builder/arg_group.rs +++ b/src/builder/arg_group.rs @@ -190,7 +190,7 @@ impl ArgGroup { /// Getters for all args. It will return a vector of `Id` /// - /// Example + /// # Example /// /// ```rust /// # use clap::{ArgGroup}; @@ -258,7 +258,7 @@ impl ArgGroup { /// Return true if the group allows more than one of the arguments /// in this group to be used. (Default: `false`) /// - /// Example + /// # Example /// /// ```rust /// # use clap::{ArgGroup}; From 88f0c5f5392a1b2c3d123223c086cd3d2121aef9 Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Mon, 3 Oct 2022 21:18:07 +0200 Subject: [PATCH 4/6] fix: Method get_args return an iterator of &Id --- src/builder/arg_group.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/builder/arg_group.rs b/src/builder/arg_group.rs index 2caa213233f..4d29f7901f2 100644 --- a/src/builder/arg_group.rs +++ b/src/builder/arg_group.rs @@ -199,8 +199,8 @@ impl ArgGroup { /// /// assert_eq!(group.get_args(), ["f", "c"]); /// ``` - pub fn get_args(self) -> Vec { - self.args + pub fn get_args(&self) -> impl Iterator { + self.args.iter() } /// Allows more than one of the [`Arg`]s in this group to be used. (Default: `false`) @@ -587,6 +587,10 @@ mod test { let args: Vec = vec!["a1".into(), "a4".into()]; let grp = ArgGroup::new("program").args(&args); - assert_eq!(grp.get_args(), args); + let mut pos = 0; + for arg in grp.get_args() { + assert_eq!(*arg, args[pos]); + pos += 1; + } } } From 665518036c8b8dbf960aaa13225118d11290ec06 Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Mon, 3 Oct 2022 21:30:57 +0200 Subject: [PATCH 5/6] fix: Use enumerate in test --- src/builder/arg_group.rs | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/builder/arg_group.rs b/src/builder/arg_group.rs index 4d29f7901f2..eb45319b85f 100644 --- a/src/builder/arg_group.rs +++ b/src/builder/arg_group.rs @@ -587,10 +587,8 @@ mod test { let args: Vec = vec!["a1".into(), "a4".into()]; let grp = ArgGroup::new("program").args(&args); - let mut pos = 0; - for arg in grp.get_args() { + for (pos, arg) in grp.get_args().enumerate() { assert_eq!(*arg, args[pos]); - pos += 1; } } } From 8252c8db9886954c445c640a456110eb79867528 Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Mon, 3 Oct 2022 21:50:15 +0200 Subject: [PATCH 6/6] fix: Update doc assertion --- src/builder/arg_group.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/builder/arg_group.rs b/src/builder/arg_group.rs index eb45319b85f..a6386a1c03a 100644 --- a/src/builder/arg_group.rs +++ b/src/builder/arg_group.rs @@ -194,10 +194,12 @@ impl ArgGroup { /// /// ```rust /// # use clap::{ArgGroup}; - /// let group = ArgGroup::new("myprog") - /// .args(["f", "c"]); + /// let args: Vec<&str> = vec!["a1".into(), "a4".into()]; + /// let grp = ArgGroup::new("program").args(&args); /// - /// assert_eq!(group.get_args(), ["f", "c"]); + /// for (pos, arg) in grp.get_args().enumerate() { + /// assert_eq!(*arg, args[pos]); + /// } /// ``` pub fn get_args(&self) -> impl Iterator { self.args.iter()