rubocop-graphql 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a06d74f8fd3b057575ec841300332c5803de10df0fd2af2fb36f290830370e4
-  data.tar.gz: 75ecf04464efb37fd64dbc1f5ad4d2a2c12523a277090897a832080100530252
+  metadata.gz: d809ed60d2d98c5f7f84a3555d8ad24ad2c2e1ece6a5fed616b6698260981d29
+  data.tar.gz: e62936fc399419ee72070e658be32660763a96144776727e183007aa53ad0bd8
 SHA512:
-  metadata.gz: 14583dce74bc8bee2f10a024aad913f607de15b4e2ea340698b2b8ba211adaadd05e8130eb860074a94b670e967c8825b8bbbbd4b9d357bef99c201040531399
-  data.tar.gz: 48b9456d0f54573da9472832322dbdd11f5e7c4793a1713131fa4fc72d4f2e8e75b0206c22eb68a1a2bfc1811af3536464c6a1a2a23c0cd137108374035107c3
+  metadata.gz: 8c508f31ceb2e6f1290ef0220896019c5f3ff007dbd2ec651ba44ad5cc422680ec761ccb6739a7e90f243cc434b787f849d872143c6e709967deeeb81e6500ec
+  data.tar.gz: ccd1741a8b20403f5a904aa321526fb089f4af357b1a8cce37547221f11ef1fa4f407169aedb35923b85c4b5dc5eb0bba76f74ce7b585b260a0d90549c2d7dfb

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

@@ -20,11 +20,13 @@ 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)
-          return if nested_class?(node)
+          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|
@@ -36,7 +38,7 @@ module RuboCop
           argument_declarations(node).each do |current|
             current_field_name = field_name(current)
             current_argument_name = argument_name(current)
-            class_name = current_class_name(current)
+            class_name = current_class_full_name(current)
 
             argument_names = if current_field_name
                                argument_names_by_field_by_class[class_name][current_field_name]
@@ -55,14 +57,6 @@ 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

@@ -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/ordered_arguments.rb

@@ -57,7 +57,19 @@ module RuboCop
               "Field `%<current>s` should appear before `%<previous>s`."
 
         def on_class(node)
-          argument_declarations(node).each_cons(2) do |previous, current|
+          declarations_with_blocks = argument_declarations_with_blocks(node)
+          declarations_without_blocks = argument_declarations_without_blocks(node)
+
+          argument_declarations = declarations_without_blocks.map do |node|
+            arg_name = argument_name(node)
+            same_arg_with_block_declaration = declarations_with_blocks.find do |dec|
+              argument_name(dec) == arg_name
+            end
+
+            same_arg_with_block_declaration || node
+          end
+
+          argument_declarations.each_cons(2) do |previous, current|
             next unless consecutive_lines(previous, current)
             next if argument_name(current) >= argument_name(previous)
 
@@ -80,16 +92,26 @@ module RuboCop
         end
 
         def argument_name(node)
-          node.first_argument.value.to_s
+          argument = node.block_type? ? node.children.first.first_argument : node.first_argument
+
+          argument.value.to_s
         end
 
         def consecutive_lines(previous, current)
           previous.source_range.last_line == current.source_range.first_line - 1
         end
 
-        def_node_search :argument_declarations, <<~PATTERN
+        def_node_search :argument_declarations_without_blocks, <<~PATTERN
           (send nil? :argument (:sym _) ...)
         PATTERN
+
+        def_node_search :argument_declarations_with_blocks, <<~PATTERN
+          (block
+            (send nil? :argument
+              (:sym _)
+              ...)
+            ...)
+        PATTERN
       end
     end
   end

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

@@ -10,16 +10,19 @@ module RuboCop
       #
       #   class SomeResolver < Resolvers::Base
       #     argument :arg1, String, required: true
-      #     argument :arg2, 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:, arg2:); end
+      #     def resolve(arg1:, user:, article:, comments:); end
       #   end
       #
       #   # good
       #
       #   class SomeResolver < Resolvers::Base
       #     argument :arg1, String, required: true
-      #     argument :arg2, 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
@@ -69,7 +72,7 @@ module RuboCop
                       arg.arg_type? || arg.kwrestarg_type?
                     end
 
-          declared_arg_nodes = argument_declarations(node)
+          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)
@@ -78,18 +81,31 @@ module RuboCop
 
         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?
+          resolve_method_nodes.find do |resolve_node|
+            # reject resolve methods from other classes
+            resolve_node.each_ancestor(:class).first == node
+          end
         end
 
         def find_unresolved_args(method_node, declared_arg_nodes)
-          resolve_method_kwargs = method_node.arguments.select(&:kwarg_type?).map do |node|
+          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(&:name).uniq.reject do |declared_arg|
-            resolve_method_kwargs.include?(declared_arg)
+          declared_args.map(&method(:arg_name)).uniq.reject do |declared_arg_name|
+            resolve_method_kwargs_names.include?(declared_arg_name)
           end
         end
 
@@ -119,6 +135,26 @@ module RuboCop
           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

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.12.0".freeze
+    VERSION = "0.13.0".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.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Dmitry Tsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - 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
@@ -113,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