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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
use std::fmt;

use crate::{Directive, FieldDefinition, StringValue};
/// ObjectDefinition types represent concrete instantiations of sets of fields.
///
/// The introspection types (e.g. `__Type`, `__Field`, etc) are examples of
/// objects.
///
/// *ObjectTypeDefinition*:
///     Description? **type** Name ImplementsInterfaces? Directives? FieldsDefinition?
///
/// Detailed documentation can be found in [GraphQL spec](https://spec.graphql.org/October2021/#sec-Object).
///
/// ### Example
/// ```rust
/// use apollo_encoder::{Type_, FieldDefinition, ObjectDefinition};
/// use indoc::indoc;
///
/// let ty_1 = Type_::NamedType {
///     name: "DanglerPoleToys".to_string(),
/// };
///
/// let ty_2 = Type_::List { ty: Box::new(ty_1) };
/// let mut field = FieldDefinition::new("toys".to_string(), ty_2);
/// let ty_3 = Type_::NamedType {
///     name: "FoodType".to_string(),
/// };
/// let mut field_2 = FieldDefinition::new("food".to_string(), ty_3);
/// field_2.description("Dry or wet food?".to_string());
///
/// let ty_4 = Type_::NamedType {
///     name: "Boolean".to_string(),
/// };
/// let field_3 = FieldDefinition::new("catGrass".to_string(), ty_4);
///
/// let mut object_def = ObjectDefinition::new("PetStoreTrip".to_string());
/// object_def.field(field);
/// object_def.field(field_2);
/// object_def.field(field_3);
/// object_def.interface("ShoppingTrip".to_string());
///
/// assert_eq!(
///     object_def.to_string(),
///     indoc! { r#"
///         type PetStoreTrip implements ShoppingTrip {
///           toys: [DanglerPoleToys]
///           "Dry or wet food?"
///           food: FoodType
///           catGrass: Boolean
///         }
///     "#}
/// );
/// ```
#[derive(Debug, Clone)]
pub struct ObjectDefinition {
    // Name must return a String.
    name: String,
    // Description may return a String or null.
    description: Option<StringValue>,
    // The vector of interfaces that an object implements.
    interfaces: Vec<String>,
    // The vector of fields query‐able on this type.
    fields: Vec<FieldDefinition>,
    /// The vector of directives for this object
    directives: Vec<Directive>,
    extend: bool,
}

impl ObjectDefinition {
    /// Create a new instance of ObjectDef with a name.
    pub fn new(name: String) -> Self {
        Self {
            name,
            description: None,
            interfaces: Vec::new(),
            fields: Vec::new(),
            directives: Vec::new(),
            extend: false,
        }
    }

    /// Set the ObjectDef's description field.
    pub fn description(&mut self, description: String) {
        self.description = Some(StringValue::Top {
            source: description,
        });
    }

    /// Add a directive on ObjectDef.
    pub fn directive(&mut self, directive: Directive) {
        self.directives.push(directive)
    }

    /// Set the object type as an extension
    pub fn extend(&mut self) {
        self.extend = true;
    }

    /// Push a Field to ObjectDef's fields vector.
    pub fn field(&mut self, field: FieldDefinition) {
        self.fields.push(field)
    }

    /// Add an interface ObjectDef implements.
    pub fn interface(&mut self, interface: String) {
        self.interfaces.push(interface)
    }
}

impl fmt::Display for ObjectDefinition {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.extend {
            write!(f, "extend ")?;
        // No description when it's a extension
        } else if let Some(description) = &self.description {
            writeln!(f, "{description}")?;
        }

        write!(f, "type {}", &self.name)?;
        for (i, interface) in self.interfaces.iter().enumerate() {
            match i {
                0 => write!(f, " implements {interface}")?,
                _ => write!(f, " & {interface}")?,
            }
        }
        for directive in &self.directives {
            write!(f, " {directive}")?;
        }

        write!(f, " {{")?;

        for field in &self.fields {
            write!(f, "\n{field}")?;
        }
        writeln!(f, "\n}}")
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{Argument, FieldDefinition, InputValueDefinition, Type_, Value};
    use indoc::indoc;
    use pretty_assertions::assert_eq;

