Process #[schemars] attributes
This commit is contained in:
parent
1d0fd18c9e
commit
6b64cedb91
9 changed files with 113 additions and 26 deletions
16
schemars/tests/expected/property-name-struct.json
Normal file
16
schemars/tests/expected/property-name-struct.json
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
{
|
||||||
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||||
|
"title": "MyStruct",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"camelCase": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"new_name_1": {
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"new_name_2": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -12,7 +12,7 @@ struct Flat {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, MakeSchema)]
|
#[derive(Debug, MakeSchema)]
|
||||||
#[serde(rename = "Flat")]
|
#[schemars(rename = "Flat")]
|
||||||
struct Deep1 {
|
struct Deep1 {
|
||||||
foo: f32,
|
foo: f32,
|
||||||
#[serde(flatten)]
|
#[serde(flatten)]
|
||||||
|
|
19
schemars/tests/property_name.rs
Normal file
19
schemars/tests/property_name.rs
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
mod util;
|
||||||
|
use schemars::MakeSchema;
|
||||||
|
use util::*;
|
||||||
|
|
||||||
|
#[derive(Debug, MakeSchema)]
|
||||||
|
#[serde(rename_all = "camelCase")]
|
||||||
|
struct MyStruct {
|
||||||
|
camel_case: i32,
|
||||||
|
#[serde(rename = "new_name_1")]
|
||||||
|
old_name_1: i32,
|
||||||
|
#[serde(rename = "ignored")]
|
||||||
|
#[schemars(rename = "new_name_2")]
|
||||||
|
old_name_2: i32,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn set_struct_property_names() -> TestResult {
|
||||||
|
test_default_generated_schema::<MyStruct>("property-name-struct")
|
||||||
|
}
|
|
@ -4,11 +4,11 @@ use util::*;
|
||||||
|
|
||||||
#[derive(Debug, MakeSchema)]
|
#[derive(Debug, MakeSchema)]
|
||||||
struct MyStruct<T, U, V, W> {
|
struct MyStruct<T, U, V, W> {
|
||||||
t: T,
|
t: T,
|
||||||
u: U,
|
u: U,
|
||||||
v: V,
|
v: V,
|
||||||
w: W,
|
w: W,
|
||||||
inner: MySimpleStruct,
|
inner: MySimpleStruct,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, MakeSchema)]
|
#[derive(Debug, MakeSchema)]
|
||||||
|
@ -16,24 +16,25 @@ struct MySimpleStruct {}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn default_name_multiple_type_params() -> TestResult {
|
fn default_name_multiple_type_params() -> TestResult {
|
||||||
test_default_generated_schema::<MyStruct<i32, (), bool, Vec<String>>>("naming-default")
|
test_default_generated_schema::<MyStruct<i32, (), bool, Vec<String>>>("schema-name-default")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, MakeSchema)]
|
#[derive(Debug, MakeSchema)]
|
||||||
#[serde(rename = "a-new-name-{W}-{T}-{T}")]
|
#[serde(rename = "a-new-name-{W}-{T}-{T}")]
|
||||||
struct MyRenamedStruct<T, U, V, W> {
|
struct MyRenamedStruct<T, U, V, W> {
|
||||||
t: T,
|
t: T,
|
||||||
u: U,
|
u: U,
|
||||||
v: V,
|
v: V,
|
||||||
w: W,
|
w: W,
|
||||||
inner: MySimpleRenamedStruct,
|
inner: MySimpleRenamedStruct,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, MakeSchema)]
|
#[derive(Debug, MakeSchema)]
|
||||||
#[serde(rename = "another-new-name")]
|
#[serde(rename = "this-attribute-is-ignored")]
|
||||||
|
#[schemars(rename = "another-new-name")]
|
||||||
struct MySimpleRenamedStruct {}
|
struct MySimpleRenamedStruct {}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn overriden_with_rename_multiple_type_params() -> TestResult {
|
fn overriden_with_rename_multiple_type_params() -> TestResult {
|
||||||
test_default_generated_schema::<MyRenamedStruct<i32, (), bool, Vec<String>>>("naming-custom")
|
test_default_generated_schema::<MyRenamedStruct<i32, (), bool, Vec<String>>>("schema-name-custom")
|
||||||
}
|
}
|
|
@ -12,5 +12,5 @@ proc-macro = true
|
||||||
[dependencies]
|
[dependencies]
|
||||||
proc-macro2 = "0.4"
|
proc-macro2 = "0.4"
|
||||||
quote = "0.6.13"
|
quote = "0.6.13"
|
||||||
syn = { version = "0.15.22", features = ["visit"] } # do we need visit?
|
syn = "0.15.22"
|
||||||
serde_derive_internals = "0.24.1"
|
serde_derive_internals = "0.24.1"
|
||||||
|
|
|
@ -5,19 +5,21 @@ extern crate syn;
|
||||||
|
|
||||||
extern crate proc_macro;
|
extern crate proc_macro;
|
||||||
|
|
||||||
|
mod preprocess;
|
||||||
|
|
||||||
use proc_macro2::{Span, TokenStream};
|
use proc_macro2::{Span, TokenStream};
|
||||||
use serde_derive_internals::ast::{Container, Data, Field, Style, Variant};
|
use serde_derive_internals::ast::{Container, Data, Field, Style, Variant};
|
||||||
use serde_derive_internals::attr::{self, EnumTag};
|
use serde_derive_internals::attr::{self, EnumTag};
|
||||||
use serde_derive_internals::{Ctxt, Derive};
|
use serde_derive_internals::{Ctxt, Derive};
|
||||||
use syn::spanned::Spanned;
|
use syn::spanned::Spanned;
|
||||||
use syn::{DeriveInput, GenericParam, Generics};
|
use syn::DeriveInput;
|
||||||
|
|
||||||
#[proc_macro_derive(MakeSchema, attributes(schemars, serde))]
|
#[proc_macro_derive(MakeSchema, attributes(schemars, serde))]
|
||||||
pub fn derive_make_schema(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
pub fn derive_make_schema(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
||||||
let mut input = parse_macro_input!(input as DeriveInput);
|
let mut input = parse_macro_input!(input as DeriveInput);
|
||||||
|
|
||||||
// TODO is mutating the input really the best way to do this?
|
preprocess::add_trait_bounds(&mut input.generics);
|
||||||
add_trait_bounds(&mut input.generics);
|
preprocess::rename_schemars_attrs(&mut input);
|
||||||
|
|
||||||
let ctxt = Ctxt::new();
|
let ctxt = Ctxt::new();
|
||||||
let cont = Container::from_ast(&ctxt, &input, Derive::Deserialize);
|
let cont = Container::from_ast(&ctxt, &input, Derive::Deserialize);
|
||||||
|
@ -75,14 +77,6 @@ pub fn derive_make_schema(input: proc_macro::TokenStream) -> proc_macro::TokenSt
|
||||||
proc_macro::TokenStream::from(impl_block)
|
proc_macro::TokenStream::from(impl_block)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn add_trait_bounds(generics: &mut Generics) {
|
|
||||||
for param in &mut generics.params {
|
|
||||||
if let GenericParam::Type(ref mut type_param) = *param {
|
|
||||||
type_param.bounds.push(parse_quote!(schemars::MakeSchema));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn wrap_schema_fields(schema_contents: TokenStream) -> TokenStream {
|
fn wrap_schema_fields(schema_contents: TokenStream) -> TokenStream {
|
||||||
quote! {
|
quote! {
|
||||||
Ok(schemars::schema::Schema::Object(
|
Ok(schemars::schema::Schema::Object(
|
||||||
|
|
57
schemars_derive/src/preprocess.rs
Normal file
57
schemars_derive/src/preprocess.rs
Normal file
|
@ -0,0 +1,57 @@
|
||||||
|
use proc_macro2::Span;
|
||||||
|
use syn::{Attribute, Data, DeriveInput, Field, GenericParam, Generics, Ident, Variant};
|
||||||
|
|
||||||
|
pub fn add_trait_bounds(generics: &mut Generics) {
|
||||||
|
for param in &mut generics.params {
|
||||||
|
if let GenericParam::Type(ref mut type_param) = *param {
|
||||||
|
type_param.bounds.push(parse_quote!(schemars::MakeSchema));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If a struct/variant/field has any #[schemars] attributes, then rename them
|
||||||
|
// to #[serde] so that serde_derive_internals will parse them for us.
|
||||||
|
pub fn rename_schemars_attrs(input: &mut DeriveInput) {
|
||||||
|
rename_attrs(input.attrs.iter_mut());
|
||||||
|
match input.data {
|
||||||
|
Data::Struct(ref mut s) => rename_field_attrs(s.fields.iter_mut()),
|
||||||
|
Data::Enum(ref mut e) => rename_variant_attrs(e.variants.iter_mut()),
|
||||||
|
Data::Union(ref mut u) => rename_field_attrs(u.fields.named.iter_mut()),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
fn rename_variant_attrs<'a>(variants: impl Iterator<Item = &'a mut Variant>) {
|
||||||
|
for v in variants {
|
||||||
|
rename_attrs(v.attrs.iter_mut());
|
||||||
|
rename_field_attrs(v.fields.iter_mut());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn rename_field_attrs<'a>(fields: impl Iterator<Item = &'a mut Field>) {
|
||||||
|
for f in fields {
|
||||||
|
rename_attrs(f.attrs.iter_mut());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn rename_attrs<'a>(attrs: impl Iterator<Item = &'a mut Attribute>) {
|
||||||
|
let (schemars_attrs, others): (Vec<_>, Vec<_>) =
|
||||||
|
attrs.partition(|a| a.path.is_ident("schemars"));
|
||||||
|
|
||||||
|
if !schemars_attrs.is_empty() {
|
||||||
|
for attr in schemars_attrs {
|
||||||
|
let schemars_ident = attr.path.segments.pop().unwrap().into_value().ident;
|
||||||
|
attr.path
|
||||||
|
.segments
|
||||||
|
.push(Ident::new("serde", schemars_ident.span()).into());
|
||||||
|
}
|
||||||
|
// Give any other attributes a new name so that serde doesn't process them
|
||||||
|
// and complain about duplicate attributes.
|
||||||
|
// TODO we shouldn't need to remove all attributes - it should be possible
|
||||||
|
// to just remove duplicated parts of the attributes.
|
||||||
|
for attr in others {
|
||||||
|
attr.path
|
||||||
|
.segments
|
||||||
|
.push(Ident::new("dummy", Span::call_site()).into());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue