nushell/crates/nu-command/src/strings/split/row.rs

160 lines
4.6 KiB
Rust
Raw Normal View History

2021-10-09 04:45:25 +02:00
use nu_engine::CallExt;
use nu_protocol::{
ast::Call,
2021-10-25 18:58:58 +02:00
engine::{Command, EngineState, Stack},
Category, Example, PipelineData, ShellError, Signature, Span, Spanned, SyntaxShape, Type,
Value,
2021-10-09 04:45:25 +02:00
};
2021-10-25 06:01:02 +02:00
#[derive(Clone)]
2021-10-09 04:45:25 +02:00
pub struct SubCommand;
impl Command for SubCommand {
fn name(&self) -> &str {
"split row"
}
fn signature(&self) -> Signature {
Signature::build("split row")
.input_output_types(vec![(Type::String, Type::List(Box::new(Type::String)))])
.vectorizes_over_list(true)
.required(
"separator",
SyntaxShape::String,
"the character that denotes what separates rows",
)
.named(
"number",
SyntaxShape::Int,
"Split into maximum number of items",
Some('n'),
)
.category(Category::Strings)
2021-10-09 04:45:25 +02:00
}
fn usage(&self) -> &str {
"Split a string into multiple rows using a separator."
2021-10-09 04:45:25 +02:00
}
fn search_terms(&self) -> Vec<&str> {
vec!["separate", "divide"]
}
2021-10-09 04:45:25 +02:00
fn run(
&self,
2021-10-25 08:31:39 +02:00
engine_state: &EngineState,
stack: &mut Stack,
2021-10-09 04:45:25 +02:00
call: &Call,
2021-10-25 06:01:02 +02:00
input: PipelineData,
) -> Result<PipelineData, ShellError> {
2021-10-25 08:31:39 +02:00
split_row(engine_state, stack, call, input)
2021-10-09 04:45:25 +02:00
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Split a string into rows of char",
example: "'abc' | split row ''",
result: Some(Value::List {
vals: vec![
Value::test_string(""),
Value::test_string("a"),
Value::test_string("b"),
Value::test_string("c"),
Value::test_string(""),
],
span: Span::test_data(),
}),
},
Example {
description: "Split a string into rows by the specified separator",
example: "'a--b--c' | split row '--'",
result: Some(Value::List {
vals: vec![
Value::test_string("a"),
Value::test_string("b"),
Value::test_string("c"),
],
span: Span::test_data(),
}),
},
Example {
description: "Split a string by '-'",
example: "'-a-b-c-' | split row '-'",
result: Some(Value::List {
vals: vec![
Value::test_string(""),
Value::test_string("a"),
Value::test_string("b"),
Value::test_string("c"),
Value::test_string(""),
],
span: Span::test_data(),
}),
},
]
}
2021-10-09 04:45:25 +02:00
}
fn split_row(
2021-10-25 08:31:39 +02:00
engine_state: &EngineState,
stack: &mut Stack,
2021-10-09 04:45:25 +02:00
call: &Call,
2021-10-25 06:01:02 +02:00
input: PipelineData,
) -> Result<PipelineData, ShellError> {
2021-10-09 04:45:25 +02:00
let name_span = call.head;
2021-10-25 08:31:39 +02:00
let separator: Spanned<String> = call.req(engine_state, stack, 0)?;
let max_split: Option<usize> = call.get_flag(engine_state, stack, "number")?;
2021-10-28 06:13:10 +02:00
input.flat_map(
move |x| split_row_helper(&x, &separator, max_split, name_span),
2021-10-28 06:13:10 +02:00
engine_state.ctrlc.clone(),
)
2021-10-09 04:45:25 +02:00
}
fn split_row_helper(
v: &Value,
separator: &Spanned<String>,
max_split: Option<usize>,
name: Span,
) -> Vec<Value> {
2021-10-11 20:45:31 +02:00
match v.span() {
Ok(v_span) => {
if let Ok(s) = v.as_string() {
match max_split {
Some(max_split) => s
.splitn(max_split, &separator.item)
.map(|s| Value::string(s, v_span))
.collect(),
None => s
.split(&separator.item)
.map(|s| Value::string(s, v_span))
.collect(),
}
2021-10-11 20:45:31 +02:00
} else {
vec![Value::Error {
error: Box::new(ShellError::PipelineMismatch {
exp_input_type: "string".into(),
dst_span: name,
src_span: v_span,
}),
2021-10-11 20:45:31 +02:00
}]
}
}
Err(error) => vec![Value::Error {
error: Box::new(error),
}],
2021-10-09 04:45:25 +02:00
}
}
#[cfg(test)]
mod test {
use super::*;
2021-10-09 04:45:25 +02:00
#[test]
fn test_examples() {
use crate::test_examples;
2021-10-09 04:45:25 +02:00
test_examples(SubCommand {})
}
}