1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
use std::fmt;
use crate::{Field, StringValue};
/// InterfaceDefs are an abstract type where there are common fields declared.
///
/// Any type that implements an interface must define all the fields with names
/// and types exactly matching. The implementations of this interface are
/// explicitly listed out in possibleTypes.
///
/// *InterfaceDefTypeDefinition*:
/// Description? **interface** Name ImplementsInterfaceDefs? Directives?
///
/// Detailed documentation can be found in [GraphQL spec](https://spec.graphql.org/October2021/#sec-InterfaceDef).
///
/// ### Example
/// ```rust
/// use apollo_encoder::{Type_, Field, InterfaceDef};
/// use indoc::indoc;
///
/// let ty_1 = Type_::NamedType {
/// name: "String".to_string(),
/// };
///
/// let ty_2 = Type_::NamedType {
/// name: "String".to_string(),
/// };
///
/// let ty_3 = Type_::NonNull { ty: Box::new(ty_2) };
/// let ty_4 = Type_::List { ty: Box::new(ty_3) };
/// let ty_5 = Type_::NonNull { ty: Box::new(ty_4) };
///
/// let ty_6 = Type_::NamedType {
/// name: "Boolean".to_string(),
/// };
///
/// let mut field_1 = Field::new("main".to_string(), ty_1);
/// field_1.description(Some("Cat's main dish of a meal.".to_string()));
///
/// let mut field_2 = Field::new("snack".to_string(), ty_5);
/// field_2.description(Some("Cat's post meal snack.".to_string()));
///
/// let mut field_3 = Field::new("pats".to_string(), ty_6);
/// field_3.description(Some("Does cat get a pat after meal?".to_string()));
///
/// // a schema definition
/// let mut interface = InterfaceDef::new("Meal".to_string());
/// interface.description(Some(
/// "Meal interface for various\nmeals during the day.".to_string(),
/// ));
/// interface.field(field_1);
/// interface.field(field_2);
/// interface.field(field_3);
///
/// assert_eq!(
/// interface.to_string(),
/// indoc! { r#"
/// """
/// Meal interface for various
/// meals during the day.
/// """
/// interface Meal {
/// "Cat's main dish of a meal."
/// main: String
/// "Cat's post meal snack."
/// snack: [String!]!
/// "Does cat get a pat after meal?"
/// pats: Boolean
/// }
/// "# }
/// );
/// ```
#[derive(Debug, Clone)]
pub struct InterfaceDef {
// Name must return a String.
name: String,
// Description may return a String or null.
description: StringValue,
// The vector of interfaces that this interface implements.
interfaces: Vec<String>,
// The vector of fields required by this interface.
fields: Vec<Field>,
}
impl InterfaceDef {
/// Create a new instance of InterfaceDef.
pub fn new(name: String) -> Self {
Self {
name,
description: StringValue::Top { source: None },
fields: Vec::new(),
interfaces: Vec::new(),
}
}
/// Set the schema def's description.
pub fn description(&mut self, description: Option<String>) {
self.description = StringValue::Top {
source: description,
};
}
/// Set the interfaces ObjectDef implements.
pub fn interface(&mut self, interface: String) {
self.interfaces.push(interface)
}
/// Push a Field to schema def's fields vector.
pub fn field(&mut self, field: Field) {
self.fields.push(field)
}
}
impl fmt::Display for InterfaceDef {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.description)?;
write!(f, "interface {}", &self.name)?;
for (i, interface) in self.interfaces.iter().enumerate() {
match i {
0 => write!(f, " implements {}", interface)?,
_ => write!(f, "& {}", interface)?,
}
}
write!(f, " {{")?;
for field in &self.fields {
write!(f, "\n{}", field)?;
}
writeln!(f, "\n}}")
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::Type_;
use indoc::indoc;
use pretty_assertions::assert_eq;
#[test]
fn it_encodes_interfaces() {
let ty_1 = Type_::NamedType {
name: "String".to_string(),
};
let ty_2 = Type_::NamedType {
name: "String".to_string(),
};
let ty_3 = Type_::NonNull { ty: Box::new(ty_2) };
let ty_4 = Type_::List { ty: Box::new(ty_3) };
let ty_5 = Type_::NonNull { ty: Box::new(ty_4) };
let ty_6 = Type_::NamedType {
name: "Boolean".to_string(),
};
let mut field_1 = Field::new("main".to_string(), ty_1);
field_1.description(Some("Cat's main dish of a meal.".to_string()));
let mut field_2 = Field::new("snack".to_string(), ty_5);
field_2.description(Some("Cat's post meal snack.".to_string()));
let mut field_3 = Field::new("pats".to_string(), ty_6);
field_3.description(Some("Does cat get a pat\nafter meal?".to_string()));
// a schema definition
let mut interface = InterfaceDef::new("Meal".to_string());
interface.description(Some(
"Meal interface for various\nmeals during the day.".to_string(),
));
interface.field(field_1);
interface.field(field_2);
interface.field(field_3);
assert_eq!(
interface.to_string(),
indoc! { r#"
"""
Meal interface for various
meals during the day.
"""
interface Meal {
"Cat's main dish of a meal."
main: String
"Cat's post meal snack."
snack: [String!]!
"""
Does cat get a pat
after meal?
"""
pats: Boolean
}
"# }
);
}
}