rubocop-graphql 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffc9fa90011bdaddbf2d485a5948ede1e7bf2ade1c91c3a960799a1e0cd47bb3
-  data.tar.gz: 4dcbb755ed55538cfb8539b86f0c186e13b201bbfd0bbf3201d3091b8058c0fe
+  metadata.gz: 4a06d74f8fd3b057575ec841300332c5803de10df0fd2af2fb36f290830370e4
+  data.tar.gz: 75ecf04464efb37fd64dbc1f5ad4d2a2c12523a277090897a832080100530252
 SHA512:
-  metadata.gz: 25cf86cd5e3e3942eafed3383df445c3f71296bc63a617ba4a0a9e597f6c355a1f5f94b1f2718439cd5606c50573758b8d3381a40af59937ba20cba150a9fe3d
-  data.tar.gz: 745057b345ba218c88b5a21addced87fc6bd972147ac72281efa0e1c1db005694f3ec44d33dc6760bdff68edddf8fedaff1d23f270ca3fc5162b5f01652da902
+  metadata.gz: 14583dce74bc8bee2f10a024aad913f607de15b4e2ea340698b2b8ba211adaadd05e8130eb860074a94b670e967c8825b8bbbbd4b9d357bef99c201040531399
+  data.tar.gz: 48b9456d0f54573da9472832322dbdd11f5e7c4793a1713131fa4fc72d4f2e8e75b0206c22eb68a1a2bfc1811af3536464c6a1a2a23c0cd137108374035107c3

data/config/default.yml

@@ -1,4 +1,5 @@
 GraphQL:
+  Enabled: true
   Include:
     - "**/graphql/**/*"
   Exclude:
@@ -104,4 +105,8 @@ GraphQL/OrderedFields:
   VersionAdded: '0.80'
   Description: 'Fields should be alphabetically sorted within groups'
 
+GraphQL/UnusedArgument:
+  Enabled: true
+  Description: 'Arguments should either be listed explicitly or **rest should be in the resolve signature'
+
 

data/lib/rubocop/cop/graphql/argument_uniqueness.rb

@@ -24,19 +24,25 @@ module RuboCop
               "Argument `%<current>s` is duplicated%<field_name>s."
 
         def on_class(node)
-          global_argument_names = Set.new
-          argument_names_by_field = {}
+          return if nested_class?(node)
+
+          # { "MyClassName" => { "test_field" => <Set: {"field_arg_name"}> } }
+          argument_names_by_field_by_class = Hash.new do |h, k|
+            h[k] = Hash.new do |h1, k1|
+              h1[k1] = Set.new
+            end
+          end
 
           argument_declarations(node).each do |current|
             current_field_name = field_name(current)
             current_argument_name = argument_name(current)
+            class_name = current_class_name(current)
 
-            if current_field_name
-              argument_names_by_field[current_field_name] ||= Set.new
-              argument_names = argument_names_by_field[current_field_name]
-            else
-              argument_names = global_argument_names
-            end
+            argument_names = if current_field_name
+                               argument_names_by_field_by_class[class_name][current_field_name]
+                             else
+                               argument_names_by_field_by_class[class_name][:root]
+                             end
 
             unless argument_names.include?(current_argument_name)
               argument_names.add(current_argument_name)
@@ -49,6 +55,14 @@ module RuboCop
 
         private
 
+        def current_class_name(node)
+          node.each_ancestor(:class).first.defined_module_name
+        end
+
+        def nested_class?(node)
+          node.each_ancestor(:class).any?
+        end
+
         def register_offense(current)
           current_field_name = field_name(current)
           field_name_message = " in field `#{current_field_name}`" if current_field_name

