VienDesu/schemars
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make Option<T> fields optional in generated schemas (#16)

Browse source
This commit is contained in:
Graham Esau 2020-02-29 19:37:20 +00:00 • committed by GitHub
parent 60284fdf93
commit 4ad5000232
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 269 additions and 148 deletions
Download patch file Download diff file Expand all files Collapse all files

71
schemars_derive/src/lib.rs
View file

@ -38,7 +38,8 @@ pub fn derive_json_schema(input: proc_macro::TokenStream) -> proc_macro::TokenSt
Data::Struct(Style::Struct, ref fields) => schema_for_struct(fields, Some(&cont.attrs)),
Data::Enum(ref variants) => schema_for_enum(variants, &cont.attrs),
};
let schema_expr = set_metadata_on_schema_from_docs(schema_expr, &cont.original.attrs);
let doc_metadata = SchemaMetadata::from_doc_attrs(&cont.original.attrs);
let schema_expr = doc_metadata.apply_to_schema(schema_expr);
let type_name = cont.ident;
let type_params: Vec<_> = cont.generics.type_params().map(|ty| &ty.ident).collect();
@ -176,7 +177,8 @@ fn schema_for_external_tagged_enum<'a>(
..Default::default()
})),
});
set_metadata_on_schema_from_docs(schema_expr, &variant.original.attrs)
let doc_metadata = SchemaMetadata::from_doc_attrs(&variant.original.attrs);
doc_metadata.apply_to_schema(schema_expr)
}));
wrap_schema_fields(quote! {
@ -214,7 +216,8 @@ fn schema_for_internal_tagged_enum<'a>(
..Default::default()
})),
});
let tag_schema = set_metadata_on_schema_from_docs(tag_schema, &variant.original.attrs);
let doc_metadata = SchemaMetadata::from_doc_attrs(&variant.original.attrs);
let tag_schema = doc_metadata.apply_to_schema(tag_schema);
let variant_schema = match variant.style {
Style::Unit => return tag_schema,
@ -244,7 +247,8 @@ fn schema_for_internal_tagged_enum<'a>(
fn schema_for_untagged_enum<'a>(variants: impl Iterator<Item = &'a Variant<'a>>) -> TokenStream {
let schemas = variants.map(|variant| {
let schema_expr = schema_for_untagged_enum_variant(variant);
set_metadata_on_schema_from_docs(schema_expr, &variant.original.attrs)
let doc_metadata = SchemaMetadata::from_doc_attrs(&variant.original.attrs);
doc_metadata.apply_to_schema(schema_expr)
});
wrap_schema_fields(quote! {
@ -288,7 +292,7 @@ fn schema_for_tuple_struct(fields: &[Field]) -> TokenStream {
}
fn schema_for_struct(fields: &[Field], cattrs: Option<&serde_attr::Container>) -> TokenStream {
let (flat, nested): (Vec<_>, Vec<_>) = fields
let (flattened_fields, property_fields): (Vec<_>, Vec<_>) = fields
.iter()
.filter(|f| !f.attrs.skip_deserializing() || !f.attrs.skip_serializing())
.partition(|f| f.attrs.flatten());
@ -299,63 +303,50 @@ fn schema_for_struct(fields: &[Field], cattrs: Option<&serde_attr::Container>) -
SerdeDefault::Path(path) => Some(quote!(let container_default = #path();)),
};
let mut required = Vec::new();
let recurse = nested.iter().map(|field| {
let properties = property_fields.iter().map(|field| {
let name = field.attrs.name().deserialize_name();
let default = field_default_expr(field, set_container_default.is_some());
if default.is_none() {
required.push(name.clone());
}
let ty = get_json_schema_type(field);
let span = field.original.span();
let schema_expr = quote_spanned! {span=>
gen.subschema_for::<#ty>()
let required = match default {
Some(_) => quote!(false),
None => quote!(true),
};
let metadata = SchemaMetadata {
let metadata = &SchemaMetadata {
read_only: field.attrs.skip_deserializing(),
write_only: field.attrs.skip_serializing(),
default,
skip_default_if: field.attrs.skip_serializing_if().cloned(),
..get_metadata_from_docs(&field.original.attrs)
..SchemaMetadata::from_doc_attrs(&field.original.attrs)
};
let schema_expr = set_metadata_on_schema(schema_expr, &metadata);
let ty = get_json_schema_type(field);
let span = field.original.span();
quote_spanned! {span=>
props.insert(#name.to_owned(), #schema_expr);
<#ty>::add_schema_as_property(gen, &mut schema_object, #name.to_owned(), #metadata, #required);
}
});
let schema = wrap_schema_fields(quote! {
instance_type: Some(schemars::schema::InstanceType::Object.into()),
object: Some(Box::new(schemars::schema::ObjectValidation {
properties: {
let mut props = schemars::Map::new();
#(#recurse)*
props
},
required: {
let mut required = schemars::Set::new();
#(required.insert(#required.to_owned());)*
required
},
..Default::default()
})),
});
let flattens = flat.iter().map(|field| {
let flattens = flattened_fields.iter().map(|field| {
let ty = get_json_schema_type(field);
quote_spanned! {field.original.span()=>
.flatten(<#ty>::json_schema_optional(gen))
let span = field.original.span();
quote_spanned! {span=>
.flatten(<#ty>::json_schema_for_flatten(gen))
}
});
quote! {
{
#set_container_default
#schema #(#flattens)*
let mut schema_object = schemars::schema::SchemaObject {
instance_type: Some(schemars::schema::InstanceType::Object.into()),
..Default::default()
};
#(#properties)*
schemars::schema::Schema::Object(schema_object)
#(#flattens)*
}
}
}

156
schemars_derive/src/metadata.rs
View file

@ -1,5 +1,6 @@
use crate::attr;
use proc_macro2::TokenStream;
use proc_macro2::{Ident, Span, TokenStream};
use quote::{ToTokens, TokenStreamExt};
use syn::{Attribute, ExprPath};
#[derive(Debug, Clone, Default)]
@ -12,74 +13,91 @@ pub struct SchemaMetadata {
pub skip_default_if: Option<ExprPath>,
}
pub fn set_metadata_on_schema_from_docs(
schema_expr: TokenStream,
attrs: &[Attribute],
) -> TokenStream {
let metadata = get_metadata_from_docs(attrs);
set_metadata_on_schema(schema_expr, &metadata)
}
pub fn get_metadata_from_docs(attrs: &[Attribute]) -> SchemaMetadata {
let (title, description) = attr::get_title_and_desc_from_doc(attrs);
SchemaMetadata {
title,
description,
..Default::default()
}
}
pub fn set_metadata_on_schema(schema_expr: TokenStream, metadata: &SchemaMetadata) -> TokenStream {
let mut setters = Vec::<TokenStream>::new();
if let Some(title) = &metadata.title {
setters.push(quote! {
metadata.title = Some(#title.to_owned());
});
}
if let Some(description) = &metadata.description {
setters.push(quote! {
metadata.description = Some(#description.to_owned());
});
}
if metadata.read_only {
setters.push(quote! {
metadata.read_only = true;
});
}
if metadata.write_only {
setters.push(quote! {
metadata.write_only = true;
});
}
match (&metadata.default, &metadata.skip_default_if) {
(Some(default), Some(skip_if)) => setters.push(quote! {
{
let default = #default;
if !#skip_if(&default) {
metadata.default = schemars::_serde_json::value::to_value(default).ok();
}
}
}),
(Some(default), None) => setters.push(quote! {
metadata.default = schemars::_serde_json::value::to_value(#default).ok();
}),
_ => {}
}
if setters.is_empty() {
return schema_expr;
}
quote! {
{
let schema = #schema_expr.into();
let mut schema_obj = gen.make_extensible(schema);
let mut metadata = schema_obj.metadata();
#(#setters)*
schemars::schema::Schema::Object(schema_obj)
impl ToTokens for SchemaMetadata {
fn to_tokens(&self, tokens: &mut TokenStream) {
let setters = self.make_setters();
if setters.is_empty() {
tokens.append(Ident::new("None", Span::call_site()))
} else {
tokens.extend(quote! {
Some({
let mut metadata = schemars::schema::Metadata::default();
#(#setters)*
metadata
})
})
}
}
}
impl SchemaMetadata {
pub fn from_doc_attrs(attrs: &[Attribute]) -> SchemaMetadata {
let (title, description) = attr::get_title_and_desc_from_doc(attrs);
SchemaMetadata {
title,
description,
..Default::default()
}
}
pub fn apply_to_schema(&self, schema_expr: TokenStream) -> TokenStream {
let setters = self.make_setters();
if setters.is_empty() {
return schema_expr;
}
quote! {
{
let mut schema = #schema_expr.into();
gen.make_extensible(&mut schema);
let mut metadata = schema.metadata();
#(#setters)*
schemars::schema::Schema::Object(schema)
}
}
}
fn make_setters(self: &SchemaMetadata) -> Vec<TokenStream> {
let mut setters = Vec::<TokenStream>::new();
if let Some(title) = &self.title {
setters.push(quote! {
metadata.title = Some(#title.to_owned());
});
}
if let Some(description) = &self.description {
setters.push(quote! {
metadata.description = Some(#description.to_owned());
});
}
if self.read_only {
setters.push(quote! {
metadata.read_only = true;
});
}
if self.write_only {
setters.push(quote! {
metadata.write_only = true;
});
}
match (&self.default, &self.skip_default_if) {
(Some(default), Some(skip_if)) => setters.push(quote! {
{
let default = #default;
if !#skip_if(&default) {
metadata.default = schemars::_serde_json::value::to_value(default).ok();
}
}
}),
(Some(default), None) => setters.push(quote! {
metadata.default = schemars::_serde_json::value::to_value(#default).ok();
}),
_ => {}
}
setters
}
}