Skip to content

Commit

Permalink
WIP: Add impl support unnamed field structs (#4)
Browse files Browse the repository at this point in the history 
* Add Component derive support for unnamed field structs
* Add unit tests
  • Loading branch information
@juhaku
juhaku committed Dec 7, 2021
1 parent af008be commit 18ccc7b
Show file tree
Hide file tree
Showing 3 changed files with 232 additions and 39 deletions.
159 changes: 141 additions & 18 deletions tests/component_derive_test.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,21 +227,144 @@ fn derive_enum_with_comments_success() {
}
}

// Not supported at least at the moment
// #[test]
// fn derive_struct_tuple_type_success() {
// #[allow(dead_code)]
// #[derive(Component)]
// struct Point(i32);

// #[derive(OpenApi)]
// #[openapi(handler_files = [], components = [$name])]
// struct ApiDoc;

// let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
// let account = get_json_path(&api_doc_value, "components.schemas.AccountStatus");

// assert_value! {account=>
// "description" = r#""This is user account status enum""#, "AccountStatus description"
// }
// }
#[test]
fn derive_struct_unnamed_field_single_value_type_success() {
#[allow(dead_code)]
#[derive(Component)]
struct Point(f64);

#[derive(OpenApi)]
#[openapi(handler_files = [], components = [Point])]
struct ApiDoc;

let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
let point = get_json_path(&api_doc_value, "components.schemas.Point");

assert_value! {point=>
"type" = r#""number""#, "Point type"
"format" = r#""float""#, "Point format"
}
}

#[test]
fn derive_struct_unnamed_fields_tuple_with_same_type_success() {
#[allow(dead_code)]
#[derive(Component)]
struct Point(f64, f64);

#[derive(OpenApi)]
#[openapi(handler_files = [], components = [Point])]
struct ApiDoc;

let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
let point = get_json_path(&api_doc_value, "components.schemas.Point");

assert_value! {point=>
"type" = r#""array""#, "Point type"
"items.type" = r#""number""#, "Point items type"
"items.format" = r#""float""#, "Point items format"
}
}

#[test]
fn derive_struct_unnamed_fields_tuple_with_different_types_success() {
#[allow(dead_code)]
#[derive(Component)]
struct Point(f64, String);

#[derive(OpenApi)]
#[openapi(handler_files = [], components = [Point])]
struct ApiDoc;

let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
let point = get_json_path(&api_doc_value, "components.schemas.Point");

assert_value! {point=>
"type" = r#""array""#, "Point type"
"items.type" = r#""object""#, "Point items type"
"items.format" = r#"null"#, "Point items format"
}
}

#[test]
fn derive_struct_unnamed_field_with_generic_types_success() {
#[allow(dead_code)]
#[derive(Component)]
struct Wrapper(Option<String>);

#[derive(OpenApi)]
#[openapi(handler_files = [], components = [Wrapper])]
struct ApiDoc;

let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
let point = get_json_path(&api_doc_value, "components.schemas.Wrapper");

assert_value! {point=>
"type" = r#""string""#, "Wrapper type"
}
}

#[test]
fn derive_struct_unnamed_field_with_nested_generic_type_success() {
#[allow(dead_code)]
#[derive(Component)]
struct Wrapper(Option<Vec<i32>>);

#[derive(OpenApi)]
#[openapi(handler_files = [], components = [Wrapper])]
struct ApiDoc;

let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
let point = get_json_path(&api_doc_value, "components.schemas.Wrapper");

assert_value! {point=>
"type" = r#""array""#, "Wrapper type"
"items.type" = r#""integer""#, "Wrapper items type"
"items.format" = r#""int32""#, "Wrapper items format"
}
}

#[test]
fn derive_struct_unnamed_field_with_multiple_nested_generic_type_success() {
#[allow(dead_code)]
#[derive(Component)]
struct Wrapper(Option<Vec<i32>>, String);

#[derive(OpenApi)]
#[openapi(handler_files = [], components = [Wrapper])]
struct ApiDoc;

let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
let point = get_json_path(&api_doc_value, "components.schemas.Wrapper");

assert_value! {point=>
"type" = r#""array""#, "Wrapper type"
"items.type" = r#""object""#, "Wrapper items type"
"items.format" = r#"null"#, "Wrapper items format"
}
}

