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 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
|
# frozen_string_literal: true
module GraphQL
module Language
module Nodes
NONE = GraphQL::EmptyObjects::EMPTY_ARRAY
# {AbstractNode} is the base class for all nodes in a GraphQL AST.
#
# It provides some APIs for working with ASTs:
# - `children` returns all AST nodes attached to this one. Used for tree traversal.
# - `scalars` returns all scalar (Ruby) values attached to this one. Used for comparing nodes.
# - `to_query_string` turns an AST node into a GraphQL string
class AbstractNode
module DefinitionNode
# This AST node's {#line} returns the first line, which may be the description.
# @return [Integer] The first line of the definition (not the description)
attr_reader :definition_line
def initialize(definition_line: nil, **_rest)
@definition_line = definition_line
super(**_rest)
end
end
attr_reader :filename
def line
@line ||= (@source_string && @pos) ? @source_string[0..@pos].count("\n") + 1 : nil
end
def col
@col ||= if @source_string && @pos
if @pos == 0
1
else
@source_string[0..@pos].split("\n").last.length
end
end
end
def definition_line
@definition_line ||= (@source_string && @definition_pos) ? @source_string[0..@definition_pos].count("\n") + 1 : nil
end
# Value equality
# @return [Boolean] True if `self` is equivalent to `other`
def ==(other)
return true if equal?(other)
other.kind_of?(self.class) &&
other.scalars == self.scalars &&
other.children == self.children
end
NO_CHILDREN = GraphQL::EmptyObjects::EMPTY_ARRAY
# @return [Array<GraphQL::Language::Nodes::AbstractNode>] all nodes in the tree below this one
def children
NO_CHILDREN
end
# @return [Array<Integer, Float, String, Boolean, Array>] Scalar values attached to this node
def scalars
NO_CHILDREN
end
# This might be unnecessary, but its easiest to add it here.
def initialize_copy(other)
@children = nil
@scalars = nil
@query_string = nil
end
def children_method_name
self.class.children_method_name
end
def position
[line, col]
end
def to_query_string(printer: GraphQL::Language::Printer.new)
if printer.is_a?(GraphQL::Language::Printer)
@query_string ||= printer.print(self)
else
printer.print(self)
end
end
# This creates a copy of `self`, with `new_options` applied.
# @param new_options [Hash]
# @return [AbstractNode] a shallow copy of `self`
def merge(new_options)
dup.merge!(new_options)
end
# Copy `self`, but modify the copy so that `previous_child` is replaced by `new_child`
def replace_child(previous_child, new_child)
# Figure out which list `previous_child` may be found in
method_name = previous_child.children_method_name
# Get the value from this (original) node
prev_children = public_send(method_name)
if prev_children.is_a?(Array)
# Copy that list, and replace `previous_child` with `new_child`
# in the list.
new_children = prev_children.dup
prev_idx = new_children.index(previous_child)
new_children[prev_idx] = new_child
else
# Use the new value for the given attribute
new_children = new_child
end
# Copy this node, but with the new child value
copy_of_self = merge(method_name => new_children)
# Return the copy:
copy_of_self
end
# TODO DRY with `replace_child`
def delete_child(previous_child)
# Figure out which list `previous_child` may be found in
method_name = previous_child.children_method_name
# Copy that list, and delete previous_child
new_children = public_send(method_name).dup
new_children.delete(previous_child)
# Copy this node, but with the new list of children:
copy_of_self = merge(method_name => new_children)
# Return the copy:
copy_of_self
end
protected
def merge!(new_options)
new_options.each do |key, value|
instance_variable_set(:"@#{key}", value)
end
self
end
class << self
# rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
# Add a default `#visit_method` and `#children_method_name` using the class name
def inherited(child_class)
super
name_underscored = child_class.name
.split("::").last
.gsub(/([a-z])([A-Z])/,'\1_\2') # insert underscores
.downcase # remove caps
child_class.module_eval <<-RUBY, __FILE__, __LINE__
def visit_method
:on_#{name_underscored}
end
class << self
attr_accessor :children_method_name
def visit_method
:on_#{name_underscored}
end
end
self.children_method_name = :#{name_underscored}s
RUBY
end
def children_of_type
@children_methods
end
private
# Name accessors which return lists of nodes,
# along with the kind of node they return, if possible.
# - Add a reader for these children
# - Add a persistent update method to add a child
# - Generate a `#children` method
def children_methods(children_of_type)
if defined?(@children_methods)
raise "Can't re-call .children_methods for #{self} (already have: #{@children_methods})"
else
@children_methods = children_of_type
end
if children_of_type == false
@children_methods = {}
# skip
else
children_of_type.each do |method_name, node_type|
module_eval <<-RUBY, __FILE__, __LINE__
# A reader for these children
attr_reader :#{method_name}
RUBY
if node_type
# Only generate a method if we know what kind of node to make
module_eval <<-RUBY, __FILE__, __LINE__
# Singular method: create a node with these options
# and return a new `self` which includes that node in this list.
def merge_#{method_name.to_s.sub(/s$/, "")}(**node_opts)
merge(#{method_name}: #{method_name} + [#{node_type.name}.new(**node_opts)])
end
RUBY
end
end
if children_of_type.size == 1
module_eval <<-RUBY, __FILE__, __LINE__
alias :children #{children_of_type.keys.first}
RUBY
else
module_eval <<-RUBY, __FILE__, __LINE__
def children
@children ||= begin
if #{children_of_type.keys.map { |k| "@#{k}.any?" }.join(" || ")}
new_children = []
#{children_of_type.keys.map { |k| "new_children.concat(@#{k})" }.join("; ")}
new_children.freeze
new_children
else
NO_CHILDREN
end
end
end
RUBY
end
end
if defined?(@scalar_methods)
if !@initialize_was_generated
@initialize_was_generated = true
generate_initialize
else
# This method was defined manually
end
else
raise "Can't generate_initialize because scalar_methods wasn't called; call it before children_methods"
end
end
# These methods return a plain Ruby value, not another node
# - Add reader methods
# - Add a `#scalars` method
def scalar_methods(*method_names)
if defined?(@scalar_methods)
raise "Can't re-call .scalar_methods for #{self} (already have: #{@scalar_methods})"
else
@scalar_methods = method_names
end
if method_names == [false]
@scalar_methods = []
# skip it
else
module_eval <<-RUBY, __FILE__, __LINE__
# add readers for each scalar
attr_reader #{method_names.map { |m| ":#{m}"}.join(", ")}
def scalars
@scalars ||= [#{method_names.map { |k| "@#{k}" }.join(", ")}].freeze
end
RUBY
end
end
DEFAULT_INITIALIZE_OPTIONS = [
"line: nil",
"col: nil",
"pos: nil",
"filename: nil",
"source_string: nil",
]
def generate_initialize
scalar_method_names = @scalar_methods
# TODO: These probably should be scalar methods, but `types` returns an array
[:types, :description].each do |extra_method|
if method_defined?(extra_method)
scalar_method_names += [extra_method]
end
end
all_method_names = scalar_method_names + @children_methods.keys
if all_method_names.include?(:alias)
# Rather than complicating this special case,
# let it be overridden (in field)
return
else
arguments = scalar_method_names.map { |m| "#{m}: nil"} +
@children_methods.keys.map { |m| "#{m}: NO_CHILDREN" } +
DEFAULT_INITIALIZE_OPTIONS
assignments = scalar_method_names.map { |m| "@#{m} = #{m}"} +
@children_methods.keys.map { |m| "@#{m} = #{m}.freeze" }
if name.end_with?("Definition") && name != "FragmentDefinition"
arguments << "definition_pos: nil"
assignments << "@definition_pos = definition_pos"
end
keywords = scalar_method_names.map { |m| "#{m}: #{m}"} +
@children_methods.keys.map { |m| "#{m}: #{m}" }
module_eval <<-RUBY, __FILE__, __LINE__
def initialize(#{arguments.join(", ")})
@line = line
@col = col
@pos = pos
@filename = filename
@source_string = source_string
#{assignments.join("\n")}
end
def self.from_a(filename, line, col, #{(scalar_method_names + @children_methods.keys).join(", ")})
self.new(filename: filename, line: line, col: col, #{keywords.join(", ")})
end
RUBY
end
end
# rubocop:enable Development/NoEvalCop
end
end
# Base class for non-null type names and list type names
class WrapperType < AbstractNode
scalar_methods :of_type
children_methods(false)
end
# Base class for nodes whose only value is a name (no child nodes or other scalars)
class NameOnlyNode < AbstractNode
scalar_methods :name
children_methods(false)
end
# A key-value pair for a field's inputs
class Argument < AbstractNode
scalar_methods :name, :value
children_methods(false)
# @!attribute name
# @return [String] the key for this argument
# @!attribute value
# @return [String, Float, Integer, Boolean, Array, InputObject, VariableIdentifier] The value passed for this key
def children
@children ||= Array(value).flatten.tap { _1.select! { |v| v.is_a?(AbstractNode) } }
end
end
class Directive < AbstractNode
scalar_methods :name
children_methods(arguments: GraphQL::Language::Nodes::Argument)
end
class DirectiveLocation < NameOnlyNode
end
class DirectiveDefinition < AbstractNode
attr_reader :description
scalar_methods :name, :repeatable
children_methods(
arguments: Nodes::Argument,
locations: Nodes::DirectiveLocation,
)
end
# An enum value. The string is available as {#name}.
class Enum < NameOnlyNode
end
# A null value literal.
class NullValue < NameOnlyNode
end
# A single selection in a GraphQL query.
class Field < AbstractNode
scalar_methods :name, :alias
children_methods({
arguments: GraphQL::Language::Nodes::Argument,
selections: GraphQL::Language::Nodes::Field,
directives: GraphQL::Language::Nodes::Directive,
})
# @!attribute selections
# @return [Array<Nodes::Field>] Selections on this object (or empty array if this is a scalar field)
def initialize(name: nil, arguments: NONE, directives: NONE, selections: NONE, field_alias: nil, line: nil, col: nil, pos: nil, filename: nil, source_string: nil)
@name = name
@arguments = arguments || NONE
@directives = directives || NONE
@selections = selections || NONE
# oops, alias is a keyword:
@alias = field_alias
@line = line
@col = col
@pos = pos
@filename = filename
@source_string = source_string
end
def self.from_a(filename, line, col, field_alias, name, arguments, directives, selections) # rubocop:disable Metrics/ParameterLists
self.new(filename: filename, line: line, col: col, field_alias: field_alias, name: name, arguments: arguments, directives: directives, selections: selections)
end
# Override this because default is `:fields`
self.children_method_name = :selections
end
# A reusable fragment, defined at document-level.
class FragmentDefinition < AbstractNode
scalar_methods :name, :type
children_methods({
selections: GraphQL::Language::Nodes::Field,
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :definitions
# @!attribute name
# @return [String] the identifier for this fragment, which may be applied with `...#{name}`
# @!attribute type
# @return [String] the type condition for this fragment (name of type which it may apply to)
def initialize(name: nil, type: nil, directives: NONE, selections: NONE, filename: nil, pos: nil, source_string: nil, line: nil, col: nil)
@name = name
@type = type
@directives = directives
@selections = selections
@filename = filename
@pos = pos
@source_string = source_string
@line = line
@col = col
end
def self.from_a(filename, line, col, name, type, directives, selections)
self.new(filename: filename, line: line, col: col, name: name, type: type, directives: directives, selections: selections)
end
end
# Application of a named fragment in a selection
class FragmentSpread < AbstractNode
scalar_methods :name
children_methods(directives: GraphQL::Language::Nodes::Directive)
self.children_method_name = :selections
# @!attribute name
# @return [String] The identifier of the fragment to apply, corresponds with {FragmentDefinition#name}
end
# An unnamed fragment, defined directly in the query with `... { }`
class InlineFragment < AbstractNode
scalar_methods :type
children_methods({
directives: GraphQL::Language::Nodes::Directive,
selections: GraphQL::Language::Nodes::Field,
})
self.children_method_name = :selections
# @!attribute type
# @return [String, nil] Name of the type this fragment applies to, or `nil` if this fragment applies to any type
end
# A collection of key-value inputs which may be a field argument
class InputObject < AbstractNode
scalar_methods(false)
children_methods(arguments: GraphQL::Language::Nodes::Argument)
# @!attribute arguments
# @return [Array<Nodes::Argument>] A list of key-value pairs inside this input object
# @return [Hash<String, Any>] Recursively turn this input object into a Ruby Hash
def to_h(options={})
arguments.inject({}) do |memo, pair|
v = pair.value
memo[pair.name] = serialize_value_for_hash v
memo
end
end
self.children_method_name = :value
private
def serialize_value_for_hash(value)
case value
when InputObject
value.to_h
when Array
value.map do |v|
serialize_value_for_hash v
end
when Enum
value.name
when NullValue
nil
else
value
end
end
end
# A list type definition, denoted with `[...]` (used for variable type definitions)
class ListType < WrapperType
end
# A non-null type definition, denoted with `...!` (used for variable type definitions)
class NonNullType < WrapperType
end
# An operation-level query variable
class VariableDefinition < AbstractNode
scalar_methods :name, :type, :default_value
children_methods(directives: Directive)
# @!attribute default_value
# @return [String, Integer, Float, Boolean, Array, NullValue] A Ruby value to use if no other value is provided
# @!attribute type
# @return [TypeName, NonNullType, ListType] The expected type of this value
# @!attribute name
# @return [String] The identifier for this variable, _without_ `$`
self.children_method_name = :variables
end
# A query, mutation or subscription.
# May be anonymous or named.
# May be explicitly typed (eg `mutation { ... }`) or implicitly a query (eg `{ ... }`).
class OperationDefinition < AbstractNode
scalar_methods :operation_type, :name
children_methods({
variables: GraphQL::Language::Nodes::VariableDefinition,
directives: GraphQL::Language::Nodes::Directive,
selections: GraphQL::Language::Nodes::Field,
})
# @!attribute variables
# @return [Array<VariableDefinition>] Variable $definitions for this operation
# @!attribute selections
# @return [Array<Field>] Root-level fields on this operation
# @!attribute operation_type
# @return [String, nil] The root type for this operation, or `nil` for implicit `"query"`
# @!attribute name
# @return [String, nil] The name for this operation, or `nil` if unnamed
self.children_method_name = :definitions
end
# This is the AST root for normal queries
#
# @example Deriving a document by parsing a string
# document = GraphQL.parse(query_string)
#
# @example Creating a string from a document
# document.to_query_string
# # { ... }
#
# @example Creating a custom string from a document
# class VariableScrubber < GraphQL::Language::Printer
# def print_argument(arg)
# print_string("#{arg.name}: <HIDDEN>")
# end
# end
#
# document.to_query_string(printer: VariableScrubber.new)
#
class Document < AbstractNode
scalar_methods false
children_methods(definitions: nil)
# @!attribute definitions
# @return [Array<OperationDefinition, FragmentDefinition>] top-level GraphQL units: operations or fragments
def slice_definition(name)
GraphQL::Language::DefinitionSlice.slice(self, name)
end
end
# A type name, used for variable definitions
class TypeName < NameOnlyNode
end
# Usage of a variable in a query. Name does _not_ include `$`.
class VariableIdentifier < NameOnlyNode
self.children_method_name = :value
end
class SchemaDefinition < AbstractNode
scalar_methods :query, :mutation, :subscription
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :definitions
end
class SchemaExtension < AbstractNode
scalar_methods :query, :mutation, :subscription
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :definitions
end
class ScalarTypeDefinition < AbstractNode
attr_reader :description
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :definitions
end
class ScalarTypeExtension < AbstractNode
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :definitions
end
class InputValueDefinition < AbstractNode
attr_reader :description
scalar_methods :name, :type, :default_value
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :fields
end
class FieldDefinition < AbstractNode
attr_reader :description
scalar_methods :name, :type
children_methods({
arguments: GraphQL::Language::Nodes::InputValueDefinition,
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :fields
# this is so that `children_method_name` of `InputValueDefinition` works properly
# with `#replace_child`
alias :fields :arguments
def merge(new_options)
if (f = new_options.delete(:fields))
new_options[:arguments] = f
end
super
end
end
class ObjectTypeDefinition < AbstractNode
attr_reader :description
scalar_methods :name, :interfaces
children_methods({
directives: GraphQL::Language::Nodes::Directive,
fields: GraphQL::Language::Nodes::FieldDefinition,
})
self.children_method_name = :definitions
end
class ObjectTypeExtension < AbstractNode
scalar_methods :name, :interfaces
children_methods({
directives: GraphQL::Language::Nodes::Directive,
fields: GraphQL::Language::Nodes::FieldDefinition,
})
self.children_method_name = :definitions
end
class InterfaceTypeDefinition < AbstractNode
attr_reader :description
scalar_methods :name
children_methods({
interfaces: GraphQL::Language::Nodes::TypeName,
directives: GraphQL::Language::Nodes::Directive,
fields: GraphQL::Language::Nodes::FieldDefinition,
})
self.children_method_name = :definitions
end
class InterfaceTypeExtension < AbstractNode
scalar_methods :name
children_methods({
interfaces: GraphQL::Language::Nodes::TypeName,
directives: GraphQL::Language::Nodes::Directive,
fields: GraphQL::Language::Nodes::FieldDefinition,
})
self.children_method_name = :definitions
end
class UnionTypeDefinition < AbstractNode
attr_reader :description, :types
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :definitions
end
class UnionTypeExtension < AbstractNode
attr_reader :types
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :definitions
end
class EnumValueDefinition < AbstractNode
attr_reader :description
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
})
self.children_method_name = :values
end
class EnumTypeDefinition < AbstractNode
attr_reader :description
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
values: GraphQL::Language::Nodes::EnumValueDefinition,
})
self.children_method_name = :definitions
end
class EnumTypeExtension < AbstractNode
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
values: GraphQL::Language::Nodes::EnumValueDefinition,
})
self.children_method_name = :definitions
end
class InputObjectTypeDefinition < AbstractNode
attr_reader :description
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
fields: GraphQL::Language::Nodes::InputValueDefinition,
})
self.children_method_name = :definitions
end
class InputObjectTypeExtension < AbstractNode
scalar_methods :name
children_methods({
directives: GraphQL::Language::Nodes::Directive,
fields: GraphQL::Language::Nodes::InputValueDefinition,
})
self.children_method_name = :definitions
end
end
end
end
|