Class: GraphQL::StaticValidation::BaseVisitor

Inherits:
Language::StaticVisitor show all
Defined in:
lib/graphql/static_validation/base_visitor.rb

Direct Known Subclasses

InterpreterVisitor

Defined Under Namespace

Modules: ContextMethods

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Language::StaticVisitor

make_visit_methods, #on_argument_children, #on_document_children, #on_field_children, #on_fragment_definition_children, #on_operation_definition_children, #visit, #visit_directives, #visit_selections

Constructor Details

#initialize(document, context) ⇒ BaseVisitor

Returns a new instance of BaseVisitor.



5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/graphql/static_validation/base_visitor.rb', line 5

def initialize(document, context)
  @path = []
  @object_types = []
  @directives = []
  @field_definitions = []
  @argument_definitions = []
  @directive_definitions = []
  @context = context
  @types = context.query.types
  @schema = context.schema
  super(document)
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



18
19
20
 
# File 'lib/graphql/static_validation/base_visitor.rb', line 18

def context
  @context
end

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

Returns Types whose scope we've entered.

Returns:

  • (Array<GraphQL::ObjectType>) —

    Types whose scope we've entered



21
22
23
 
# File 'lib/graphql/static_validation/base_visitor.rb', line 21

def object_types
  @object_types
end

Class Method Details

.including_rules(rules) ⇒ Class

Build a class to visit the AST and perform validation, or use a pre-built class if rules is ALL_RULES or empty.

Parameters:

  • rules (Array<Module, Class>)

Returns:

  • (Class) —

    A class for validating rules during visitation



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/graphql/static_validation/base_visitor.rb', line 32

def self.including_rules(rules)
  if rules.empty?
    # It's not doing _anything?!?_
    BaseVisitor
  elsif rules == ALL_RULES
    InterpreterVisitor
  else
    visitor_class = Class.new(self) do
      include(GraphQL::StaticValidation::DefinitionDependencies)
    end

    rules.reverse_each do |r|
      # If it's a class, it gets attached later.
      if !r.is_a?(Class)
        visitor_class.include(r)
      end
    end

    visitor_class.include(ContextMethods)
    visitor_class
  end
end

Instance Method Details

#path ⇒ Array<String>

Returns The nesting of the current position in the AST.

Returns:

  • (Array<String>) —

    The nesting of the current position in the AST



24
25
26
 
# File 'lib/graphql/static_validation/base_visitor.rb', line 24

def path
  @path.dup
end