    #[test]
    fn it_encodes_object_with_description() {
        let ty_1 = Type_::NamedType {
            name: "DanglerPoleToys".to_string(),
        };

        let ty_2 = Type_::List { ty: Box::new(ty_1) };
        let field = FieldDefinition::new("toys".to_string(), ty_2);

        let mut object_def = ObjectDefinition::new("PetStoreTrip".to_string());
        object_def.field(field);
        object_def.description("What to get at Fressnapf?".to_string());

        assert_eq!(
            object_def.to_string(),
            indoc! { r#"
                "What to get at Fressnapf?"
                type PetStoreTrip {
                  toys: [DanglerPoleToys]
                }
            "#}
        );
    }

    #[test]
    fn it_encodes_object_with_field_directives() {
        let ty_1 = Type_::NamedType {
            name: "DanglerPoleToys".to_string(),
        };

        let mut field = FieldDefinition::new("toys".to_string(), ty_1);
        let mut deprecated_directive = Directive::new(String::from("deprecated"));
        deprecated_directive.arg(Argument::new(
            String::from("reason"),
            Value::String(String::from(
                "\"DanglerPoleToys\" are no longer interesting",
            )),
        ));
        field.directive(deprecated_directive);

        let mut object_def = ObjectDefinition::new("PetStoreTrip".to_string());
        object_def.field(field);
        object_def.description("What to get at Fressnapf?".to_string());

        assert_eq!(
            object_def.to_string(),
            indoc! { r#"
                "What to get at Fressnapf?"
                type PetStoreTrip {
                  toys: DanglerPoleToys @deprecated(reason: """"DanglerPoleToys" are no longer interesting""")
                }
            "#}
        );
    }

    #[test]
    fn it_encodes_object_with_extend() {
        let ty_1 = Type_::NamedType {
            name: "DanglerPoleToys".to_string(),
        };

        let mut field = FieldDefinition::new("toys".to_string(), ty_1);
        let mut deprecated_directive = Directive::new(String::from("deprecated"));
        deprecated_directive.arg(Argument::new(
            String::from("reason"),
            Value::String(String::from("DanglerPoleToys are no longer interesting")),
        ));
        field.directive(deprecated_directive);

        let mut object_def = ObjectDefinition::new("PetStoreTrip".to_string());
        object_def.field(field);
        object_def.description("What to get at Fressnapf?".to_string());
        object_def.extend();

        assert_eq!(
            object_def.to_string(),
            indoc! { r#"
                extend type PetStoreTrip {
                  toys: DanglerPoleToys @deprecated(reason: "DanglerPoleToys are no longer interesting")
                }
            "#}
        );
    }

    #[test]
    fn it_encodes_object_with_interface() {
        let ty_1 = Type_::NamedType {
            name: "DanglerPoleToys".to_string(),
        };

        let ty_2 = Type_::List { ty: Box::new(ty_1) };
        let mut field = FieldDefinition::new("toys".to_string(), ty_2);
        let mut deprecated_directive = Directive::new(String::from("deprecated"));
        deprecated_directive.arg(Argument::new(
            String::from("reason"),
            Value::String(String::from("Cats are too spoiled")),
        ));
        field.directive(deprecated_directive);
        let ty_3 = Type_::NamedType {
            name: "FoodType".to_string(),
        };
        let mut field_2 = FieldDefinition::new("food".to_string(), ty_3);
        field_2.description("Dry or wet food?".to_string());

        let ty_4 = Type_::NamedType {
            name: "Boolean".to_string(),
        };
        let field_3 = FieldDefinition::new("catGrass".to_string(), ty_4);

        let mut object_def = ObjectDefinition::new("PetStoreTrip".to_string());
        object_def.field(field);
        object_def.field(field_2);
        object_def.field(field_3);
        object_def.description("Shopping list for cats at the pet store.".to_string());
        object_def.interface("ShoppingTrip".to_string());

        assert_eq!(
            object_def.to_string(),
            indoc! { r#"
                "Shopping list for cats at the pet store."
                type PetStoreTrip implements ShoppingTrip {
                  toys: [DanglerPoleToys] @deprecated(reason: "Cats are too spoiled")
                  "Dry or wet food?"
                  food: FoodType
                  catGrass: Boolean
                }
            "#}
        );
    }

    #[test]
    fn it_encodes_object_with_interface_and_directives() {
        let ty_1 = Type_::NamedType {
            name: "DanglerPoleToys".to_string(),
        };

        let mut directive = Directive::new(String::from("testDirective"));
        directive.arg(Argument::new(
            String::from("first"),
            Value::String("one".to_string()),
        ));
        let ty_2 = Type_::List { ty: Box::new(ty_1) };
        let mut field = FieldDefinition::new("toys".to_string(), ty_2);
        let mut deprecated_directive = Directive::new(String::from("deprecated"));
        deprecated_directive.arg(Argument::new(
            String::from("reason"),
            Value::String(String::from("Cats are too spoiled")),
        ));
        field.directive(deprecated_directive);
        let ty_3 = Type_::NamedType {
            name: "FoodType".to_string(),
        };
        let mut field_2 = FieldDefinition::new("food".to_string(), ty_3);
        field_2.description("Dry or wet food?".to_string());

        let ty_4 = Type_::NamedType {
            name: "Boolean".to_string(),
        };
        let mut field_3 = FieldDefinition::new("catGrass".to_string(), ty_4);

        let value = Type_::NamedType {
            name: "Boolean".to_string(),
        };

        let mut arg = InputValueDefinition::new("fresh".to_string(), value);
        arg.description("How fresh is this grass".to_string());
        field_3.arg(arg);

        let mut object_def = ObjectDefinition::new("PetStoreTrip".to_string());
        object_def.field(field);
        object_def.field(field_2);
        object_def.field(field_3);
        object_def.description("Shopping list for cats at the pet store.".to_string());
        object_def.interface("ShoppingTrip".to_string());
        object_def.directive(directive);

        assert_eq!(
            object_def.to_string(),
            indoc! { r#"
                "Shopping list for cats at the pet store."
                type PetStoreTrip implements ShoppingTrip @testDirective(first: "one") {
                  toys: [DanglerPoleToys] @deprecated(reason: "Cats are too spoiled")
                  "Dry or wet food?"
                  food: FoodType
                  catGrass(
                    "How fresh is this grass"
                    fresh: Boolean
                  ): Boolean
                }
            "#}
        );
    }

    #[test]
    fn it_encodes_object_with_input_value_definition_fields() {
        let ty_1 = Type_::NamedType {
            name: "DanglerPoleToys".to_string(),
        };

        let ty_2 = Type_::List { ty: Box::new(ty_1) };
        let field = FieldDefinition::new("toys".to_string(), ty_2);

        let ty_4 = Type_::NamedType {
            name: "Boolean".to_string(),
        };
        let mut field_3 = FieldDefinition::new("catGrass".to_string(), ty_4);

        let value = Type_::NamedType {
            name: "Boolean".to_string(),
        };

        let mut arg = InputValueDefinition::new("fresh".to_string(), value);
        arg.description("How fresh is this grass".to_string());
        field_3.arg(arg);

        let value = Type_::NamedType {
            name: "Int".to_string(),
        };

        let mut arg = InputValueDefinition::new("quantity".to_string(), value);
        arg.description("Number of pots\ngrowing at a given time".to_string());
        field_3.arg(arg);

        let mut object_def = ObjectDefinition::new("PetStoreTrip".to_string());
        object_def.field(field);
        object_def.field(field_3);
        object_def.description("Shopping list for cats at the pet store.".to_string());

        assert_eq!(
            object_def.to_string(),
            indoc! { r#"
                "Shopping list for cats at the pet store."
                type PetStoreTrip {
                  toys: [DanglerPoleToys]
                  catGrass(
                    "How fresh is this grass"
                    fresh: Boolean,
                    """
                    Number of pots
                    growing at a given time
                    """
                    quantity: Int
                  ): Boolean
                }
            "#}
        );
    }

    #[test]
    fn it_encodes_object_with_block_string_description() {
        let ty_1 = Type_::NamedType {
            name: "String".to_string(),
        };

        let mut field = FieldDefinition::new("name".to_string(), ty_1);
        field.description("multiline\ndescription".to_string());

        let mut object_def = ObjectDefinition::new("Book".to_string());
        object_def.field(field);
        object_def.description("Book Object\nType".to_string());

        assert_eq!(
            object_def.to_string(),
            indoc! { r#"
                """
                Book Object
                Type
                """
                type Book {
                  """
                  multiline
                  description
                  """
                  name: String
                }
            "#}
        );
    }
}