Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-11-10 14:54:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix!: Rename ArgValue to PossibleValue

Browse source 
In considering potential work for #2683, I realized we might need a type to carry data for
each of the `multiple_values`.  `ArgValue` works both for that and for
possible values, so we need to come up with a better name for one or
both.  Changing `ArgValue`s name now would be ideal since its new in
clap3 and by renaming it, we can reduce churn for users.

While thinking about this, I realized I regularly get these mixed
up, so renaming `ArgValue` to `PossibleValue` I think will help clear
things up, regardless of #2683.
This commit is contained in:
Ed Page 2021-10-18 08:35:52 -05:00
parent fe29af7a63
commit 9f12bfec47
17 changed files with 91 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
clap_derive/src/derives/arg_enum.rs
View file

@ -47,8 +47,8 @@ pub fn gen_for_enum(name: &Ident, attrs: &[Attribute], e: &DataEnum) -> TokenStr
);
let lits = lits(&e.variants, &attrs);
let arg_values = gen_arg_values(&lits);
let to_arg_value = gen_to_arg_value(&lits);
let value_variants = gen_value_variants(&lits);
let to_possible_value = gen_to_possible_value(&lits);
quote! {
#[allow(dead_code, unreachable_code, unused_variables)]
@ -64,8 +64,8 @@ pub fn gen_for_enum(name: &Ident, attrs: &[Attribute], e: &DataEnum) -> TokenStr
)]
#[deny(clippy::correctness)]
impl clap::ArgEnum for #name {
#arg_values
#to_arg_value
#value_variants
#to_possible_value
}
}
}
@ -89,7 +89,7 @@ fn lits(
let name = attrs.cased_name();
Some((
quote! {
clap::ArgValue::new(#name)
clap::PossibleValue::new(#name)
#fields
},
variant.ident.clone(),
@ -99,7 +99,7 @@ fn lits(
.collect::<Vec<_>>()
}
fn gen_arg_values(lits: &[(TokenStream, Ident)]) -> TokenStream {
fn gen_value_variants(lits: &[(TokenStream, Ident)]) -> TokenStream {
let lit = lits.iter().map(|l| &l.1).collect::<Vec<_>>();
quote! {
@ -109,11 +109,11 @@ fn gen_arg_values(lits: &[(TokenStream, Ident)]) -> TokenStream {
}
}
fn gen_to_arg_value(lits: &[(TokenStream, Ident)]) -> TokenStream {
fn gen_to_possible_value(lits: &[(TokenStream, Ident)]) -> TokenStream {
let (lit, variant): (Vec<TokenStream>, Vec<Ident>) = lits.iter().cloned().unzip();
quote! {
fn to_arg_value<'a>(&self) -> Option<clap::ArgValue<'a>> {
fn to_possible_value<'a>(&self) -> Option<clap::PossibleValue<'a>> {
match self {
#(Self::#variant => Some(#lit),)*
_ => None

2
clap_derive/src/derives/args.rs
View file

@ -372,7 +372,7 @@ pub fn gen_augment(
fn gen_arg_enum_possible_values(ty: &Type) -> TokenStream {
quote_spanned! { ty.span()=>
.possible_values(<#ty as clap::ArgEnum>::value_variants().iter().filter_map(clap::ArgEnum::to_arg_value))
.possible_values(<#ty as clap::ArgEnum>::value_variants().iter().filter_map(clap::ArgEnum::to_possible_value))
}
}

2
clap_derive/src/dummies.rs
View file

@ -82,7 +82,7 @@ pub fn arg_enum(name: &Ident) {
fn from_str(_input: &str, _case_insensitive: bool) -> Result<Self, String> {
unimplemented!()
}
fn to_arg_value<'a>(&self) -> Option<clap::ArgValue<'a>>{
fn to_possible_value<'a>(&self) -> Option<clap::PossibleValue<'a>>{
unimplemented!()
}
}

8
clap_derive/tests/arg_enum.rs
View file

@ -7,7 +7,7 @@
// <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::{ArgEnum, ArgValue, Parser};
use clap::{ArgEnum, Parser, PossibleValue};
#[test]
fn basic() {
@ -54,7 +54,7 @@ fn default_value() {
impl std::fmt::Display for ArgChoice {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
std::fmt::Display::fmt(self.to_arg_value().unwrap().get_name(), f)
std::fmt::Display::fmt(self.to_possible_value().unwrap().get_name(), f)
}
}
@ -370,10 +370,10 @@ fn skip_variant() {
assert_eq!(
ArgChoice::value_variants()
.iter()
.map(ArgEnum::to_arg_value)
.map(ArgEnum::to_possible_value)
.map(Option::unwrap)
.collect::<Vec<_>>(),
vec![ArgValue::new("foo"), ArgValue::new("bar")]
vec![PossibleValue::new("foo"), PossibleValue::new("bar")]
);
assert!(ArgChoice::from_str("foo", true).is_ok());
assert!(ArgChoice::from_str("bar", true).is_ok());

2
clap_generate/examples/value_hints.rs
View file

@ -23,7 +23,7 @@ fn build_cli() -> App<'static> {
.arg(
Arg::new("generator")
.long("generate")
.possible_values(Shell::arg_values()),
.possible_values(Shell::possible_values()),
)
.arg(
Arg::new("unknown")

2
clap_generate/src/generators/shells/bash.rs
View file

@ -179,7 +179,7 @@ fn vals_for(o: &Arg) -> String {
format!(
"$(compgen -W \"{}\" -- \"${{cur}}\")",
vals.iter()
.filter_map(ArgValue::get_visible_name)
.filter_map(PossibleValue::get_visible_name)
.collect::<Vec<_>>()
.join(" ")
)

2
clap_generate/src/generators/shells/zsh.rs
View file

@ -372,7 +372,7 @@ fn value_completion(arg: &Arg) -> Option<String> {
"({})",
values
.iter()
.filter_map(ArgValue::get_visible_name)
.filter_map(PossibleValue::get_visible_name)
.collect::<Vec<_>>()
.join(" ")
))

2
clap_generate/src/lib.rs
View file

@ -36,7 +36,7 @@
//! .arg(
//! Arg::new("generator")
//! .long("generate")
//! .possible_values(Shell::arg_values()),
//! .possible_values(Shell::possible_values()),
//! )
//! }
//!

22
clap_generate/src/shell.rs
View file

@ -1,7 +1,7 @@
use std::fmt::Display;
use std::str::FromStr;
use clap::{ArgEnum, ArgValue};
use clap::{ArgEnum, PossibleValue};
use crate::{generators, Generator};
@ -23,16 +23,16 @@ pub enum Shell {
impl Shell {
/// Report all `possible_values`
pub fn arg_values() -> impl Iterator<Item = ArgValue<'static>> {
pub fn possible_values() -> impl Iterator<Item = PossibleValue<'static>> {
Shell::value_variants()
.iter()
.filter_map(ArgEnum::to_arg_value)
.filter_map(ArgEnum::to_possible_value)
}
}
impl Display for Shell {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.to_arg_value()
self.to_possible_value()
.expect("no values are skipped")
.get_name()
.fmt(f)
@ -44,7 +44,7 @@ impl FromStr for Shell {
fn from_str(s: &str) -> Result<Self, Self::Err> {
for variant in Self::value_variants() {
if variant.to_arg_value().unwrap().matches(s, false) {
if variant.to_possible_value().unwrap().matches(s, false) {
return Ok(*variant);
}
}
@ -64,13 +64,13 @@ impl ArgEnum for Shell {
]
}
fn to_arg_value<'a>(&self) -> Option<ArgValue<'a>> {
fn to_possible_value<'a>(&self) -> Option<PossibleValue<'a>> {
Some(match self {
Shell::Bash => ArgValue::new("bash"),
Shell::Elvish => ArgValue::new("elvish"),
Shell::Fish => ArgValue::new("fish"),
Shell::PowerShell => ArgValue::new("powershell"),
Shell::Zsh => ArgValue::new("zsh"),
Shell::Bash => PossibleValue::new("bash"),
Shell::Elvish => PossibleValue::new("elvish"),
Shell::Fish => PossibleValue::new("fish"),
Shell::PowerShell => PossibleValue::new("powershell"),
Shell::Zsh => PossibleValue::new("zsh"),
})
}
}

36
src/build/arg/mod.rs
View file

@ -1,12 +1,12 @@
mod arg_value;
#[cfg(debug_assertions)]
pub mod debug_asserts;
mod possible_value;
mod settings;
#[cfg(test)]
mod tests;
mod value_hint;
pub use self::arg_value::ArgValue;
pub use self::possible_value::PossibleValue;
pub use self::settings::{ArgFlags, ArgSettings};
pub use self::value_hint::ValueHint;
@ -102,7 +102,7 @@ pub struct Arg<'help> {
pub(crate) short_aliases: Vec<(char, bool)>, // (name, visible)
pub(crate) disp_ord: usize,
pub(crate) unified_ord: usize,
pub(crate) possible_vals: Vec<ArgValue<'help>>,
pub(crate) possible_vals: Vec<PossibleValue<'help>>,
pub(crate) val_names: Vec<&'help str>,
pub(crate) num_vals: Option<usize>,
pub(crate) max_occurs: Option<usize>,
@ -231,7 +231,7 @@ impl<'help> Arg<'help> {
/// Get the list of the possible values for this argument, if any
#[inline]
pub fn get_possible_values(&self) -> Option<&[ArgValue]> {
pub fn get_possible_values(&self) -> Option<&[PossibleValue]> {
if self.possible_vals.is_empty() {
None
} else {
@ -1959,7 +1959,7 @@ impl<'help> Arg<'help> {
///
/// **NOTE:** This setting only applies to [options] and [positional arguments]
///
/// **NOTE:** You can use both strings directly or use [`ArgValue`] if you want more control
/// **NOTE:** You can use both strings directly or use [`PossibleValue`] if you want more control
/// over single possible values.
///
/// # Examples
@ -1971,16 +1971,16 @@ impl<'help> Arg<'help> {
/// .possible_values(["fast", "slow", "medium"])
/// # ;
/// ```
/// The same using [`ArgValue`]:
/// The same using [`PossibleValue`]:
///
/// ```rust
/// # use clap::{App, Arg, ArgValue};
/// # use clap::{App, Arg, PossibleValue};
/// Arg::new("mode").takes_value(true).possible_values([
/// ArgValue::new("fast"),
/// PossibleValue::new("fast"),
/// // value with a help text
/// ArgValue::new("slow").about("not that fast"),
/// PossibleValue::new("slow").about("not that fast"),
/// // value that is hidden from completion and help text
/// ArgValue::new("medium").hidden(true),
/// PossibleValue::new("medium").hidden(true),
/// ])
/// # ;
/// ```
@ -2020,7 +2020,7 @@ impl<'help> Arg<'help> {
pub fn possible_values<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<ArgValue<'help>>,
T: Into<PossibleValue<'help>>,
{
self.possible_vals
.extend(values.into_iter().map(|value| value.into()));
@ -2032,7 +2032,7 @@ impl<'help> Arg<'help> {
///
/// **NOTE:** This setting only applies to [options] and [positional arguments]
///
/// **NOTE:** You can use both strings directly or use [`ArgValue`] if you want more control
/// **NOTE:** You can use both strings directly or use [`PossibleValue`] if you want more control
/// over single possible values.
///
/// # Examples
@ -2046,16 +2046,16 @@ impl<'help> Arg<'help> {
/// .possible_value("medium")
/// # ;
/// ```
/// The same using [`ArgValue`]:
/// The same using [`PossibleValue`]:
///
/// ```rust
/// # use clap::{App, Arg, ArgValue};
/// # use clap::{App, Arg, PossibleValue};
/// Arg::new("mode").takes_value(true)
/// .possible_value(ArgValue::new("fast"))
/// .possible_value(PossibleValue::new("fast"))
/// // value with a help text
/// .possible_value(ArgValue::new("slow").about("not that fast"))
/// .possible_value(PossibleValue::new("slow").about("not that fast"))
/// // value that is hidden from completion and help text
/// .possible_value(ArgValue::new("medium").hidden(true))
/// .possible_value(PossibleValue::new("medium").hidden(true))
/// # ;
/// ```
///
@ -2097,7 +2097,7 @@ impl<'help> Arg<'help> {
/// [positional arguments]: Arg::index()
pub fn possible_value<T>(mut self, value: T) -> Self
where
T: Into<ArgValue<'help>>,
T: Into<PossibleValue<'help>>,
{
self.possible_vals.push(value.into());
self.takes_value(true)

52
src/build/arg/arg_value.rs → src/build/arg/possible_value.rs
View file

@ -12,40 +12,40 @@ use crate::util::eq_ignore_case;
/// # Examples
///
/// ```rust
/// # use clap::{Arg, ArgValue};
/// # use clap::{Arg, PossibleValue};
/// let cfg = Arg::new("config")
/// .takes_value(true)
/// .value_name("FILE")
/// .possible_value(ArgValue::new("fast"))
/// .possible_value(ArgValue::new("slow").about("slower than fast"))
/// .possible_value(ArgValue::new("secret speed").hidden(true));
/// .possible_value(PossibleValue::new("fast"))
/// .possible_value(PossibleValue::new("slow").about("slower than fast"))
/// .possible_value(PossibleValue::new("secret speed").hidden(true));
/// ```
/// [Args]: crate::Arg
/// [possible values]: crate::Arg::possible_value()
/// [hide]: ArgValue::hidden()
/// [about]: ArgValue::about()
/// [hide]: PossibleValue::hidden()
/// [about]: PossibleValue::about()
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub struct ArgValue<'help> {
pub struct PossibleValue<'help> {
pub(crate) name: &'help str,
pub(crate) about: Option<&'help str>,
pub(crate) aliases: Vec<&'help str>, // (name, visible)
pub(crate) hidden: bool,
}
impl<'help> From<&'help str> for ArgValue<'help> {
impl<'help> From<&'help str> for PossibleValue<'help> {
fn from(s: &'help str) -> Self {
Self::new(s)
}
}
impl<'help> From<&'help &'help str> for ArgValue<'help> {
impl<'help> From<&'help &'help str> for PossibleValue<'help> {
fn from(s: &'help &'help str) -> Self {
Self::new(s)
}
}
/// Getters
impl<'help> ArgValue<'help> {
impl<'help> PossibleValue<'help> {
/// Get the name of the argument value
#[inline]
pub fn get_name(&self) -> &str {
@ -86,8 +86,8 @@ impl<'help> ArgValue<'help> {
/// # Examples
///
/// ```rust
/// # use clap::ArgValue;
/// let arg_value = ArgValue::new("fast").alias("not-slow");
/// # use clap::PossibleValue;
/// let arg_value = PossibleValue::new("fast").alias("not-slow");
///
/// assert!(arg_value.matches("fast", false));
/// assert!(arg_value.matches("not-slow", false));
@ -105,8 +105,8 @@ impl<'help> ArgValue<'help> {
}
}
impl<'help> ArgValue<'help> {
/// Creates a new instance of [`ArgValue`] using a string name. The name will be used to
impl<'help> PossibleValue<'help> {
/// Creates a new instance of [`PossibleValue`] using a string name. The name will be used to
/// decide wether this value was provided by the user to an argument.
///
/// **NOTE:** In case it is not [hidden] it will also be shown in help messages for arguments
@ -115,15 +115,15 @@ impl<'help> ArgValue<'help> {
/// # Examples
///
/// ```rust
/// # use clap::ArgValue;
/// ArgValue::new("fast")
/// # use clap::PossibleValue;
/// PossibleValue::new("fast")
/// # ;
/// ```
/// [hidden]: ArgValue::hidden
/// [hidden]: PossibleValue::hidden
/// [possible value]: crate::Arg::possible_values
/// [`Arg::hide_possible_values(true)`]: crate::Arg::hide_possible_values()
pub fn new(name: &'help str) -> Self {
ArgValue {
PossibleValue {
name,
..Default::default()
}
@ -135,8 +135,8 @@ impl<'help> ArgValue<'help> {
/// # Examples
///
/// ```rust
/// # use clap::ArgValue;
/// ArgValue::new("slow")
/// # use clap::PossibleValue;
/// PossibleValue::new("slow")
/// .about("not fast")
/// # ;
/// ```
@ -154,8 +154,8 @@ impl<'help> ArgValue<'help> {
/// # Examples
///
/// ```rust
/// # use clap::ArgValue;
/// ArgValue::new("secret")
/// # use clap::PossibleValue;
/// PossibleValue::new("secret")
/// .hidden(true)
/// # ;
/// ```
@ -173,8 +173,8 @@ impl<'help> ArgValue<'help> {
/// # Examples
///
/// ```rust
/// # use clap::ArgValue;
/// ArgValue::new("slow")
/// # use clap::PossibleValue;
/// PossibleValue::new("slow")
/// .alias("not-fast")
/// # ;
/// ```
@ -190,8 +190,8 @@ impl<'help> ArgValue<'help> {
/// # Examples
///
/// ```rust
/// # use clap::ArgValue;
/// ArgValue::new("slow")
/// # use clap::PossibleValue;
/// PossibleValue::new("slow")
/// .aliases(["not-fast", "snake-like"])
/// # ;
/// ```

2
src/build/mod.rs
View file

@ -9,6 +9,6 @@ mod usage_parser;
pub use self::{
app::{App, AppFlags, AppSettings},
arg::{Arg, ArgFlags, ArgSettings, ArgValue, ValueHint},
arg::{Arg, ArgFlags, ArgSettings, PossibleValue, ValueHint},
arg_group::ArgGroup,
};

8
src/derive.rs
View file

@ -1,7 +1,7 @@
//! This module contains traits that are usable with the `#[derive(...)].`
//! macros in [`clap_derive`].
use crate::{App, ArgMatches, ArgValue, Error};
use crate::{App, ArgMatches, Error, PossibleValue};
use std::ffi::OsString;
@ -295,8 +295,8 @@ pub trait ArgEnum: Sized + Clone {
Self::value_variants()
.iter()
.find(|v| {
v.to_arg_value()
.expect("ArgEnum::value_variants contains only values with a corresponding ArgEnum::to_arg_value")
v.to_possible_value()
.expect("ArgEnum::value_variants contains only values with a corresponding ArgEnum::to_possible_value")
.matches(input, case_insensitive)
})
.cloned()
@ -306,7 +306,7 @@ pub trait ArgEnum: Sized + Clone {
/// The canonical argument value.
///
/// The value is `None` for skipped variants.
fn to_arg_value<'a>(&self) -> Option<ArgValue<'a>>;
fn to_possible_value<'a>(&self) -> Option<PossibleValue<'a>>;
}
impl<T: Parser> Parser for Box<T> {

2
src/lib.rs
View file

@ -25,7 +25,7 @@ compile_error!("`std` feature is currently required to build `clap`");
pub use crate::{
build::{
App, AppFlags, AppSettings, Arg, ArgFlags, ArgGroup, ArgSettings, ArgValue, ValueHint,
App, AppFlags, AppSettings, Arg, ArgFlags, ArgGroup, ArgSettings, PossibleValue, ValueHint,
},
parse::errors::{Error, ErrorKind, Result},
parse::{ArgMatches, Indices, OsValues, Values},

4
src/parse/validator.rs
View file

@ -1,6 +1,6 @@
// Internal
use crate::{
build::{arg::ArgValue, AppSettings as AS, Arg, ArgSettings},
build::{arg::PossibleValue, AppSettings as AS, Arg, ArgSettings},
output::Usage,
parse::{
errors::{Error, ErrorKind, Result as ClapResult},
@ -121,7 +121,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
val_str.into_owned(),
&arg.possible_vals
.iter()
.filter_map(ArgValue::get_visible_name)
.filter_map(PossibleValue::get_visible_name)
.collect::<Vec<_>>(),
arg,
Usage::new(self.p).create_usage_with_title(&used),

4
tests/help.rs
View file

@ -1,6 +1,6 @@
mod utils;
use clap::{App, AppSettings, Arg, ArgGroup, ArgSettings, ArgValue, ErrorKind};
use clap::{App, AppSettings, Arg, ArgGroup, ArgSettings, ErrorKind, PossibleValue};
static REQUIRE_DELIM_HELP: &str = "test 1.3
@ -1049,7 +1049,7 @@ fn hide_single_possible_val() {
.long("pos")
.value_name("VAL")
.possible_values(["fast", "slow"])
.possible_value(ArgValue::new("secret speed").hidden(true))
.possible_value(PossibleValue::new("secret speed").hidden(true))
.about("Some vals")
.takes_value(true),
)

16
tests/possible_values.rs
View file

@ -1,6 +1,6 @@
mod utils;
use clap::{App, Arg, ArgValue, ErrorKind};
use clap::{App, Arg, ErrorKind, PossibleValue};
#[cfg(feature = "suggestions")]
static PV_ERROR: &str = "error: \"slo\" isn't a valid value for '-O <option>'
@ -64,7 +64,7 @@ fn possible_value_arg_value() {
let m = App::new("possible_values")
.arg(
Arg::new("arg_value").index(1).possible_value(
ArgValue::new("test123")
PossibleValue::new("test123")
.hidden(false)
.about("It's just a test"),
),
@ -226,8 +226,8 @@ fn possible_values_alias_output() {
Arg::new("option")
.short('O')
.possible_value("slow")
.possible_value(ArgValue::new("fast").alias("fost"))
.possible_value(ArgValue::new("ludicrous speed").aliases(["ls", "lcs"]))
.possible_value(PossibleValue::new("fast").alias("fost"))
.possible_value(PossibleValue::new("ludicrous speed").aliases(["ls", "lcs"]))
),
"clap-test -O slo",
PV_ERROR,
@ -242,8 +242,8 @@ fn possible_values_hidden_output() {
Arg::new("option")
.short('O')
.possible_values(["slow", "fast"])
.possible_value(ArgValue::new("ludicrous speed"))
.possible_value(ArgValue::new("forbidden speed").hidden(true))
.possible_value(PossibleValue::new("ludicrous speed"))
.possible_value(PossibleValue::new("forbidden speed").hidden(true))
),
"clap-test -O slo",
PV_ERROR,
@ -273,7 +273,7 @@ fn alias() {
.short('o')
.long("--option")
.takes_value(true)
.possible_value(ArgValue::new("test123").alias("123"))
.possible_value(PossibleValue::new("test123").alias("123"))
.possible_value("test321")
.case_insensitive(true),
)
@ -291,7 +291,7 @@ fn aliases() {
.short('o')
.long("--option")
.takes_value(true)
.possible_value(ArgValue::new("test123").aliases(["1", "2", "3"]))
.possible_value(PossibleValue::new("test123").aliases(["1", "2", "3"]))
.possible_value("test321")
.case_insensitive(true),
)