mirror of
https://github.com/nushell/nushell.git
synced 2024-11-25 09:53:43 +01:00
6cdfee3573
# Description As part of the refactor to split spans off of Value, this moves to using helper functions to create values, and using `.span()` instead of matching span out of Value directly. Hoping to get a few more helping hands to finish this, as there are a lot of commands to update :) # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> --------- Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com> Co-authored-by: WindSoilder <windsoilder@outlook.com>
75 lines
2.1 KiB
Rust
75 lines
2.1 KiB
Rust
use crate::math::reducers::{reducer_for, Reduce};
|
|
use crate::math::utils::run_with_function;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Span, Type, Value};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"math avg"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math avg")
|
|
.input_output_types(vec![
|
|
(Type::List(Box::new(Type::Number)), Type::Number),
|
|
(Type::List(Box::new(Type::Duration)), Type::Duration),
|
|
(Type::List(Box::new(Type::Filesize)), Type::Filesize),
|
|
])
|
|
.allow_variants_without_examples(true)
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Returns the average of a list of numbers."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["average", "mean", "statistics"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
run_with_function(call, input, average)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Compute the average of a list of numbers",
|
|
example: "[-50 100.0 25] | math avg",
|
|
result: Some(Value::test_float(25.0)),
|
|
}]
|
|
}
|
|
}
|
|
|
|
pub fn average(values: &[Value], span: Span, head: Span) -> Result<Value, ShellError> {
|
|
let sum = reducer_for(Reduce::Summation);
|
|
let total = &sum(Value::int(0, head), values.to_vec(), span, head)?;
|
|
let span = total.span();
|
|
match total {
|
|
Value::Filesize { val, .. } => Ok(Value::filesize(val / values.len() as i64, span)),
|
|
Value::Duration { val, .. } => Ok(Value::duration(val / values.len() as i64, span)),
|
|
_ => total.div(head, &Value::int(values.len() as i64, head), head),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|