mirror of
https://github.com/nushell/nushell.git
synced 2025-04-11 23:08:20 +02:00
375 lines
14 KiB
Rust
375 lines
14 KiB
Rust
use crate::commands::WholeStreamCommand;
|
|
use crate::prelude::*;
|
|
use indexmap::indexmap;
|
|
use nu_errors::ShellError;
|
|
use nu_protocol::{ReturnSuccess, Signature, SyntaxShape, UntaggedValue, Value};
|
|
use nu_source::Tagged;
|
|
use nu_value_ext::as_string;
|
|
|
|
pub struct GroupBy;
|
|
|
|
#[derive(Deserialize)]
|
|
pub struct GroupByArgs {
|
|
grouper: Option<Value>,
|
|
}
|
|
|
|
#[async_trait]
|
|
impl WholeStreamCommand for GroupBy {
|
|
fn name(&self) -> &str {
|
|
"group-by"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("group-by").optional(
|
|
"grouper",
|
|
SyntaxShape::Any,
|
|
"the grouper value to use",
|
|
)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"create a new table grouped."
|
|
}
|
|
|
|
async fn run(
|
|
&self,
|
|
args: CommandArgs,
|
|
registry: &CommandRegistry,
|
|
) -> Result<OutputStream, ShellError> {
|
|
group_by(args, registry).await
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "group items by column named \"type\"",
|
|
example: r#"ls | group-by type"#,
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "blocks can be used for generating a grouping key (same as above)",
|
|
example: r#"ls | group-by { get type }"#,
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "you can also group by raw values by leaving out the argument",
|
|
example: "echo [1 3 1 3 2 1 1] | group-by",
|
|
result: Some(vec![UntaggedValue::row(indexmap! {
|
|
"1".to_string() => UntaggedValue::Table(vec![
|
|
UntaggedValue::int(1).into(),
|
|
UntaggedValue::int(1).into(),
|
|
UntaggedValue::int(1).into(),
|
|
UntaggedValue::int(1).into(),
|
|
]).into(),
|
|
|
|
"3".to_string() => UntaggedValue::Table(vec![
|
|
UntaggedValue::int(3).into(),
|
|
UntaggedValue::int(3).into(),
|
|
]).into(),
|
|
|
|
"2".to_string() => UntaggedValue::Table(vec![
|
|
UntaggedValue::int(2).into(),
|
|
]).into(),
|
|
})
|
|
.into()]),
|
|
},
|
|
Example {
|
|
description: "write pipelines for a more involved grouping key",
|
|
example:
|
|
"echo [1 3 1 3 2 1 1] | group-by { echo `({{$it}} - 1) % 3` | calc | str from }",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
enum Grouper {
|
|
ByColumn(Option<Tagged<String>>),
|
|
ByBlock,
|
|
}
|
|
|
|
pub async fn group_by(
|
|
args: CommandArgs,
|
|
registry: &CommandRegistry,
|
|
) -> Result<OutputStream, ShellError> {
|
|
let name = args.call_info.name_tag.clone();
|
|
let registry = registry.clone();
|
|
let head = Arc::new(args.call_info.args.head.clone());
|
|
let scope = Arc::new(args.call_info.scope.clone());
|
|
let context = Arc::new(Context::from_raw(&args, ®istry));
|
|
let (GroupByArgs { grouper }, input) = args.process(®istry).await?;
|
|
|
|
let values: Vec<Value> = input.collect().await;
|
|
let mut keys: Vec<Result<String, ShellError>> = vec![];
|
|
let mut group_strategy = Grouper::ByColumn(None);
|
|
|
|
match grouper {
|
|
Some(Value {
|
|
value: UntaggedValue::Block(block_given),
|
|
..
|
|
}) => {
|
|
let block = Arc::new(block_given);
|
|
let error_key = "error";
|
|
|
|
for value in values.iter() {
|
|
let run = block.clone();
|
|
let scope = scope.clone();
|
|
let head = head.clone();
|
|
let context = context.clone();
|
|
|
|
match crate::commands::each::process_row(run, scope, head, context, value.clone())
|
|
.await
|
|
{
|
|
Ok(mut s) => {
|
|
let collection: Vec<Result<ReturnSuccess, ShellError>> =
|
|
s.drain_vec().await;
|
|
|
|
if collection.len() > 1 {
|
|
return Err(ShellError::labeled_error(
|
|
"expected one value from the block",
|
|
"requires a table with one value for grouping",
|
|
&name,
|
|
));
|
|
}
|
|
|
|
let value = match collection.get(0) {
|
|
Some(Ok(return_value)) => {
|
|
return_value.raw_value().unwrap_or_else(|| {
|
|
UntaggedValue::string(error_key).into_value(&name)
|
|
})
|
|
}
|
|
Some(Err(_)) | None => {
|
|
UntaggedValue::string(error_key).into_value(&name)
|
|
}
|
|
};
|
|
|
|
keys.push(as_string(&value));
|
|
}
|
|
Err(_) => {
|
|
keys.push(Ok(error_key.into()));
|
|
}
|
|
}
|
|
}
|
|
|
|
group_strategy = Grouper::ByBlock;
|
|
}
|
|
Some(other) => {
|
|
group_strategy = Grouper::ByColumn(Some(as_string(&other)?.tagged(&name)));
|
|
}
|
|
_ => {}
|
|
}
|
|
|
|
if values.is_empty() {
|
|
return Err(ShellError::labeled_error(
|
|
"expected table from pipeline",
|
|
"requires a table input",
|
|
name,
|
|
));
|
|
}
|
|
|
|
let values = UntaggedValue::table(&values).into_value(&name);
|
|
|
|
match group_strategy {
|
|
Grouper::ByBlock => {
|
|
let map = keys.clone();
|
|
|
|
let block = Box::new(move |idx: usize, row: &Value| match map.get(idx) {
|
|
Some(Ok(key)) => Ok(key.clone()),
|
|
Some(Err(reason)) => Err(reason.clone()),
|
|
None => as_string(row),
|
|
});
|
|
|
|
match crate::utils::data::group(&values, &Some(block), &name) {
|
|
Ok(grouped) => Ok(OutputStream::one(ReturnSuccess::value(grouped))),
|
|
Err(reason) => Err(reason),
|
|
}
|
|
}
|
|
Grouper::ByColumn(column_name) => match group(&column_name, &values, name) {
|
|
Ok(grouped) => Ok(OutputStream::one(ReturnSuccess::value(grouped))),
|
|
Err(reason) => Err(reason),
|
|
},
|
|
}
|
|
}
|
|
|
|
pub fn suggestions(tried: Tagged<&str>, for_value: &Value) -> ShellError {
|
|
let possibilities = for_value.data_descriptors();
|
|
|
|
let mut possible_matches: Vec<_> = possibilities
|
|
.iter()
|
|
.map(|x| (natural::distance::levenshtein_distance(x, &tried), x))
|
|
.collect();
|
|
|
|
possible_matches.sort();
|
|
|
|
if !possible_matches.is_empty() {
|
|
ShellError::labeled_error(
|
|
"Unknown column",
|
|
format!("did you mean '{}'?", possible_matches[0].1),
|
|
tried.tag(),
|
|
)
|
|
} else {
|
|
ShellError::labeled_error(
|
|
"Unknown column",
|
|
"row does not contain this column",
|
|
tried.tag(),
|
|
)
|
|
}
|
|
}
|
|
|
|
pub fn group(
|
|
column_name: &Option<Tagged<String>>,
|
|
values: &Value,
|
|
tag: impl Into<Tag>,
|
|
) -> Result<Value, ShellError> {
|
|
let name = tag.into();
|
|
|
|
let grouper = if let Some(column_name) = column_name {
|
|
Grouper::ByColumn(Some(column_name.clone()))
|
|
} else {
|
|
Grouper::ByColumn(None)
|
|
};
|
|
|
|
match grouper {
|
|
Grouper::ByColumn(Some(column_name)) => {
|
|
let block = Box::new(move |_, row: &Value| {
|
|
match row.get_data_by_key(column_name.borrow_spanned()) {
|
|
Some(group_key) => Ok(as_string(&group_key)?),
|
|
None => Err(suggestions(column_name.borrow_tagged(), &row)),
|
|
}
|
|
});
|
|
|
|
crate::utils::data::group(&values, &Some(block), &name)
|
|
}
|
|
Grouper::ByColumn(None) => {
|
|
let block = Box::new(move |_, row: &Value| match as_string(row) {
|
|
Ok(group_key) => Ok(group_key),
|
|
Err(reason) => Err(reason),
|
|
});
|
|
|
|
crate::utils::data::group(&values, &Some(block), &name)
|
|
}
|
|
Grouper::ByBlock => Err(ShellError::unimplemented(
|
|
"Block not implemented: This should never happen.",
|
|
)),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::group;
|
|
use indexmap::IndexMap;
|
|
use nu_errors::ShellError;
|
|
use nu_protocol::{UntaggedValue, Value};
|
|
use nu_source::*;
|
|
|
|
fn string(input: impl Into<String>) -> Value {
|
|
UntaggedValue::string(input.into()).into_untagged_value()
|
|
}
|
|
|
|
fn row(entries: IndexMap<String, Value>) -> Value {
|
|
UntaggedValue::row(entries).into_untagged_value()
|
|
}
|
|
|
|
fn table(list: &[Value]) -> Value {
|
|
UntaggedValue::table(list).into_untagged_value()
|
|
}
|
|
|
|
fn nu_releases_committers() -> Vec<Value> {
|
|
vec![
|
|
row(
|
|
indexmap! {"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("August 23-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("August 23-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("October 10-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("Sept 24-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("October 10-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("Sept 24-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("October 10-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("Sept 24-2019")},
|
|
),
|
|
row(
|
|
indexmap! {"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("August 23-2019")},
|
|
),
|
|
]
|
|
}
|
|
|
|
#[test]
|
|
fn groups_table_by_date_column() -> Result<(), ShellError> {
|
|
let for_key = Some(String::from("date").tagged_unknown());
|
|
let sample = table(&nu_releases_committers());
|
|
|
|
assert_eq!(
|
|
group(&for_key, &sample, Tag::unknown())?,
|
|
row(indexmap! {
|
|
"August 23-2019".into() => table(&[
|
|
row(indexmap!{"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("August 23-2019")}),
|
|
row(indexmap!{"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("August 23-2019")}),
|
|
row(indexmap!{"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("August 23-2019")})
|
|
]),
|
|
"October 10-2019".into() => table(&[
|
|
row(indexmap!{"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("October 10-2019")}),
|
|
row(indexmap!{"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("October 10-2019")}),
|
|
row(indexmap!{"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("October 10-2019")})
|
|
]),
|
|
"Sept 24-2019".into() => table(&[
|
|
row(indexmap!{"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("Sept 24-2019")}),
|
|
row(indexmap!{"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("Sept 24-2019")}),
|
|
row(indexmap!{"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("Sept 24-2019")})
|
|
]),
|
|
})
|
|
);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn groups_table_by_country_column() -> Result<(), ShellError> {
|
|
let for_key = Some(String::from("country").tagged_unknown());
|
|
let sample = table(&nu_releases_committers());
|
|
|
|
assert_eq!(
|
|
group(&for_key, &sample, Tag::unknown())?,
|
|
row(indexmap! {
|
|
"EC".into() => table(&[
|
|
row(indexmap!{"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("August 23-2019")}),
|
|
row(indexmap!{"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("Sept 24-2019")}),
|
|
row(indexmap!{"name".into() => string("AR"), "country".into() => string("EC"), "date".into() => string("October 10-2019")})
|
|
]),
|
|
"NZ".into() => table(&[
|
|
row(indexmap!{"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("August 23-2019")}),
|
|
row(indexmap!{"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("October 10-2019")}),
|
|
row(indexmap!{"name".into() => string("JT"), "country".into() => string("NZ"), "date".into() => string("Sept 24-2019")})
|
|
]),
|
|
"US".into() => table(&[
|
|
row(indexmap!{"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("October 10-2019")}),
|
|
row(indexmap!{"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("Sept 24-2019")}),
|
|
row(indexmap!{"name".into() => string("YK"), "country".into() => string("US"), "date".into() => string("August 23-2019")}),
|
|
]),
|
|
})
|
|
);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn examples_work_as_expected() {
|
|
use super::GroupBy;
|
|
use crate::examples::test as test_examples;
|
|
|
|
test_examples(GroupBy {})
|
|
}
|
|
}
|