Class: GraphQL::Schema::Argument
- Inherits:
-
Object
- Object
- GraphQL::Schema::Argument
- Includes:
- EmptyObjects, Member::HasAstNode, Member::HasDeprecationReason, Member::HasDirectives, Member::HasPath, Member::HasValidators
- Defined in:
- lib/graphql/schema/argument.rb
Defined Under Namespace
Classes: InvalidDefaultValueError
Constant Summary
Constants included from EmptyObjects
EmptyObjects::EMPTY_ARRAY, EmptyObjects::EMPTY_HASH
Instance Attribute Summary collapse
-
#comment(text = nil) ⇒ String
Comment for this argument.
-
#description(text = nil) ⇒ String
Documentation for this argument.
-
#keyword ⇒ Symbol
readonly
This argument’s name in Ruby keyword arguments.
-
#loads ⇒ Class, ...
readonly
If this argument should load an application object, this is the type of object to load.
-
#name ⇒ String
(also: #graphql_name)
readonly
The GraphQL name for this argument, camelized unless
camelize: false
is provided. -
#owner ⇒ GraphQL::Schema::Field, Class
readonly
The field or input object this argument belongs to.
Attributes included from Member::HasAstNode
Instance Method Summary collapse
-
#authorized?(obj, value, ctx) ⇒ Boolean
-
#authorized_as_type?(obj, value, ctx, as_type:) ⇒ Boolean
-
#coerce_into_values(parent_object, values, context, argument_values) ⇒ Object
private
-
#default_value(new_default_value = NOT_CONFIGURED) ⇒ Object
The value used when the client doesn’t provide a value for this argument.
-
#default_value? ⇒ Boolean
True if this argument has a default value.
-
#deprecation_reason(text = nil) ⇒ String
Deprecation reason for this argument.
-
#deprecation_reason=(new_reason) ⇒ Object
-
#from_resolver? ⇒ Boolean
True if a resolver defined this argument.
-
#initialize(arg_name = nil, type_expr = nil, desc = nil, required: true, type: nil, name: nil, loads: nil, description: nil, comment: nil, ast_node: nil, default_value: NOT_CONFIGURED, as: nil, from_resolver: false, camelize: true, prepare: nil, owner:, validates: nil, directives: nil, deprecation_reason: nil, replace_null_with_default: false, &definition_block) ⇒ Argument
constructor
A new instance of Argument.
-
#inspect ⇒ Object
-
#load_and_authorize_value(load_method_owner, coerced_value, context) ⇒ Object
-
#prepare(new_prepare = NOT_CONFIGURED) ⇒ Symbol
A method or proc to call to transform this value before sending it to field resolution method.
-
#prepare_value(obj, value, context: nil) ⇒ Object
private
Apply the #prepare configuration to
value
, using methods fromobj
. -
#replace_null_with_default? ⇒ Boolean
-
#statically_coercible? ⇒ Boolean
-
#type ⇒ Object
-
#type=(new_type) ⇒ Object
-
#validate_default_value ⇒ Object
private
-
#visible?(context) ⇒ Boolean
Methods included from Member::HasValidators
Methods included from Member::HasDirectives
add_directive, #directive, #directives, get_directives, #inherited, #remove_directive, remove_directive
Methods included from Member::HasAstNode
Methods included from Member::HasPath
Constructor Details
#initialize(arg_name = nil, type_expr = nil, desc = nil, required: true, type: nil, name: nil, loads: nil, description: nil, comment: nil, ast_node: nil, default_value: NOT_CONFIGURED, as: nil, from_resolver: false, camelize: true, prepare: nil, owner:, validates: nil, directives: nil, deprecation_reason: nil, replace_null_with_default: false, &definition_block) ⇒ Argument
Returns a new instance of Argument.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/graphql/schema/argument.rb', line 53 def initialize(arg_name = nil, type_expr = nil, desc = nil, required: true, type: nil, name: nil, loads: nil, description: nil, comment: nil, ast_node: nil, default_value: NOT_CONFIGURED, as: nil, from_resolver: false, camelize: true, prepare: nil, owner:, validates: nil, directives: nil, deprecation_reason: nil, replace_null_with_default: false, &definition_block) arg_name ||= name @name = -(camelize ? Member::BuildType.camelize(arg_name.to_s) : arg_name.to_s) NameValidator.validate!(@name) @type_expr = type_expr || type @description = desc || description @comment = comment @null = required != true @default_value = default_value if replace_null_with_default if !default_value? raise ArgumentError, "`replace_null_with_default: true` requires a default value, please provide one with `default_value: ...`" end @replace_null_with_default = true end @owner = owner @as = as @loads = loads @keyword = as || (arg_name.is_a?(Symbol) ? arg_name : Schema::Member::BuildType.underscore(@name).to_sym) @prepare = prepare @ast_node = ast_node @from_resolver = from_resolver self.deprecation_reason = deprecation_reason if directives directives.each do |dir_class, | directive(dir_class, **) end end if validates && !validates.empty? self.validates(validates) end if required == :nullable self.owner.validates(required: { argument: arg_name }) end if definition_block # `self` will still be self, it will also be the first argument to the block: instance_exec(self, &definition_block) end end |
Instance Attribute Details
#comment(text = nil) ⇒ String
Returns Comment for this argument.
134 135 136 137 138 139 140 |
# File 'lib/graphql/schema/argument.rb', line 134 def comment(text = nil) if text @comment = text else @comment end end |
#description(text = nil) ⇒ String
Returns Documentation for this argument.
123 124 125 126 127 128 129 |
# File 'lib/graphql/schema/argument.rb', line 123 def description(text = nil) if text @description = text else @description end end |
#keyword ⇒ Symbol (readonly)
Returns This argument’s name in Ruby keyword arguments.
29 30 31 |
# File 'lib/graphql/schema/argument.rb', line 29 def keyword @keyword end |
#loads ⇒ Class, ... (readonly)
Returns If this argument should load an application object, this is the type of object to load.
32 33 34 |
# File 'lib/graphql/schema/argument.rb', line 32 def loads @loads end |
#name ⇒ String (readonly) Also known as: graphql_name
Returns the GraphQL name for this argument, camelized unless camelize: false
is provided.
13 14 15 |
# File 'lib/graphql/schema/argument.rb', line 13 def name @name end |
#owner ⇒ GraphQL::Schema::Field, Class (readonly)
Returns The field or input object this argument belongs to.
17 18 19 |
# File 'lib/graphql/schema/argument.rb', line 17 def owner @owner end |
Instance Method Details
#authorized?(obj, value, ctx) ⇒ Boolean
160 161 162 |
# File 'lib/graphql/schema/argument.rb', line 160 def (obj, value, ctx) (obj, value, ctx, as_type: type) end |
#authorized_as_type?(obj, value, ctx, as_type:) ⇒ Boolean
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/graphql/schema/argument.rb', line 164 def (obj, value, ctx, as_type:) if value.nil? return true end if as_type.kind.non_null? as_type = as_type.of_type end if as_type.kind.list? value.each do |v| if !(obj, v, ctx, as_type: as_type.of_type) return false end end elsif as_type.kind.input_object? return as_type.(obj, value, ctx) end # None of the early-return conditions were activated, # so this is authorized. true end |
#coerce_into_values(parent_object, values, context, argument_values) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/graphql/schema/argument.rb', line 250 def coerce_into_values(parent_object, values, context, argument_values) arg_name = graphql_name arg_key = keyword default_used = false if values.key?(arg_name) value = values[arg_name] elsif values.key?(arg_key) value = values[arg_key] elsif default_value? value = default_value default_used = true else # no value at all owner.validate_directive_argument(self, nil) return end if value.nil? && replace_null_with_default? value = default_value default_used = true end loaded_value = nil coerced_value = begin type.coerce_input(value, context) rescue StandardError => err context.schema.handle_or_reraise(context, err) end # If this isn't lazy, then the block returns eagerly and assigns the result here # If it _is_ lazy, then we write the lazy to the hash, then update it later argument_values[arg_key] = context.query.after_lazy(coerced_value) do |resolved_coerced_value| owner.validate_directive_argument(self, resolved_coerced_value) prepared_value = begin prepare_value(parent_object, resolved_coerced_value, context: context) rescue StandardError => err context.schema.handle_or_reraise(context, err) end if loads && !from_resolver? loaded_value = begin (owner, prepared_value, context) rescue StandardError => err context.schema.handle_or_reraise(context, err) end end maybe_loaded_value = loaded_value || prepared_value context.query.after_lazy(maybe_loaded_value) do |resolved_loaded_value| # TODO code smell to access such a deeply-nested constant in a distant module argument_values[arg_key] = GraphQL::Execution::Interpreter::ArgumentValue.new( value: resolved_loaded_value, original_value: resolved_coerced_value, definition: self, default_used: default_used, ) end end end |
#default_value(new_default_value = NOT_CONFIGURED) ⇒ Object
Returns the value used when the client doesn’t provide a value for this argument.
104 105 106 107 108 109 |
# File 'lib/graphql/schema/argument.rb', line 104 def default_value(new_default_value = NOT_CONFIGURED) if new_default_value != NOT_CONFIGURED @default_value = new_default_value end @default_value end |
#default_value? ⇒ Boolean
Returns True if this argument has a default value.
112 113 114 |
# File 'lib/graphql/schema/argument.rb', line 112 def default_value? @default_value != NOT_CONFIGURED end |
#deprecation_reason(text = nil) ⇒ String
Returns Deprecation reason for this argument.
143 144 145 146 147 148 149 |
# File 'lib/graphql/schema/argument.rb', line 143 def deprecation_reason(text = nil) if text self.deprecation_reason = text else super() end end |
#deprecation_reason=(new_reason) ⇒ Object
151 152 153 154 |
# File 'lib/graphql/schema/argument.rb', line 151 def deprecation_reason=(new_reason) validate_deprecated_or_optional(null: @null, deprecation_reason: new_reason) super end |
#from_resolver? ⇒ Boolean
Returns true if a resolver defined this argument.
35 36 37 |
# File 'lib/graphql/schema/argument.rb', line 35 def from_resolver? @from_resolver end |
#inspect ⇒ Object
98 99 100 |
# File 'lib/graphql/schema/argument.rb', line 98 def inspect "#<#{self.class} #{path}: #{type.to_type_signature}#{description ? " @description=#{description.inspect}" : ""}>" end |
#load_and_authorize_value(load_method_owner, coerced_value, context) ⇒ Object
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/graphql/schema/argument.rb', line 311 def (load_method_owner, coerced_value, context) if coerced_value.nil? return nil end arg_load_method = "load_#{keyword}" if load_method_owner.respond_to?(arg_load_method) custom_loaded_value = if load_method_owner.is_a?(Class) load_method_owner.public_send(arg_load_method, coerced_value, context) else load_method_owner.public_send(arg_load_method, coerced_value) end context.query.after_lazy(custom_loaded_value) do |custom_value| if loads if type.list? loaded_values = [] context.dataloader.run_isolated do custom_value.each_with_index.map { |custom_val, idx| id = coerced_value[idx] context.dataloader.append_job do loaded_values[idx] = load_method_owner.(self, id, context, custom_val) end } end context.schema.after_any_lazies(loaded_values, &:itself) else load_method_owner.(self, coerced_value, context, custom_loaded_value) end else custom_value end end elsif loads if type.list? loaded_values = [] # We want to run these list items all together, # but we also need to wait for the result so we can return it :S context.dataloader.run_isolated do coerced_value.each_with_index { |val, idx| context.dataloader.append_job do loaded_values[idx] = load_method_owner.(self, val, context) end } end context.schema.after_any_lazies(loaded_values, &:itself) else load_method_owner.(self, coerced_value, context) end else coerced_value end end |
#prepare(new_prepare = NOT_CONFIGURED) ⇒ Symbol
Returns A method or proc to call to transform this value before sending it to field resolution method.
21 22 23 24 25 26 |
# File 'lib/graphql/schema/argument.rb', line 21 def prepare(new_prepare = NOT_CONFIGURED) if new_prepare != NOT_CONFIGURED @prepare = new_prepare end @prepare end |
#prepare_value(obj, value, context: nil) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Apply the #prepare configuration to value
, using methods from obj
.
Used by the runtime.
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/graphql/schema/argument.rb', line 218 def prepare_value(obj, value, context: nil) if type.unwrap.kind.input_object? value = recursively_prepare_input_object(value, type) end Schema::Validator.validate!(validators, obj, context, value) if @prepare.nil? value elsif @prepare.is_a?(String) || @prepare.is_a?(Symbol) if obj.nil? # The problem here is, we _used to_ prepare while building variables. # But now we don't have the runtime object there. # # This will have to be called later, when the runtime object _is_ available. value elsif obj.respond_to?(@prepare) obj.public_send(@prepare, value) elsif owner.respond_to?(@prepare) owner.public_send(@prepare, value, context || obj.context) else raise "Invalid prepare for #{@owner.name}.name: #{@prepare.inspect}. "\ "Could not find prepare method #{@prepare} on #{obj.class} or #{owner}." end elsif @prepare.respond_to?(:call) @prepare.call(value, context || obj.context) else raise "Invalid prepare for #{@owner.name}.name: #{@prepare.inspect}" end end |
#replace_null_with_default? ⇒ Boolean
116 117 118 |
# File 'lib/graphql/schema/argument.rb', line 116 def replace_null_with_default? @replace_null_with_default end |
#statically_coercible? ⇒ Boolean
209 210 211 212 213 |
# File 'lib/graphql/schema/argument.rb', line 209 def statically_coercible? return @statically_coercible if defined?(@statically_coercible) requires_parent_object = @prepare.is_a?(String) || @prepare.is_a?(Symbol) || @own_validators @statically_coercible = !requires_parent_object end |
#type ⇒ Object
197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/graphql/schema/argument.rb', line 197 def type @type ||= begin parsed_type = begin Member::BuildType.parse_type(@type_expr, null: @null) rescue StandardError => err raise ArgumentError, "Couldn't build type for Argument #{@owner.name}.#{name}: #{err.class.name}: #{err.}", err.backtrace end # Use the setter method to get validations self.type = parsed_type end end |
#type=(new_type) ⇒ Object
187 188 189 190 191 192 193 194 195 |
# File 'lib/graphql/schema/argument.rb', line 187 def type=(new_type) validate_input_type(new_type) # This isn't true for LateBoundTypes, but we can assume those will # be updated via this codepath later in schema setup. if new_type.respond_to?(:non_null?) validate_deprecated_or_optional(null: !new_type.non_null?, deprecation_reason: deprecation_reason) end @type = new_type end |
#validate_default_value ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/graphql/schema/argument.rb', line 364 def validate_default_value return unless default_value? coerced_default_value = begin # This is weird, but we should accept single-item default values for list-type arguments. # If we used `coerce_isolated_input` below, it would do this for us, but it's not really # the right thing here because we expect default values in application format (Ruby values) # not GraphQL format (scalar values). # # But I don't think Schema::List#coerce_result should apply wrapping to single-item lists. prepped_default_value = if default_value.nil? nil elsif (type.kind.list? || (type.kind.non_null? && type.of_type.list?)) && !default_value.respond_to?(:map) [default_value] else default_value end type.coerce_isolated_result(prepped_default_value) unless prepped_default_value.nil? rescue GraphQL::Schema::Enum::UnresolvedValueError # It raises this, which is helpful at runtime, but not here... default_value end res = type.valid_isolated_input?(coerced_default_value) if !res raise InvalidDefaultValueError.new(self) end end |
#visible?(context) ⇒ Boolean
156 157 158 |
# File 'lib/graphql/schema/argument.rb', line 156 def visible?(context) true end |