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.

Sign up for GitHub

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

Implement Serialization and Deserialization for Verbosity #114

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Implement Serialization and Deserialization for Verbosity #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 106 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,19 @@ codecov = { repository = "clap-rs/clap-verbosity-flag" }
default = ["log"]
log = ["dep:log"]
tracing = ["dep:tracing-core"]
serde = ["dep:serde"]

[dependencies]
clap = { version = "4.0.0", default-features = false, features = ["std", "derive"] }
log = { version = "0.4.1", optional = true }
serde = { version = "1", features = ["derive"], optional = true }
epage marked this conversation as resolved.
Show resolved Hide resolved
tracing-core = { version = "0.1", optional = true }

[dev-dependencies]
clap = { version = "4.5.4", default-features = false, features = ["help", "usage"] }
env_logger = "0.11.3"
serde_test = { version = "1.0.177" }
toml = { version = "0.8.19" }
tracing = "0.1"
tracing-subscriber = "0.3"

Expand Down
148 changes: 132 additions & 16 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,21 @@ pub mod log;
pub mod tracing;

/// Logging flags to `#[command(flatten)]` into your CLI
#[derive(clap::Args, Debug, Clone, Default)]
#[derive(clap::Args, Debug, Clone, Default, PartialEq, Eq)]
joshka marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

This PR seems to be mixing a lot of different things

  • Making types support Eq
  • More From impls
  • A refactor with how the count math is done

etc

Ideally these would at least be split into individual commits

  • We can track them in release notes more easily
  • I can better see how all of the parts for a single change fit together

#[command(about = None, long_about = None)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(
feature = "serde",
serde(
from = "VerbosityFilter",
into = "VerbosityFilter",
bound(serialize = "L: Clone")
)
)]
#[cfg_attr(
feature = "serde",
doc = r#"This type serializes to a string representation of the log level, e.g. `"Debug"`"#
)]
pub struct Verbosity<L: LogLevel = ErrorLevel> {
#[arg(
long,
Expand Down Expand Up @@ -162,6 +175,21 @@ impl<L: LogLevel> fmt::Display for Verbosity<L> {
}
}

impl<L: LogLevel> From<Verbosity<L>> for VerbosityFilter {
fn from(verbosity: Verbosity<L>) -> Self {
verbosity.filter()
}
}

impl<L: LogLevel> From<VerbosityFilter> for Verbosity<L> {
fn from(filter: VerbosityFilter) -> Self {
let default = L::default_filter();
let verbose = filter.value().saturating_sub(default.value());
let quiet = default.value().saturating_sub(filter.value());
Verbosity::new(verbose, quiet)
}
}

/// Customize the default log-level and associated help
pub trait LogLevel {
/// Baseline level before applying `--verbose` and `--quiet`
Expand Down Expand Up @@ -192,6 +220,7 @@ pub trait LogLevel {
///
/// Used to calculate the log level and filter.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum VerbosityFilter {
Off,
Error,
Expand All @@ -206,15 +235,7 @@ impl VerbosityFilter {
///
/// Negative values will decrease the verbosity, while positive values will increase it.
fn with_offset(&self, offset: i16) -> VerbosityFilter {
let value = match self {
Self::Off => 0_i16,
Self::Error => 1,
Self::Warn => 2,
Self::Info => 3,
Self::Debug => 4,
Self::Trace => 5,
};
match value.saturating_add(offset) {
match i16::from(self.value()).saturating_add(offset) {
i16::MIN..=0 => Self::Off,
1 => Self::Error,
2 => Self::Warn,
Expand All @@ -223,6 +244,20 @@ impl VerbosityFilter {
5..=i16::MAX => Self::Trace,
}
}

/// Get the numeric value of the filter.
///
/// This is an internal representation of the filter level used only for conversion / offset.
fn value(&self) -> u8 {
match self {
Self::Off => 0,
Self::Error => 1,
Self::Warn => 2,
Self::Info => 3,
Self::Debug => 4,
Self::Trace => 5,
}
}
}

impl fmt::Display for VerbosityFilter {
Expand All @@ -239,7 +274,7 @@ impl fmt::Display for VerbosityFilter {
}

/// Default to [`VerbosityFilter::Error`]
#[derive(Copy, Clone, Debug, Default)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct ErrorLevel;

impl LogLevel for ErrorLevel {
Expand All @@ -249,7 +284,7 @@ impl LogLevel for ErrorLevel {
}

/// Default to [`VerbosityFilter::Warn`]
#[derive(Copy, Clone, Debug, Default)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct WarnLevel;

impl LogLevel for WarnLevel {
Expand All @@ -259,7 +294,7 @@ impl LogLevel for WarnLevel {
}

/// Default to [`VerbosityFilter::Info`]
#[derive(Copy, Clone, Debug, Default)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct InfoLevel;

impl LogLevel for InfoLevel {
Expand All @@ -269,7 +304,7 @@ impl LogLevel for InfoLevel {
}

/// Default to [`VerbosityFilter::Debug`]
#[derive(Copy, Clone, Debug, Default)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct DebugLevel;

impl LogLevel for DebugLevel {
Expand All @@ -279,7 +314,7 @@ impl LogLevel for DebugLevel {
}

/// Default to [`VerbosityFilter::Trace`]
#[derive(Copy, Clone, Debug, Default)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct TraceLevel;

impl LogLevel for TraceLevel {
Expand All @@ -289,7 +324,7 @@ impl LogLevel for TraceLevel {
}

/// Default to [`VerbosityFilter::Off`] (no logging)
#[derive(Copy, Clone, Debug, Default)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct OffLevel;

impl LogLevel for OffLevel {
Expand Down Expand Up @@ -453,4 +488,85 @@ mod test {
assert_filter::<TraceLevel>(verbose, quiet, expected_filter);
}
}

#[test]
fn from_verbosity_filter() {
for &filter in &[
VerbosityFilter::Off,
VerbosityFilter::Error,
VerbosityFilter::Warn,
VerbosityFilter::Info,
VerbosityFilter::Debug,
VerbosityFilter::Trace,
] {
assert_eq!(Verbosity::<OffLevel>::from(filter).filter(), filter);
assert_eq!(Verbosity::<ErrorLevel>::from(filter).filter(), filter);
assert_eq!(Verbosity::<WarnLevel>::from(filter).filter(), filter);
assert_eq!(Verbosity::<InfoLevel>::from(filter).filter(), filter);
assert_eq!(Verbosity::<DebugLevel>::from(filter).filter(), filter);
assert_eq!(Verbosity::<TraceLevel>::from(filter).filter(), filter);
}
}
}

#[cfg(feature = "serde")]
#[cfg(test)]
mod serde_tests {
use super::*;
joshka marked this conversation as resolved.
Fixed Show resolved Hide resolved

use clap::Parser;
use serde::{Deserialize, Serialize};

#[derive(Debug, Parser, Serialize, Deserialize)]
struct Cli {
meaning_of_life: u8,
#[command(flatten)]
verbosity: Verbosity<InfoLevel>,
}

#[test]
fn serialize_toml() {
let cli = Cli {
meaning_of_life: 42,
verbosity: Verbosity::new(2, 1),
};
let toml = toml::to_string(&cli).unwrap();
assert_eq!(toml, "meaning_of_life = 42\nverbosity = \"Debug\"\n");
}

#[test]
fn deserialize_toml() {
let toml = "meaning_of_life = 42\nverbosity = \"Debug\"\n";
let cli: Cli = toml::from_str(toml).unwrap();
assert_eq!(cli.meaning_of_life, 42);
assert_eq!(cli.verbosity.filter(), VerbosityFilter::Debug);
}

/// Tests that the `Verbosity` can be serialized and deserialized correctly from an a token.
#[test]
fn serde_round_trips() {
use serde_test::{assert_tokens, Token};

for (filter, variant) in [
(VerbosityFilter::Off, "Off"),
(VerbosityFilter::Error, "Error"),
(VerbosityFilter::Warn, "Warn"),
(VerbosityFilter::Info, "Info"),
(VerbosityFilter::Debug, "Debug"),
(VerbosityFilter::Trace, "Trace"),
] {
let tokens = &[Token::UnitVariant {
name: "VerbosityFilter",
variant,
}];

// `assert_tokens` checks both serialization and deserialization.
assert_tokens(&Verbosity::<OffLevel>::from(filter), tokens);
assert_tokens(&Verbosity::<ErrorLevel>::from(filter), tokens);
assert_tokens(&Verbosity::<WarnLevel>::from(filter), tokens);
assert_tokens(&Verbosity::<InfoLevel>::from(filter), tokens);
assert_tokens(&Verbosity::<DebugLevel>::from(filter), tokens);
assert_tokens(&Verbosity::<TraceLevel>::from(filter), tokens);
}
}
}
Loading