mirror of
https://github.com/nushell/nushell
synced 2025-01-08 19:29:08 +00:00
220b105efb
# Description
While perusing Value.rs, I noticed the `Value::int()`, `Value::float()`,
`Value::boolean()` and `Value::string()` constructors, which seem
designed to make it easier to construct various Values, but which aren't
used often at all in the codebase. So, using a few find-replaces
regexes, I increased their usage. This reduces overall LOC because
structures like this:
```
Value::Int {
val: a,
span: head
}
```
are changed into
```
Value::int(a, head)
```
and are respected as such by the project's formatter.
There are little readability concerns because the second argument to all
of these is `span`, and it's almost always extremely obvious which is
the span at every callsite.
# User-Facing Changes
None.
# 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 -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass
# 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.
74 lines
2 KiB
Rust
74 lines
2 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)])
|
|
.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<nu_protocol::PipelineData, nu_protocol::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::float(25.0, Span::test_data())),
|
|
}]
|
|
}
|
|
}
|
|
|
|
pub fn average(values: &[Value], head: &Span) -> Result<Value, ShellError> {
|
|
let sum = reducer_for(Reduce::Summation);
|
|
let total = &sum(Value::int(0, *head), values.to_vec(), *head)?;
|
|
match total {
|
|
Value::Filesize { val, span } => Ok(Value::Filesize {
|
|
val: val / values.len() as i64,
|
|
span: *span,
|
|
}),
|
|
Value::Duration { val, span } => Ok(Value::Duration {
|
|
val: val / values.len() as i64,
|
|
span: *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 {})
|
|
}
|
|
}
|