Coerce boolean values into strings too (#14704)

<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx

you can also mention related issues, PRs or discussions!
-->

# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.

Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->

The `Value::coerce_str` method weirdly doesn't allow coercing boolean
values into strings while commands like `true | into string` work
without issues. So I added that.

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

This is technically a breaking change if a nushell library user depended
on the fact that boolean values weren't coerceable to strings. But I
doubt that really.

# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`
This commit is contained in:
Piepmatz 2024-12-31 04:23:40 +01:00 committed by GitHub
parent 1181349c22
commit e7877db078
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -366,6 +366,7 @@ impl Value {
/// Returns this `Value` converted to a `str` or an error if it cannot be converted
///
/// Only the following `Value` cases will return an `Ok` result:
/// - `Bool`
/// - `Int`
/// - `Float`
/// - `String`
@ -379,7 +380,8 @@ impl Value {
/// assert_eq!(
/// matches!(
/// val,
/// Value::Int { .. }
/// Value::Bool { .. }
/// | Value::Int { .. }
/// | Value::Float { .. }
/// | Value::String { .. }
/// | Value::Glob { .. }
@ -392,6 +394,7 @@ impl Value {
/// ```
pub fn coerce_str(&self) -> Result<Cow<str>, ShellError> {
match self {
Value::Bool { val, .. } => Ok(Cow::Owned(val.to_string())),
Value::Int { val, .. } => Ok(Cow::Owned(val.to_string())),
Value::Float { val, .. } => Ok(Cow::Owned(val.to_string())),
Value::String { val, .. } => Ok(Cow::Borrowed(val)),
@ -419,6 +422,7 @@ impl Value {
/// if you do not need to keep the original `Value` around.
///
/// Only the following `Value` cases will return an `Ok` result:
/// - `Bool`
/// - `Int`
/// - `Float`
/// - `String`
@ -432,7 +436,8 @@ impl Value {
/// assert_eq!(
/// matches!(
/// val,
/// Value::Int { .. }
/// Value::Bool { .. }
/// | Value::Int { .. }
/// | Value::Float { .. }
/// | Value::String { .. }
/// | Value::Glob { .. }
@ -450,6 +455,7 @@ impl Value {
/// Returns this `Value` converted to a `String` or an error if it cannot be converted
///
/// Only the following `Value` cases will return an `Ok` result:
/// - `Bool`
/// - `Int`
/// - `Float`
/// - `String`
@ -463,7 +469,8 @@ impl Value {
/// assert_eq!(
/// matches!(
/// val,
/// Value::Int { .. }
/// Value::Bool { .. }
/// | Value::Int { .. }
/// | Value::Float { .. }
/// | Value::String { .. }
/// | Value::Glob { .. }
@ -477,6 +484,7 @@ impl Value {
pub fn coerce_into_string(self) -> Result<String, ShellError> {
let span = self.span();
match self {
Value::Bool { val, .. } => Ok(val.to_string()),
Value::Int { val, .. } => Ok(val.to_string()),
Value::Float { val, .. } => Ok(val.to_string()),
Value::String { val, .. } => Ok(val),