Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom name for Other variant #469

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions graphql_client_codegen/src/codegen/enums.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,18 +59,27 @@ pub(super) fn generate_enum_definitions<'a, 'schema: 'a>(

let name = name_ident;

let fallback_name = if let Some(other_vname) = options.serde_enum_fallback_variant_name() {
other_vname.to_owned()
} else {
"Other".to_string()
};

let fallback_ident = Ident::new(&fallback_name, Span::call_site());
let fallback_variant = quote!(#fallback_ident);

quote! {
#derives
pub enum #name {
#(#variant_names,)*
Other(String),
#fallback_variant(String)
}

impl ::serde::Serialize for #name {
fn serialize<S: serde::Serializer>(&self, ser: S) -> Result<S::Ok, S::Error> {
ser.serialize_str(match *self {
#(#constructors => #variant_str,)*
#name::Other(ref s) => &s,
#name::#fallback_variant(ref s) => &s,
})
}
}
Expand All @@ -81,7 +90,7 @@ pub(super) fn generate_enum_definitions<'a, 'schema: 'a>(

match s.as_str() {
#(#variant_str => Ok(#constructors),)*
_ => Ok(#name::Other(s)),
_ => Ok(#name::#fallback_variant(s)),
}
}
}
Expand Down
15 changes: 14 additions & 1 deletion graphql_client_codegen/src/codegen_options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ pub struct GraphQLClientCodegenOptions {
extern_enums: Vec<String>,
/// Flag to trigger generation of Other variant for fragments Enum
fragments_other_variant: bool,
/// Create Other variant with custom name for ser/de
serde_enum_fallback_variant_name: Option<String>,
/// Skip Serialization of None values.
skip_serializing_none: bool,
skip_serializing_none: bool
}

impl GraphQLClientCodegenOptions {
Expand All @@ -67,6 +69,7 @@ impl GraphQLClientCodegenOptions {
custom_scalars_module: Default::default(),
extern_enums: Default::default(),
fragments_other_variant: Default::default(),
serde_enum_fallback_variant_name: Default::default(),
skip_serializing_none: Default::default(),
}
}
Expand Down Expand Up @@ -218,6 +221,16 @@ impl GraphQLClientCodegenOptions {
&self.fragments_other_variant
}

/// Set the graphql client codegen option's serde_enum_fallback_variant_name
pub fn set_serde_enum_fallback_variant_name(&mut self, serde_enum_fallback_variant_name: Option<String>) {
self.serde_enum_fallback_variant_name = serde_enum_fallback_variant_name;
}

/// Get a reference to the graphql client codegen option's serde_enum_fallback_variant_name
pub fn serde_enum_fallback_variant_name(&self) -> &Option<String> {
&self.serde_enum_fallback_variant_name
}

/// Set the graphql client codegen option's skip none value.
pub fn set_skip_serializing_none(&mut self, skip_serializing_none: bool) {
self.skip_serializing_none = skip_serializing_none
Expand Down
45 changes: 44 additions & 1 deletion graphql_client_codegen/src/tests/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ fn fragments_other_variant_should_generate_unknown_other_variant() {
.to_token_stream()
.expect("Generate foobars module");
let generated_code = generated_tokens.to_string();

let r: syn::parse::Result<proc_macro2::TokenStream> = syn::parse2(generated_tokens);
match r {
Ok(_) => {
Expand Down Expand Up @@ -159,3 +159,46 @@ fn skip_serializing_none_should_generate_serde_skip_serializing() {
};
}
}

#[test]
fn serde_enum_custom_fallback_name() {
let query_string = include_str!("keywords_query.graphql");
let query = graphql_parser::parse_query::<&str>(query_string).expect("Parse keywords query");
let schema = graphql_parser::parse_schema(include_str!("keywords_schema.graphql"))
.expect("Parse keywords schema")
.into_static();
let schema = Schema::from(schema);

let mut options = GraphQLClientCodegenOptions::new(CodegenMode::Cli);

options.set_serde_enum_fallback_variant_name(Some("Autre".to_string()));

let query = crate::query::resolve(&schema, &query).unwrap();

for (_id, operation) in query.operations() {
let generated_tokens = generated_module::GeneratedModule {
query_string,
schema: &schema,
operation: &operation.name,
resolved_query: &query,
options: &options,
}
.to_token_stream()
.expect("Generate keywords module");

let generated_code = generated_tokens.to_string();

let r: syn::parse::Result<proc_macro2::TokenStream> = syn::parse2(generated_tokens);

match r {
Ok(_) => {
println!("{}", generated_code);
assert!(!generated_code.contains("Other (String)"));
assert!(generated_code.contains("Autre (String)"));
}
Err(e) => {
panic!("Error: {}\n Generated content: {}\n", e, &generated_code);
}
};
}
}
2 changes: 2 additions & 0 deletions graphql_query_derive/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,13 @@ fn build_graphql_client_derive_options(
let custom_scalars_module = attributes::extract_attr(input, "custom_scalars_module").ok();
let extern_enums = attributes::extract_attr_list(input, "extern_enums").ok();
let fragments_other_variant: bool = attributes::extract_fragments_other_variant(input);
let serde_enum_fallback_variant_name: Option<String> = attributes::extract_attr(input, "serde_enum_fallback_variant_name").ok();
let skip_serializing_none: bool = attributes::extract_skip_serializing_none(input);

let mut options = GraphQLClientCodegenOptions::new(CodegenMode::Derive);
options.set_query_file(query_path);
options.set_fragments_other_variant(fragments_other_variant);
options.set_serde_enum_fallback_variant_name(serde_enum_fallback_variant_name);
options.set_skip_serializing_none(skip_serializing_none);

if let Some(variables_derives) = variables_derives {
Expand Down