#[test]
fn derive_struct_unnamed_field_vec_type_success() {
#[allow(dead_code)]
#[derive(Component)]
struct Wrapper(Vec<i32>);

#[derive(OpenApi)]
#[openapi(handler_files = [], components = [Wrapper])]
struct ApiDoc;

let api_doc_value = serde_json::to_value(ApiDoc::openapi()).unwrap();
println!(
"apidoc: {}",
serde_json::to_string_pretty(&api_doc_value).unwrap()
);

let point = get_json_path(&api_doc_value, "components.schemas.Wrapper");

assert_value! {point=>
"type" = r#""array""#, "Wrapper type"
"items.type" = r#""integer""#, "Wrapper items type"
"items.format" = r#""int32""#, "Wrapper items format"
}
}
3 changes: 3 additions & 0 deletions utoipa-gen/src/attribute.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ const COMPONENT_ATTRIBUTE_TYPE: &str = "component";
pub(crate) struct CommentAttributes(pub(crate) Vec<String>);

impl CommentAttributes {
pub(crate) fn empty() -> Self {
Self { 0: vec![] }
}
/// Creates new [`CommentAttributes`] instance from syn::Attribute slice filtering out all
/// other attributes which are not `doc` comments
pub(crate) fn from_attributes(attributes: &[Attribute]) -> Self {
Expand Down
109 changes: 88 additions & 21 deletions utoipa-gen/src/component.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ use proc_macro2::{Group, Ident, Punct, TokenStream as TokenStream2};
use proc_macro_error::{abort, abort_call_site, emit_error};
use quote::{quote, ToTokens, TokenStreamExt};
use syn::{
punctuated::Punctuated, Attribute, Fields, FieldsNamed, GenericArgument, PathArguments,
PathSegment, Type, TypePath, Variant,
punctuated::Punctuated, Attribute, Fields, FieldsNamed, FieldsUnnamed, GenericArgument,
PathArguments, PathSegment, Type, TypePath, Variant,
};

use crate::{
Expand All @@ -24,10 +24,17 @@ pub(crate) fn impl_component(data: syn::Data, attrs: Vec<syn::Attribute>) -> Tok
}

#[cfg_attr(feature = "all-features", derive(Debug))]
/// Holds the openapi Component implementation which can be added the Schema.

enum FieldType {
Named,
Unnamed,
}

#[cfg_attr(feature = "all-features", derive(Debug))]
/// Holds the OpenAPI Component implementation which can be added the Schema.
enum ComponentVariant<'a> {
/// Object variant is rust sturct with Component derive annotation.
Object(Vec<syn::Field>, &'a [Attribute]),
Object(Vec<syn::Field>, &'a [Attribute], FieldType),
/// Enum variant is rust enum with Component derive annotation. **Only supports** enums with
/// Unit type fields.
Enum(Vec<syn::Variant>, &'a [Attribute]),
Expand All @@ -37,13 +44,18 @@ impl<'a> ComponentVariant<'a> {
fn new(data: syn::Data, attributes: &'a [Attribute]) -> ComponentVariant<'a> {
match data {
syn::Data::Struct(content) => {
if let Fields::Named(named_fields) = content.fields {
let FieldsNamed { named, .. } = named_fields;

ComponentVariant::Object(named.into_iter().collect(), attributes)
} else {
ComponentVariant::Object(vec![], attributes)
}
let (fields , field_type ) = match content.fields {
Fields::Unnamed(fields) => {
let FieldsUnnamed { unnamed, .. } = fields;
(unnamed , FieldType::Unnamed)
}
Fields::Named(fields) => {
let FieldsNamed { named, .. } = fields;
(named, FieldType::Named)
}
Fields::Unit => abort_call_site!("Expected struct with either named or unnamed fields, unit type unsupported")
};
ComponentVariant::Object(fields.into_iter().collect(), attributes, field_type)
}
syn::Data::Enum(content) => {
ComponentVariant::Enum(content.variants.into_iter().collect(), attributes)
Expand All @@ -58,7 +70,9 @@ impl<'a> ComponentVariant<'a> {
impl<'a> ToTokens for ComponentVariant<'a> {
fn to_tokens(&self, tokens: &mut TokenStream2) {
match self {
Self::Object(fields, attrs) => self.struct_to_tokens(fields, *attrs, tokens),
Self::Object(fields, attrs, field_type) => {
self.struct_to_tokens(fields, *attrs, tokens, field_type)
}
Self::Enum(variants, attrs) => self.enum_to_tokens(variants, *attrs, tokens),
};
}
Expand All @@ -70,11 +84,22 @@ impl<'a> ComponentVariant<'a> {
fields: &[syn::Field],
attributes: &[Attribute],
tokens: &mut TokenStream2,
field_type: &FieldType,
) {
match field_type {
FieldType::Named => self.named_fields_struct_to_tokens(fields, tokens),
FieldType::Unnamed => self.unnamed_fields_struct_to_tokens(fields, tokens),
}

self.append_description(attributes, tokens);
}

fn named_fields_struct_to_tokens(&self, fields: &[syn::Field], tokens: &mut TokenStream2) {
tokens.extend(quote! { utoipa::openapi::Object::new() });

fields.iter().for_each(|field| {
let field_name = &*field.ident.as_ref().unwrap().to_string();

let component_part = &ComponentPart::from_type(&field.ty);
let component = Into::<ComponentPartRef<'_, ComponentPart<'_>>>::into(component_part)
.collect::<Component>();
Expand All @@ -95,12 +120,56 @@ impl<'a> ComponentVariant<'a> {
})
}
});
}

self.append_description(attributes, tokens);
fn unnamed_fields_struct_to_tokens(&self, fields: &[syn::Field], tokens: &mut TokenStream2) {
let fields_len = fields.len();
let first_field = fields.first().unwrap();
let first_part = &ComponentPart::from_type(&first_field.ty);
let first_component = Into::<ComponentPartRef<'_, ComponentPart<'_>>>::into(first_part)
.collect::<Component>();

let all_fields_are_same = fields.iter().skip(1).all(|field| {
let component_part = &ComponentPart::from_type(&field.ty);
let component = Into::<ComponentPartRef<'_, ComponentPart<'_>>>::into(component_part)
.collect::<Component>();

first_component == component
});

// If Struct is single value struct such as Point(i64) create a Property component based on type
if fields_len == 1 {
let component =
create_property_stream(&first_component, CommentAttributes::empty(), None);

tokens.extend(quote! { #component });
} else {
let component = if all_fields_are_same {
// When all fields are same we can represent the struct as typed array
create_property_stream(&first_component, CommentAttributes::empty(), None)
} else {
// Struct that has multiple unnamed fields is serialized to array by default with serde.
// See: https://serde.rs/json.html
// Typically OpenAPI does not support multi type arrays thus we simply consider the case
// as generic object array
quote! {
utoipa::openapi::Object::new()
}
};

tokens.extend(quote! {
utoipa::openapi::Array::new(
#component
)
});
}
}

fn is_not_enum_unit_variant(variant: &&Variant) -> bool {
!matches!(variant.fields, Fields::Unit)
fn warn_unsupported_enum_variants(&self, variants: &[Variant]) {
variants
.iter()
.filter(|variant| !matches!(variant.fields, Fields::Unit))
.for_each(|variant| emit_error!(variant.ident.span(), "Currently unsupported enum variant, expected Unit variant without additional fields"));
}

fn enum_to_tokens(
Expand All @@ -109,10 +178,7 @@ impl<'a> ComponentVariant<'a> {
attributes: &[Attribute],
tokens: &mut TokenStream2,
) {
variants
.iter()
.filter(ComponentVariant::is_not_enum_unit_variant)
.for_each(|variant| emit_error!(variant.ident.span(), "Currently unsupported enum variant, expected Unit variant without additional fields"));
self.warn_unsupported_enum_variants(variants);

let enum_values = &variants
.iter()
Expand Down Expand Up @@ -435,7 +501,7 @@ impl<'a> Iterator for ComponentPartRef<'a, ComponentPart<'a>> {
}

#[cfg_attr(feature = "all-features", derive(Debug))]
#[derive(Clone, Copy)]
#[derive(Clone, Copy, PartialEq)]
enum ValueType {
Primitive,
Object,
Expand All @@ -450,10 +516,11 @@ enum GenericType {
}

#[cfg_attr(feature = "all-features", derive(Debug))]
#[derive(PartialEq)]
struct TypeTuple<'a, T>(T, &'a Ident);

#[cfg_attr(feature = "all-features", derive(Debug))]
#[derive(Default)]
#[derive(Default, PartialEq)]
struct Component<'a> {
option: bool,
generic_type: Option<TypeTuple<'a, GenericType>>,
Expand Down

0 comments on commit 18ccc7b

Please sign in to comment.