Module: GraphQL::Client::TypeStack

Included in:
DefinitionVariables::VariablesVisitor, DocumentTypes::AnalyzeTypesVisitor
Defined in:
lib/graphql/client/type_stack.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#argument_definitions ⇒ Array<GraphQL::Node::Argument> (readonly)

Returns arguments which have been entered.

Returns:

  • (Array<GraphQL::Node::Argument>) —

    arguments which have been entered



23
24
25
 
# File 'lib/graphql/client/type_stack.rb', line 23

def argument_definitions
  @argument_definitions
end

#directive_definitions ⇒ Array<GraphQL::Node::Directive> (readonly)

Directives are pushed on, then popped off while traversing the tree

Returns:

  • (Array<GraphQL::Node::Directive>) —

    directives which have been entered



20
21
22
 
# File 'lib/graphql/client/type_stack.rb', line 20

def directive_definitions
  @directive_definitions
end

#field_definitions ⇒ Array<GraphQL::Field> (readonly)

When it enters a field, it’s pushed on this stack (useful for nested fields, args). When it exits, it’s popped off.

Returns:

  • (Array<GraphQL::Field>) —

    fields which have been entered



16
17
18
 
# File 'lib/graphql/client/type_stack.rb', line 16

def field_definitions
  @field_definitions
end

#object_types ⇒ Array<GraphQL::ObjectType, GraphQL::Union, GraphQL::Interface> (readonly)

When it enters an object (starting with query or mutation root), it’s pushed on this stack. When it exits, it’s popped off.

Returns:

  • (Array<GraphQL::ObjectType, GraphQL::Union, GraphQL::Interface>) 


11
12
13
 
# File 'lib/graphql/client/type_stack.rb', line 11

def object_types
  @object_types
end

#path ⇒ Array<String> (readonly)

Returns fields which have been entered (by their AST name).

Returns:

  • (Array<String>) —

    fields which have been entered (by their AST name)



26
27
28
 
# File 'lib/graphql/client/type_stack.rb', line 26

def path
  @path
end

#schema ⇒ GraphQL::Schema (readonly)

Returns the schema whose types are present in this document.

Returns:

  • (GraphQL::Schema) —

    the schema whose types are present in this document



6
7
8
 
# File 'lib/graphql/client/type_stack.rb', line 6

def schema
  @schema
end

Instance Method Details

#initialize(document, schema:, **rest) ⇒ Object

Parameters:

  • schema (GraphQL::Schema) —

    the schema whose types to use when climbing this document

  • visitor (GraphQL::Language::Visitor) —

    a visitor to follow & watch the types



30
31
32
33
34
35
36
37
38
 
# File 'lib/graphql/client/type_stack.rb', line 30

def initialize(document, schema:, **rest)
  @schema = schema
  @object_types = []
  @field_definitions = []
  @directive_definitions = []
  @argument_definitions = []
  @path = []
  super(document, **rest)
end

#on_argument(node, parent) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/graphql/client/type_stack.rb', line 68

def on_argument(node, parent)
  if @argument_definitions.last
    arg_type = @argument_definitions.last.type.unwrap
    if arg_type.kind.input_object?
      argument_defn = arg_type.arguments[node.name]
    else
      argument_defn = nil
    end
  elsif @directive_definitions.last
    argument_defn = @directive_definitions.last.arguments[node.name]
  elsif @field_definitions.last
    argument_defn = @field_definitions.last.arguments[node.name]
  else
    argument_defn = nil
  end
  @argument_definitions.push(argument_defn)
  @path.push(node.name)
  super(node, parent)
ensure
  @argument_definitions.pop
  @path.pop
end

#on_directive(node, parent) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/graphql/client/type_stack.rb', line 40

def on_directive(node, parent)
  directive_defn = @schema.directives[node.name]
  @directive_definitions.push(directive_defn)
  super(node, parent)
ensure
  @directive_definitions.pop
end

#on_field(node, parent) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/graphql/client/type_stack.rb', line 48

def on_field(node, parent)
  parent_type = @object_types.last
  parent_type = parent_type.unwrap

  field_definition = @schema.get_field(parent_type, node.name)
  @field_definitions.push(field_definition)
  if !field_definition.nil?
    next_object_type = field_definition.type
    @object_types.push(next_object_type)
  else
    @object_types.push(nil)
  end
  @path.push(node.alias || node.name)
  super(node, parent)
ensure
  @field_definitions.pop
  @object_types.pop
  @path.pop
end

#on_fragment_definition(node, parent) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/graphql/client/type_stack.rb', line 119

def on_fragment_definition(node, parent)
  object_type = if node.type
                  @schema.get_type(node.type.name)
                else
                  @object_types.last
                end
  if !object_type.nil?
    object_type = object_type.unwrap
  end
  @object_types.push(object_type)
  @path.push("fragment #{node.name}")
  super(node, parent)
ensure
  @object_types.pop
  @path.pop
end

#on_fragment_spread(node, parent) ⇒ Object 



136
137
138
139
140
141
 
# File 'lib/graphql/client/type_stack.rb', line 136

def on_fragment_spread(node, parent)
  @path.push("... #{node.name}")
  super(node, parent)
ensure
  @path.pop
end

#on_inline_fragment(node, parent) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/graphql/client/type_stack.rb', line 102

def on_inline_fragment(node, parent)
  object_type = if node.type
                  @schema.get_type(node.type.name)
                else
                  @object_types.last
                end
  if !object_type.nil?
    object_type = object_type.unwrap
  end
  @object_types.push(object_type)
  @path.push("...#{node.type ? " on #{node.type.to_query_string}" : ""}")
  super(node, parent)
ensure
  @object_types.pop
  @path.pop
end

#on_operation_definition(node, parent) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/graphql/client/type_stack.rb', line 91

def on_operation_definition(node, parent)
  # eg, QueryType, MutationType
  object_type = @schema.root_type_for_operation(node.operation_type)
  @object_types.push(object_type)
  @path.push("#{node.operation_type}#{node.name ? " #{node.name}" : ""}")
  super(node, parent)
ensure
  @object_types.pop
  @path.pop
end