mirror of
https://github.com/nushell/nushell
synced 2025-01-05 01:39:02 +00:00
39b0f3bdda
<!-- 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. --> In this PR I expanded the helper attribute `#[nu_value]` on `#[derive(FromValue)]`. It now allows the usage of `#[nu_value(type_name = "...")]` to set a type name for the `FromValue::expected_type` implementation. Currently it only uses the default implementation but I'd like to change that without having to manually implement the entire trait on my own. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> Users that derive `FromValue` may now change the name of the expected type. # 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 > ``` --> I added some tests that check if this feature work and updated the documentation about the derive macro. - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
135 lines
3.4 KiB
Rust
135 lines
3.4 KiB
Rust
// These tests only check that the derive macros throw the relevant errors.
|
|
// Functionality of the derived types is tested in nu_protocol::value::test_derive.
|
|
|
|
use crate::error::DeriveError;
|
|
use crate::from::derive_from_value;
|
|
use crate::into::derive_into_value;
|
|
use quote::quote;
|
|
|
|
#[test]
|
|
fn unsupported_unions() {
|
|
let input = quote! {
|
|
#[nu_value]
|
|
union SomeUnion {
|
|
f1: u32,
|
|
f2: f32,
|
|
}
|
|
};
|
|
|
|
let from_res = derive_from_value(input.clone());
|
|
assert!(
|
|
matches!(from_res, Err(DeriveError::UnsupportedUnions)),
|
|
"expected `DeriveError::UnsupportedUnions`, got {:?}",
|
|
from_res
|
|
);
|
|
|
|
let into_res = derive_into_value(input);
|
|
assert!(
|
|
matches!(into_res, Err(DeriveError::UnsupportedUnions)),
|
|
"expected `DeriveError::UnsupportedUnions`, got {:?}",
|
|
into_res
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn unsupported_enums() {
|
|
let input = quote! {
|
|
#[nu_value(rename_all = "SCREAMING_SNAKE_CASE")]
|
|
enum ComplexEnum {
|
|
Unit,
|
|
Unnamed(u32, f32),
|
|
Named {
|
|
u: u32,
|
|
f: f32,
|
|
}
|
|
}
|
|
};
|
|
|
|
let from_res = derive_from_value(input.clone());
|
|
assert!(
|
|
matches!(from_res, Err(DeriveError::UnsupportedEnums { .. })),
|
|
"expected `DeriveError::UnsupportedEnums`, got {:?}",
|
|
from_res
|
|
);
|
|
|
|
let into_res = derive_into_value(input);
|
|
assert!(
|
|
matches!(into_res, Err(DeriveError::UnsupportedEnums { .. })),
|
|
"expected `DeriveError::UnsupportedEnums`, got {:?}",
|
|
into_res
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn unexpected_attribute() {
|
|
let input = quote! {
|
|
#[nu_value(what)]
|
|
enum SimpleEnum {
|
|
A,
|
|
B,
|
|
}
|
|
};
|
|
|
|
let from_res = derive_from_value(input.clone());
|
|
assert!(
|
|
matches!(from_res, Err(DeriveError::UnexpectedAttribute { .. })),
|
|
"expected `DeriveError::UnexpectedAttribute`, got {:?}",
|
|
from_res
|
|
);
|
|
|
|
let into_res = derive_into_value(input);
|
|
assert!(
|
|
matches!(into_res, Err(DeriveError::UnexpectedAttribute { .. })),
|
|
"expected `DeriveError::UnexpectedAttribute`, got {:?}",
|
|
into_res
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn deny_attribute_on_fields() {
|
|
let input = quote! {
|
|
struct SomeStruct {
|
|
#[nu_value]
|
|
field: ()
|
|
}
|
|
};
|
|
|
|
let from_res = derive_from_value(input.clone());
|
|
assert!(
|
|
matches!(from_res, Err(DeriveError::InvalidAttributePosition { .. })),
|
|
"expected `DeriveError::InvalidAttributePosition`, got {:?}",
|
|
from_res
|
|
);
|
|
|
|
let into_res = derive_into_value(input);
|
|
assert!(
|
|
matches!(into_res, Err(DeriveError::InvalidAttributePosition { .. })),
|
|
"expected `DeriveError::InvalidAttributePosition`, got {:?}",
|
|
into_res
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn invalid_attribute_value() {
|
|
let input = quote! {
|
|
#[nu_value(rename_all = "CrazY-CasE")]
|
|
enum SimpleEnum {
|
|
A,
|
|
B
|
|
}
|
|
};
|
|
|
|
let from_res = derive_from_value(input.clone());
|
|
assert!(
|
|
matches!(from_res, Err(DeriveError::InvalidAttributeValue { .. })),
|
|
"expected `DeriveError::InvalidAttributeValue`, got {:?}",
|
|
from_res
|
|
);
|
|
|
|
let into_res = derive_into_value(input);
|
|
assert!(
|
|
matches!(into_res, Err(DeriveError::InvalidAttributeValue { .. })),
|
|
"expected `DeriveError::InvalidAttributeValue`, got {:?}",
|
|
into_res
|
|
);
|
|
}
|