Update implementation and tests for HasArgument

Author: rmosolgo

lib/graphql/schema/member/has_arguments.rb

@@ -17,28 +17,28 @@ def self.extended(cls)
         # @param arg_name [Symbol] The underscore-cased name of this argument, `name:` keyword also accepted
         # @param type_expr The GraphQL type of this argument; `type:` keyword also accepted
         # @param desc [String] Argument description, `description:` keyword also accepted
-        # @param required [Boolean, :nullable] if true, this argument is non-null; if false, this argument is nullable. If `:nullable`, then the argument must be provided, though it may be `null`.
-        # @param description [String] Positional argument also accepted
-        # @param type [Class, Array<Class>] Input type; positional argument also accepted
-        # @param name [Symbol] positional argument also accepted
-        # @param default_value [Object]
-        # @param loads [Class, Array<Class>] A GraphQL type to load for the given ID when one is present
-        # @param as [Symbol] Override the keyword name when passed to a method
-        # @param prepare [Symbol] A method to call to transform this argument's valuebefore sending it to field resolution
-        # @param camelize [Boolean] if true, the name will be camelized when building the schema
-        # @param from_resolver [Boolean] if true, a Resolver class defined this argument
-        # @param directives [Hash{Class => Hash}]
-        # @param deprecation_reason [String]
-        # @param comment [String] Private, used by GraphQL-Ruby when parsing GraphQL schema files
-        # @param ast_node [GraphQL::Language::Nodes::InputValueDefinition] Private, used by GraphQL-Ruby when parsing schema files
-        # @param validates [Hash, nil] Options for building validators, if any should be applied
-        # @param replace_null_with_default [Boolean] if `true`, incoming values of `null` will be replaced with the configured `default_value`
+        # @option kwargs [Boolean, :nullable] :required if true, this argument is non-null; if false, this argument is nullable. If `:nullable`, then the argument must be provided, though it may be `null`.
+        # @option kwargs [String] :description Positional argument also accepted
+        # @option kwargs [Class, Array<Class>] :type Input type; positional argument also accepted
+        # @option kwargs [Symbol] :name positional argument also accepted
+        # @option kwargs [Object] :default_value
+        # @option kwargs [Class, Array<Class>] :loads A GraphQL type to load for the given ID when one is present
+        # @option kwargs [Symbol] :as Override the keyword name when passed to a method
+        # @option kwargs [Symbol] :prepare A method to call to transform this argument's valuebefore sending it to field resolution
+        # @option kwargs [Boolean] :camelize if true, the name will be camelized when building the schema
+        # @option kwargs [Boolean] :from_resolver if true, a Resolver class defined this argument
+        # @option kwargs [Hash{Class => Hash}] :directives
+        # @option kwargs [String] :deprecation_reason
+        # @option kwargs [String] :comment Private, used by GraphQL-Ruby when parsing GraphQL schema files
+        # @option kwargs [GraphQL::Language::Nodes::InputValueDefinition] :ast_node Private, used by GraphQL-Ruby when parsing schema files
+        # @option kwargs [Hash, nil] :validates Options for building validators, if any should be applied
+        # @option kwargs [Boolean] :replace_null_with_default if `true`, incoming values of `null` will be replaced with the configured `default_value`
         # @param definition_block [Proc] Called with the newly-created {Argument}
-        # @param custom_kwargs [Hash] Any application-specific options; must be handled by your base {Argument} class
-        # @return [GraphQL::Schema::Argument] An instance of {argument_class}, created from `*args`
-        def argument(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, validates: nil, directives: nil, deprecation_reason: nil, replace_null_with_default: false, **custom_kwargs, &definition_block)
-          if loads
-            loads_name = arg_name || name
+        # @param kwargs [Hash] Keywords for defining an argument. Any keywords not documented here must be handled by your base Argument class.
+        # @return [GraphQL::Schema::Argument] An instance of {argument_class} created from these arguments
+        def argument(arg_name = nil, type_expr = nil, desc = nil, **kwargs, &definition_block)
+          if kwargs[:loads]
+            loads_name = arg_name || kwargs[:name]
             loads_name_as_string = loads_name.to_s
 
             inferred_arg_name = case loads_name_as_string
