Module: GraphQL::Schema::Member::HasArguments Private
- Included in:
- Directive, Field, InputObject, Resolver
- Defined in:
- lib/graphql/schema/member/has_arguments.rb
This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.
Defined Under Namespace
Modules: ArgumentClassAccessor, ArgumentObjectLoader
Constant Summary collapse
- NO_ARGUMENTS =
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.
{}.freeze
Instance Method Summary collapse
-
#add_argument(arg_defn) ⇒ GraphQL::Schema::Argument
private
Register this argument with the class.
-
#argument(*args, **kwargs, &block) ⇒ GraphQL::Schema::Argument
private
An instance of arguments_class, created from
*args
. -
#argument_class(new_arg_class = nil) ⇒ Object
private
-
#arguments ⇒ Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions
private
Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name.
-
#arguments_statically_coercible? ⇒ Boolean
private
-
#coerce_arguments(parent_object, values, context) ⇒ Hash<Symbol, Object>, Execution::Lazy<Hash>
private
-
#get_argument(argument_name) ⇒ GraphQL::Schema::Argument?
private
Argument defined on this thing, fetched by name.
-
#own_arguments ⇒ Object
private
Instance Method Details
#add_argument(arg_defn) ⇒ GraphQL::Schema::Argument
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.
Register this argument with the class.
45 46 47 48 49 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 45 def add_argument(arg_defn) @own_arguments ||= {} own_arguments[arg_defn.name] = arg_defn arg_defn end |
#argument(*args, **kwargs, &block) ⇒ GraphQL::Schema::Argument
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.
Returns An instance of arguments_class, created from *args
.
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 18 def argument(*args, **kwargs, &block) kwargs[:owner] = self loads = kwargs[:loads] if loads name = args[0] name_as_string = name.to_s inferred_arg_name = case name_as_string when /_id$/ name_as_string.sub(/_id$/, "").to_sym when /_ids$/ name_as_string.sub(/_ids$/, "") .sub(/([^s])$/, "\\1s") .to_sym else name end kwargs[:as] ||= inferred_arg_name end arg_defn = self.argument_class.new(*args, **kwargs, &block) add_argument(arg_defn) end |
#argument_class(new_arg_class = 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.
79 80 81 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 79 def argument_class(new_arg_class = nil) self.class.argument_class(new_arg_class) end |
#arguments ⇒ Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions
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.
Returns Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions.
52 53 54 55 56 57 58 59 60 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 52 def arguments inherited_arguments = ((self.is_a?(Class) && superclass.respond_to?(:arguments)) ? superclass.arguments : nil) # Local definitions override inherited ones if inherited_arguments inherited_arguments.merge(own_arguments) else own_arguments end end |
#arguments_statically_coercible? ⇒ Boolean
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.
155 156 157 158 159 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 155 def arguments_statically_coercible? return @arguments_statically_coercible if defined?(@arguments_statically_coercible) @arguments_statically_coercible = arguments.each_value.all?(&:statically_coercible?) end |
#coerce_arguments(parent_object, values, context) ⇒ Hash<Symbol, Object>, Execution::Lazy<Hash>
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.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 87 def coerce_arguments(parent_object, values, context) argument_values = {} kwarg_arguments = {} # Cache this hash to avoid re-merging it arg_defns = self.arguments maybe_lazies = [] arg_lazies = arg_defns.map do |arg_name, arg_defn| arg_key = arg_defn.keyword has_value = false default_used = false if values.key?(arg_name) has_value = true value = values[arg_name] elsif values.key?(arg_key) has_value = true value = values[arg_key] elsif arg_defn.default_value? has_value = true value = arg_defn.default_value default_used = true end if has_value loads = arg_defn.loads loaded_value = nil if loads && !arg_defn.from_resolver? loaded_value = if arg_defn.type.list? loaded_values = value.map { |val| load_application_object(arg_defn, loads, val, context) } context.schema.after_any_lazies(loaded_values) { |result| result } else load_application_object(arg_defn, loads, value, context) end end coerced_value = if loaded_value loaded_value else context.schema.error_handler.with_error_handling(context) do arg_defn.type.coerce_input(value, context) end end context.schema.after_lazy(coerced_value) do |coerced_value| prepared_value = context.schema.error_handler.with_error_handling(context) do arg_defn.prepare_value(parent_object, coerced_value, context: context) end kwarg_arguments[arg_key] = prepared_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: prepared_value, definition: arg_defn, default_used: default_used, ) end end end maybe_lazies.concat(arg_lazies) context.schema.after_any_lazies(maybe_lazies) do GraphQL::Execution::Interpreter::Arguments.new( keyword_arguments: kwarg_arguments, argument_values: argument_values, ) end end |
#get_argument(argument_name) ⇒ GraphQL::Schema::Argument?
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.
Returns Argument defined on this thing, fetched by name.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 63 def get_argument(argument_name) a = own_arguments[argument_name] if a || !self.is_a?(Class) a else for ancestor in ancestors if ancestor.respond_to?(:own_arguments) && a = ancestor.own_arguments[argument_name] return a end end nil end end |
#own_arguments ⇒ 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.
234 235 236 |
# File 'lib/graphql/schema/member/has_arguments.rb', line 234 def own_arguments @own_arguments || NO_ARGUMENTS end |