Class: GraphQL::Schema::InputObject

Inherits:
Member
  • Object
show all
Extended by:
Forwardable, Member::AcceptsDefinition, Member::HasArguments, Member::HasArguments::ArgumentObjectLoader, Member::HasValidators, Member::ValidatesInput
Includes:
Dig
Defined in:
lib/graphql/schema/input_object.rb

Constant Summary collapse

INVALID_OBJECT_MESSAGE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"Expected %{object} to be a key-value object responding to `to_h` or `to_unsafe_h`."

Constants included from Member::HasArguments

Member::HasArguments::NO_ARGUMENTS

Constants included from FindInheritedValue::EmptyObjects

FindInheritedValue::EmptyObjects::EMPTY_ARRAY, FindInheritedValue::EmptyObjects::EMPTY_HASH

Constants included from Member::HasDirectives

Member::HasDirectives::NO_DIRECTIVES

Constants included from Member::GraphQLTypeNames

Member::GraphQLTypeNames::Boolean, Member::GraphQLTypeNames::ID, Member::GraphQLTypeNames::Int

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Member::HasArguments

add_argument, argument, argument_class, arguments_statically_coercible?, coerce_arguments, get_argument, own_arguments, validate_directive_argument

Methods included from Member::HasArguments::ArgumentObjectLoader

load_application_object, load_application_object_failed, object_from_id

Methods included from Member::ValidatesInput

coerce_isolated_input, coerce_isolated_result, valid_input?, valid_isolated_input?, validate_input

Methods included from Member::HasValidators

validates, validators

Methods included from Dig

#dig

Methods included from Member::CachedGraphQLDefinition

#graphql_definition, #initialize_copy, #type_class

Methods included from Relay::TypeExtensions

#connection_type, #define_connection, #define_edge, #edge_type

Methods included from Member::BaseDSLMethods

#accessible?, #authorized?, #default_graphql_name, #description, #graphql_name, #introspection, #introspection?, #mutation, #name, #overridden_graphql_name, #to_graphql, #visible?

Methods included from Member::BaseDSLMethods::ConfigurationExtension

#inherited

Methods included from Member::TypeSystemHelpers

#kind, #list?, #non_null?, #to_list_type, #to_non_null_type, #to_type_signature

Methods included from Member::Scoped

#scope_items

Methods included from Member::RelayShortcuts

#connection_type, #connection_type_class, #edge_type, #edge_type_class

Methods included from Member::HasPath

#path

Methods included from Member::HasAstNode

#ast_node

Methods included from Member::HasDirectives

#directive, #directives, #remove_directive

Constructor Details

#initialize(arguments = nil, ruby_kwargs: nil, context:, defaults_used:) ⇒ InputObject

Returns a new instance of InputObject.



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
# File 'lib/graphql/schema/input_object.rb', line 14

def initialize(arguments = nil, ruby_kwargs: nil, context:, defaults_used:)
  @context = context
  if ruby_kwargs
    @ruby_style_hash = ruby_kwargs
    @arguments = arguments
  else
    @arguments = self.class.arguments_class.new(arguments, context: context, defaults_used: defaults_used)
    # Symbolized, underscored hash:
    @ruby_style_hash = @arguments.to_kwargs
  end
  # Apply prepares, not great to have it duplicated here.
  maybe_lazies = []
  self.class.arguments.each_value do |arg_defn|
    ruby_kwargs_key = arg_defn.keyword

    if @ruby_style_hash.key?(ruby_kwargs_key)
      loads = arg_defn.loads
      # Resolvers do this loading themselves;
      # With the interpreter, it's done during `coerce_arguments`
      if loads && !arg_defn.from_resolver? && !context.interpreter?
        value = @ruby_style_hash[ruby_kwargs_key]
        loaded_value = if arg_defn.type.list?
          value.map { |val| load_application_object(arg_defn, loads, val, context) }
        else
          load_application_object(arg_defn, loads, value, context)
        end
        maybe_lazies << context.schema.after_lazy(loaded_value) do |loaded_value|
          overwrite_argument(ruby_kwargs_key, loaded_value)
        end
      end

      # Weirdly, procs are applied during coercion, but not methods.
      # Probably because these methods require a `self`.
      if arg_defn.prepare.is_a?(Symbol) || context.nil? || !context.interpreter?
        prepared_value = arg_defn.prepare_value(self, @ruby_style_hash[ruby_kwargs_key])
        overwrite_argument(ruby_kwargs_key, prepared_value)
      end
    end
  end

  @maybe_lazies = maybe_lazies
end

Class Attribute Details

.arguments_classClass<GraphQL::Arguments>

Returns:

  • (Class<GraphQL::Arguments>)


128
129
130
# File 'lib/graphql/schema/input_object.rb', line 128

def arguments_class
  @arguments_class
end

Instance Attribute Details

#argumentsGraphQL::Query::Arguments, GraphQL::Execution::Interpereter::Arguments (readonly)

Returns The underlying arguments instance.

Returns:



61
62
63
# File 'lib/graphql/schema/input_object.rb', line 61

def arguments
  @arguments
end

#contextGraphQL::Query::Context (readonly)

Returns The context for this query.

Returns:



58
59
60
# File 'lib/graphql/schema/input_object.rb', line 58

def context
  @context
end

Class Method Details

.argument(*args, **kwargs, &block) ⇒ Object



130
131
132
133
134
135
136
137
138
139
# File 'lib/graphql/schema/input_object.rb', line 130