@@ -52,28 +52,12 @@ def argument(arg_name = nil, type_expr = nil, desc = nil, required: true, type:
               loads_name
             end
 
-            as ||= inferred_arg_name
+            kwargs[:as] ||= inferred_arg_name
           end
+          kwargs[:owner] = self
           arg_defn = self.argument_class.new(
             arg_name, type_expr, desc,
-            required: required,
-            type: type,
-            name: name,
-            loads: loads,
-            description: description,
-            comment: comment,
-            ast_node: ast_node,
-            default_value: default_value,
-            as: as,
-            from_resolver: from_resolver,
-            camelize: camelize,
-            prepare: prepare,
-            owner: self,
-            validates: validates,
-            directives: directives,
-            deprecation_reason: deprecation_reason,
-            replace_null_with_default: replace_null_with_default,
-            **custom_kwargs,
+            **kwargs,
             &definition_block
           )
           add_argument(arg_defn)

lib/graphql/schema/member/has_fields.rb

@@ -45,7 +45,6 @@ module HasFields
         # @option kwargs [Boolean] :relay_node_field (Private, used by GraphQL-Ruby)
         # @option kwargs [Boolean] :relay_nodes_field (Private, used by GraphQL-Ruby)
         # @option kwargs [Array<:ast_node, :parent, :lookahead, :owner, :execution_errors, :graphql_name, :argument_details, Symbol>] :extras Extra arguments to be injected into the resolver for this field
-
         # @param kwargs [Hash] Keywords for defining the field. Any not documented here will be passed to your base field class where they must be handled.
         # @param definition_block [Proc] an additional block for configuring the field. Receive the field as a block param, or, if no block params are defined, then the block is `instance_eval`'d on the new {Field}.
         # @yieldparam field [GraphQL::Schema::Field] The newly-created field instance

spec/graphql/schema/argument_spec.rb

@@ -800,20 +800,12 @@ class Query < GraphQL::Schema::Object
   end
 
   describe "argument definitions" do
-    it "matches the HasArgument::argument arguments for better IDE support" do
-      argument_new_arguments = GraphQL::Schema::Argument.instance_method(:initialize).parameters
-      has_arguments_argument_arguments = GraphQL::Schema::Member::HasArguments.instance_method(:argument).parameters
-      extra_argument_args = [[:keyrest, :custom_kwargs]]
-      assert_equal extra_argument_args, has_arguments_argument_arguments - argument_new_arguments
-      extra_new_args = [[:keyreq, :owner]]
-      assert_equal extra_new_args, argument_new_arguments - has_arguments_argument_arguments
-    end
-
     it "HasArguments::argument documents each argument" do
       has_arguments_argument_comment = File.read("./lib/graphql/schema/member/has_arguments.rb")[/(\s+#[^\n]*\n)+\s+def argument\(/m]
-      has_arguments_argument_doc_param_names = has_arguments_argument_comment.split("\n").map { |line| line[/@param (\S+)/]; $1 }.compact
-      has_arguments_argument_argument_names = GraphQL::Schema::Member::HasArguments.instance_method(:argument).parameters.map { |param| param[1].to_s }
-      assert_equal has_arguments_argument_doc_param_names.sort, has_arguments_argument_argument_names.sort
+      has_arguments_argument_doc_param_names = has_arguments_argument_comment.split("\n").map { |line| (line[/@param (\S+)/] || line[/@option kwargs \[.*\] :(\S+)/]); $1 }.compact
+      argument_initialize_argument_names = GraphQL::Schema::Argument.instance_method(:initialize).parameters.map { |param| param[1].to_s }
+      assert_equal ["kwargs"], has_arguments_argument_doc_param_names - argument_initialize_argument_names
+      assert_equal ["owner"], argument_initialize_argument_names - has_arguments_argument_doc_param_names
     end
 
     it "Argument::initialize documents each argument" do