rubocop-graphql 0.11.3 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffc9fa90011bdaddbf2d485a5948ede1e7bf2ade1c91c3a960799a1e0cd47bb3
-  data.tar.gz: 4dcbb755ed55538cfb8539b86f0c186e13b201bbfd0bbf3201d3091b8058c0fe
+  metadata.gz: b0b5a6defb854d907bf12c23a7262adc13b55228e3d7cf345f19ea7b1371bacb
+  data.tar.gz: 3250274062d10447eb23994e4bc1e99393d4d03a6b17221cdbda5f1d1bd4b2d6
 SHA512:
-  metadata.gz: 25cf86cd5e3e3942eafed3383df445c3f71296bc63a617ba4a0a9e597f6c355a1f5f94b1f2718439cd5606c50573758b8d3381a40af59937ba20cba150a9fe3d
-  data.tar.gz: 745057b345ba218c88b5a21addced87fc6bd972147ac72281efa0e1c1db005694f3ec44d33dc6760bdff68edddf8fedaff1d23f270ca3fc5162b5f01652da902
+  metadata.gz: 3f59543ad00f27cf92048d5fa3fb7e09ea99c9e1179839f848316025eb48d66a92012f2cdb13847113d602b740a49aab128d8a4538cf5d8c0f8ea8a2c0f47321
+  data.tar.gz: 2b5110aa616044c726f466c6e82a36af0cdad58d096c6359a97a91b3d0c6e023dd4e2ce96f8ecaf44638393bce6b2a4330fa2b3ff76b8c5ecc89d0b07ed6f5e4

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

@@ -20,23 +20,31 @@ module RuboCop
       #   end
       #
       class ArgumentUniqueness < Base
+        include RuboCop::GraphQL::NodeUniqueness
+
         MSG = "Argument names should only be defined once per block. "\
               "Argument `%<current>s` is duplicated%<field_name>s."
 
         def on_class(node)
-          global_argument_names = Set.new
-          argument_names_by_field = {}
+          return if ::RuboCop::GraphQL::Class.new(node).nested?
+
+          # { "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_full_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)

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

@@ -27,16 +27,18 @@ module RuboCop
       #   end
       #
       class FieldUniqueness < Base
+        include RuboCop::GraphQL::NodeUniqueness
+
         MSG = "Field names should only be defined once per type. "\
               "Field `%<current>s` is duplicated."
 
         def on_class(node)
-          return if nested_class?(node)
+          return if ::RuboCop::GraphQL::Class.new(node).nested?
 
           field_names_by_class = Hash.new { |h, k| h[k] = Set.new }
 
           field_declarations(node).each do |current|
-            current_class = current_class_name(current)
+            current_class = current_class_full_name(current)
             field_names = field_names_by_class[current_class]
             current_field_name = field_name(current)
 
@@ -51,10 +53,6 @@ module RuboCop
 
         private
 
-        def nested_class?(node)
-          node.each_ancestor(:class).any?
-        end
-
         def register_offense(current)
           message = format(
             self.class::MSG,
@@ -68,10 +66,6 @@ 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,166 @@
+# 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 = find_declared_arg_nodes(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_declared_arg_nodes(node)
+          argument_declarations(node).select do |arg_declaration|
+            # argument is declared on the same class that is being analyzed
+            arg_declaration.each_ancestor(:class).first == node
+          end
+        end
+
+        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)
+          return declared_arg.as if declared_arg.kwargs.as
+          return inferred_arg_name(declared_arg.name.to_s) if declared_arg.kwargs.loads
+
+          declared_arg.name
+        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/class.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    class Class
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def nested?
+        node.each_ancestor(:class).any?
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/node_uniqueness.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GraphQL
+    # Shared methods to check duplicated definitions
+    module NodeUniqueness
+      def current_class_full_name(node)
+        node.each_ancestor(:class).map(&:defined_module_name).join("::")
+      end
+    end
+  end
+end

data/lib/rubocop/graphql/version.rb

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

data/lib/rubocop-graphql.rb

@@ -9,11 +9,13 @@ require_relative "rubocop/graphql/version"
 require_relative "rubocop/graphql/inject"
 require_relative "rubocop/graphql/description_method"
 require_relative "rubocop/graphql/node_pattern"
+require_relative "rubocop/graphql/node_uniqueness"
 require_relative "rubocop/graphql/swap_range"
 
 require_relative "rubocop/graphql/argument"
 require_relative "rubocop/graphql/argument/block"
 require_relative "rubocop/graphql/argument/kwargs"
+require_relative "rubocop/graphql/class"
 require_relative "rubocop/graphql/field"
 require_relative "rubocop/graphql/field/block"
 require_relative "rubocop/graphql/field/kwargs"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-graphql
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.3
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,11 +100,13 @@ 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
 - lib/rubocop/graphql/argument/block.rb
 - lib/rubocop/graphql/argument/kwargs.rb
+- lib/rubocop/graphql/class.rb
 - lib/rubocop/graphql/description_method.rb
 - lib/rubocop/graphql/ext/snake_case.rb
 - lib/rubocop/graphql/field.rb
@@ -112,6 +114,7 @@ files:
 - lib/rubocop/graphql/field/kwargs.rb
 - lib/rubocop/graphql/inject.rb
 - lib/rubocop/graphql/node_pattern.rb
+- lib/rubocop/graphql/node_uniqueness.rb
 - lib/rubocop/graphql/schema_member.rb
 - lib/rubocop/graphql/swap_range.rb
 - lib/rubocop/graphql/version.rb
@@ -121,7 +124,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: