Class: GraphQL::Client::Definition
- Inherits:
-
Module
- Object
- Module
- GraphQL::Client::Definition
- 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
Instance Attribute Summary collapse
-
#definition_node ⇒ Object
readonly
Internal: Get underlying operation or fragment defintion AST node for definition.
-
#document ⇒ Object
readonly
Public: Get document with only the definitions needed to perform this operation.
-
#document_types ⇒ Object
readonly
Internal: Mapping of document nodes to schema types.
-
#enforce_collocated_callers ⇒ Object
readonly
Returns the value of attribute enforce_collocated_callers.
-
#schema ⇒ Object
readonly
Returns the value of attribute schema.
-
#source_location ⇒ Object
readonly
Public: Returns the Ruby source filename and line number containing this definition was not defined in Ruby.
Class Method Summary collapse
Instance Method Summary collapse
-
#definition_name ⇒ Object
Public: Global name of definition in client document.
-
#initialize(node:, document:, schema:, document_types:, source_location:, enforce_collocated_callers:) ⇒ Definition
constructor
A new instance of Definition.
- #new(*args) ⇒ Object
- #type ⇒ Object
Constructor Details
#initialize(node:, document:, schema:, document_types:, source_location:, enforce_collocated_callers:) ⇒ Definition
Returns a new instance of Definition.
107 108 109 110 111 112 113 114 |
# File 'lib/graphql/client.rb', line 107 def initialize(node:, document:, schema:, document_types:, source_location:, enforce_collocated_callers:) @definition_node = node @document = document @schema = schema @document_types = document_types @source_location = source_location @enforce_collocated_callers = enforce_collocated_callers end |
Instance Attribute Details
#definition_node ⇒ Object (readonly)
Internal: Get underlying operation or fragment defintion AST node for definition.
Returns OperationDefinition or FragmentDefinition object.
120 121 122 |
# File 'lib/graphql/client.rb', line 120 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.
144 145 146 |
# File 'lib/graphql/client.rb', line 144 def document @document end |
#document_types ⇒ Object (readonly)
Internal: Mapping of document nodes to schema types.
147 148 149 |
# File 'lib/graphql/client.rb', line 147 def document_types @document_types end |
#enforce_collocated_callers ⇒ Object (readonly)
Returns the value of attribute enforce_collocated_callers.
157 158 159 |
# File 'lib/graphql/client.rb', line 157 def enforce_collocated_callers @enforce_collocated_callers end |
#schema ⇒ Object (readonly)
Returns the value of attribute schema.
149 150 151 |
# File 'lib/graphql/client.rb', line 149 def schema @schema end |
#source_location ⇒ Object (readonly)
Public: Returns the Ruby source filename and line number containing this definition was not defined in Ruby.
Returns Array pair of [String, Fixnum].
155 156 157 |
# File 'lib/graphql/client.rb', line 155 def source_location @source_location end |
Class Method Details
.for(node:, **kargs) ⇒ Object
96 97 98 99 100 101 102 103 104 105 |
# File 'lib/graphql/client.rb', line 96 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.
129 130 131 132 133 134 135 136 137 |
# File 'lib/graphql/client.rb', line 129 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
159 160 161 |
# File 'lib/graphql/client.rb', line 159 def new(*args) type.new(*args) end |
#type ⇒ Object
163 164 165 166 |
# File 'lib/graphql/client.rb', line 163 def type # TODO: Fix type indirection @type ||= GraphQL::Client::QueryResult.wrap(self, definition_node, name: "#{name}.type") end |