2022-05-11 11:26:43 +02:00
|
|
|
mod into_string;
|
Add string/binary type color to `ByteStream` (#12897)
# 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>
2024-05-20 02:35:32 +02:00
|
|
|
mod join;
|
2020-08-02 09:29:29 +02:00
|
|
|
|
2020-05-27 00:19:18 +02:00
|
|
|
use nu_test_support::fs::Stub::FileWithContent;
|
|
|
|
use nu_test_support::playground::Playground;
|
|
|
|
use nu_test_support::{nu, pipeline};
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn trims() {
|
|
|
|
Playground::setup("str_test_1", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[dependency]
|
|
|
|
name = "nu "
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(),
|
2020-10-26 07:55:52 +01:00
|
|
|
"open sample.toml | str trim dependency.name | get dependency.name"
|
2020-05-27 00:19:18 +02:00
|
|
|
);
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "nu");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-07-13 07:45:34 +02:00
|
|
|
#[test]
|
|
|
|
fn error_trim_multiple_chars() {
|
2023-07-17 18:43:51 +02:00
|
|
|
let actual = nu!(pipeline(
|
2020-07-13 07:45:34 +02:00
|
|
|
r#"
|
2023-10-19 22:08:09 +02:00
|
|
|
echo "does it work now?!" | str trim --char "?!"
|
2020-07-13 07:45:34 +02:00
|
|
|
"#
|
2023-07-17 18:43:51 +02:00
|
|
|
));
|
2020-07-13 07:45:34 +02:00
|
|
|
|
|
|
|
assert!(actual.err.contains("char"));
|
|
|
|
}
|
|
|
|
|
2020-05-27 00:19:18 +02:00
|
|
|
#[test]
|
|
|
|
fn capitalizes() {
|
|
|
|
Playground::setup("str_test_2", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[dependency]
|
|
|
|
name = "nu"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(),
|
2020-10-26 07:55:52 +01:00
|
|
|
"open sample.toml | str capitalize dependency.name | get dependency.name"
|
2020-05-27 00:19:18 +02:00
|
|
|
);
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "Nu");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn downcases() {
|
|
|
|
Playground::setup("str_test_3", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[dependency]
|
|
|
|
name = "LIGHT"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(),
|
2020-10-26 07:55:52 +01:00
|
|
|
"open sample.toml | str downcase dependency.name | get dependency.name"
|
2020-05-27 00:19:18 +02:00
|
|
|
);
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "light");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2023-10-27 19:16:17 +02:00
|
|
|
#[test]
|
|
|
|
fn non_ascii_downcase() {
|
|
|
|
let actual = nu!("'ὈΔΥΣΣΕΎΣ' | str downcase");
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "ὀδυσσεύς");
|
|
|
|
}
|
|
|
|
|
2020-05-27 00:19:18 +02:00
|
|
|
#[test]
|
|
|
|
fn upcases() {
|
|
|
|
Playground::setup("str_test_4", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[package]
|
|
|
|
name = "nushell"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(),
|
2020-10-26 07:55:52 +01:00
|
|
|
"open sample.toml | str upcase package.name | get package.name"
|
2020-05-27 00:19:18 +02:00
|
|
|
);
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "NUSHELL");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2023-10-27 19:16:17 +02:00
|
|
|
#[test]
|
|
|
|
fn non_ascii_upcase() {
|
|
|
|
let actual = nu!("'ὀδυσσεύς' | str upcase");
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "ὈΔΥΣΣΕΎΣ");
|
|
|
|
}
|
|
|
|
|
2020-08-17 22:18:23 +02:00
|
|
|
#[test]
|
2023-08-06 15:40:44 +02:00
|
|
|
#[ignore = "Playgrounds are not supported in nu-cmd-extra"]
|
2020-08-17 22:18:23 +02:00
|
|
|
fn camelcases() {
|
|
|
|
Playground::setup("str_test_3", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-08-17 22:18:23 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[dependency]
|
|
|
|
name = "THIS_IS_A_TEST"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(),
|
2020-10-26 07:55:52 +01:00
|
|
|
"open sample.toml | str camel-case dependency.name | get dependency.name"
|
2020-08-17 22:18:23 +02:00
|
|
|
);
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "thisIsATest");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-05-27 00:19:18 +02:00
|
|
|
#[test]
|
|
|
|
fn converts_to_int() {
|
2023-07-17 18:43:51 +02:00
|
|
|
let actual = nu!(pipeline(
|
2020-05-27 00:19:18 +02:00
|
|
|
r#"
|
last, skip, drop, take until, take while, skip until, skip while, where, reverse, shuffle, append, prepend and sort-by raise error when given non-lists (#7623)
Closes https://github.com/nushell/nushell/issues/6941
2022-12-31 12:35:12 +01:00
|
|
|
echo '[{number_as_string: "1"}]'
|
2020-05-27 00:19:18 +02:00
|
|
|
| from json
|
2022-02-04 03:01:45 +01:00
|
|
|
| into int number_as_string
|
2020-05-27 00:19:18 +02:00
|
|
|
| rename number
|
|
|
|
| where number == 1
|
2022-02-18 23:11:27 +01:00
|
|
|
| get number.0
|
2021-01-29 14:43:35 +01:00
|
|
|
|
2020-05-27 00:19:18 +02:00
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "1");
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2023-09-13 23:53:55 +02:00
|
|
|
fn converts_to_float() {
|
2023-07-17 18:43:51 +02:00
|
|
|
let actual = nu!(pipeline(
|
2020-05-27 00:19:18 +02:00
|
|
|
r#"
|
|
|
|
echo "3.1, 0.0415"
|
|
|
|
| split row ","
|
2023-09-12 13:02:47 +02:00
|
|
|
| into float
|
2020-06-19 04:02:01 +02:00
|
|
|
| math sum
|
2020-05-27 00:19:18 +02:00
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "3.1415");
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn find_and_replaces() {
|
|
|
|
Playground::setup("str_test_6", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[fortune.teller]
|
|
|
|
phone = "1-800-KATZ"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
2022-04-07 15:41:09 +02:00
|
|
|
| str replace KATZ "5289" fortune.teller.phone
|
2020-05-27 00:19:18 +02:00
|
|
|
| get fortune.teller.phone
|
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "1-800-5289");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn find_and_replaces_without_passing_field() {
|
|
|
|
Playground::setup("str_test_7", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[fortune.teller]
|
|
|
|
phone = "1-800-KATZ"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
|
|
|
| get fortune.teller.phone
|
2022-04-07 15:41:09 +02:00
|
|
|
| str replace KATZ "5289"
|
2020-05-27 00:19:18 +02:00
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "1-800-5289");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2023-02-12 14:25:40 +01:00
|
|
|
#[test]
|
|
|
|
fn regex_error_in_pattern() {
|
|
|
|
Playground::setup("str_test_8", |dirs, _sandbox| {
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
'source string'
|
2023-08-17 23:18:16 +02:00
|
|
|
| str replace -r 'source \Ufoo' "destination"
|
2023-02-12 14:25:40 +01:00
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
let err = actual.err;
|
|
|
|
let expecting_str = "Incorrect value";
|
|
|
|
assert!(
|
|
|
|
err.contains(expecting_str),
|
|
|
|
"Error should contain '{expecting_str}', but was: {err}"
|
|
|
|
);
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-05-27 00:19:18 +02:00
|
|
|
#[test]
|
|
|
|
fn substrings_the_input() {
|
|
|
|
Playground::setup("str_test_8", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[fortune.teller]
|
|
|
|
phone = "1-800-ROBALINO"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
2023-03-29 09:01:42 +02:00
|
|
|
| str substring 6..14 fortune.teller.phone
|
2020-05-27 00:19:18 +02:00
|
|
|
| get fortune.teller.phone
|
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "ROBALINO");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2024-06-18 14:19:13 +02:00
|
|
|
fn substring_empty_if_start_index_is_greater_than_end_index() {
|
2020-05-27 00:19:18 +02:00
|
|
|
Playground::setup("str_test_9", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[fortune.teller]
|
|
|
|
phone = "1-800-ROBALINO"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
2024-05-22 19:00:58 +02:00
|
|
|
| str substring 6..4 fortune.teller.phone
|
2024-06-18 14:19:13 +02:00
|
|
|
| get fortune.teller.phone
|
2020-05-27 00:19:18 +02:00
|
|
|
"#
|
|
|
|
));
|
2024-06-18 14:19:13 +02:00
|
|
|
assert_eq!(actual.out, "")
|
2020-05-27 00:19:18 +02:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn substrings_the_input_and_returns_the_string_if_end_index_exceeds_length() {
|
|
|
|
Playground::setup("str_test_10", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[package]
|
|
|
|
name = "nu-arepas"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
2023-03-29 09:01:42 +02:00
|
|
|
| str substring 0..999 package.name
|
2020-05-27 00:19:18 +02:00
|
|
|
| get package.name
|
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "nu-arepas");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn substrings_the_input_and_returns_blank_if_start_index_exceeds_length() {
|
|
|
|
Playground::setup("str_test_11", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[package]
|
|
|
|
name = "nu-arepas"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
2023-03-29 09:01:42 +02:00
|
|
|
| str substring 50..999 package.name
|
2020-05-27 00:19:18 +02:00
|
|
|
| get package.name
|
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn substrings_the_input_and_treats_start_index_as_zero_if_blank_start_index_given() {
|
|
|
|
Playground::setup("str_test_12", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[package]
|
|
|
|
name = "nu-arepas"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
2024-05-22 19:00:58 +02:00
|
|
|
| str substring ..1 package.name
|
2020-05-27 00:19:18 +02:00
|
|
|
| get package.name
|
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "nu");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn substrings_the_input_and_treats_end_index_as_length_if_blank_end_index_given() {
|
|
|
|
Playground::setup("str_test_13", |dirs, sandbox| {
|
2024-05-04 02:53:15 +02:00
|
|
|
sandbox.with_files(&[FileWithContent(
|
2020-05-27 00:19:18 +02:00
|
|
|
"sample.toml",
|
|
|
|
r#"
|
|
|
|
[package]
|
|
|
|
name = "nu-arepas"
|
|
|
|
"#,
|
|
|
|
)]);
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), pipeline(
|
|
|
|
r#"
|
|
|
|
open sample.toml
|
2023-03-29 09:01:42 +02:00
|
|
|
| str substring 3.. package.name
|
2020-05-27 00:19:18 +02:00
|
|
|
| get package.name
|
|
|
|
"#
|
|
|
|
));
|
|
|
|
|
|
|
|
assert_eq!(actual.out, "arepas");
|
|
|
|
})
|
|
|
|
}
|
2020-07-12 05:57:39 +02:00
|
|
|
|
2024-06-18 14:19:13 +02:00
|
|
|
#[test]
|
|
|
|
fn substring_by_negative_index() {
|
|
|
|
Playground::setup("str_test_13", |dirs, _| {
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), "'apples' | str substring 0..-1",
|
|
|
|
);
|
|
|
|
assert_eq!(actual.out, "apples");
|
|
|
|
|
|
|
|
let actual = nu!(
|
|
|
|
cwd: dirs.test(), "'apples' | str substring 0..<-1",
|
|
|
|
);
|
|
|
|
assert_eq!(actual.out, "apple");
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-07-14 22:47:04 +02:00
|
|
|
#[test]
|
|
|
|
fn str_reverse() {
|
2023-07-17 18:43:51 +02:00
|
|
|
let actual = nu!(r#"
|
2020-07-14 22:47:04 +02:00
|
|
|
echo "nushell" | str reverse
|
2023-07-17 18:43:51 +02:00
|
|
|
"#);
|
2020-07-14 22:47:04 +02:00
|
|
|
|
|
|
|
assert!(actual.out.contains("llehsun"));
|
|
|
|
}
|
2022-02-21 23:22:21 +01:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_redirection_trim() {
|
2023-07-17 18:43:51 +02:00
|
|
|
let actual = nu!(r#"
|
2022-02-21 23:22:21 +01:00
|
|
|
let x = (nu --testbin cococo niceone); $x | str trim | str length
|
2023-07-17 18:43:51 +02:00
|
|
|
"#);
|
2022-02-21 23:22:21 +01:00
|
|
|
|
|
|
|
assert_eq!(actual.out, "7");
|
|
|
|
}
|