def argument(*args, **kwargs, &block)
  argument_defn = super(*args, **kwargs, &block)
  # Add a method access
  method_name = argument_defn.keyword
  class_eval <<-RUBY, __FILE__, __LINE__
    def #{method_name}
      self[#{method_name.inspect}]
    end
  RUBY
end

.coerce_input(value, ctx) ⇒ Object



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/graphql/schema/input_object.rb', line 209

def coerce_input(value, ctx)
  if value.nil?
    return nil
  end

  arguments = coerce_arguments(nil, value, ctx)

  ctx.schema.after_lazy(arguments) do |resolved_arguments|
    if resolved_arguments.is_a?(GraphQL::Error)
      raise resolved_arguments
    else
      input_obj_instance = self.new(resolved_arguments, ruby_kwargs: resolved_arguments.keyword_arguments, context: ctx, defaults_used: nil)
      input_obj_instance.prepare
    end
  end
end

.coerce_result(value, ctx) ⇒ Object

It’s funny to think of a result of an input object. This is used for rendering the default value in introspection responses.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/graphql/schema/input_object.rb', line 228

def coerce_result(value, ctx)
  # Allow the application to provide values as :symbols, and convert them to the strings
  value = value.reduce({}) { |memo, (k, v)| memo[k.to_s] = v; memo }

  result = {}

  arguments.each do |input_key, input_field_defn|
    input_value = value[input_key]
    if value.key?(input_key)
      result[input_key] = if input_value.nil?
        nil
      else
        input_field_defn.type.coerce_result(input_value, ctx)
      end
    end
  end

  result
end

.kindObject



158
159
160
# File 'lib/graphql/schema/input_object.rb', line 158

def kind
  GraphQL::TypeKinds::INPUT_OBJECT
end

.to_graphqlObject



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/graphql/schema/input_object.rb', line 141

def to_graphql
  type_defn = GraphQL::InputObjectType.new
  type_defn.name = graphql_name
  type_defn.description = description
  type_defn.[:type_class] = self
  type_defn.mutation = mutation
  type_defn.ast_node = ast_node
  arguments.each do |name, arg|
    type_defn.arguments[arg.graphql_definition.name] = arg.graphql_definition
  end
  # Make a reference to a classic-style Arguments class
  self.arguments_class = GraphQL::Query::Arguments.construct_arguments_class(type_defn)
  # But use this InputObject class at runtime
  type_defn.arguments_class = self
  type_defn
end

.validate_non_null_input(input, ctx) ⇒ Object



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
# File 'lib/graphql/schema/input_object.rb', line 166

def validate_non_null_input(input, ctx)
  result = GraphQL::Query::InputValidationResult.new

  warden = ctx.warden

  if input.is_a?(Array)
    result.add_problem(INVALID_OBJECT_MESSAGE % { object: JSON.generate(input, quirks_mode: true) })
    return result
  end

  if !(input.respond_to?(:to_h) || input.respond_to?(:to_unsafe_h))
    # We're not sure it'll act like a hash, so reject it:
    result.add_problem(INVALID_OBJECT_MESSAGE % { object: JSON.generate(input, quirks_mode: true) })
    return result
  end

  # Inject missing required arguments
  missing_required_inputs = self.arguments.reduce({}) do |m, (argument_name, argument)|
    if !input.key?(argument_name) && argument.type.non_null? && warden.get_argument(self, argument_name)
      m[argument_name] = nil
    end

    m
  end


  [input, missing_required_inputs].each do |args_to_validate|
    args_to_validate.each do |argument_name, value|
      argument = warden.get_argument(self, argument_name)
      # Items in the input that are unexpected
      unless argument
        result.add_problem("Field is not defined on #{self.graphql_name}", [argument_name])
        next
      end
      # Items in the input that are expected, but have invalid values
      argument_result = argument.type.validate_input(value, ctx)
      result.merge_result!(argument_name, argument_result) unless argument_result.valid?
    end
  end

  result
end

Instance Method Details

#[](key) ⇒ Object

Lookup a key on this object, it accepts new-style underscored symbols Or old-style camelized identifiers.

Parameters:

  • key (Symbol, String)


107
108
109
110
111
112
113
114
115
# File 'lib/graphql/schema/input_object.rb', line 107

def [](key)
  if @ruby_style_hash.key?(key)
    @ruby_style_hash[key]
  elsif @arguments
    @arguments[key]
  else
    nil
  end
end

#key?(key) ⇒ Boolean

Returns:



117
118
119
# File 'lib/graphql/schema/input_object.rb', line 117

def key?(key)
  @ruby_style_hash.key?(key) || (@arguments && @arguments.key?(key)) || false
end

#prepareObject



76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/graphql/schema/input_object.rb', line 76

def prepare
  if context
    context.schema.after_any_lazies(@maybe_lazies) do
      object = context[:current_object]
      # Pass this object's class with `as` so that messages are rendered correctly from inherited validators
      Schema::Validator.validate!(self.class.validators, object, context, @ruby_style_hash, as: self.class)
      self
    end
  else
    self
  end
end

#to_hObject



66
67
68
69
70
# File 'lib/graphql/schema/input_object.rb', line 66

def to_h
  @ruby_style_hash.inject({}) do |h, (key, value)|
    h.merge(key => unwrap_value(value))
  end
end

#to_hashObject



72
73
74
# File 'lib/graphql/schema/input_object.rb', line 72

def to_hash
  to_h
end

#to_kwargsObject

A copy of the Ruby-style hash



122
123
124
# File 'lib/graphql/schema/input_object.rb', line 122

def to_kwargs
  @ruby_style_hash.dup
end

#unwrap_value(value) ⇒ Object



89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/graphql/schema/input_object.rb', line 89

def unwrap_value(value)
  case value
  when Array
    value.map { |item| unwrap_value(item) }
  when Hash
    value.inject({}) do |h, (key, value)|
      h.merge(key => unwrap_value(value))
    end
  when InputObject
    value.to_h
  else
    value
  end
end