data/lib/rubocop/cop/graphql/unused_argument.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module GraphQL
+      # Arguments should either be listed explicitly or **rest should be in the resolve signature.
+      #
+      # @example
+      #   # good
+      #
+      #   class SomeResolver < Resolvers::Base
+      #     argument :arg1, String, required: true
+      #     argument :arg2, String, required: true
+      #
+      #     def resolve(arg1:, arg2:); end
+      #   end
+      #
+      #   # good
+      #
+      #   class SomeResolver < Resolvers::Base
+      #     argument :arg1, String, required: true
+      #     argument :arg2, String, required: true
+      #
+      #     def resolve(arg1:, **rest); end
+      #   end
+      #
+      #   # good
+      #
+      #   class SomeResolver < Resolvers::Base
+      #     type SomeType, null: false
+      #
+      #     argument :arg1, String, required: true
+      #     argument :arg2, String, required: true
+      #
+      #     def resolve(args); end
+      #   end
+      #
+      #   # bad
+      #
+      #   class SomeResolver < Resolvers::Base
+      #     type SomeType, null: false
+      #
+      #     argument :arg1, String, required: true
+      #     argument :arg2, String, required: true
+      #
+      #     def resolve(arg1:); end
+      #   end
+      #
+      #   # bad
+      #
+      #   class SomeResolver < Resolvers::Base
+      #     type SomeType, null: false
+      #
+      #     argument :arg1, String, required: true
+      #     argument :arg2, String, required: true
+      #
+      #     def resolve; end
+      #   end
+      #
+      class UnusedArgument < Base
+        extend AutoCorrector
+
+        MSG = "Argument%<ending>s `%<unresolved_args>s` should be listed in the resolve signature."
+
+        def on_class(node)
+          resolve_method_node = find_resolve_method_node(node)
+          return if resolve_method_node.nil? ||
+                    resolve_method_node.arguments.any? do |arg|
+                      arg.arg_type? || arg.kwrestarg_type?
+                    end
+
+          declared_arg_nodes = argument_declarations(node)
+          return unless declared_arg_nodes.any?
+
+          unresolved_args = find_unresolved_args(resolve_method_node, declared_arg_nodes)
+          register_offense(resolve_method_node, unresolved_args) if unresolved_args.any?
+        end
+
+        private
+
+        def find_resolve_method_node(node)
+          resolve_method_nodes = resolve_method_definition(node)
+          resolve_method_nodes.to_a.last if resolve_method_nodes.any?
+        end
+
+        def find_unresolved_args(method_node, declared_arg_nodes)
+          resolve_method_kwargs = method_node.arguments.select(&:kwarg_type?).map do |node|
+            node.node_parts[0]
+          end.to_set
+          declared_args = declared_arg_nodes.map { |node| RuboCop::GraphQL::Argument.new(node) }
+          declared_args.map(&:name).uniq.reject do |declared_arg|
+            resolve_method_kwargs.include?(declared_arg)
+          end
+        end
+
+        def register_offense(node, unresolved_args)
+          unresolved_args_source = unresolved_args.map { |v| "#{v}:" }.join(", ")
+
+          message = format(
+            self.class::MSG,
+            unresolved_args: unresolved_args_source,
+            ending: unresolved_args.size == 1 ? "" : "s"
+          )
+
+          add_offense(node, message: message) do |corrector|
+            if node.arguments?
+              corrector.insert_after(arg_end(node.arguments.last), ", #{unresolved_args_source}")
+            else
+              corrector.insert_after(method_name(node), "(#{unresolved_args_source})")
+            end
+          end
+        end
+
+        def method_name(node)
+          node.loc.keyword.end.resize(node.method_name.to_s.size + 1)
+        end
+
+        def arg_end(node)
+          node.loc.expression.end
+        end
+
+        def_node_search :argument_declarations, <<~PATTERN
+          (send nil? :argument (:sym _) ...)
+        PATTERN
+
+        def_node_search :resolve_method_definition, <<~PATTERN
+          (def :resolve
+            (args ...) ...)
+        PATTERN
+      end
+    end
+  end
+end

data/lib/rubocop/cop/graphql_cops.rb

@@ -16,3 +16,4 @@ require_relative "graphql/resolver_method_length"
 require_relative "graphql/object_description"
 require_relative "graphql/ordered_arguments"
 require_relative "graphql/ordered_fields"
+require_relative "graphql/unused_argument"

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.11.3".freeze
+    VERSION = "0.12.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - lib/rubocop/cop/graphql/ordered_arguments.rb
 - lib/rubocop/cop/graphql/ordered_fields.rb
 - lib/rubocop/cop/graphql/resolver_method_length.rb
+- lib/rubocop/cop/graphql/unused_argument.rb
 - lib/rubocop/cop/graphql_cops.rb
 - lib/rubocop/graphql.rb
 - lib/rubocop/graphql/argument.rb
@@ -121,7 +122,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/DmitryTsepelev/rubocop-graphql
   source_code_uri: https://github.com/DmitryTsepelev/rubocop-graphql
-  changelog_uri: https://github.com/DmitryTsepelev/rubocop-graphql/CHANGELOG.md
+  changelog_uri: https://github.com/DmitryTsepelev/rubocop-graphql/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: