mirror of
https://github.com/bytedream/serde-inline-default.git
synced 2026-11-04 15:12:09 +01:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6eea08da2d | ||
|
|
473210c388 | ||
|
|
0cc4052eaf | ||
|
|
d197326c32 | ||
|
|
71cdef9d6e | ||
|
|
6132d5369f | ||
|
|
2865e49da3 | ||
|
|
a44606e99c | ||
|
|
5cafcf3e3f | ||
|
|
ba08395a42 | ||
|
|
5427bdffe7 | ||
|
|
ce70ea4365 |
No files matched your search
@@ -1,6 +0,0 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: cargo
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
+27
-14
@@ -2,30 +2,43 @@ name: ci
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "**"
|
||||
tags-ignore:
|
||||
- "**"
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Generate cargo lockfile
|
||||
run: cargo generate-lockfile
|
||||
|
||||
- name: Cargo cache
|
||||
uses: actions/cache@v3
|
||||
- name: Setup Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/bin/
|
||||
~/.cargo/registry/index/
|
||||
~/.cargo/registry/cache/
|
||||
~/.cargo/git/db/
|
||||
target/
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
toolchain: stable
|
||||
|
||||
- name: Test
|
||||
run: cargo test
|
||||
|
||||
verify-msrv:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
toolchain: stable
|
||||
|
||||
- name: Install cargo-msrv
|
||||
uses: taiki-e/install-action@v2
|
||||
with:
|
||||
tool: cargo-msrv
|
||||
|
||||
- name: Verify msrv
|
||||
run: cargo msrv verify --all-features
|
||||
@@ -8,10 +8,16 @@ on:
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
toolchain: stable
|
||||
|
||||
- name: Publish crate
|
||||
run: cargo publish --token ${{ secrets.CRATES_TOKEN }}
|
||||
env:
|
||||
CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_TOKEN }}
|
||||
run: cargo publish
|
||||
+5
-3
@@ -1,23 +1,25 @@
|
||||
[package]
|
||||
name = "serde-inline-default"
|
||||
version = "1.0.0"
|
||||
version = "1.0.3"
|
||||
authors = ["bytedream"]
|
||||
edition = "2021"
|
||||
rust-version = "1.71.0"
|
||||
description = "Serde default values via inline declaration"
|
||||
readme = "README.md"
|
||||
repository = "https://github.com/bytedream/serde-inline-default"
|
||||
license = "MIT OR Apache-2.0"
|
||||
keywords = ["serde", "serialization"]
|
||||
categories = ["encoding"]
|
||||
include = ["/Cargo.toml", "/LICENSE-APACHE", "/LICENSE-MIT", "/README.md", "/src/**", "/tests/**"]
|
||||
|
||||
[lib]
|
||||
proc-macro = true
|
||||
doctest = false
|
||||
proc-macro = true
|
||||
|
||||
[dependencies]
|
||||
proc-macro2 = "1.0"
|
||||
quote = "1.0"
|
||||
syn = { version = "2.0", features = ["full"] }
|
||||
syn = { version = "3.0", features = ["full"] }
|
||||
|
||||
[dev-dependencies]
|
||||
serde = { version = "1.0", features = ["derive"] }
|
||||
|
||||
+57
-42
@@ -1,55 +1,70 @@
|
||||
use crate::utils::type_lifetimes_to_static;
|
||||
use proc_macro2::{Ident, Span, TokenStream};
|
||||
use quote::quote;
|
||||
use syn::{parse_quote, ItemStruct};
|
||||
use syn::{spanned::Spanned, Error, Fields, ItemEnum, ItemStruct};
|
||||
|
||||
use crate::utils::{check_field_for_default_expr, ATTR_NAME, DEFAULT_FN_PREFIX};
|
||||
|
||||
pub(crate) fn expand_struct(mut item: ItemStruct) -> proc_macro::TokenStream {
|
||||
let mut inline_fns: Vec<TokenStream> = vec![];
|
||||
let mut default_fns = vec![];
|
||||
|
||||
for (i, field) in item.fields.iter_mut().enumerate() {
|
||||
for (j, attr) in field.attrs.iter_mut().enumerate() {
|
||||
if !attr.path().is_ident("serde_inline_default") {
|
||||
continue;
|
||||
default_fns.extend(check_field_for_default_expr(field, || {
|
||||
format!("{}_{}_Field{}", DEFAULT_FN_PREFIX, item.ident, i)
|
||||
}));
|
||||
}
|
||||
|
||||
quote! {
|
||||
#( #default_fns )*
|
||||
|
||||
#item
|
||||
}
|
||||
.into()
|
||||
}
|
||||
|
||||
pub(crate) fn expand_enum(mut item: ItemEnum) -> proc_macro::TokenStream {
|
||||
let mut default_fns = vec![];
|
||||
|
||||
for (i, variant) in item.variants.iter_mut().enumerate() {
|
||||
if variant.attrs.iter().any(|a| a.path().is_ident(ATTR_NAME)) {
|
||||
return Error::new(
|
||||
variant.span(),
|
||||
format!(
|
||||
"#[{}] can only be used on named enum variant fields",
|
||||
ATTR_NAME
|
||||
),
|
||||
)
|
||||
.to_compile_error()
|
||||
.into();
|
||||
}
|
||||
|
||||
let fields = match &mut variant.fields {
|
||||
Fields::Named(fields) => fields,
|
||||
_ => {
|
||||
return Error::new(
|
||||
variant.span(),
|
||||
format!(
|
||||
"#[{}] can only be used on named enum variant fields",
|
||||
ATTR_NAME
|
||||
),
|
||||
)
|
||||
.to_compile_error()
|
||||
.into()
|
||||
}
|
||||
};
|
||||
|
||||
let default: TokenStream = attr.parse_args().unwrap();
|
||||
|
||||
// copy all the same #[cfg] conditional compilations flags for the field onto our built
|
||||
// default function.
|
||||
// otherwise, it's possible to create a constructor for a type that may be filtered by
|
||||
// the same #[cfg]'s, breaking compilation
|
||||
let cfg_attrs = field.attrs.iter().filter(|a| a.path().is_ident("cfg"));
|
||||
|
||||
let fn_name_lit = format!("__serde_inline_default_{}_{}", item.ident, i);
|
||||
let fn_name_ident = Ident::new(&fn_name_lit, Span::call_site());
|
||||
let mut return_type = field.ty.clone();
|
||||
|
||||
// replace lifetimes with 'static.
|
||||
// the built default function / default values in general can only be static as they're
|
||||
// generated without reference to the parent struct
|
||||
type_lifetimes_to_static(&mut return_type);
|
||||
|
||||
inline_fns.push(quote! {
|
||||
#[doc(hidden)]
|
||||
#[allow(non_snake_case)]
|
||||
#( #cfg_attrs )*
|
||||
fn #fn_name_ident () -> #return_type {
|
||||
#default
|
||||
}
|
||||
});
|
||||
|
||||
field.attrs.remove(j);
|
||||
field
|
||||
.attrs
|
||||
.insert(j, parse_quote!( #[serde(default = #fn_name_lit)] ));
|
||||
break;
|
||||
for (j, field) in fields.named.iter_mut().enumerate() {
|
||||
default_fns.extend(check_field_for_default_expr(field, || {
|
||||
format!(
|
||||
"{}_{}_Variant{}_Field{}",
|
||||
DEFAULT_FN_PREFIX, item.ident, i, j
|
||||
)
|
||||
}));
|
||||
}
|
||||
}
|
||||
|
||||
let expanded = quote! {
|
||||
#( #inline_fns )*
|
||||
quote! {
|
||||
#( #default_fns )*
|
||||
|
||||
#item
|
||||
};
|
||||
expanded.into()
|
||||
}
|
||||
.into()
|
||||
}
|
||||
+9
-3
@@ -1,7 +1,7 @@
|
||||
#![doc = include_str!("../README.md")]
|
||||
|
||||
use proc_macro::TokenStream;
|
||||
use syn::{parse_macro_input, Item};
|
||||
use syn::{parse_macro_input, spanned::Spanned, Error, Item};
|
||||
|
||||
mod expand;
|
||||
mod utils;
|
||||
@@ -32,11 +32,17 @@ mod utils;
|
||||
/// [`Serialize`]: https://docs.rs/serde/*/serde/trait.Serialize.html
|
||||
/// [`Deserialize`]: https://docs.rs/serde/*/serde/trait.Deserialize.html
|
||||
#[proc_macro_attribute]
|
||||
pub fn serde_inline_default(_attr: TokenStream, input: TokenStream) -> TokenStream {
|
||||
pub fn serde_inline_default(attr: TokenStream, input: TokenStream) -> TokenStream {
|
||||
let item = parse_macro_input!(input as Item);
|
||||
|
||||
match item {
|
||||
Item::Struct(s) => expand::expand_struct(s),
|
||||
_ => panic!("can only be used on structs"),
|
||||
Item::Enum(e) => expand::expand_enum(e),
|
||||
_ => Error::new(
|
||||
proc_macro2::TokenStream::from(attr).span(),
|
||||
"can only be used on structs and enums",
|
||||
)
|
||||
.to_compile_error()
|
||||
.into(),
|
||||
}
|
||||
}
|
||||
+50
-2
@@ -1,4 +1,9 @@
|
||||
use syn::{parse_quote, GenericArgument, PathArguments, Type};
|
||||
use proc_macro2::{Span, TokenStream};
|
||||
use quote::quote;
|
||||
use syn::{parse_quote, Field, GenericArgument, Ident, PathArguments, Type};
|
||||
|
||||
pub(crate) const ATTR_NAME: &str = "serde_inline_default";
|
||||
pub(crate) const DEFAULT_FN_PREFIX: &str = "__serde_inline_default";
|
||||
|
||||
pub(crate) fn type_lifetimes_to_static(ty: &mut Type) {
|
||||
match ty {
|
||||
@@ -21,7 +26,7 @@ pub(crate) fn type_lifetimes_to_static(ty: &mut Type) {
|
||||
}
|
||||
PathArguments::Parenthesized(parenthesized) => {
|
||||
for input in &mut parenthesized.inputs {
|
||||
type_lifetimes_to_static(input)
|
||||
type_lifetimes_to_static(&mut input.ty)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -38,3 +43,46 @@ pub(crate) fn type_lifetimes_to_static(ty: &mut Type) {
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn check_field_for_default_expr(
|
||||
field: &mut Field,
|
||||
identifier_fn: impl FnOnce() -> String,
|
||||
) -> Option<TokenStream> {
|
||||
for (i, attr) in field.attrs.iter_mut().enumerate() {
|
||||
if !attr.path().is_ident(ATTR_NAME) {
|
||||
continue;
|
||||
}
|
||||
|
||||
let default_expr: TokenStream = attr.parse_args().unwrap();
|
||||
|
||||
// copy all the same #[cfg] conditional compilations flags for the field onto our built
|
||||
// default function.
|
||||
// otherwise, it's possible to create a constructor for a type that may be filtered by
|
||||
// the same #[cfg]'s, breaking compilation
|
||||
let cfg_attrs = field.attrs.iter().filter(|a| a.path().is_ident("cfg"));
|
||||
|
||||
let default_fn_lit = identifier_fn();
|
||||
let default_fn_ident = Ident::new(&default_fn_lit, Span::call_site());
|
||||
let mut return_type = field.ty.clone();
|
||||
|
||||
// replace lifetimes with 'static.
|
||||
// the built default function / default values in general can only be static as they're
|
||||
// generated without reference to the parent struct
|
||||
type_lifetimes_to_static(&mut return_type);
|
||||
|
||||
let default_fn_expr = quote! {
|
||||
#[doc(hidden)]
|
||||
#[allow(non_snake_case)]
|
||||
#[inline]
|
||||
#( #cfg_attrs )*
|
||||
fn #default_fn_ident () -> #return_type {
|
||||
#default_expr
|
||||
}
|
||||
};
|
||||
|
||||
field.attrs[i] = parse_quote!( #[serde(default = #default_fn_lit)] );
|
||||
return Some(default_fn_expr);
|
||||
}
|
||||
|
||||
None
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
use serde::Deserialize;
|
||||
use serde_inline_default::serde_inline_default;
|
||||
use serde_json::json;
|
||||
|
||||
#[test]
|
||||
fn enum_default() {
|
||||
#[serde_inline_default]
|
||||
#[derive(Debug, PartialEq, Eq, Deserialize)]
|
||||
#[serde(untagged)]
|
||||
enum Test {
|
||||
VariantWithFields {
|
||||
#[serde_inline_default(255)]
|
||||
test_int: u8,
|
||||
},
|
||||
}
|
||||
|
||||
let enum_test: Test = serde_json::from_value(json!({"VariantWithFields": {}})).unwrap();
|
||||
|
||||
assert_eq!(enum_test, Test::VariantWithFields { test_int: 255 })
|
||||
}
|
||||
@@ -1,10 +1,11 @@
|
||||
use std::borrow::Cow;
|
||||
|
||||
use serde::Deserialize;
|
||||
use serde_inline_default::serde_inline_default;
|
||||
use serde_json::json;
|
||||
use std::borrow::Cow;
|
||||
|
||||
#[test]
|
||||
fn test_serde_inline_default() {
|
||||
fn struct_normal() {
|
||||
fn native_default() -> u32 {
|
||||
69
|
||||
}
|
||||
@@ -31,7 +32,7 @@ fn test_serde_inline_default() {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_lifetime() {
|
||||
fn lifetime() {
|
||||
#[serde_inline_default]
|
||||
#[derive(Deserialize)]
|
||||
struct LifetimeTest<'a> {
|
||||
@@ -46,7 +47,7 @@ fn test_lifetime() {
|
||||
|
||||
#[test]
|
||||
#[allow(dead_code)]
|
||||
fn test_conditional_compilation() {
|
||||
fn conditional_compilation() {
|
||||
#[cfg(debug_assertions)]
|
||||
#[derive(Deserialize)]
|
||||
struct TypeA(u8);
|
||||
Reference in new issue
Block a user