# Description This PR creates a new `Record` type to reduce duplicate code and possibly bugs as well. (This is an edited version of #9648.) - `Record` implements `FromIterator` and `IntoIterator` and so can be iterated over or collected into. For example, this helps with conversions to and from (hash)maps. (Also, no more `cols.iter().zip(vals)`!) - `Record` has a `push(col, val)` function to help insure that the number of columns is equal to the number of values. I caught a few potential bugs thanks to this (e.g. in the `ls` command). - Finally, this PR also adds a `record!` macro that helps simplify record creation. It is used like so: ```rust record! { "key1" => some_value, "key2" => Value::string("text", span), "key3" => Value::int(optional_int.unwrap_or(0), span), "key4" => Value::bool(config.setting, span), } ``` Since macros hinder formatting, etc., the right hand side values should be relatively short and sweet like the examples above. Where possible, prefer `record!` or `.collect()` on an iterator instead of multiple `Record::push`s, since the first two automatically set the record capacity and do less work overall. # User-Facing Changes Besides the changes in `nu-protocol` the only other breaking changes are to `nu-table::{ExpandedTable::build_map, JustTable::kv_table}`.
210 lines
6.1 KiB
Rust
210 lines
6.1 KiB
Rust
use std::collections::HashMap;
|
|
|
|
use nu_engine::get_columns;
|
|
use nu_protocol::{
|
|
ast::PathMember, record, ListStream, PipelineData, PipelineMetadata, RawStream, Value,
|
|
};
|
|
|
|
use super::NuSpan;
|
|
|
|
pub fn collect_pipeline(input: PipelineData) -> (Vec<String>, Vec<Vec<Value>>) {
|
|
match input {
|
|
PipelineData::Empty => (vec![], vec![]),
|
|
PipelineData::Value(value, ..) => collect_input(value),
|
|
PipelineData::ListStream(stream, ..) => collect_list_stream(stream),
|
|
PipelineData::ExternalStream {
|
|
stdout,
|
|
stderr,
|
|
exit_code,
|
|
metadata,
|
|
span,
|
|
..
|
|
} => collect_external_stream(stdout, stderr, exit_code, metadata.map(|m| *m), span),
|
|
}
|
|
}
|
|
|
|
fn collect_list_stream(mut stream: ListStream) -> (Vec<String>, Vec<Vec<Value>>) {
|
|
let mut records = vec![];
|
|
for item in stream.by_ref() {
|
|
records.push(item);
|
|
}
|
|
|
|
let mut cols = get_columns(&records);
|
|
let data = convert_records_to_dataset(&cols, records);
|
|
|
|
// trying to deal with 'non-standard input'
|
|
if cols.is_empty() && !data.is_empty() {
|
|
let min_column_length = data.iter().map(|row| row.len()).min().unwrap_or(0);
|
|
if min_column_length > 0 {
|
|
cols = (0..min_column_length).map(|i| i.to_string()).collect();
|
|
}
|
|
}
|
|
|
|
(cols, data)
|
|
}
|
|
|
|
fn collect_external_stream(
|
|
stdout: Option<RawStream>,
|
|
stderr: Option<RawStream>,
|
|
exit_code: Option<ListStream>,
|
|
metadata: Option<PipelineMetadata>,
|
|
span: NuSpan,
|
|
) -> (Vec<String>, Vec<Vec<Value>>) {
|
|
let mut columns = vec![];
|
|
let mut data = vec![];
|
|
if let Some(stdout) = stdout {
|
|
let value = stdout.into_string().map_or_else(
|
|
|error| Value::Error {
|
|
error: Box::new(error),
|
|
},
|
|
|string| Value::string(string.item, span),
|
|
);
|
|
|
|
columns.push(String::from("stdout"));
|
|
data.push(value);
|
|
}
|
|
if let Some(stderr) = stderr {
|
|
let value = stderr.into_string().map_or_else(
|
|
|error| Value::Error {
|
|
error: Box::new(error),
|
|
},
|
|
|string| Value::string(string.item, span),
|
|
);
|
|
|
|
columns.push(String::from("stderr"));
|
|
data.push(value);
|
|
}
|
|
if let Some(exit_code) = exit_code {
|
|
let list = exit_code.collect::<Vec<_>>();
|
|
let val = Value::List { vals: list, span };
|
|
|
|
columns.push(String::from("exit_code"));
|
|
data.push(val);
|
|
}
|
|
if metadata.is_some() {
|
|
let val = Value::record(record! { "data_source" => Value::string("ls", span) }, span);
|
|
|
|
columns.push(String::from("metadata"));
|
|
data.push(val);
|
|
}
|
|
(columns, vec![data])
|
|
}
|
|
|
|
/// Try to build column names and a table grid.
|
|
pub fn collect_input(value: Value) -> (Vec<String>, Vec<Vec<Value>>) {
|
|
match value {
|
|
Value::Record { val: record, .. } => (record.cols, vec![record.vals]),
|
|
Value::List { vals, .. } => {
|
|
let mut columns = get_columns(&vals);
|
|
let data = convert_records_to_dataset(&columns, vals);
|
|
|
|
if columns.is_empty() && !data.is_empty() {
|
|
columns = vec![String::from("")];
|
|
}
|
|
|
|
(columns, data)
|
|
}
|
|
Value::String { val, span } => {
|
|
let lines = val
|
|
.lines()
|
|
.map(|line| Value::String {
|
|
val: line.to_string(),
|
|
span,
|
|
})
|
|
.map(|val| vec![val])
|
|
.collect();
|
|
|
|
(vec![String::from("")], lines)
|
|
}
|
|
Value::LazyRecord { val, span } => match val.collect() {
|
|
Ok(value) => collect_input(value),
|
|
Err(_) => (
|
|
vec![String::from("")],
|
|
vec![vec![Value::LazyRecord { val, span }]],
|
|
),
|
|
},
|
|
Value::Nothing { .. } => (vec![], vec![]),
|
|
value => (vec![String::from("")], vec![vec![value]]),
|
|
}
|
|
}
|
|
|
|
fn convert_records_to_dataset(cols: &Vec<String>, records: Vec<Value>) -> Vec<Vec<Value>> {
|
|
if !cols.is_empty() {
|
|
create_table_for_record(cols, &records)
|
|
} else if cols.is_empty() && records.is_empty() {
|
|
vec![]
|
|
} else if cols.len() == records.len() {
|
|
vec![records]
|
|
} else {
|
|
// I am not sure whether it's good to return records as its length LIKELY
|
|
// will not match columns, which makes no sense......
|
|
//
|
|
// BUT...
|
|
// we can represent it as a list; which we do
|
|
|
|
records.into_iter().map(|record| vec![record]).collect()
|
|
}
|
|
}
|
|
|
|
fn create_table_for_record(headers: &[String], items: &[Value]) -> Vec<Vec<Value>> {
|
|
let mut data = vec![Vec::new(); items.len()];
|
|
|
|
for (i, item) in items.iter().enumerate() {
|
|
let row = record_create_row(headers, item);
|
|
data[i] = row;
|
|
}
|
|
|
|
data
|
|
}
|
|
|
|
fn record_create_row(headers: &[String], item: &Value) -> Vec<Value> {
|
|
let mut rows = vec![Value::default(); headers.len()];
|
|
|
|
for (i, header) in headers.iter().enumerate() {
|
|
let value = record_lookup_value(item, header);
|
|
rows[i] = value;
|
|
}
|
|
|
|
rows
|
|
}
|
|
|
|
fn record_lookup_value(item: &Value, header: &str) -> Value {
|
|
match item {
|
|
Value::Record { .. } => {
|
|
let path = PathMember::String {
|
|
val: header.to_owned(),
|
|
span: NuSpan::unknown(),
|
|
optional: false,
|
|
};
|
|
|
|
item.clone()
|
|
.follow_cell_path(&[path], false)
|
|
.unwrap_or_else(|_| unknown_error_value())
|
|
}
|
|
item => item.clone(),
|
|
}
|
|
}
|
|
|
|
pub fn create_map(value: &Value) -> Option<HashMap<String, Value>> {
|
|
Some(
|
|
value
|
|
.as_record()
|
|
.ok()?
|
|
.iter()
|
|
.map(|(k, v)| (k.clone(), v.clone()))
|
|
.collect(),
|
|
)
|
|
}
|
|
|
|
pub fn map_into_value(hm: HashMap<String, Value>) -> Value {
|
|
Value::record(hm.into_iter().collect(), NuSpan::unknown())
|
|
}
|
|
|
|
pub fn nu_str<S: AsRef<str>>(s: S) -> Value {
|
|
Value::string(s.as_ref().to_owned(), NuSpan::unknown())
|
|
}
|
|
|
|
fn unknown_error_value() -> Value {
|
|
Value::string(String::from("❎"), NuSpan::unknown())
|
|
}
|