Ported compact command to engine-q (#558)

* :Interm work porting compact to engine-q

* Port 'compact' command from nushell to engine-q

* Fixed example
This commit is contained in:
Matthew Auld 2021-12-22 22:08:39 -05:00 committed by GitHub
parent ef59b4aa51
commit c33104c4ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 119 additions and 0 deletions

View file

@ -51,6 +51,7 @@ pub fn create_default_context() -> EngineState {
Append,
Collect,
Columns,
Compact,
Drop,
DropColumn,
DropNth,

View file

@ -0,0 +1,116 @@
use nu_engine::CallExt;
use nu_protocol::{
ast::Call, engine::Command, engine::EngineState, engine::Stack, Category, Example,
PipelineData, ShellError, Signature, Span, SyntaxShape, Value,
};
#[derive(Clone)]
pub struct Compact;
impl Command for Compact {
fn name(&self) -> &str {
"compact"
}
fn signature(&self) -> Signature {
Signature::build("compact")
.rest(
"columns",
SyntaxShape::Any,
"the columns to compact from the table",
)
.category(Category::Filters)
}
fn usage(&self) -> &str {
"Creates a table with non-empty rows."
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
) -> Result<nu_protocol::PipelineData, ShellError> {
compact(engine_state, stack, call, input)
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Filter out all records where 'Hello' is null (returns nothing)",
example: r#"echo [["Hello" "World"]; [$nothing 3]]| compact Hello"#,
result: Some(Value::List {
vals: vec![],
span: Span::test_data(),
}),
},
Example {
description: "Filter out all records where 'World' is null (Returns the table)",
example: r#"echo [["Hello" "World"]; [$nothing 3]]| compact World"#,
result: Some(Value::List {
vals: vec![Value::Record {
cols: vec!["Hello".into(), "World".into()],
vals: vec![Value::nothing(Span::test_data()), Value::test_int(3)],
span: Span::test_data(),
}],
span: Span::test_data(),
}),
},
Example {
description: "Filter out all instances of nothing from a list (Returns [1,2]",
example: r#"echo [1, $nothing, 2] | compact"#,
result: Some(Value::List {
vals: vec![Value::test_int(1), Value::test_int(2)],
span: Span::test_data(),
}),
},
]
}
}
pub fn compact(
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
) -> Result<nu_protocol::PipelineData, ShellError> {
let columns: Vec<String> = call.rest(engine_state, stack, 0)?;
input.filter(
move |item| {
match item {
// Nothing is filtered out
Value::Nothing { .. } => false,
Value::Record { .. } => {
for column in columns.iter() {
match item.get_data_by_key(column) {
None => return false,
Some(x) => {
if let Value::Nothing { .. } = x {
return false;
}
}
}
}
// No defined columns contained Nothing
true
}
// Any non-Nothing, non-record should be kept
_ => true,
}
},
engine_state.ctrlc.clone(),
)
}
#[cfg(test)]
mod tests {
use super::Compact;
#[test]
fn examples_work_as_expected() {
use crate::test_examples;
test_examples(Compact {})
}
}

View file

@ -3,6 +3,7 @@ mod any;
mod append;
mod collect;
mod columns;
mod compact;
mod drop;
mod each;
mod empty;
@ -33,6 +34,7 @@ pub use any::Any;
pub use append::Append;
pub use collect::Collect;
pub use columns::Columns;
pub use compact::Compact;
pub use drop::*;
pub use each::Each;
pub use empty::Empty;