mirror of
https://github.com/nushell/nushell
synced 2024-12-30 23:08:56 +00:00
c61075e20e
# Description
This PR allows byte streams to optionally be colored as being
specifically binary or string data, which guarantees that they'll be
converted to `Binary` or `String` appropriately on `into_value()`,
making them compatible with `Type` guarantees. This makes them
significantly more broadly usable for command input and output.
There is still an `Unknown` type for byte streams coming from external
commands, which uses the same behavior as we previously did where it's a
string if it's UTF-8.
A small number of commands were updated to take advantage of this, just
to prove the point. I will be adding more after this merges.
# User-Facing Changes
- New types in `describe`: `string (stream)`, `binary (stream)`
- These commands now return a stream if their input was a stream:
- `into binary`
- `into string`
- `bytes collect`
- `str join`
- `first` (binary)
- `last` (binary)
- `take` (binary)
- `skip` (binary)
- Streams that are explicitly binary colored will print as a streaming
hexdump
- example:
```nushell
1.. | each { into binary } | bytes collect
```
# Tests + Formatting
I've added some tests to cover it at a basic level, and it doesn't break
anything existing, but I do think more would be nice. Some of those will
come when I modify more commands to stream.
# After Submitting
There are a few things I'm not quite satisfied with:
- **String trimming behavior.** We automatically trim newlines from
streams from external commands, but I don't think we should do this with
internal commands. If I call a command that happens to turn my string
into a stream, I don't want the newline to suddenly disappear. I changed
this to specifically do it only on `Child` and `File`, but I don't know
if this is quite right, and maybe we should bring back the old flag for
`trim_end_newline`
- **Known binary always resulting in a hexdump.** It would be nice to
have a `print --raw`, so that we can put binary data on stdout
explicitly if we want to. This PR doesn't change how external commands
work though - they still dump straight to stdout.
Otherwise, here's the normal checklist:
- [ ] release notes
- [ ] docs update for plugin protocol changes (added `type` field)
---------
Co-authored-by: Ian Manske <ian.manske@pm.me>
105 lines
2.6 KiB
Rust
105 lines
2.6 KiB
Rust
use nu_test_support::fs::Stub::EmptyFile;
|
|
use nu_test_support::nu;
|
|
use nu_test_support::playground::Playground;
|
|
|
|
#[test]
|
|
fn gets_first_rows_by_amount() {
|
|
Playground::setup("first_test_1", |dirs, sandbox| {
|
|
sandbox.with_files(&[
|
|
EmptyFile("los.txt"),
|
|
EmptyFile("tres.txt"),
|
|
EmptyFile("amigos.txt"),
|
|
EmptyFile("arepas.clu"),
|
|
]);
|
|
|
|
let actual = nu!(cwd: dirs.test(), "ls | first 3 | length");
|
|
|
|
assert_eq!(actual.out, "3");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn gets_all_rows_if_amount_higher_than_all_rows() {
|
|
Playground::setup("first_test_2", |dirs, sandbox| {
|
|
sandbox.with_files(&[
|
|
EmptyFile("los.txt"),
|
|
EmptyFile("tres.txt"),
|
|
EmptyFile("amigos.txt"),
|
|
EmptyFile("arepas.clu"),
|
|
]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(), "ls | first 99 | length");
|
|
|
|
assert_eq!(actual.out, "4");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn gets_first_row_when_no_amount_given() {
|
|
Playground::setup("first_test_3", |dirs, sandbox| {
|
|
sandbox.with_files(&[EmptyFile("caballeros.txt"), EmptyFile("arepas.clu")]);
|
|
|
|
// FIXME: We should probably change first to return a one row table instead of a record here
|
|
let actual = nu!(cwd: dirs.test(), "ls | first | values | length");
|
|
|
|
assert_eq!(actual.out, "4");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn gets_first_row_as_list_when_amount_given() {
|
|
let actual = nu!("[1, 2, 3] | first 1 | describe");
|
|
|
|
assert_eq!(actual.out, "list<int>");
|
|
}
|
|
|
|
#[test]
|
|
fn gets_first_bytes() {
|
|
let actual = nu!("(0x[aa bb cc] | first 2) == 0x[aa bb]");
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn gets_first_byte() {
|
|
let actual = nu!("0x[aa bb cc] | first");
|
|
|
|
assert_eq!(actual.out, "170");
|
|
}
|
|
|
|
#[test]
|
|
fn gets_first_bytes_from_stream() {
|
|
let actual = nu!("(1.. | each { 0x[aa bb cc] } | bytes collect | first 2) == 0x[aa bb]");
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn gets_first_byte_from_stream() {
|
|
let actual = nu!("1.. | each { 0x[aa bb cc] } | bytes collect | first");
|
|
|
|
assert_eq!(actual.out, "170");
|
|
}
|
|
|
|
#[test]
|
|
// covers a situation where `first` used to behave strangely on list<binary> input
|
|
fn works_with_binary_list() {
|
|
let actual = nu!("([0x[01 11]] | first) == 0x[01 11]");
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn errors_on_negative_rows() {
|
|
let actual = nu!("[1, 2, 3] | first -10");
|
|
|
|
assert!(actual.err.contains("use a positive value"));
|
|
}
|
|
|
|
#[test]
|
|
fn errors_on_empty_list_when_no_rows_given() {
|
|
let actual = nu!("[] | first");
|
|
|
|
assert!(actual.err.contains("index too large"));
|
|
}
|