async-graphql/derive/src/args.rs

728 lines
18 KiB
Rust

use std::fmt::{self, Display, Formatter};
use darling::ast::{Data, Fields};
use darling::util::{Ignored, SpannedValue};
use darling::{FromDeriveInput, FromField, FromMeta, FromVariant};
use inflector::Inflector;
use syn::{
Attribute, Generics, Ident, Lit, LitBool, LitStr, Meta, NestedMeta, Path, Type, Visibility,
};
use crate::validators::Validators;
#[derive(FromMeta, Clone)]
#[darling(default)]
pub struct CacheControl {
public: bool,
private: bool,
pub max_age: usize,
}
impl Default for CacheControl {
fn default() -> Self {
Self {
public: true,
private: false,
max_age: 0,
}
}
}
impl CacheControl {
pub fn is_public(&self) -> bool {
!self.private && self.public
}
}
#[derive(Debug)]
pub enum DefaultValue {
Default,
Value(Lit),
}
impl FromMeta for DefaultValue {
fn from_word() -> darling::Result<Self> {
Ok(DefaultValue::Default)
}
fn from_value(value: &Lit) -> darling::Result<Self> {
Ok(DefaultValue::Value(value.clone()))
}
}
#[derive(Debug, Clone)]
pub enum Visible {
None,
HiddenAlways,
FnName(Path),
}
impl FromMeta for Visible {
fn from_value(value: &Lit) -> darling::Result<Self> {
match value {
Lit::Bool(LitBool { value: true, .. }) => Ok(Visible::None),
Lit::Bool(LitBool { value: false, .. }) => Ok(Visible::HiddenAlways),
Lit::Str(str) => Ok(Visible::FnName(syn::parse_str::<Path>(&str.value())?)),
_ => Err(darling::Error::unexpected_lit_type(value)),
}
}
}
pub struct PathList(pub Vec<Path>);
impl FromMeta for PathList {
fn from_list(items: &[NestedMeta]) -> darling::Result<Self> {
let mut res = Vec::new();
for item in items {
if let NestedMeta::Meta(Meta::Path(p)) = item {
res.push(p.clone());
} else {
return Err(darling::Error::custom("Invalid path list"));
}
}
Ok(PathList(res))
}
}
#[derive(FromMeta)]
pub struct ConcreteType {
pub name: String,
pub params: PathList,
}
#[derive(Debug, Clone)]
pub enum Deprecation {
NoDeprecated,
Deprecated { reason: Option<String> },
}
impl Default for Deprecation {
fn default() -> Self {
Deprecation::NoDeprecated
}
}
impl FromMeta for Deprecation {
fn from_word() -> darling::Result<Self> {
Ok(Deprecation::Deprecated { reason: None })
}
fn from_value(value: &Lit) -> darling::Result<Self> {
match value {
Lit::Bool(LitBool { value: true, .. }) => Ok(Deprecation::Deprecated { reason: None }),
Lit::Bool(LitBool { value: false, .. }) => Ok(Deprecation::NoDeprecated),
Lit::Str(str) => Ok(Deprecation::Deprecated {
reason: Some(str.value()),
}),
_ => Err(darling::Error::unexpected_lit_type(value)),
}
}
}
#[derive(FromField)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct SimpleObjectField {
pub ident: Option<Ident>,
pub ty: Type,
pub vis: Visibility,
pub attrs: Vec<Attribute>,
#[darling(default)]
pub skip: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub deprecation: Deprecation,
#[darling(default)]
pub owned: bool,
#[darling(default)]
pub cache_control: CacheControl,
#[darling(default)]
pub external: bool,
#[darling(default)]
pub provides: Option<String>,
#[darling(default)]
pub requires: Option<String>,
#[darling(default)]
pub guard: Option<SpannedValue<String>>,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default, multiple)]
pub derived: Vec<DerivedField>,
// for InputObject
#[darling(default)]
pub default: Option<DefaultValue>,
#[darling(default)]
pub default_with: Option<LitStr>,
#[darling(default)]
pub validator: Option<Validators>,
#[darling(default)]
pub flatten: bool,
#[darling(default)]
pub secret: bool,
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct SimpleObject {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<Ignored, SimpleObjectField>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub fake: bool,
#[darling(default)]
pub complex: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub rename_fields: Option<RenameRule>,
#[darling(default)]
pub rename_args: Option<RenameRule>,
#[darling(default)]
pub cache_control: CacheControl,
#[darling(default)]
pub extends: bool,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default, multiple, rename = "concrete")]
pub concretes: Vec<ConcreteType>,
#[darling(default)]
pub serial: bool,
// for InputObject
#[darling(default)]
pub input_name: Option<String>,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct Argument {
pub name: Option<String>,
pub desc: Option<String>,
pub default: Option<DefaultValue>,
pub default_with: Option<LitStr>,
pub validator: Option<Validators>,
pub key: bool, // for entity
pub visible: Option<Visible>,
pub secret: bool,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct Object {
pub internal: bool,
pub name: Option<String>,
pub rename_fields: Option<RenameRule>,
pub rename_args: Option<RenameRule>,
pub cache_control: CacheControl,
pub extends: bool,
pub use_type_description: bool,
pub visible: Option<Visible>,
pub serial: bool,
#[darling(multiple, rename = "concrete")]
pub concretes: Vec<ConcreteType>,
}
pub enum ComplexityType {
Const(usize),
Fn(String),
}
impl FromMeta for ComplexityType {
fn from_value(value: &Lit) -> darling::Result<Self> {
match value {
Lit::Int(n) => {
let n = n.base10_parse::<i32>().unwrap();
if n < 0 {
return Err(darling::Error::custom(
"The complexity must be greater than or equal to 0.",
));
}
Ok(ComplexityType::Const(n as usize))
}
Lit::Str(s) => Ok(ComplexityType::Fn(s.value())),
_ => Err(darling::Error::unexpected_lit_type(value)),
}
}
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct ObjectField {
pub skip: bool,
pub entity: bool,
pub name: Option<String>,
pub deprecation: Deprecation,
pub cache_control: CacheControl,
pub external: bool,
pub provides: Option<String>,
pub requires: Option<String>,
pub guard: Option<SpannedValue<String>>,
pub visible: Option<Visible>,
pub complexity: Option<ComplexityType>,
#[darling(default, multiple)]
pub derived: Vec<DerivedField>,
}
#[derive(FromMeta, Default, Clone)]
#[darling(default)]
/// Derivied fields arguments: are used to generate derivied fields.
pub struct DerivedField {
pub name: Option<Ident>,
pub into: Option<String>,
pub with: Option<Path>,
#[darling(default)]
pub owned: Option<bool>,
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct Enum {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<EnumItem, Ignored>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub rename_items: Option<RenameRule>,
#[darling(default)]
pub remote: Option<String>,
#[darling(default)]
pub visible: Option<Visible>,
}
#[derive(FromVariant)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct EnumItem {
pub ident: Ident,
pub attrs: Vec<Attribute>,
pub fields: Fields<Ignored>,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub deprecation: Deprecation,
#[darling(default)]
pub visible: Option<Visible>,
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct Union {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<UnionItem, Ignored>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub visible: Option<Visible>,
}
#[derive(FromVariant)]
#[darling(attributes(graphql))]
pub struct UnionItem {
pub ident: Ident,
pub fields: Fields<syn::Type>,
#[darling(default)]
pub flatten: bool,
}
#[derive(FromField)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct InputObjectField {
pub ident: Option<Ident>,
pub ty: Type,
pub vis: Visibility,
pub attrs: Vec<Attribute>,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub default: Option<DefaultValue>,
#[darling(default)]
pub default_with: Option<LitStr>,
#[darling(default)]
pub validator: Option<Validators>,
#[darling(default)]
pub flatten: bool,
#[darling(default)]
pub skip: bool,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default)]
pub secret: bool,
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct InputObject {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<Ignored, InputObjectField>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub input_name: Option<String>,
#[darling(default)]
pub rename_fields: Option<RenameRule>,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default, multiple, rename = "concrete")]
pub concretes: Vec<ConcreteType>,
}
#[derive(FromMeta)]
pub struct InterfaceFieldArgument {
pub name: String,
#[darling(default)]
pub desc: Option<String>,
#[darling(rename = "type")]
pub ty: LitStr,
#[darling(default)]
pub default: Option<DefaultValue>,
#[darling(default)]
pub default_with: Option<LitStr>,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default)]
pub secret: bool,
}
#[derive(FromMeta)]
pub struct InterfaceField {
pub name: String,
#[darling(rename = "type")]
pub ty: LitStr,
#[darling(default)]
pub method: Option<String>,
#[darling(default)]
pub desc: Option<String>,
#[darling(default, multiple, rename = "arg")]
pub args: Vec<InterfaceFieldArgument>,
#[darling(default)]
pub deprecation: Deprecation,
#[darling(default)]
pub external: bool,
#[darling(default)]
pub provides: Option<String>,
#[darling(default)]
pub requires: Option<String>,
#[darling(default)]
pub visible: Option<Visible>,
}
#[derive(FromVariant)]
pub struct InterfaceMember {
pub ident: Ident,
pub fields: Fields<syn::Type>,
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct Interface {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<InterfaceMember, Ignored>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub rename_fields: Option<RenameRule>,
#[darling(default)]
pub rename_args: Option<RenameRule>,
#[darling(default, multiple, rename = "field")]
pub fields: Vec<InterfaceField>,
#[darling(default)]
pub extends: bool,
#[darling(default)]
pub visible: Option<Visible>,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct Scalar {
pub internal: bool,
pub name: Option<String>,
pub use_type_description: bool,
pub visible: Option<Visible>,
pub specified_by_url: Option<String>,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct Subscription {
pub internal: bool,
pub name: Option<String>,
pub rename_fields: Option<RenameRule>,
pub rename_args: Option<RenameRule>,
pub use_type_description: bool,
pub extends: bool,
pub visible: Option<Visible>,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct SubscriptionFieldArgument {
pub name: Option<String>,
pub desc: Option<String>,
pub default: Option<DefaultValue>,
pub default_with: Option<LitStr>,
pub validator: Option<Validators>,
pub visible: Option<Visible>,
pub secret: bool,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct SubscriptionField {
pub skip: bool,
pub name: Option<String>,
pub deprecation: Deprecation,
pub guard: Option<SpannedValue<String>>,
pub visible: Option<Visible>,
pub complexity: Option<ComplexityType>,
}
#[derive(FromField)]
pub struct MergedObjectField {
pub ident: Option<Ident>,
pub ty: Type,
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct MergedObject {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<Ignored, MergedObjectField>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub cache_control: CacheControl,
#[darling(default)]
pub extends: bool,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default)]
pub serial: bool,
}
#[derive(FromField)]
pub struct MergedSubscriptionField {
pub ident: Option<Ident>,
pub ty: Type,
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct MergedSubscription {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<Ignored, MergedSubscriptionField>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub name: Option<String>,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default)]
pub extends: bool,
}
#[derive(Debug, Copy, Clone, FromMeta)]
pub enum RenameRule {
#[darling(rename = "lowercase")]
Lower,
#[darling(rename = "UPPERCASE")]
Upper,
#[darling(rename = "PascalCase")]
Pascal,
#[darling(rename = "camelCase")]
Camel,
#[darling(rename = "snake_case")]
Snake,
#[darling(rename = "SCREAMING_SNAKE_CASE")]
ScreamingSnake,
}
impl RenameRule {
fn rename(&self, name: impl AsRef<str>) -> String {
match self {
Self::Lower => name.as_ref().to_lowercase(),
Self::Upper => name.as_ref().to_uppercase(),
Self::Pascal => name.as_ref().to_pascal_case(),
Self::Camel => name.as_ref().to_camel_case(),
Self::Snake => name.as_ref().to_snake_case(),
Self::ScreamingSnake => name.as_ref().to_screaming_snake_case(),
}
}
}
#[derive(Debug, Copy, Clone)]
pub enum RenameTarget {
Type,
EnumItem,
Field,
Argument,
}
impl RenameTarget {
fn rule(&self) -> RenameRule {
match self {
RenameTarget::Type => RenameRule::Pascal,
RenameTarget::EnumItem => RenameRule::ScreamingSnake,
RenameTarget::Field => RenameRule::Camel,
RenameTarget::Argument => RenameRule::Camel,
}
}
pub fn rename(&self, name: impl AsRef<str>) -> String {
self.rule().rename(name)
}
}
pub trait RenameRuleExt {
fn rename(&self, name: impl AsRef<str>, target: RenameTarget) -> String;
}
impl RenameRuleExt for Option<RenameRule> {
fn rename(&self, name: impl AsRef<str>, target: RenameTarget) -> String {
self.unwrap_or(target.rule()).rename(name)
}
}
#[derive(FromDeriveInput)]
#[darling(forward_attrs(doc))]
pub struct Description {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
#[darling(default)]
pub internal: bool,
}
#[derive(Debug)]
pub enum NewTypeName {
New(String),
Rust,
Original,
}
impl Default for NewTypeName {
fn default() -> Self {
Self::Original
}
}
impl FromMeta for NewTypeName {
fn from_word() -> darling::Result<Self> {
Ok(Self::Rust)
}
fn from_string(value: &str) -> darling::Result<Self> {
Ok(Self::New(value.to_string()))
}
fn from_bool(value: bool) -> darling::Result<Self> {
if value {
Ok(Self::Rust)
} else {
Ok(Self::Original)
}
}
}
#[derive(FromDeriveInput)]
#[darling(attributes(graphql), forward_attrs(doc))]
pub struct NewType {
pub ident: Ident,
pub generics: Generics,
pub attrs: Vec<Attribute>,
pub data: Data<Ignored, syn::Type>,
#[darling(default)]
pub internal: bool,
#[darling(default)]
pub name: NewTypeName,
#[darling(default)]
pub visible: Option<Visible>,
#[darling(default)]
pub specified_by_url: Option<String>,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct ComplexObject {
pub internal: bool,
pub name: Option<String>,
pub rename_fields: Option<RenameRule>,
pub rename_args: Option<RenameRule>,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct ComplexObjectField {
pub skip: bool,
pub name: Option<String>,
pub deprecation: Deprecation,
pub cache_control: CacheControl,
pub external: bool,
pub provides: Option<String>,
pub requires: Option<String>,
pub guard: Option<SpannedValue<String>>,
pub visible: Option<Visible>,
pub complexity: Option<ComplexityType>,
}
#[derive(FromMeta, Default)]
#[darling(default)]
pub struct Directive {
pub internal: bool,
pub name: Option<String>,
pub visible: Option<Visible>,
pub repeatable: bool,
pub rename_args: Option<RenameRule>,
#[darling(multiple, rename = "location")]
pub locations: Vec<DirectiveLocation>,
}
#[derive(Debug, Copy, Clone, FromMeta)]
#[darling(rename_all = "lowercase")]
pub enum DirectiveLocation {
Field,
}
impl Display for DirectiveLocation {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self {
DirectiveLocation::Field => write!(f, "FIELD"),
}
}
}