File: printer.rb

package info (click to toggle)
ruby-graphql 2.2.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,584 kB
  • sloc: ruby: 67,505; ansic: 1,753; yacc: 831; javascript: 331; makefile: 6
file content (557 lines) | stat: -rw-r--r-- 17,795 bytes parent folder | download
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# frozen_string_literal: true
module GraphQL
  module Language
    class Printer
      OMISSION = "... (truncated)"

      class TruncatableBuffer
        class TruncateSizeReached < StandardError; end

        DEFAULT_INIT_CAPACITY = 500

        def initialize(truncate_size: nil)
          @out = String.new(capacity: truncate_size || DEFAULT_INIT_CAPACITY)
          @truncate_size = truncate_size
        end

        def append(other)
          if @truncate_size && (@out.size + other.size) > @truncate_size
            @out << other.slice(0, @truncate_size - @out.size)
            raise(TruncateSizeReached, "Truncate size reached")
          else
            @out << other
          end
        end

        def to_string
          @out
        end
      end

      # Turn an arbitrary AST node back into a string.
      #
      # @example Turning a document into a query string
      #    document = GraphQL.parse(query_string)
      #    GraphQL::Language::Printer.new.print(document)
      #    # => "{ ... }"
      #
      #
      # @example Building a custom printer
      #
      #  class MyPrinter < GraphQL::Language::Printer
      #    def print_argument(arg)
      #      print_string("#{arg.name}: <HIDDEN>")
      #    end
      #  end
      #
      #  MyPrinter.new.print(document)
      #  # => "mutation { pay(creditCard: <HIDDEN>) { success } }"
      #
      # @param node [Nodes::AbstractNode]
      # @param indent [String] Whitespace to add to the printed node
      # @param truncate_size [Integer, nil] The size to truncate to.
      # @return [String] Valid GraphQL for `node`
      def print(node, indent: "", truncate_size: nil)
        truncate_size = truncate_size ? [truncate_size - OMISSION.size, 0].max : nil
        @out = TruncatableBuffer.new(truncate_size: truncate_size)
        print_node(node, indent: indent)
        @out.to_string
      rescue TruncatableBuffer::TruncateSizeReached
        @out.to_string << OMISSION
      end

      protected

      def print_string(str)
        @out.append(str)
      end

      def print_document(document)
        document.definitions.each_with_index do |d, i|
          print_node(d)
          print_string("\n\n") if i < document.definitions.size - 1
        end
      end

      def print_argument(argument)
        print_string(argument.name)
        print_string(": ")
        print_node(argument.value)
      end

      def print_input_object(input_object)
        print_string("{")
        input_object.arguments.each_with_index do |a, i|
          print_argument(a)
          print_string(", ") if i < input_object.arguments.size - 1
        end
        print_string("}")
      end

      def print_directive(directive)
        print_string("@")
        print_string(directive.name)

        if directive.arguments.any?
          print_string("(")
          directive.arguments.each_with_index do |a, i|
            print_argument(a)
            print_string(", ") if i < directive.arguments.size - 1
          end
          print_string(")")
        end
      end

      def print_enum(enum)
        print_string(enum.name)
      end

      def print_null_value
        print_string("null")
      end

      def print_field(field, indent: "")
        print_string(indent)
        if field.alias
          print_string(field.alias)
          print_string(": ")
        end
        print_string(field.name)
        if field.arguments.any?
          print_string("(")
          field.arguments.each_with_index do |a, i|
            print_argument(a)
            print_string(", ") if i < field.arguments.size - 1
          end
          print_string(")")
        end
        print_directives(field.directives)
        print_selections(field.selections, indent: indent)
      end

      def print_fragment_definition(fragment_def, indent: "")
        print_string(indent)
        print_string("fragment")
        if fragment_def.name
          print_string(" ")
          print_string(fragment_def.name)
        end

        if fragment_def.type
          print_string(" on ")
          print_node(fragment_def.type)
        end
        print_directives(fragment_def.directives)
        print_selections(fragment_def.selections, indent: indent)
      end

      def print_fragment_spread(fragment_spread, indent: "")
        print_string(indent)
        print_string("...")
        print_string(fragment_spread.name)
        print_directives(fragment_spread.directives)
      end

      def print_inline_fragment(inline_fragment, indent: "")
        print_string(indent)
        print_string("...")
        if inline_fragment.type
          print_string(" on ")
          print_node(inline_fragment.type)
        end
        print_directives(inline_fragment.directives)
        print_selections(inline_fragment.selections, indent: indent)
      end

      def print_list_type(list_type)
        print_string("[")
        print_node(list_type.of_type)
        print_string("]")
      end

      def print_non_null_type(non_null_type)
        print_node(non_null_type.of_type)
        print_string("!")
      end

      def print_operation_definition(operation_definition, indent: "")
        print_string(indent)
        print_string(operation_definition.operation_type)
        if operation_definition.name
          print_string(" ")
          print_string(operation_definition.name)
        end

        if operation_definition.variables.any?
          print_string("(")
          operation_definition.variables.each_with_index do |v, i|
            print_variable_definition(v)
            print_string(", ") if i < operation_definition.variables.size - 1
          end
          print_string(")")
        end

        print_directives(operation_definition.directives)
        print_selections(operation_definition.selections, indent: indent)
      end

      def print_type_name(type_name)
        print_string(type_name.name)
      end

      def print_variable_definition(variable_definition)
        print_string("$")
        print_string(variable_definition.name)
        print_string(": ")
        print_node(variable_definition.type)
        unless variable_definition.default_value.nil?
          print_string(" = ")
          print_node(variable_definition.default_value)
        end
        variable_definition.directives.each do |dir|
          print_string(" ")
          print_directive(dir)
        end
      end

      def print_variable_identifier(variable_identifier)
        print_string("$")
        print_string(variable_identifier.name)
      end

      def print_schema_definition(schema, extension: false)
        has_conventional_names = (schema.query.nil? || schema.query == 'Query') &&
          (schema.mutation.nil? || schema.mutation == 'Mutation') &&
          (schema.subscription.nil? || schema.subscription == 'Subscription')

        if has_conventional_names && schema.directives.empty?
          return
        end

        extension ? print_string("extend schema") : print_string("schema")

        if schema.directives.any?
          schema.directives.each do |dir|
            print_string("\n  ")
            print_node(dir)
          end

          if !has_conventional_names
            print_string("\n")
          end
        end

        if !has_conventional_names
          if schema.directives.empty?
            print_string(" ")
          end
          print_string("{\n")
          print_string("  query: #{schema.query}\n") if schema.query
          print_string("  mutation: #{schema.mutation}\n") if schema.mutation
          print_string("  subscription: #{schema.subscription}\n") if schema.subscription
          print_string("}")
        end
      end


      def print_scalar_type_definition(scalar_type, extension: false)
        extension ? print_string("extend ") : print_description(scalar_type)
        print_string("scalar ")
        print_string(scalar_type.name)
        print_directives(scalar_type.directives)
      end

      def print_object_type_definition(object_type, extension: false)
        extension ? print_string("extend ") : print_description(object_type)
        print_string("type ")
        print_string(object_type.name)
        print_implements(object_type) unless object_type.interfaces.empty?
        print_directives(object_type.directives)
        print_field_definitions(object_type.fields)
      end

      def print_implements(type)
        print_string(" implements ")
        i = 0
        type.interfaces.each do |int|
          if i > 0
            print_string(" & ")
          end
          print_string(int.name)
          i += 1
        end
      end

      def print_input_value_definition(input_value)
        print_string(input_value.name)
        print_string(": ")
        print_node(input_value.type)
        unless input_value.default_value.nil?
          print_string(" = ")
          print_node(input_value.default_value)
        end
        print_directives(input_value.directives)
      end

      def print_arguments(arguments, indent: "")
        if arguments.all? { |arg| !arg.description }
          print_string("(")
          arguments.each_with_index do |arg, i|
            print_input_value_definition(arg)
            print_string(", ") if i < arguments.size - 1
          end
          print_string(")")
          return
        end

        print_string("(\n")
        arguments.each_with_index do |arg, i|
          print_description(arg, indent: "  " + indent, first_in_block: i == 0)
          print_string("  ")
          print_string(indent)
          print_input_value_definition(arg)
          print_string("\n") if i < arguments.size - 1
        end
        print_string("\n")
        print_string(indent)
        print_string(")")
      end

      def print_field_definition(field)
        print_string(field.name)
        unless field.arguments.empty?
          print_arguments(field.arguments, indent: "  ")
        end
        print_string(": ")
        print_node(field.type)
        print_directives(field.directives)
      end

      def print_interface_type_definition(interface_type, extension: false)
        extension ? print_string("extend ") : print_description(interface_type)
        print_string("interface ")
        print_string(interface_type.name)
        print_implements(interface_type) if interface_type.interfaces.any?
        print_directives(interface_type.directives)
        print_field_definitions(interface_type.fields)
      end

      def print_union_type_definition(union_type, extension: false)
        extension ? print_string("extend ") : print_description(union_type)
        print_string("union ")
        print_string(union_type.name)
        print_directives(union_type.directives)
        if union_type.types.any?
          print_string(" = ")
          i = 0
          union_type.types.each do |t|
            if i > 0
              print_string(" | ")
            end
            print_string(t.name)
            i += 1
          end
        end
      end

      def print_enum_type_definition(enum_type, extension: false)
        extension ? print_string("extend ") : print_description(enum_type)
        print_string("enum ")
        print_string(enum_type.name)
        print_directives(enum_type.directives)
        if enum_type.values.any?
          print_string(" {\n")
          enum_type.values.each.with_index do |value, i|
            print_description(value, indent: "  ", first_in_block: i == 0)
            print_enum_value_definition(value)
          end
          print_string("}")
        end
      end

      def print_enum_value_definition(enum_value)
        print_string("  ")
        print_string(enum_value.name)
        print_directives(enum_value.directives)
        print_string("\n")
      end

      def print_input_object_type_definition(input_object_type, extension: false)
        extension ? print_string("extend ") : print_description(input_object_type)
        print_string("input ")
        print_string(input_object_type.name)
        print_directives(input_object_type.directives)
        if !input_object_type.fields.empty?
          print_string(" {\n")
          input_object_type.fields.each.with_index do |field, i|
            print_description(field, indent: "  ", first_in_block: i == 0)
            print_string("  ")
            print_input_value_definition(field)
            print_string("\n")
          end
          print_string("}")
        end
      end

      def print_directive_definition(directive)
        print_description(directive)
        print_string("directive @")
        print_string(directive.name)

        if directive.arguments.any?
          print_arguments(directive.arguments)
        end

        if directive.repeatable
          print_string(" repeatable")
        end

        print_string(" on ")
        i = 0
        directive.locations.each do |loc|
          if i > 0
            print_string(" | ")
          end
          print_string(loc.name)
          i += 1
        end
      end

      def print_description(node, indent: "", first_in_block: true)
        return unless node.description

        print_string("\n") if indent != "" && !first_in_block
        print_string(GraphQL::Language::BlockString.print(node.description, indent: indent))
      end

      def print_field_definitions(fields)
        return if fields.empty?

        print_string(" {\n")
        i = 0
        fields.each do |field|
          print_description(field, indent: "  ", first_in_block: i == 0)
          print_string("  ")
          print_field_definition(field)
          print_string("\n")
          i += 1
        end
        print_string("}")
      end

      def print_directives(directives)
        return if directives.empty?

        directives.each do |d|
          print_string(" ")
          print_directive(d)
        end
      end

      def print_selections(selections, indent: "")
        return if selections.empty?

        print_string(" {\n")
        selections.each do |selection|
          print_node(selection, indent: indent + "  ")
          print_string("\n")
        end
        print_string(indent)
        print_string("}")
      end

      def print_node(node, indent: "")
        case node
        when Nodes::Document
          print_document(node)
        when Nodes::Argument
          print_argument(node)
        when Nodes::Directive
          print_directive(node)
        when Nodes::Enum
          print_enum(node)
        when Nodes::NullValue
          print_null_value
        when Nodes::Field
          print_field(node, indent: indent)
        when Nodes::FragmentDefinition
          print_fragment_definition(node, indent: indent)
        when Nodes::FragmentSpread
          print_fragment_spread(node, indent: indent)
        when Nodes::InlineFragment
          print_inline_fragment(node, indent: indent)
        when Nodes::InputObject
          print_input_object(node)
        when Nodes::ListType
          print_list_type(node)
        when Nodes::NonNullType
          print_non_null_type(node)
        when Nodes::OperationDefinition
          print_operation_definition(node, indent: indent)
        when Nodes::TypeName
          print_type_name(node)
        when Nodes::VariableDefinition
          print_variable_definition(node)
        when Nodes::VariableIdentifier
          print_variable_identifier(node)
        when Nodes::SchemaDefinition
          print_schema_definition(node)
        when Nodes::SchemaExtension
          print_schema_definition(node, extension: true)
        when Nodes::ScalarTypeDefinition
          print_scalar_type_definition(node)
        when Nodes::ScalarTypeExtension
          print_scalar_type_definition(node, extension: true)
        when Nodes::ObjectTypeDefinition
          print_object_type_definition(node)
        when Nodes::ObjectTypeExtension
          print_object_type_definition(node, extension: true)
        when Nodes::InputValueDefinition
          print_input_value_definition(node)
        when Nodes::FieldDefinition
          print_field_definition(node)
        when Nodes::InterfaceTypeDefinition
          print_interface_type_definition(node)
        when Nodes::InterfaceTypeExtension
          print_interface_type_definition(node, extension: true)
        when Nodes::UnionTypeDefinition
          print_union_type_definition(node)
        when Nodes::UnionTypeExtension
          print_union_type_definition(node, extension: true)
        when Nodes::EnumTypeDefinition
          print_enum_type_definition(node)
        when Nodes::EnumTypeExtension
          print_enum_type_definition(node, extension: true)
        when Nodes::EnumValueDefinition
          print_enum_value_definition(node)
        when Nodes::InputObjectTypeDefinition
          print_input_object_type_definition(node)
        when Nodes::InputObjectTypeExtension
          print_input_object_type_definition(node, extension: true)
        when Nodes::DirectiveDefinition
          print_directive_definition(node)
        when FalseClass, Float, Integer, NilClass, String, TrueClass, Symbol
          print_string(GraphQL::Language.serialize(node))
        when Array
          print_string("[")
          node.each_with_index do |v, i|
            print_node(v)
            print_string(", ") if i < node.length - 1
          end
          print_string("]")
        when Hash
          print_string("{")
          node.each_with_index do |(k, v), i|
            print_string(k)
            print_string(": ")
            print_node(v)
            print_string(", ") if i < node.length - 1
          end
          print_string("}")
        else
          print_string(GraphQL::Language.serialize(node.to_s))
        end
      end
    end
  end
end