Class: GraphQL::Client::Definition

Inherits:
Module
  • Object
show all
Defined in:
lib/graphql/client.rb

Overview

Definitions are constructed by Client.parse and wrap a parsed AST of the query string as well as hold references to any external query definition dependencies.

Definitions MUST be assigned to a constant.

Direct Known Subclasses

FragmentDefinition, OperationDefinition

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(node:, document:) ⇒ Definition

Returns a new instance of Definition.



91
92
93
94
 
# File 'lib/graphql/client.rb', line 91

def initialize(node:, document:)
  @definition_node = node
  @document = document
end

Instance Attribute Details

#definition_node ⇒ Object (readonly)

Internal: Get underlying operation or fragment defintion AST node for definition.

Returns OperationDefinition or FragmentDefinition object.



100
101
102
 
# File 'lib/graphql/client.rb', line 100

def definition_node
  @definition_node
end

#document ⇒ Object (readonly)

Public: Get document with only the definitions needed to perform this operation.

Returns GraphQL::Language::Nodes::Document with one OperationDefinition and any FragmentDefinition dependencies.



124
125
126
 
# File 'lib/graphql/client.rb', line 124

def document
  @document
end

Class Method Details

.for(node:, **kargs) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/graphql/client.rb', line 80

def self.for(node:, **kargs)
  case node
  when Language::Nodes::OperationDefinition
    OperationDefinition.new(node: node, **kargs)
  when Language::Nodes::FragmentDefinition
    FragmentDefinition.new(node: node, **kargs)
  else
    raise TypeError, "expected node to be a definition type, but was #{node.class}"
  end
end

Instance Method Details

#definition_name ⇒ Object

Public: Global name of definition in client document.

Returns a GraphQL safe name of the Ruby constant String.

"Users::UserQuery" #=> "Users__UserQuery"

Returns String.



109
110
111
112
113
114
115
116
117
 
# File 'lib/graphql/client.rb', line 109

def definition_name
  return @definition_name if defined?(@definition_name)

  if name
    @definition_name = name.gsub("::", "__").freeze
  else
    "#{self.class.name}_#{object_id}".gsub("::", "__").freeze
  end
end

#new(*args) ⇒ Object 



126
127
128
 
# File 'lib/graphql/client.rb', line 126

def new(*args)
  type.new(*args)
end

#type ⇒ Object 



130
131
132
133
 
# File 'lib/graphql/client.rb', line 130

def type
  # TODO: Fix type indirection
  @type ||= GraphQL::Client::QueryResult.wrap(definition_node, name: "#{name}.type")
end