rubocop-graphql 0.11.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660e5888a933adf211a4c140882cd9bab799e0f0bcaa545f7ec1bbe9668e064f
-  data.tar.gz: efca9c85b37c7a91d46844ef7f574dc434ffffbb1a01adfcefc3a31c71cf2d02
+  metadata.gz: 34e03ca837f50f20a65cb0e80d7322c5b2998160148dbc354052875335efee8d
+  data.tar.gz: d14bb40f366fa3320c56262a7fafa7d47ffbe445092e481b3d9d0e946bd64649
 SHA512:
-  metadata.gz: b51da944eeca0ff3be527823992860e9c690bf8dca86eab7800e0d694cd212654bdc614c5e849516bf7afabbb36c36c1da8cdcb7bb490c84f66606d79439dab5
-  data.tar.gz: acd228993fe068085136b68e21d872ac52db7ddd7dd36e7ee047d95b2f7fe406db2af8de01a51275b023d45a29bf4a9b0eca60d824fcfb31742e3115b0703bb8
+  metadata.gz: 634b1f66850e898eb545d78da1f6ccb8c0b0bc4fe11d5910e9d8f4820ea1af19e5d55a09ca755acfea73eb6cbb114ac59436a1dae6e6282da8b5fc176c09533e
+  data.tar.gz: 95ec70c992b7428116555b7c1107d1465d14ce7aa6753efea42ad4739a3c6c4bb3f67f0450eb320cd04d8bba4afbce0b00d1d3e4cef8aa305fa4eb80f81113bd

data/config/default.yml

@@ -1,6 +1,10 @@
 GraphQL:
+  Enabled: true
   Include:
     - "**/graphql/**/*"
+  Exclude:
+    - "spec/**/*"
+    - "test/**/*"
 
 GraphQL/ArgumentDescription:
   Enabled: true
@@ -101,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/field_uniqueness.rb

@@ -31,9 +31,13 @@ module RuboCop
               "Field `%<current>s` is duplicated."
 
         def on_class(node)
-          field_names = Set.new
+          return if nested_class?(node)
+
+          field_names_by_class = Hash.new { |h, k| h[k] = Set.new }
 
           field_declarations(node).each do |current|
+            current_class = current_class_name(current)
+            field_names = field_names_by_class[current_class]
             current_field_name = field_name(current)
 
             unless field_names.include?(current_field_name)
@@ -47,6 +51,10 @@ module RuboCop
 
         private
 
+        def nested_class?(node)
+          node.each_ancestor(:class).any?
+        end
+
         def register_offense(current)
           message = format(
             self.class::MSG,
@@ -60,6 +68,10 @@ module RuboCop
           node.first_argument.value.to_s
         end
 
+        def current_class_name(node)
+          node.each_ancestor(:class).first.defined_module_name
+        end
+
         def_node_search :field_declarations, <<~PATTERN
           {
             (send nil? :field (:sym _) ...)

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

@@ -0,0 +1,160 @@
+# 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 :user_id, String, required: true, loads: Types::UserType
+      #     argument :post_id, String, loads: Types::PostType, as: :article
+      #     argument :comment_ids, String, loads: Types::CommentType
+      #
+      #     def resolve(arg1:, user:, article:, comments:); end
+      #   end
+      #
+      #   # good
+      #
+      #   class SomeResolver < Resolvers::Base
+      #     argument :arg1, String, required: true
+      #     argument :user_id, String, required: true, loads: Types::UserType
+      #     argument :comment_ids, String, loads: Types::CommentType
+      #
+      #     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 do |arg|
+            arg.kwarg_type? || arg.kwoptarg_type?
+          end
+          resolve_method_kwargs_names = resolve_method_kwargs.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(&method(:arg_name)).uniq.reject do |declared_arg_name|
+            resolve_method_kwargs_names.include?(declared_arg_name)
+          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 inferred_arg_name(name_as_string)
+          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
+        end
+
+        def arg_name(declared_arg)
+          if declared_arg.kwargs.loads.nil?
+            declared_arg.name
+          else
+            declared_arg.as || inferred_arg_name(declared_arg.name.to_s)
+          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/argument/kwargs.rb

@@ -19,6 +19,14 @@ module RuboCop
           (pair (sym :description) ...)
         PATTERN
 
+        def_node_matcher :loads_kwarg?, <<~PATTERN
+          (pair (sym :loads) ...)
+        PATTERN
+
+        def_node_matcher :as_kwarg?, <<~PATTERN
+          (pair (sym :as) ...)
+        PATTERN
+
         def initialize(argument_node)
           @nodes = argument_kwargs(argument_node) || []
         end
@@ -26,6 +34,14 @@ module RuboCop
         def description
           @nodes.find { |kwarg| description_kwarg?(kwarg) }
         end
+
+        def loads
+          @nodes.find { |kwarg| loads_kwarg?(kwarg) }
+        end
+
+        def as
+          @nodes.find { |kwarg| as_kwarg?(kwarg) }
+        end
       end
     end
   end

data/lib/rubocop/graphql/argument.rb

@@ -13,6 +13,10 @@ module RuboCop
         (send nil? :argument (:sym $_) ...)
       PATTERN
 
+      def_node_matcher :argument_as, <<~PATTERN
+        (pair (sym :as) (sym $_))
+      PATTERN
+
       attr_reader :node
 
       def initialize(node)
@@ -23,6 +27,10 @@ module RuboCop
         @name ||= argument_name(@node)
       end
 
+      def as
+        @as ||= argument_as(kwargs.as)
+      end
+
       def description
         @description ||= argument_description(@node) || kwargs.description || block.description
       end

data/lib/rubocop/graphql/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module GraphQL
-    VERSION = "0.11.1".freeze
+    VERSION = "0.12.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.1
 platform: ruby
 authors:
 - Dmitry Tsepelev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-01-05 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,8 +122,8 @@ 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
-post_install_message:
+  changelog_uri: https://github.com/DmitryTsepelev/rubocop-graphql/blob/master/CHANGELOG.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Automatic performance checking tool for Ruby code.
 test_files: []