forked from extern/nushell
a042f407c1
* Converting average.rs to math.rs * Making some progress towards math Examples and unit tests failing, also think I found a bug with passing in strings * Fix typos * Found issue with negative numbers * Add some comments * Split commands like in split and str_ but do not register? * register commands in cli * Address clippy warnings * Fix bad examples * Make the example failure message more helpful * Replace unwraps * Use compare_values to avoid coercion issues * Remove unneeded code
136 lines
4.5 KiB
Rust
136 lines
4.5 KiB
Rust
use crate::commands::WholeStreamCommand;
|
|
use crate::prelude::*;
|
|
use nu_errors::ShellError;
|
|
use nu_protocol::{ReturnSuccess, Signature, UntaggedValue};
|
|
|
|
pub struct Command;
|
|
|
|
#[async_trait]
|
|
impl WholeStreamCommand for Command {
|
|
fn name(&self) -> &str {
|
|
"math"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math")
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
r#"Use mathematical functions (average, min, max) to aggregate list of numbers or tables
|
|
math average
|
|
math min
|
|
math max
|
|
"#
|
|
}
|
|
|
|
async fn run(
|
|
&self,
|
|
_args: CommandArgs,
|
|
registry: &CommandRegistry,
|
|
) -> Result<OutputStream, ShellError> {
|
|
Ok(OutputStream::one(Ok(ReturnSuccess::Value(
|
|
UntaggedValue::string(crate::commands::help::get_help(&Command, ®istry.clone()))
|
|
.into_value(Tag::unknown()),
|
|
))))
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::commands::math::{
|
|
average::average, max::maximum, min::minimum, utils::MathFunction,
|
|
};
|
|
use nu_plugin::test_helpers::value::{decimal, int};
|
|
use nu_protocol::Value;
|
|
|
|
#[test]
|
|
fn examples_work_as_expected() {
|
|
use crate::examples::test as test_examples;
|
|
|
|
test_examples(Command {})
|
|
}
|
|
|
|
#[test]
|
|
fn test_math_functions() {
|
|
struct TestCase {
|
|
description: &'static str,
|
|
values: Vec<Value>,
|
|
expected_err: Option<ShellError>,
|
|
// Order is: avg, min, max
|
|
expected_res: Vec<Result<Value, ShellError>>,
|
|
}
|
|
let tt: Vec<TestCase> = vec![
|
|
TestCase {
|
|
description: "Empty data should throw an error",
|
|
values: Vec::new(),
|
|
expected_err: Some(ShellError::unexpected("Expected data")),
|
|
expected_res: Vec::new(),
|
|
},
|
|
TestCase {
|
|
description: "Single value",
|
|
values: vec![int(10)],
|
|
expected_err: None,
|
|
expected_res: vec![Ok(decimal(10)), Ok(int(10)), Ok(int(10))],
|
|
},
|
|
TestCase {
|
|
description: "Multiple Values",
|
|
values: vec![int(10), int(30), int(20)],
|
|
expected_err: None,
|
|
expected_res: vec![Ok(decimal(20)), Ok(int(10)), Ok(int(30))],
|
|
},
|
|
TestCase {
|
|
description: "Mixed Values",
|
|
values: vec![int(10), decimal(26.5), decimal(26.5)],
|
|
expected_err: None,
|
|
expected_res: vec![Ok(decimal(21)), Ok(int(10)), Ok(decimal(26.5))],
|
|
},
|
|
TestCase {
|
|
description: "Negative Values",
|
|
values: vec![int(10), int(-11), int(-14)],
|
|
expected_err: None,
|
|
expected_res: vec![Ok(decimal(-5)), Ok(int(-14)), Ok(int(10))],
|
|
},
|
|
TestCase {
|
|
description: "Mixed Negative Values",
|
|
values: vec![int(10), decimal(-11.5), decimal(-13.5)],
|
|
expected_err: None,
|
|
expected_res: vec![Ok(decimal(-5)), Ok(decimal(-13.5)), Ok(int(10))],
|
|
},
|
|
// TODO-Uncomment once Issue: https://github.com/nushell/nushell/issues/1883 is resolved
|
|
// TestCase {
|
|
// description: "Invalid Mixed Values",
|
|
// values: vec![int(10), decimal(26.5), decimal(26.5), string("math")],
|
|
// expected_err: Some(ShellError::unimplemented("something")),
|
|
// expected_res: vec![],
|
|
// },
|
|
];
|
|
let test_tag = Tag::unknown();
|
|
|
|
for tc in tt.iter() {
|
|
let tc: &TestCase = tc; // Just for type annotations
|
|
let math_functions: Vec<MathFunction> = vec![average, minimum, maximum];
|
|
let results = math_functions
|
|
.iter()
|
|
.map(|mf| mf(&tc.values, &test_tag))
|
|
.collect_vec();
|
|
|
|
if tc.expected_err.is_some() {
|
|
assert!(
|
|
results.iter().all(|r| r.is_err()),
|
|
"Expected all functions to error for test-case: {}",
|
|
tc.description,
|
|
);
|
|
} else {
|
|
for (i, res) in results.into_iter().enumerate() {
|
|
assert_eq!(
|
|
res, tc.expected_res[i],
|
|
"math function {} failed on test-case {}",
|
|
i, tc.description
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|